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 #include "gameconfig.hpp"
  33
  34 /// speed (pixels/s) the console closes
  35 static const float FADE_SPEED = 1;
  36
  37 Console::Console()
  38   : history_position(history.end()), vm(NULL), backgroundOffset(0),
  39     height(0), alpha(1.0), offset(0), focused(false), stayOpen(0) {
  40   fontheight = 8;
  41 }
  42
  43 Console::~Console()
  44 {
  45   if(vm != NULL) {
  46     sq_release(Scripting::global_vm, &vm_object);
  47   }
  48 }
  49
  50 void
  51 Console::init_graphics()
  52 {
  53   font.reset(new Font("images/engine/fonts/white-small.png",
  54                       "images/engine/fonts/shadow-small.png", 8, 9, 1));
  55   fontheight = font->get_height();
  56   background.reset(new Surface("images/engine/console.png"));
  57   background2.reset(new Surface("images/engine/console2.png"));
  58 }
  59
  60 void
  61 Console::flush(ConsoleStreamBuffer* buffer)
  62 {
  63   if (buffer == &outputBuffer) {
  64     std::string s = outputBuffer.str();
  65     if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
  66       while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
  67       addLines(s);
  68       outputBuffer.str(std::string());
  69     }
  70   }
  71   if (buffer == &inputBuffer) {
  72     std::string s = inputBuffer.str();
  73     if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
  74       while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
  75       addLines("> "+s);
  76       parse(s);
  77       inputBuffer.str(std::string());
  78     }
  79   }
  80 }
  81
  82 void
  83 Console::ready_vm()
  84 {
  85   if(vm == NULL) {
  86     vm = Scripting::global_vm;
  87     HSQUIRRELVM new_vm = sq_newthread(vm, 16);
  88     if(new_vm == NULL)
  89       throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
  90
  91     // store reference to thread
  92     sq_resetobject(&vm_object);
  93     if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
  94       throw Scripting::SquirrelError(vm, "Couldn't get vm object for console");
  95     sq_addref(vm, &vm_object);
  96     sq_pop(vm, 1);
  97
  98     // create new roottable for thread
  99     sq_newtable(new_vm);
 100     sq_pushroottable(new_vm);
 101     if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
 102       throw Scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");
 103
 104     sq_setroottable(new_vm);
 105
 106     vm = new_vm;
 107
 108     try {
 109       std::string filename = "scripts/console.nut";
 110       IFileStream stream(filename);
 111       Scripting::compile_and_run(vm, stream, filename);
 112     } catch(std::exception& e) {
 113       log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
 114     }
 115   }
 116 }
 117
 118 void
 119 Console::execute_script(const std::string& command)
 120 {
 121   using namespace Scripting;
 122
 123   ready_vm();
 124
 125   SQInteger oldtop = sq_gettop(vm);
 126   try {
 127     if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
 128                  "", SQTrue)))
 129       throw SquirrelError(vm, "Couldn't compile command");
 130
 131     sq_pushroottable(vm);
 132     if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
 133       throw SquirrelError(vm, "Problem while executing command");
 134
 135     if(sq_gettype(vm, -1) != OT_NULL)
 136       addLines(squirrel2string(vm, -1));
 137   } catch(std::exception& e) {
 138     addLines(e.what());
 139   }
 140   SQInteger newtop = sq_gettop(vm);
 141   if(newtop < oldtop) {
 142     log_fatal << "Script destroyed squirrel stack..." << std::endl;
 143   } else {
 144     sq_settop(vm, oldtop);
 145   }
 146 }
 147
 148 void
 149 Console::backspace()
 150 {
 151   std::string s = inputBuffer.str();
 152   if (s.length() > 0) {
 153     s.erase(s.length()-1);
 154     inputBuffer.str(s);
 155     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 156   }
 157 }
 158
 159 void
 160 Console::scroll(int numLines)
 161 {
 162   offset += numLines;
 163   if (offset > 0) offset = 0;
 164 }
 165
 166 void
 167 Console::show_history(int offset)
 168 {
 169   while ((offset > 0) && (history_position != history.end())) {
 170     history_position++;
 171     offset--;
 172   }
 173   while ((offset < 0) && (history_position != history.begin())) {
 174     history_position--;
 175     offset++;
 176   }
 177   if (history_position == history.end()) {
 178     inputBuffer.str(std::string());
 179   } else {
 180     inputBuffer.str(*history_position);
 181     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 182   }
 183 }
 184
 185 // Helper functions for Console::autocomplete
 186 // TODO: Fix rough documentation
 187 namespace {
 188
 189 void sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix);
 190
 191 /**
 192  * Acts upon key,value on top of stack:
 193  * Appends key (plus type-dependent suffix) to cmds if table_prefix+key starts with search_prefix;
 194  * Calls sq_insert_commands if search_prefix starts with table_prefix+key (and value is a table/class/instance);
 195  */
 196 void
 197 sq_insert_command(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
 198 {
 199   const SQChar* key_chars;
 200   if (SQ_FAILED(sq_getstring(vm, -2, &key_chars))) return;
 201   std::string key_string = table_prefix + key_chars;
 202
 203   switch (sq_gettype(vm, -1)) {
 204     case OT_INSTANCE:
 205       key_string+=".";
 206       if (search_prefix.substr(0, key_string.length()) == key_string) {
 207         sq_getclass(vm, -1);
 208         sq_insert_commands(cmds, vm, key_string, search_prefix);
 209         sq_pop(vm, 1);
 210       }
 211       break;
 212     case OT_TABLE:
 213     case OT_CLASS:
 214       key_string+=".";
 215       if (search_prefix.substr(0, key_string.length()) == key_string) {
 216         sq_insert_commands(cmds, vm, key_string, search_prefix);
 217       }
 218       break;
 219     case OT_CLOSURE:
 220     case OT_NATIVECLOSURE:
 221       key_string+="()";
 222       break;
 223     default:
 224       break;
 225   }
 226
 227   if (key_string.substr(0, search_prefix.length()) == search_prefix) {
 228     cmds.push_back(key_string);
 229   }
 230
 231 }
 232
 233 /**
 234  * calls sq_insert_command for all entries of table/class on top of stack
 235  */
 236 void
 237 sq_insert_commands(std::list<std::string>& cmds, HSQUIRRELVM vm, std::string table_prefix, std::string search_prefix)
 238 {
 239   sq_pushnull(vm); // push iterator
 240   while (SQ_SUCCEEDED(sq_next(vm,-2))) {
 241     sq_insert_command(cmds, vm, table_prefix, search_prefix);
 242     sq_pop(vm, 2); // pop key, val
 243   }
 244   sq_pop(vm, 1); // pop iterator
 245 }
 246
 247
 248 }
 249 // End of Console::autocomplete helper functions
 250
 251 void
 252 Console::autocomplete()
 253 {
 254   std::string prefix = inputBuffer.str();
 255   addLines("> "+prefix);
 256
 257   std::list<std::string> cmds;
 258
 259   ready_vm();
 260
 261   // append all keys of the current root table to list
 262   sq_pushroottable(vm); // push root table
 263   while(true) {
 264     // check all keys (and their children) for matches
 265     sq_insert_commands(cmds, vm, "", prefix);
 266
 267     // cycle through parent(delegate) table
 268     SQInteger oldtop = sq_gettop(vm);
 269     if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
 270       break;
 271     }
 272     sq_remove(vm, -2); // remove old table
 273   }
 274   sq_pop(vm, 1); // remove table
 275
 276   // depending on number of hits, show matches or autocomplete
 277   if (cmds.size() == 0) addLines("No known command starts with \""+prefix+"\"");
 278   if (cmds.size() == 1) {
 279     // one match: just replace input buffer with full command
 280     inputBuffer.str(cmds.front());
 281     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 282   }
 283   if (cmds.size() > 1) {
 284     // multiple matches: show all matches and set input buffer to longest common prefix
 285     std::string commonPrefix = cmds.front();
 286     while (cmds.begin() != cmds.end()) {
 287       std::string cmd = cmds.front();
 288       cmds.pop_front();
 289       addLines(cmd);
 290       for (int n = commonPrefix.length(); n >= 1; n--) {
 291         if (cmd.compare(0, n, commonPrefix) != 0) commonPrefix.resize(n-1); else break;
 292       }
 293     }
 294     inputBuffer.str(commonPrefix);
 295     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 296   }
 297 }
 298
 299 void
 300 Console::addLines(std::string s)
 301 {
 302   std::istringstream iss(s);
 303   std::string line;
 304   while (std::getline(iss, line, '\n')) addLine(line);
 305 }
 306
 307 void
 308 Console::addLine(std::string s)
 309 {
 310   // output line to stderr
 311   std::cerr << s << std::endl;
 312
 313   // wrap long lines
 314   std::string overflow;
 315   do {
 316     lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
 317     s = overflow;
 318   } while (s.length() > 0);
 319
 320   // trim scrollback buffer
 321   while (lines.size() >= 1000)
 322     lines.pop_back();
 323
 324   // increase console height if necessary
 325   if (height < 64) {
 326     if(height < 4)
 327       height = 4;
 328     height += fontheight;
 329   }
 330
 331   // reset console to full opacity
 332   alpha = 1.0;
 333
 334   // increase time that console stays open
 335   if(stayOpen < 6)
 336     stayOpen += 1.5;
 337 }
 338
 339 void
 340 Console::parse(std::string s)
 341 {
 342   // make sure we actually have something to parse
 343   if (s.length() == 0) return;
 344
 345   // add line to history
 346   history.push_back(s);
 347   history_position = history.end();
 348
 349   // split line into list of args
 350   std::vector<std::string> args;
 351   size_t start = 0;
 352   size_t end = 0;
 353   while (1) {
 354     start = s.find_first_not_of(" ,", end);
 355     end = s.find_first_of(" ,", start);
 356     if (start == s.npos) break;
 357     args.push_back(s.substr(start, end-start));
 358   }
 359
 360   // command is args[0]
 361   if (args.size() == 0) return;
 362   std::string command = args.front();
 363   args.erase(args.begin());
 364
 365   // ignore if it's an internal command
 366   if (consoleCommand(command,args)) return;
 367
 368   try {
 369     execute_script(s);
 370   } catch(std::exception& e) {
 371     addLines(e.what());
 372   }
 373
 374 }
 375
 376 bool
 377 Console::consoleCommand(std::string /*command*/, std::vector<std::string> /*arguments*/)
 378 {
 379   return false;
 380 }
 381
 382 bool
 383 Console::hasFocus()
 384 {
 385   return focused;
 386 }
 387
 388 void
 389 Console::show()
 390 {
 391   if(!config->console_enabled)
 392     return;
 393
 394   focused = true;
 395   height = 256;
 396   alpha = 1.0;
 397   SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
 398 }
 399
 400 void
 401 Console::hide()
 402 {
 403   focused = false;
 404   height = 0;
 405   stayOpen = 0;
 406
 407   // clear input buffer
 408   inputBuffer.str(std::string());
 409   SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
 410 }
 411
 412 void
 413 Console::toggle()
 414 {
 415   if (Console::hasFocus()) {
 416     Console::hide();
 417   }
 418   else {
 419     Console::show();
 420   }
 421 }
 422
 423 void
 424 Console::update(float elapsed_time)
 425 {
 426   if(stayOpen > 0) {
 427     stayOpen -= elapsed_time;
 428     if(stayOpen < 0)
 429       stayOpen = 0;
 430   } else if(!focused && height > 0) {
 431     alpha -= elapsed_time * FADE_SPEED;
 432     if(alpha < 0) {
 433       alpha = 0;
 434       height = 0;
 435     }
 436   }
 437 }
 438
 439 void
 440 Console::draw(DrawingContext& context)
 441 {
 442   if (height == 0)
 443     return;
 444
 445   int layer = LAYER_GUI + 1;
 446
 447   context.push_transform();
 448   context.set_alpha(alpha);
 449   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
 450   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
 451   context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
 452   backgroundOffset+=10;
 453   if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
 454
 455   int lineNo = 0;
 456
 457   if (focused) {
 458     lineNo++;
 459     float py = height-4-1*9;
 460     context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
 461   }
 462
 463   int skipLines = -offset;
 464   for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
 465     if (skipLines-- > 0) continue;
 466     lineNo++;
 467     float py = height-4-lineNo*9;
 468     if (py < -9) break;
 469     context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
 470   }
 471   context.pop_transform();
 472 }
 473
 474 Console* Console::instance = NULL;
 475 ConsoleStreamBuffer Console::inputBuffer;
 476 ConsoleStreamBuffer Console::outputBuffer;
 477 std::ostream Console::input(&Console::inputBuffer);
 478 std::ostream Console::output(&Console::outputBuffer);