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       addLine(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       addLine("> "+s);
  75       parse(s);
  76       inputBuffer.str(std::string());
  77     }
  78   }
  79 }
  80
  81 void
  82 Console::execute_script(const std::string& command)
  83 {
  84   using namespace Scripting;
  85
  86   if(vm == NULL) {
  87     vm = Scripting::global_vm;
  88     HSQUIRRELVM new_vm = sq_newthread(vm, 16);
  89     if(new_vm == NULL)
  90       throw Scripting::SquirrelError(vm, "Couldn't create new VM thread for console");
  91
  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);
  97     sq_pop(vm, 1);
  98
  99     // create new roottable for thread
 100     sq_newtable(new_vm);
 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");
 104
 105     sq_setroottable(new_vm);
 106
 107     vm = new_vm;
 108
 109     try {
 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;
 115     }
 116   }
 117
 118   SQInteger oldtop = sq_gettop(vm);
 119   try {
 120     if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
 121                  "", SQTrue)))
 122       throw SquirrelError(vm, "Couldn't compile command");
 123
 124     sq_pushroottable(vm);
 125     if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
 126       throw SquirrelError(vm, "Problem while executing command");
 127
 128     if(sq_gettype(vm, -1) != OT_NULL)
 129       addLine(squirrel2string(vm, -1));
 130   } catch(std::exception& e) {
 131     addLine(e.what());
 132   }
 133   SQInteger newtop = sq_gettop(vm);
 134   if(newtop < oldtop) {
 135     log_fatal << "Script destroyed squirrel stack..." << std::endl;
 136   } else {
 137     sq_settop(vm, oldtop);
 138   }
 139 }
 140
 141 void
 142 Console::backspace()
 143 {
 144   std::string s = inputBuffer.str();
 145   if (s.length() > 0) {
 146     s.erase(s.length()-1);
 147     inputBuffer.str(s);
 148     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 149   }
 150 }
 151
 152 void
 153 Console::scroll(int numLines)
 154 {
 155   offset += numLines;
 156   if (offset > 0) offset = 0;
 157 }
 158
 159 void
 160 Console::show_history(int offset)
 161 {
 162   while ((offset > 0) && (history_position != history.end())) {
 163     history_position++;
 164     offset--;
 165   }
 166   while ((offset < 0) && (history_position != history.begin())) {
 167     history_position--;
 168     offset++;
 169   }
 170   if (history_position == history.end()) {
 171     inputBuffer.str(std::string());
 172   } else {
 173     inputBuffer.str(*history_position);
 174     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 175   }
 176 }
 177
 178 void
 179 Console::autocomplete()
 180 {
 181   std::string cmdPart = inputBuffer.str();
 182   addLine("> "+cmdPart);
 183
 184   std::string cmdList = "";
 185   int cmdListLen = 0;
 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;
 191       cmdListLen++;
 192     }
 193   }
 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);
 198   }
 199   if (cmdListLen > 1) addLine(cmdList);
 200 }
 201
 202 void
 203 Console::addLine(std::string s)
 204 {
 205   std::string overflow;
 206   do {
 207     lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
 208     s = overflow;
 209   } while (s.length() > 0);
 210
 211   while (lines.size() >= 1000)
 212     lines.pop_back();
 213
 214   if (height < 64) {
 215     if(height < 4)
 216       height = 4;
 217     height += fontheight;
 218   }
 219
 220   alpha = 1.0;
 221   if(stayOpen < 6)
 222     stayOpen += 1.5;
 223 }
 224
 225 void
 226 Console::parse(std::string s)
 227 {
 228   // make sure we actually have something to parse
 229   if (s.length() == 0) return;
 230
 231   // add line to history
 232   history.push_back(s);
 233   history_position = history.end();
 234
 235   // split line into list of args
 236   std::vector<std::string> args;
 237   size_t start = 0;
 238   size_t end = 0;
 239   while (1) {
 240     start = s.find_first_not_of(" ,", end);
 241     end = s.find_first_of(" ,", start);
 242     if (start == s.npos) break;
 243     args.push_back(s.substr(start, end-start));
 244   }
 245
 246   // command is args[0]
 247   if (args.size() == 0) return;
 248   std::string command = args.front();
 249   args.erase(args.begin());
 250
 251   // ignore if it's an internal command
 252   if (consoleCommand(command,args)) return;
 253
 254   // look up registered ccr
 255   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 256   if ((i == commands.end()) || (i->second.size() == 0)) {
 257     try {
 258       execute_script(s);
 259     } catch(std::exception& e) {
 260       addLine(e.what());
 261     }
 262     return;
 263   }
 264
 265   // send command to the most recently registered ccr
 266   ConsoleCommandReceiver* ccr = i->second.front();
 267   if (ccr->consoleCommand(command, args) != true) log_warning << "Sent command to registered ccr, but command was unhandled" << std::endl;
 268 }
 269
 270 bool
 271 Console::consoleCommand(std::string command, std::vector<std::string> arguments)
 272 {
 273   if (command == "ccrs") {
 274     if (arguments.size() != 1) {
 275       log_info << "Usage: ccrs <command>" << std::endl;
 276       return true;
 277     }
 278     std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(arguments[0]);
 279     if ((i == commands.end()) || (i->second.size() == 0)) {
 280       log_info << "unknown command: \"" << arguments[0] << "\"" << std::endl;
 281       return true;
 282     }
 283
 284     std::ostringstream ccr_list;
 285     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 286     std::list<ConsoleCommandReceiver*>::iterator j;
 287     for (j = ccrs.begin(); j != ccrs.end(); j++) {
 288       if (j != ccrs.begin()) ccr_list << ", ";
 289       ccr_list << "[" << *j << "]";
 290     }
 291
 292     log_info << "registered ccrs for \"" << arguments[0] << "\": " << ccr_list.str() << std::endl;
 293     return true;
 294   }
 295
 296   return false;
 297 }
 298
 299 bool
 300 Console::hasFocus()
 301 {
 302   return focused;
 303 }
 304
 305 void
 306 Console::show()
 307 {
 308   focused = true;
 309   height = 256;
 310   alpha = 1.0;
 311 }
 312
 313 void
 314 Console::hide()
 315 {
 316   focused = false;
 317   height = 0;
 318   stayOpen = 0;
 319
 320   // clear input buffer
 321   inputBuffer.str(std::string());
 322 }
 323
 324 void
 325 Console::toggle()
 326 {
 327   if (Console::hasFocus()) {
 328     Console::hide();
 329   }
 330   else {
 331     Console::show();
 332   }
 333 }
 334
 335 void
 336 Console::update(float elapsed_time)
 337 {
 338   if(stayOpen > 0) {
 339     stayOpen -= elapsed_time;
 340     if(stayOpen < 0)
 341       stayOpen = 0;
 342   } else if(!focused && height > 0) {
 343     alpha -= elapsed_time * FADE_SPEED;
 344     if(alpha < 0) {
 345       alpha = 0;
 346       height = 0;
 347     }
 348   }
 349 }
 350
 351 void
 352 Console::draw(DrawingContext& context)
 353 {
 354   if (height == 0)
 355     return;
 356
 357   int layer = LAYER_GUI + 1;
 358
 359   context.push_transform();
 360   context.set_alpha(alpha);
 361   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
 362   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
 363   context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
 364   backgroundOffset+=10;
 365   if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
 366
 367   int lineNo = 0;
 368
 369   if (focused) {
 370     lineNo++;
 371     float py = height-4-1*9;
 372     context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
 373   }
 374
 375   int skipLines = -offset;
 376   for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
 377     if (skipLines-- > 0) continue;
 378     lineNo++;
 379     float py = height-4-lineNo*9;
 380     if (py < -9) break;
 381     context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
 382   }
 383
 384   context.pop_transform();
 385 }
 386
 387 void
 388 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
 389 {
 390   commands[command].push_front(ccr);
 391 }
 392
 393 void
 394 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
 395 {
 396   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 397   if ((i == commands.end()) || (i->second.size() == 0)) {
 398     log_warning << "Command \"" << command << "\" not associated with a command receiver. Not dissociated." << std::endl;
 399     return;
 400   }
 401   std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
 402   if (j == i->second.end()) {
 403     log_warning << "Command \"" << command << "\" not associated with given command receiver. Not dissociated." << std::endl;
 404     return;
 405   }
 406   i->second.erase(j);
 407 }
 408
 409 void
 410 Console::unregisterCommands(ConsoleCommandReceiver* ccr)
 411 {
 412   for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
 413     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 414     std::list<ConsoleCommandReceiver*>::iterator j;
 415     while ((j = find(ccrs.begin(), ccrs.end(), ccr)) != ccrs.end()) {
 416       ccrs.erase(j);
 417     }
 418   }
 419 }
 420
 421 Console* Console::instance = NULL;
 422 ConsoleStreamBuffer Console::inputBuffer;
 423 ConsoleStreamBuffer Console::outputBuffer;
 424 std::ostream Console::input(&Console::inputBuffer);
 425 std::ostream Console::output(&Console::outputBuffer);
 426