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());
85 vm = Scripting::global_vm;
86 HSQUIRRELVM new_vm = sq_newthread(vm, 16);
88 throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
90 // store reference to thread
91 sq_resetobject(&vm_object);
92 if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
93 throw Scripting::SquirrelError(vm, "Couldn't get vm object for console");
94 sq_addref(vm, &vm_object);
97 // create new roottable for thread
99 sq_pushroottable(new_vm);
100 if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
101 throw Scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");
103 sq_setroottable(new_vm);
108 std::string filename = "scripts/console.nut";
109 IFileStream stream(filename);
110 Scripting::compile_and_run(vm, stream, filename);
111 } catch(std::exception& e) {
112 log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
118 Console::execute_script(const std::string& command)
120 using namespace Scripting;
124 SQInteger oldtop = sq_gettop(vm);
126 if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
128 throw SquirrelError(vm, "Couldn't compile command");
130 sq_pushroottable(vm);
131 if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
132 throw SquirrelError(vm, "Problem while executing command");
134 if(sq_gettype(vm, -1) != OT_NULL)
135 addLines(squirrel2string(vm, -1));
136 } catch(std::exception& e) {
139 SQInteger newtop = sq_gettop(vm);
140 if(newtop < oldtop) {
141 log_fatal << "Script destroyed squirrel stack..." << std::endl;
143 sq_settop(vm, oldtop);
150 std::string s = inputBuffer.str();
151 if (s.length() > 0) {
152 s.erase(s.length()-1);
154 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
159 Console::scroll(int numLines)
162 if (offset > 0) offset = 0;
166 Console::show_history(int offset)
168 while ((offset > 0) && (history_position != history.end())) {
172 while ((offset < 0) && (history_position != history.begin())) {
176 if (history_position == history.end()) {
177 inputBuffer.str(std::string());
179 inputBuffer.str(*history_position);
180 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
184 // Helper functions for Console::autocomplete
185 // TODO: Fix rough documentation
188 void sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix);
191 * Acts upon key,value on top of stack:
192 * Appends key (plus type-dependent suffix) to cmds if table_prefix+key starts with search_prefix;
193 * Calls sq_insert_commands if search_prefix starts with table_prefix+key (and value is a table/class/instance);
196 sq_insert_command(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
198 const SQChar* key_chars;
199 if (SQ_FAILED(sq_getstring(vm, -2, &key_chars))) return;
200 std::string key_string = table_prefix + key_chars;
202 switch (sq_gettype(vm, -1)) {
205 if (search_prefix.substr(0, key_string.length()) == key_string) {
207 sq_insert_commands(cmds, vm, key_string, search_prefix);
214 if (search_prefix.substr(0, key_string.length()) == key_string) {
215 sq_insert_commands(cmds, vm, key_string, search_prefix);
219 case OT_NATIVECLOSURE:
226 if (key_string.substr(0, search_prefix.length()) == search_prefix) {
227 cmds.push_back(key_string);
233 * calls sq_insert_command for all entries of table/class on top of stack
236 sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
238 sq_pushnull(vm); // push iterator
239 while (SQ_SUCCEEDED(sq_next(vm,-2))) {
240 sq_insert_command(cmds, vm, table_prefix, search_prefix);
241 sq_pop(vm, 2); // pop key, val
243 sq_pop(vm, 1); // pop iterator
248 // End of Console::autocomplete helper functions
251 Console::autocomplete()
253 std::string prefix = inputBuffer.str();
254 addLines("> "+prefix);
256 std::list<std::string> cmds;
258 // append all known CCRs to list
259 for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
260 std::string cmdKnown = i->first;
261 if (cmdKnown.substr(0, prefix.length()) == prefix) {
262 cmds.push_back(cmdKnown);
268 // append all keys of the current root table to list
269 sq_pushroottable(vm); // push root table
271 // check all keys (and their children) for matches
272 sq_insert_commands(cmds, vm, "", prefix);
274 // cycle through parent(delegate) table
275 SQInteger oldtop = sq_gettop(vm);
276 if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
279 sq_remove(vm, -2); // remove old table
281 sq_pop(vm, 1); // remove table
283 // depending on number of hits, show matches or autocomplete
284 if (cmds.size() == 0) addLines("No known command starts with \""+prefix+"\"");
285 if (cmds.size() == 1) {
286 inputBuffer.str(cmds.front());
287 inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
289 if (cmds.size() > 1) {
290 while (cmds.begin() != cmds.end()) {
291 addLines(cmds.front());
298 Console::addLines(std::string s)
300 std::istringstream iss(s);
302 while (std::getline(iss, line, '\n')) addLine(line);
306 Console::addLine(std::string s)
308 // output line to stderr
309 std::cerr << s << std::endl;
312 std::string overflow;
314 lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
316 } while (s.length() > 0);
318 // trim scrollback buffer
319 while (lines.size() >= 1000)
322 // increase console height if necessary
326 height += fontheight;
329 // reset console to full opacity
332 // increase time that console stays open
338 Console::parse(std::string s)
340 // make sure we actually have something to parse
341 if (s.length() == 0) return;
343 // add line to history
344 history.push_back(s);
345 history_position = history.end();
347 // split line into list of args
348 std::vector<std::string> args;
352 start = s.find_first_not_of(" ,", end);
353 end = s.find_first_of(" ,", start);
354 if (start == s.npos) break;
355 args.push_back(s.substr(start, end-start));
358 // command is args[0]
359 if (args.size() == 0) return;
360 std::string command = args.front();
361 args.erase(args.begin());
363 // ignore if it's an internal command
364 if (consoleCommand(command,args)) return;
366 // look up registered ccr
367 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
368 if ((i == commands.end()) || (i->second.size() == 0)) {
371 } catch(std::exception& e) {
377 // send command to the most recently registered ccr
378 ConsoleCommandReceiver* ccr = i->second.front();
379 if (ccr->consoleCommand(command, args) != true) log_warning << "Sent command to registered ccr, but command was unhandled" << std::endl;
383 Console::consoleCommand(std::string command, std::vector<std::string> arguments)
385 if (command == "ccrs") {
386 if (arguments.size() != 1) {
387 log_info << "Usage: ccrs <command>" << std::endl;
390 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(arguments[0]);
391 if ((i == commands.end()) || (i->second.size() == 0)) {
392 log_info << "unknown command: \"" << arguments[0] << "\"" << std::endl;
396 std::ostringstream ccr_list;
397 std::list<ConsoleCommandReceiver*> &ccrs = i->second;
398 std::list<ConsoleCommandReceiver*>::iterator j;
399 for (j = ccrs.begin(); j != ccrs.end(); j++) {
400 if (j != ccrs.begin()) ccr_list << ", ";
401 ccr_list << "[" << *j << "]";
404 log_info << "registered ccrs for \"" << arguments[0] << "\": " << ccr_list.str() << std::endl;
423 SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
433 // clear input buffer
434 inputBuffer.str(std::string());
435 SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
441 if (Console::hasFocus()) {
450 Console::update(float elapsed_time)
453 stayOpen -= elapsed_time;
456 } else if(!focused && height > 0) {
457 alpha -= elapsed_time * FADE_SPEED;
466 Console::draw(DrawingContext& context)
471 int layer = LAYER_GUI + 1;
473 context.push_transform();
474 context.set_alpha(alpha);
475 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
476 context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
477 context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
478 backgroundOffset+=10;
479 if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
485 float py = height-4-1*9;
486 context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
489 int skipLines = -offset;
490 for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
491 if (skipLines-- > 0) continue;
493 float py = height-4-lineNo*9;
495 context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
498 context.pop_transform();
502 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
504 commands[command].push_front(ccr);
508 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
510 std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
511 if ((i == commands.end()) || (i->second.size() == 0)) {
512 log_warning << "Command \"" << command << "\" not associated with a command receiver. Not dissociated." << std::endl;
515 std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
516 if (j == i->second.end()) {
517 log_warning << "Command \"" << command << "\" not associated with given command receiver. Not dissociated." << std::endl;
524 Console::unregisterCommands(ConsoleCommandReceiver* ccr)
526 for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
527 std::list<ConsoleCommandReceiver*> &ccrs = i->second;
528 std::list<ConsoleCommandReceiver*>::iterator j;
529 while ((j = find(ccrs.begin(), ccrs.end(), ccr)) != ccrs.end()) {
535 Console* Console::instance = NULL;
536 ConsoleStreamBuffer Console::inputBuffer;
537 ConsoleStreamBuffer Console::outputBuffer;
538 std::ostream Console::input(&Console::inputBuffer);
539 std::ostream Console::output(&Console::outputBuffer);