Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/libraries/core/command/TclBind.cc @ 7361

Last change on this file since 7361 was 7361, checked in by landauf, 10 years ago

added documentation

  • Property svn:eol-style set to native
File size: 8.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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#include "TclBind.h"
30
31#include <exception>
32#include <string>
33#include <cpptcl/cpptcl.h>
34
35#include "SpecialConfig.h"
36#include "util/Debug.h"
37#include "util/Exception.h"
38#include "util/StringUtils.h"
39#include "core/PathConfig.h"
40#include "CommandExecutor.h"
41#include "ConsoleCommand.h"
42#include "TclThreadManager.h"
43
44namespace orxonox
45{
46    SetConsoleCommand("tcl", &TclBind::tcl);
47    SetConsoleCommand("bgerror", &TclBind::bgerror);
48
49    TclBind* TclBind::singletonPtr_s = 0;
50
51    /**
52        @brief Constructor: Initializes the Tcl-interpreter with a given data path.
53        @param datapath Path to the directory that contains the Orxonox-specific Tcl-files
54    */
55    TclBind::TclBind(const std::string& datapath)
56    {
57        this->interpreter_ = 0;
58        this->bSetTclDataPath_ = false;
59        this->setDataPath(datapath);
60    }
61
62    /**
63        @brief Destructor: Deletes the Tcl-interpreter.
64    */
65    TclBind::~TclBind()
66    {
67        if (this->interpreter_)
68            delete this->interpreter_;
69    }
70
71    /**
72        @brief Defines the path to the directory that contains the Orxonox-specific Tcl-files and initializes the Tcl-interpreter accordingly.
73    */
74    void TclBind::setDataPath(const std::string& datapath)
75    {
76        // String has POSIX slashes
77        this->tclDataPath_ = datapath + "tcl" + '/';
78        this->bSetTclDataPath_ = true;
79
80        this->initializeTclInterpreter();
81    }
82
83    /**
84        @brief Creates and initializes the Tcl-interpreter by registering all callbacks and defining some useful functions.
85    */
86    void TclBind::initializeTclInterpreter()
87    {
88        if (this->bSetTclDataPath_ && !this->interpreter_)
89        {
90            this->interpreter_ = this->createTclInterpreter();
91
92            this->interpreter_->def("::orxonox::query", TclBind::tcl_query, Tcl::variadic());
93            this->interpreter_->def("::orxonox::crossquery", TclThreadManager::tcl_crossquery, Tcl::variadic());
94            this->interpreter_->def("execute", TclBind::tcl_execute, Tcl::variadic());
95            this->interpreter_->def("::orxonox::crossexecute", TclThreadManager::tcl_crossexecute, Tcl::variadic());
96
97            try
98            {
99                this->interpreter_->eval("proc query        {args}    { ::orxonox::query $args }");
100                this->interpreter_->eval("proc crossquery   {id args} { ::orxonox::crossquery 0 $id $args }");
101                this->interpreter_->eval("proc crossexecute {id args} { ::orxonox::crossquery 0 $id $args }");
102                this->interpreter_->eval("proc running      {}        { return 1 }");
103                this->interpreter_->eval("set id 0");
104                this->interpreter_->eval("rename exit ::tcl::exit; proc exit {} { execute exit }");
105            }
106            catch (Tcl::tcl_error const &e)
107            {   COUT(1) << "Tcl error while creating Tcl-interpreter: " << e.what() << std::endl;   }
108        }
109    }
110
111    /**
112        @brief Creates and initializes a new Tcl-interpreter and calls the Orxonox-specific
113        init.tcl script that defines some special functions which are required by Orxonox.
114    */
115    Tcl::interpreter* TclBind::createTclInterpreter()
116    {
117        Tcl::interpreter* interpreter = new Tcl::interpreter();
118        const std::string& libpath = TclBind::getTclLibraryPath();
119
120        try
121        {
122            if (!libpath.empty())
123                interpreter->eval("set tcl_library \"" + libpath + '"');
124
125            Tcl_Init(interpreter->get());
126
127            interpreter->eval("source \"" + TclBind::getInstance().tclDataPath_ + "/init.tcl\"");
128        }
129        catch (Tcl::tcl_error const &e)
130        {   COUT(1) << "Tcl error while creating Tcl-interpreter: " << e.what() << std::endl; COUT(1) << "Error: Tcl isn't properly initialized. Orxonox might possibly not work like that." << std::endl;   }
131
132        return interpreter;
133    }
134
135    /**
136        @brief Returns the path to the Tcl-library (not the Orxonox-specific Tcl-files).
137    */
138    std::string TclBind::getTclLibraryPath()
139    {
140#ifdef DEPENDENCY_PACKAGE_ENABLE
141        if (PathConfig::isDevelopmentRun())
142            return (std::string(specialConfig::dependencyLibraryDirectory) + "/tcl");
143        else
144            return (PathConfig::getRootPathString() + "lib/tcl");
145#else
146        return "";
147#endif
148    }
149
150    /**
151        @brief Callback: Used to send an Orxonox-command from Tcl to the CommandExecutor and to send its result back to Tcl.
152    */
153    std::string TclBind::tcl_query(Tcl::object const &args)
154    {
155        COUT(4) << "Tcl_query: " << args.get() << std::endl;
156
157        const std::string& command = stripEnclosingBraces(args.get());
158
159        int error;
160        CommandEvaluation evaluation = CommandExecutor::evaluate(command);
161        const std::string& result = evaluation.query(&error);
162        switch (error)
163        {
164            case CommandExecutor::Error:       COUT(1) << "Error: Can't execute command \"" << command << "\", command doesn't exist. (B)" << std::endl; break;
165            case CommandExecutor::Incomplete:  COUT(1) << "Error: Can't execute command \"" << command << "\", not enough arguments given. (B)" << std::endl; break;
166            case CommandExecutor::Deactivated: COUT(1) << "Error: Can't execute command \"" << command << "\", command is not active. (B)" << std::endl; break;
167            case CommandExecutor::Denied:      COUT(1) << "Error: Can't execute command \"" << command << "\", access denied. (B)" << std::endl; break;
168        }
169
170        if (error == CommandExecutor::Error)
171            COUT(3) << "Did you mean \"" << evaluation.getCommandSuggestion() << "\"?" << std::endl;
172
173        return result;
174    }
175
176    /**
177        @brief Callback: Used to send an Orxonox-command from Tcl to the CommandExecutor.
178    */
179    void TclBind::tcl_execute(Tcl::object const &args)
180    {
181        COUT(4) << "Tcl_execute: " << args.get() << std::endl;
182        const std::string& command = stripEnclosingBraces(args.get());
183
184        if (CommandExecutor::execute(command, false))
185        {
186            COUT(1) << "Error: Can't execute command \"" << command << "\"!" << std::endl;
187        }
188    }
189
190    /**
191        @brief Console command, executes Tcl code. Can be used to bind Tcl-commands to a key, because native
192        Tcl-commands can not be evaluated and are thus not supported by the key-binder.
193    */
194    std::string TclBind::tcl(const std::string& tclcode)
195    {
196        if (TclBind::getInstance().interpreter_)
197        {
198            try
199            {
200                const std::string& output = TclBind::getInstance().interpreter_->eval("uplevel #0 " + tclcode);
201                if (!output.empty())
202                {
203                    COUT(0) << "tcl> " << output << std::endl;
204                }
205                return output;
206            }
207            catch (Tcl::tcl_error const &e)
208            {   COUT(1) << "tcl> Error: " << e.what() << std::endl;   }
209        }
210
211        return "";
212    }
213
214    /**
215        @brief Console command and implementation of the Tcl-feature "bgerror" which is called if an error
216        occurred in the background of a Tcl-script.
217    */
218    void TclBind::bgerror(const std::string& error)
219    {
220        COUT(1) << "Tcl background error: " << stripEnclosingBraces(error) << std::endl;
221    }
222
223    /**
224        @brief Executes Tcl-code and returns the return-value.
225        @param tclcode A string that contains Tcl-code
226        @param error A pointer to an integer (or NULL) that is used to write an error-code (see @ref CommandExecutorErrorCodes "CommandExecutor error codes")
227        @return Returns the return-value of the executed code (or an empty string if there's no return-value)
228    */
229    std::string TclBind::eval(const std::string& tclcode, int* error)
230    {
231        if (error)
232            *error = CommandExecutor::Success;
233
234        try
235        {
236            // execute the code
237            return TclBind::getInstance().interpreter_->eval(tclcode);
238        }
239        catch (Tcl::tcl_error const &e)
240        {   COUT(1) << "Tcl error: " << e.what() << std::endl;   }
241
242        if (error)
243            *error = CommandExecutor::Error;
244        return "";
245    }
246}
Note: See TracBrowser for help on using the repository browser.