xoreos  0.0.5
util.h
Go to the documentation of this file.
1 /* xoreos - A reimplementation of BioWare's Aurora engine
2  *
3  * xoreos is the legal property of its developers, whose names
4  * can be found in the AUTHORS file distributed with this source
5  * distribution.
6  *
7  * xoreos is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * xoreos is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
25 #ifndef AURORA_NWSCRIPT_UTIL_H
26 #define AURORA_NWSCRIPT_UTIL_H
27 
28 #include "src/common/ustring.h"
29 
30 namespace Aurora {
31 
32 namespace NWScript {
33 
34 class Object;
35 class FunctionContext;
36 
38 Common::UString formatTag(const Object *object);
39 
41 Common::UString formatParams(const FunctionContext &ctx);
42 
44 Common::UString formatReturn(const FunctionContext &ctx);
45 
48 
50 void formatVariable(Common::UString &str, const Variable &var);
51 
52 } // End of namespace NWScript
53 
54 } // End of namespace Aurora
55 
56 #endif // AURORA_NWSCRIPT_UTIL_H
void formatVariable(Common::UString &str, const Variable &var)
Print a description of this variable into that string.
Definition: util.cpp:41
Common::UString formatTag(const Object *object)
Construct a string with the tag of this object.
Definition: util.cpp:34
A class holding an UTF-8 string.
Definition: ustring.h:48
Common::UString formatType(Type type)
Construct a string describing this variable type.
Definition: util.cpp:130
Common::UString formatReturn(const FunctionContext &ctx)
Construct a string describing the return value of this function.
Definition: util.cpp:121
Unicode string handling.
Common::UString formatParams(const FunctionContext &ctx)
Construct a string describing parameters of this function.
Definition: util.cpp:109