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