src/console.cpp

   1 //  $Id$
   2 //
   3 //  SuperTux - Console
   4 //  Copyright (C) 2006 Christoph Sommer <christoph.sommer@2006.expires.deltadevelopment.de>
   5 //
   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.
  10 //
  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.
  15 //
  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.
  19 #include <config.h>
  20
  21 #include <iostream>
  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"
  29 #include "main.hpp"
  30 #include "log.hpp"
  31 #include "resources.hpp"
  32
  33 /// speed (pixels/s) the console closes
  34 static const float FADE_SPEED = 1;
  35
  36 Console::Console()
  37   : history_position(history.end()), vm(NULL), backgroundOffset(0),
  38     height(0), alpha(1.0), offset(0), focused(false), stayOpen(0) {
  39   fontheight = 8;
  40 }
  41
  42 Console::~Console()
  43 {
  44   if(vm != NULL) {
  45     sq_release(Scripting::global_vm, &vm_object);
  46   }
  47 }
  48
  49 void
  50 Console::init_graphics()
  51 {
  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"));
  57 }
  58
  59 void
  60 Console::flush(ConsoleStreamBuffer* buffer)
  61 {
  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);
  66       addLines(s);
  67       outputBuffer.str(std::string());
  68     }
  69   }
  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);
  74       addLines("> "+s);
  75       parse(s);
  76       inputBuffer.str(std::string());
  77     }
  78   }
  79 }
  80
  81 void
  82 Console::ready_vm()
  83 {
  84   if(vm == NULL) {
  85     vm = Scripting::global_vm;
  86     HSQUIRRELVM new_vm = sq_newthread(vm, 16);
  87     if(new_vm == NULL)
  88       throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
  89
  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);
  95     sq_pop(vm, 1);
  96
  97     // create new roottable for thread
  98     sq_newtable(new_vm);
  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");
 102
 103     sq_setroottable(new_vm);
 104
 105     vm = new_vm;
 106
 107     try {
 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;
 113     }
 114   }
 115 }
 116
 117 void
 118 Console::execute_script(const std::string& command)
 119 {
 120   using namespace Scripting;
 121
 122   ready_vm();
 123
 124   SQInteger oldtop = sq_gettop(vm);
 125   try {
 126     if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
 127                  "", SQTrue)))
 128       throw SquirrelError(vm, "Couldn't compile command");
 129
 130     sq_pushroottable(vm);
 131     if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
 132       throw SquirrelError(vm, "Problem while executing command");
 133
 134     if(sq_gettype(vm, -1) != OT_NULL)
 135       addLines(squirrel2string(vm, -1));
 136   } catch(std::exception& e) {
 137     addLines(e.what());
 138   }
 139   SQInteger newtop = sq_gettop(vm);
 140   if(newtop < oldtop) {
 141     log_fatal << "Script destroyed squirrel stack..." << std::endl;
 142   } else {
 143     sq_settop(vm, oldtop);
 144   }
 145 }
 146
 147 void
 148 Console::backspace()
 149 {
 150   std::string s = inputBuffer.str();
 151   if (s.length() > 0) {
 152     s.erase(s.length()-1);
 153     inputBuffer.str(s);
 154     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 155   }
 156 }
 157
 158 void
 159 Console::scroll(int numLines)
 160 {
 161   offset += numLines;
 162   if (offset > 0) offset = 0;
 163 }
 164
 165 void
 166 Console::show_history(int offset)
 167 {
 168   while ((offset > 0) && (history_position != history.end())) {
 169     history_position++;
 170     offset--;
 171   }
 172   while ((offset < 0) && (history_position != history.begin())) {
 173     history_position--;
 174     offset++;
 175   }
 176   if (history_position == history.end()) {
 177     inputBuffer.str(std::string());
 178   } else {
 179     inputBuffer.str(*history_position);
 180     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 181   }
 182 }
 183
 184 void
 185 Console::autocomplete()
 186 {
 187   std::string cmdPart = inputBuffer.str();
 188   addLines("> "+cmdPart);
 189
 190   std::string cmdList = "";
 191   int cmdListLen = 0;
 192
 193   // append all known CCRs to cmdList
 194   for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
 195     std::string cmdKnown = i->first;
 196     if (cmdKnown.substr(0, cmdPart.length()) == cmdPart) {
 197       if (cmdListLen > 0) cmdList = cmdList + ", ";
 198       cmdList = cmdList + cmdKnown;
 199       cmdListLen++;
 200     }
 201   }
 202
 203   ready_vm();
 204
 205   // append all keys of the current root table to cmdList
 206   sq_pushroottable(vm); // push root table
 207   while(true) {
 208     sq_pushnull(vm); // push null
 209     while (SQ_SUCCEEDED(sq_next(vm,-2))) {
 210       const SQChar* s;
 211       if(SQ_SUCCEEDED(sq_getstring(vm, -2, &s))) {
 212         std::string cmdKnown = s;
 213         if (cmdKnown.substr(0, cmdPart.length()) == cmdPart) {
 214           if (cmdListLen > 0) cmdList = cmdList + ", ";
 215           cmdList = cmdList + cmdKnown;
 216           cmdListLen++;
 217         }
 218       }
 219
 220       sq_pop(vm, 2); // pop key, val
 221     }
 222
 223     // cycle through parent(delegate) table
 224     sq_pop(vm, 1); // pop iterator
 225     SQInteger oldtop = sq_gettop(vm);
 226     if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
 227       break;
 228     }
 229     sq_remove(vm, -2); // remove old table
 230   }
 231   sq_pop(vm, 1); // remove table
 232
 233   // depending on number of hits, show matches or autocomplete
 234   if (cmdListLen == 0) addLines("No known command starts with \""+cmdPart+"\"");
 235   if (cmdListLen == 1) {
 236     inputBuffer.str(cmdList);
 237     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 238   }
 239   if (cmdListLen > 1) addLines(cmdList);
 240 }
 241
 242 void
 243 Console::addLines(std::string s)
 244 {
 245   std::istringstream iss(s);
 246   std::string line;
 247   while (std::getline(iss, line, '\n')) addLine(line);
 248 }
 249
 250 void
 251 Console::addLine(std::string s)
 252 {
 253   // output line to stderr
 254   std::cerr << s << std::endl;
 255
 256   // wrap long lines
 257   std::string overflow;
 258   do {
 259     lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
 260     s = overflow;
 261   } while (s.length() > 0);
 262
 263   // trim scrollback buffer
 264   while (lines.size() >= 1000)
 265     lines.pop_back();
 266
 267   // increase console height if necessary
 268   if (height < 64) {
 269     if(height < 4)
 270       height = 4;
 271     height += fontheight;
 272   }
 273
 274   // reset console to full opacity
 275   alpha = 1.0;
 276
 277   // increase time that console stays open
 278   if(stayOpen < 6)
 279     stayOpen += 1.5;
 280 }
 281
 282 void
 283 Console::parse(std::string s)
 284 {
 285   // make sure we actually have something to parse
 286   if (s.length() == 0) return;
 287
 288   // add line to history
 289   history.push_back(s);
 290   history_position = history.end();
 291
 292   // split line into list of args
 293   std::vector<std::string> args;
 294   size_t start = 0;
 295   size_t end = 0;
 296   while (1) {
 297     start = s.find_first_not_of(" ,", end);
 298     end = s.find_first_of(" ,", start);
 299     if (start == s.npos) break;
 300     args.push_back(s.substr(start, end-start));
 301   }
 302
 303   // command is args[0]
 304   if (args.size() == 0) return;
 305   std::string command = args.front();
 306   args.erase(args.begin());
 307
 308   // ignore if it's an internal command
 309   if (consoleCommand(command,args)) return;
 310
 311   // look up registered ccr
 312   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 313   if ((i == commands.end()) || (i->second.size() == 0)) {
 314     try {
 315       execute_script(s);
 316     } catch(std::exception& e) {
 317       addLines(e.what());
 318     }
 319     return;
 320   }
 321
 322   // send command to the most recently registered ccr
 323   ConsoleCommandReceiver* ccr = i->second.front();
 324   if (ccr->consoleCommand(command, args) != true) log_warning << "Sent command to registered ccr, but command was unhandled" << std::endl;
 325 }
 326
 327 bool
 328 Console::consoleCommand(std::string command, std::vector<std::string> arguments)
 329 {
 330   if (command == "ccrs") {
 331     if (arguments.size() != 1) {
 332       log_info << "Usage: ccrs <command>" << std::endl;
 333       return true;
 334     }
 335     std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(arguments[0]);
 336     if ((i == commands.end()) || (i->second.size() == 0)) {
 337       log_info << "unknown command: \"" << arguments[0] << "\"" << std::endl;
 338       return true;
 339     }
 340
 341     std::ostringstream ccr_list;
 342     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 343     std::list<ConsoleCommandReceiver*>::iterator j;
 344     for (j = ccrs.begin(); j != ccrs.end(); j++) {
 345       if (j != ccrs.begin()) ccr_list << ", ";
 346       ccr_list << "[" << *j << "]";
 347     }
 348
 349     log_info << "registered ccrs for \"" << arguments[0] << "\": " << ccr_list.str() << std::endl;
 350     return true;
 351   }
 352
 353   return false;
 354 }
 355
 356 bool
 357 Console::hasFocus()
 358 {
 359   return focused;
 360 }
 361
 362 void
 363 Console::show()
 364 {
 365   focused = true;
 366   height = 256;
 367   alpha = 1.0;
 368 }
 369
 370 void
 371 Console::hide()
 372 {
 373   focused = false;
 374   height = 0;
 375   stayOpen = 0;
 376
 377   // clear input buffer
 378   inputBuffer.str(std::string());
 379 }
 380
 381 void
 382 Console::toggle()
 383 {
 384   if (Console::hasFocus()) {
 385     Console::hide();
 386   }
 387   else {
 388     Console::show();
 389   }
 390 }
 391
 392 void
 393 Console::update(float elapsed_time)
 394 {
 395   if(stayOpen > 0) {
 396     stayOpen -= elapsed_time;
 397     if(stayOpen < 0)
 398       stayOpen = 0;
 399   } else if(!focused && height > 0) {
 400     alpha -= elapsed_time * FADE_SPEED;
 401     if(alpha < 0) {
 402       alpha = 0;
 403       height = 0;
 404     }
 405   }
 406 }
 407
 408 void
 409 Console::draw(DrawingContext& context)
 410 {
 411   if (height == 0)
 412     return;
 413
 414   int layer = LAYER_GUI + 1;
 415
 416   context.push_transform();
 417   context.set_alpha(alpha);
 418   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
 419   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
 420   context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
 421   backgroundOffset+=10;
 422   if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
 423
 424   int lineNo = 0;
 425
 426   if (focused) {
 427     lineNo++;
 428     float py = height-4-1*9;
 429     context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
 430   }
 431
 432   int skipLines = -offset;
 433   for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
 434     if (skipLines-- > 0) continue;
 435     lineNo++;
 436     float py = height-4-lineNo*9;
 437     if (py < -9) break;
 438     context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
 439   }
 440
 441   context.pop_transform();
 442 }
 443
 444 void
 445 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
 446 {
 447   commands[command].push_front(ccr);
 448 }
 449
 450 void
 451 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
 452 {
 453   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 454   if ((i == commands.end()) || (i->second.size() == 0)) {
 455     log_warning << "Command \"" << command << "\" not associated with a command receiver. Not dissociated." << std::endl;
 456     return;
 457   }
 458   std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
 459   if (j == i->second.end()) {
 460     log_warning << "Command \"" << command << "\" not associated with given command receiver. Not dissociated." << std::endl;
 461     return;
 462   }
 463   i->second.erase(j);
 464 }
 465
 466 void
 467 Console::unregisterCommands(ConsoleCommandReceiver* ccr)
 468 {
 469   for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
 470     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 471     std::list<ConsoleCommandReceiver*>::iterator j;
 472     while ((j = find(ccrs.begin(), ccrs.end(), ccr)) != ccrs.end()) {
 473       ccrs.erase(j);
 474     }
 475   }
 476 }
 477
 478 Console* Console::instance = NULL;
 479 ConsoleStreamBuffer Console::inputBuffer;
 480 ConsoleStreamBuffer Console::outputBuffer;
 481 std::ostream Console::input(&Console::inputBuffer);
 482 std::ostream Console::output(&Console::outputBuffer);
 483