4 // Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
6 // This program is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU General Public License
8 // as published by the Free Software Foundation; either version 2
9 // of the License, or (at your option) any later version.
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // You should have received a copy of the GNU General Public License
17 // along with this program; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 #include "console.hpp"
23 #include "video/drawing_context.hpp"
24 #include "video/surface.hpp"
25 #include "scripting/squirrel_error.hpp"
26 #include "scripting/squirrel_util.hpp"
27 #include "physfs/physfs_stream.hpp"
28 #include "player_status.hpp"
31 #include "resources.hpp"
33 /// speed (pixels/s) the console closes
34 static const float FADE_SPEED = 1;
37 : history_position(history.end()), vm(NULL), backgroundOffset(0),
38 height(0), alpha(1.0), offset(0), focused(false), stayOpen(0) {
45 sq_release(Scripting::global_vm, &vm_object);
50 Console::init_graphics()
52 font.reset(new Font("images/engine/fonts/white-small.png",
53 "images/engine/fonts/shadow-small.png", 8, 9, 1));
54 fontheight = font->get_height();
55 background.reset(new Surface("images/engine/console.png"));
56 background2.reset(new Surface("images/engine/console2.png"));
60 Console::flush(ConsoleStreamBuffer* buffer)
62 if (buffer == &outputBuffer) {
63 std::string s = outputBuffer.str();
64 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
65 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
67 outputBuffer.str(std::string());
70 if (buffer == &inputBuffer) {
71 std::string s = inputBuffer.str();
72 if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
73 while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
76 inputBuffer.str(std::string());
82 Console::execute_script(const std::string& command)
84 using namespace Scripting;
87 vm = Scripting::global_vm;
88 HSQUIRRELVM new_vm = sq_newthread(vm, 16);
90 throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
92 // store reference to thread
93 sq_resetobject(&vm_object);
94 if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
95 throw Scripting::SquirrelError(vm, "Couldn't get vm object for console");
96 sq_addref(vm, &vm_object);
99 // create new roottable for thread
101 sq_pushroottable(new_vm);
102 if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
103 throw Scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");
105 sq_setroottable(new_vm);
110 std::string filename = "scripts/console.nut";
111 IFileStream stream(filename);
112 Scripting::compile_and_run(vm, stream, filename);
113 } catch(std::exception& e) {
114 log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
118 SQInteger oldtop = sq_gettop(vm);
120 if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
122 throw SquirrelError(vm, "Couldn't compile command");
124 sq_pushroottable(vm);
125 if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
126 throw SquirrelError(vm, "Problem while executing command");
128 if(sq_gettype(vm, -1) != OT_NULL)
129 addLine(squirrel2string(vm, -1));
130 } catch(std::exception& e) {
133 SQInteger newtop = sq_gettop(vm);
134 if(newtop < oldtop) {
135 log_fatal << "Script destroyed squirrel stack..." << std::endl;
137 sq_settop(vm, oldtop);
144 std::string s = inputBuffer.str();
145 if (s.length() > 0) {
146 s.erase(s.length()-1);
148 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
153 Console::scroll(int numLines)
156 if (offset > 0) offset = 0;
160 Console::show_history(int offset)
162 while ((offset > 0) && (history_position != history.end())) {
166 while ((offset < 0) && (history_position != history.begin())) {
170 if (history_position == history.end()) {
171 inputBuffer.str(std::string());
173 inputBuffer.str(*history_position);
174 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
179 Console::autocomplete()
181 std::string cmdPart = inputBuffer.str();
182 addLine("> "+cmdPart);
184 std::string cmdList = "";
186 for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
187 std::string cmdKnown = i->first;
188 if (cmdKnown.substr(0, cmdPart.length()) == cmdPart) {
189 if (cmdListLen > 0) cmdList = cmdList + ", ";
190 cmdList = cmdList + cmdKnown;
194 if (cmdListLen == 0) addLine("No known command starts with \""+cmdPart+"\"");
195 if (cmdListLen == 1) {
196 inputBuffer.str(cmdList);
197 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
199 if (cmdListLen > 1) addLine(cmdList);
203 Console::addLine(std::string s)
205 std::cerr << s << std::endl;
206 while (s.length() > 99) {
207 lines.push_front(s.substr(0, 99-3)+"...");
208 s = "..."+s.substr(99-3);
212 while (lines.size() >= 1000)
218 height += fontheight;
227 Console::parse(std::string s)
229 // make sure we actually have something to parse
230 if (s.length() == 0) return;
232 // add line to history
233 history.push_back(s);
234 history_position = history.end();
236 // split line into list of args
237 std::vector<std::string> args;
241 start = s.find_first_not_of(" ,", end);
242 end = s.find_first_of(" ,", start);
243 if (start == s.npos) break;
244 args.push_back(s.substr(start, end-start));
247 // command is args[0]
248 if (args.size() == 0) return;
249 std::string command = args.front();
250 args.erase(args.begin());
252 // ignore if it's an internal command
253 if (consoleCommand(command,args)) return;
255 // look up registered ccr
256 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
257 if ((i == commands.end()) || (i->second.size() == 0)) {
260 } catch(std::exception& e) {
266 // send command to the most recently registered ccr
267 ConsoleCommandReceiver* ccr = i->second.front();
268 if (ccr->consoleCommand(command, args) != true) log_warning << "Sent command to registered ccr, but command was unhandled" << std::endl;
272 Console::consoleCommand(std::string command, std::vector<std::string> arguments)
274 if (command == "ccrs") {
275 if (arguments.size() != 1) {
276 log_info << "Usage: ccrs <command>" << std::endl;
279 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(arguments[0]);
280 if ((i == commands.end()) || (i->second.size() == 0)) {
281 log_info << "unknown command: \"" << arguments[0] << "\"" << std::endl;
285 std::ostringstream ccr_list;
286 std::list<ConsoleCommandReceiver*> &ccrs = i->second;
287 std::list<ConsoleCommandReceiver*>::iterator j;
288 for (j = ccrs.begin(); j != ccrs.end(); j++) {
289 if (j != ccrs.begin()) ccr_list << ", ";
290 ccr_list << "[" << *j << "]";
293 log_info << "registered ccrs for \"" << arguments[0] << "\": " << ccr_list.str() << std::endl;
321 // clear input buffer
322 inputBuffer.str(std::string());
328 if (Console::hasFocus()) {
337 Console::update(float elapsed_time)
340 stayOpen -= elapsed_time;
343 } else if(!focused && height > 0) {
344 alpha -= elapsed_time * FADE_SPEED;
353 Console::draw(DrawingContext& context)
358 int layer = LAYER_GUI + 1;
360 context.push_transform();
361 context.set_alpha(alpha);
362 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
363 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
364 context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
365 backgroundOffset+=10;
366 if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
372 float py = height-4-1*9;
373 context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
376 int skipLines = -offset;
377 for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
378 if (skipLines-- > 0) continue;
380 float py = height-4-lineNo*9;
382 context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
385 context.pop_transform();
389 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
391 commands[command].push_front(ccr);
395 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
397 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
398 if ((i == commands.end()) || (i->second.size() == 0)) {
399 log_warning << "Command \"" << command << "\" not associated with a command receiver. Not dissociated." << std::endl;
402 std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
403 if (j == i->second.end()) {
404 log_warning << "Command \"" << command << "\" not associated with given command receiver. Not dissociated." << std::endl;
411 Console::unregisterCommands(ConsoleCommandReceiver* ccr)
413 for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
414 std::list<ConsoleCommandReceiver*> &ccrs = i->second;
415 std::list<ConsoleCommandReceiver*>::iterator j;
416 while ((j = find(ccrs.begin(), ccrs.end(), ccr)) != ccrs.end()) {
422 Console* Console::instance = NULL;
423 ConsoleStreamBuffer Console::inputBuffer;
424 ConsoleStreamBuffer Console::outputBuffer;
425 std::ostream Console::input(&Console::inputBuffer);
426 std::ostream Console::output(&Console::outputBuffer);