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::cerr << s << std::endl;
 206
 207   std::string overflow;
 208   do {
 209     lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
 210     s = overflow;
 211   } while (s.length() > 0);
 212
 213   while (lines.size() >= 1000)
 214     lines.pop_back();
 215
 216   if (height < 64) {
 217     if(height < 4)
 218       height = 4;
 219     height += fontheight;
 220   }
 221
 222   alpha = 1.0;
 223   if(stayOpen < 6)
 224     stayOpen += 1.5;
 225 }
 226
 227 void
 228 Console::parse(std::string s)
 229 {
 230   // make sure we actually have something to parse
 231   if (s.length() == 0) return;
 232
 233   // add line to history
 234   history.push_back(s);
 235   history_position = history.end();
 236
 237   // split line into list of args
 238   std::vector<std::string> args;
 239   size_t start = 0;
 240   size_t end = 0;
 241   while (1) {
 242     start = s.find_first_not_of(" ,", end);
 243     end = s.find_first_of(" ,", start);
 244     if (start == s.npos) break;
 245     args.push_back(s.substr(start, end-start));
 246   }
 247
 248   // command is args[0]
 249   if (args.size() == 0) return;
 250   std::string command = args.front();
 251   args.erase(args.begin());
 252
 253   // ignore if it's an internal command
 254   if (consoleCommand(command,args)) return;
 255
 256   // look up registered ccr
 257   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 258   if ((i == commands.end()) || (i->second.size() == 0)) {
 259     try {
 260       execute_script(s);
 261     } catch(std::exception& e) {
 262       addLine(e.what());
 263     }
 264     return;
 265   }
 266
 267   // send command to the most recently registered ccr
 268   ConsoleCommandReceiver* ccr = i->second.front();
 269   if (ccr->consoleCommand(command, args) != true) log_warning << "Sent command to registered ccr, but command was unhandled" << std::endl;
 270 }
 271
 272 bool
 273 Console::consoleCommand(std::string command, std::vector<std::string> arguments)
 274 {
 275   if (command == "ccrs") {
 276     if (arguments.size() != 1) {
 277       log_info << "Usage: ccrs <command>" << std::endl;
 278       return true;
 279     }
 280     std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(arguments[0]);
 281     if ((i == commands.end()) || (i->second.size() == 0)) {
 282       log_info << "unknown command: \"" << arguments[0] << "\"" << std::endl;
 283       return true;
 284     }
 285
 286     std::ostringstream ccr_list;
 287     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 288     std::list<ConsoleCommandReceiver*>::iterator j;
 289     for (j = ccrs.begin(); j != ccrs.end(); j++) {
 290       if (j != ccrs.begin()) ccr_list << ", ";
 291       ccr_list << "[" << *j << "]";
 292     }
 293
 294     log_info << "registered ccrs for \"" << arguments[0] << "\": " << ccr_list.str() << std::endl;
 295     return true;
 296   }
 297
 298   return false;
 299 }
 300
 301 bool
 302 Console::hasFocus()
 303 {
 304   return focused;
 305 }
 306
 307 void
 308 Console::show()
 309 {
 310   focused = true;
 311   height = 256;
 312   alpha = 1.0;
 313 }
 314
 315 void
 316 Console::hide()
 317 {
 318   focused = false;
 319   height = 0;
 320   stayOpen = 0;
 321
 322   // clear input buffer
 323   inputBuffer.str(std::string());
 324 }
 325
 326 void
 327 Console::toggle()
 328 {
 329   if (Console::hasFocus()) {
 330     Console::hide();
 331   }
 332   else {
 333     Console::show();
 334   }
 335 }
 336
 337 void
 338 Console::update(float elapsed_time)
 339 {
 340   if(stayOpen > 0) {
 341     stayOpen -= elapsed_time;
 342     if(stayOpen < 0)
 343       stayOpen = 0;
 344   } else if(!focused && height > 0) {
 345     alpha -= elapsed_time * FADE_SPEED;
 346     if(alpha < 0) {
 347       alpha = 0;
 348       height = 0;
 349     }
 350   }
 351 }
 352
 353 void
 354 Console::draw(DrawingContext& context)
 355 {
 356   if (height == 0)
 357     return;
 358
 359   int layer = LAYER_GUI + 1;
 360
 361   context.push_transform();
 362   context.set_alpha(alpha);
 363   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
 364   context.draw_surface(background2.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
 365   context.draw_surface(background.get(), Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), layer);
 366   backgroundOffset+=10;
 367   if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();
 368
 369   int lineNo = 0;
 370
 371   if (focused) {
 372     lineNo++;
 373     float py = height-4-1*9;
 374     context.draw_text(font.get(), "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, layer);
 375   }
 376
 377   int skipLines = -offset;
 378   for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
 379     if (skipLines-- > 0) continue;
 380     lineNo++;
 381     float py = height-4-lineNo*9;
 382     if (py < -9) break;
 383     context.draw_text(font.get(), *i, Vector(4, py), LEFT_ALLIGN, layer);
 384   }
 385
 386   context.pop_transform();
 387 }
 388
 389 void
 390 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
 391 {
 392   commands[command].push_front(ccr);
 393 }
 394
 395 void
 396 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
 397 {
 398   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 399   if ((i == commands.end()) || (i->second.size() == 0)) {
 400     log_warning << "Command \"" << command << "\" not associated with a command receiver. Not dissociated." << std::endl;
 401     return;
 402   }
 403   std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
 404   if (j == i->second.end()) {
 405     log_warning << "Command \"" << command << "\" not associated with given command receiver. Not dissociated." << std::endl;
 406     return;
 407   }
 408   i->second.erase(j);
 409 }
 410
 411 void
 412 Console::unregisterCommands(ConsoleCommandReceiver* ccr)
 413 {
 414   for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
 415     std::list<ConsoleCommandReceiver*> &ccrs = i->second;
 416     std::list<ConsoleCommandReceiver*>::iterator j;
 417     while ((j = find(ccrs.begin(), ccrs.end(), ccr)) != ccrs.end()) {
 418       ccrs.erase(j);
 419     }
 420   }
 421 }
 422
 423 Console* Console::instance = NULL;
 424 ConsoleStreamBuffer Console::inputBuffer;
 425 ConsoleStreamBuffer Console::outputBuffer;
 426 std::ostream Console::input(&Console::inputBuffer);
 427 std::ostream Console::output(&Console::outputBuffer);
 428