Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/LuaState.h @ 8858

Last change on this file since 8858 was 8858, checked in by landauf, 9 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 4.9 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Benjamin Knecht
24 *      Reto Grieder
25 *   Co-authors:
26 *      ...
27 *
28 */
29
30/**
31    @defgroup Lua Lua
32    @ingroup Core
33*/
34
35/**
36    @file
37    @ingroup Lua
38*/
39
40#ifndef _LuaState_H__
41#define _LuaState_H__
42
43#include "CorePrereqs.h"
44
45#include <map>
46#include <sstream>
47#include <string>
48#include <vector>
49#include <boost/shared_ptr.hpp>
50
51#include "util/Output.h"
52
53namespace orxonox // tolua_export
54{ // tolua_export
55    class LuaFunctor; // tolua_export
56
57    //! callback class that executes lua code
58    class _CoreExport LuaFunctor
59    {
60        public:
61            LuaFunctor(const std::string& code, LuaState* luaState);
62            void operator()();
63
64        private:
65            std::string code_;
66            LuaState*   lua_;
67    };
68
69
70    /**
71    @brief
72        Representation of an interface to lua
73    */
74    class _CoreExport LuaState // tolua_export
75    { // tolua_export
76    public:
77        LuaState();
78        ~LuaState();
79
80        bool doFile(const std::string& filename); // tolua_export
81        bool doString(const std::string& code, const shared_ptr<ResourceInfo>& sourceFileInfo = shared_ptr<ResourceInfo>());
82
83        bool includeFile(const std::string& filename); // tolua_export
84        bool includeString(const std::string& code, const shared_ptr<ResourceInfo>& sourceFileInfo = shared_ptr<ResourceInfo>());
85
86        void luaPrint(const std::string& str); // tolua_export
87        void luaOutput(orxonox::level::OutputLevel level, const std::string& context, const std::string& message); // tolua_export
88        void luaOutput(orxonox::level::OutputLevel level, const std::string& message); // tolua_export
89        void luaOutput(const std::string& message); // tolua_export
90        bool fileExists(const std::string& filename); // tolua_export
91        std::string getSourceCode(const std::string& filename); // tolua_export
92
93        const std::stringstream& getOutput() const { return output_; }
94        void clearOutput() { output_.clear(); } // tolua_export
95
96        void setIncludeParser(std::string (*function)(const std::string&)) { includeParseFunction_ = function; }
97        lua_State* getInternalLuaState() { return luaState_; }
98
99        void setDefaultResourceInfo(const shared_ptr<ResourceInfo>& sourceFileInfo) { this->sourceFileInfo_ = sourceFileInfo; }
100        const shared_ptr<ResourceInfo>& getDefaultResourceInfo() { return this->sourceFileInfo_; }
101
102        LuaFunctor* createLuaFunctor(const std::string& code) { return new LuaFunctor(code, this); } // tolua_export
103        //! Tells about whether IOConsole was activated. The Lua debugger only works with a normal console.
104        bool usingIOConsole() const; // tolua_export
105
106        static bool addToluaInterface(int (*function)(lua_State*), const std::string& name);
107        static bool removeToluaInterface(const std::string& name);
108        static void openToluaInterfaces(lua_State* state);
109        static void closeToluaInterfaces(lua_State* state);
110
111        static const std::string ERROR_HANDLER_NAME;
112
113    private:
114        shared_ptr<ResourceInfo> getFileInfo(const std::string& filename);
115
116        std::stringstream output_;
117        lua_State* luaState_;
118        bool bIsRunning_;
119        shared_ptr<ResourceInfo> sourceFileInfo_;
120        std::map<std::string, std::string> sourceCodeMap_;
121        std::string (*includeParseFunction_)(const std::string&);
122
123        typedef std::map<std::string, int (*)(lua_State *L)> ToluaInterfaceMap;
124        static ToluaInterfaceMap& getToluaInterfaces();
125        static std::vector<LuaState*>& getInstances();
126    }; // tolua_export
127
128
129    //! Helper class that registers/unregisters tolua bindings
130    class ToluaBindingsHelper
131    {
132    public:
133        ToluaBindingsHelper(int (*function)(lua_State*), const std::string& libraryName)
134            : libraryName_(libraryName)
135        {
136            LuaState::addToluaInterface(function, libraryName_);
137        }
138        ~ToluaBindingsHelper()
139        {
140            LuaState::removeToluaInterface(libraryName_);
141        }
142    private:
143        std::string libraryName_;
144    };
145} // tolua_export
146
147#endif /* _LuaState_H__ */
Note: See TracBrowser for help on using the repository browser.