src/console.cpp

   1 //  $Id: worldmap.cpp 3209 2006-04-02 22:19:22Z sommer $
   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
  20 #include <config.h>
  21 #include <iostream>
  22 #include "console.hpp"
  23 #include "video/drawing_context.hpp"
  24 #include "video/surface.hpp"
  25 #include "player_status.hpp"
  26 #include "main.hpp"
  27 #include "resources.hpp"
  28
  29 namespace {
  30   int ticks; // TODO: use a clock?
  31 }
  32
  33 Console::Console()
  34 {
  35   background = new Surface("images/engine/console.png");
  36 }
  37
  38 Console::~Console()
  39 {
  40   delete background;
  41 }
  42
  43 void
  44 Console::flush(ConsoleStreamBuffer* buffer)
  45 {
  46   if (buffer == &outputBuffer) {
  47     std::string s = outputBuffer.str();
  48     if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
  49       while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
  50       addLine(s);
  51       outputBuffer.str(std::string());
  52     }
  53   }
  54   if (buffer == &inputBuffer) {
  55     std::string s = inputBuffer.str();
  56     if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
  57       while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
  58       addLine("> "+s);
  59       parse(s);
  60       inputBuffer.str(std::string());
  61     }
  62   }
  63 }
  64
  65 void
  66 Console::backspace()
  67 {
  68   std::string s = inputBuffer.str();
  69   if (s.length() > 0) {
  70     s.erase(s.length()-1);
  71     inputBuffer.str(s);
  72     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
  73   }
  74 }
  75
  76 void
  77 Console::scroll(int numLines)
  78 {
  79   offset += numLines;
  80   if (offset > 0) offset = 0;
  81 }
  82
  83 void
  84 Console::autocomplete()
  85 {
  86   std::string cmdPart = inputBuffer.str();
  87   addLine("> "+cmdPart);
  88
  89   std::string cmdList = "";
  90   int cmdListLen = 0;
  91   for (std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.begin(); i != commands.end(); i++) {
  92     std::string cmdKnown = i->first;
  93     if (cmdKnown.substr(0, cmdPart.length()) == cmdPart) {
  94       if (cmdListLen > 0) cmdList = cmdList + ", ";
  95       cmdList = cmdList + cmdKnown;
  96       cmdListLen++;
  97     }
  98   }
  99   if (cmdListLen == 0) addLine("No known command starts with \""+cmdPart+"\"");
 100   if (cmdListLen == 1) {
 101     inputBuffer.str(cmdList);
 102     inputBuffer.pubseekoff(0, std::ios_base::end, std::ios_base::out);
 103   }
 104   if (cmdListLen > 1) addLine(cmdList);
 105 }
 106
 107 void
 108 Console::addLine(std::string s)
 109 {
 110   lines.push_front(s);
 111   if (lines.size() >= 65535) lines.pop_back();
 112   if (height < 64) {
 113     if (height < 4+9) height=4+9;
 114     height+=9;
 115   }
 116   ticks=60;
 117   std::cerr << s << std::endl;
 118 }
 119
 120 void
 121 Console::parse(std::string s)
 122 {
 123   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(s);
 124   if ((i == commands.end()) || (i->second.size() == 0)) {
 125     addLine("unknown command: \"" + s + "\"");
 126     return;
 127   }
 128
 129   // send command to the most recently registered ccr
 130   ConsoleCommandReceiver* ccr = i->second.front();
 131   if (ccr->consoleCommand(s) != true) msg_warning("Sent command to registered ccr, but command was unhandled");
 132 }
 133
 134 bool
 135 Console::hasFocus()
 136 {
 137   return focused;
 138 }
 139
 140 void
 141 Console::show()
 142 {
 143   focused = true;
 144   height = 256;
 145 }
 146
 147 void
 148 Console::hide()
 149 {
 150   focused = false;
 151   height = 0;
 152
 153   // clear input buffer
 154   inputBuffer.str(std::string());
 155 }
 156
 157 void
 158 Console::toggle()
 159 {
 160   if (Console::hasFocus()) {
 161     Console::hide();
 162   }
 163   else {
 164     Console::show();
 165   }
 166 }
 167
 168 void
 169 Console::draw(DrawingContext& context)
 170 {
 171   if (height == 0) return;
 172   if (!focused) {
 173     if (ticks-- < 0) {
 174       height-=10;
 175       ticks=0;
 176       if (height < 0) height=0;
 177     }
 178     if (height == 0) return;
 179   }
 180
 181   context.draw_surface(background, Vector(SCREEN_WIDTH/2 - background->get_width()/2, height - background->get_height()), LAYER_FOREGROUND1+1);
 182
 183   int lineNo = 0;
 184
 185   if (focused) {
 186     lineNo++;
 187     float py = height-4-1*9;
 188     context.draw_text(white_small_text, "> "+inputBuffer.str()+"_", Vector(4, py), LEFT_ALLIGN, LAYER_FOREGROUND1+1);
 189   }
 190
 191   int skipLines = -offset;
 192   for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
 193     if (skipLines-- > 0) continue;
 194     lineNo++;
 195     float py = height-4-lineNo*9;
 196     if (py < -9) break;
 197     context.draw_text(white_small_text, *i, Vector(4, py), LEFT_ALLIGN, LAYER_FOREGROUND1+1);
 198   }
 199 }
 200
 201 void
 202 Console::registerCommand(std::string command, ConsoleCommandReceiver* ccr)
 203 {
 204   commands[command].push_front(ccr);
 205 }
 206
 207 void
 208 Console::unregisterCommand(std::string command, ConsoleCommandReceiver* ccr)
 209 {
 210   std::map<std::string, std::list<ConsoleCommandReceiver*> >::iterator i = commands.find(command);
 211   if ((i == commands.end()) || (i->second.size() == 0)) {
 212     msg_warning("Command \"" << command << "\" not associated with a command receiver. Not dissociated.");
 213     return;
 214   }
 215   std::list<ConsoleCommandReceiver*>::iterator j = find(i->second.begin(), i->second.end(), ccr);
 216   if (j == i->second.end()) {
 217     msg_warning("Command \"" << command << "\" not associated with given command receiver. Not dissociated.");
 218     return;
 219   }
 220   i->second.erase(j);
 221 }
 222
 223 int Console::height = 0;
 224 bool Console::focused = false;
 225 std::list<std::string> Console::lines;
 226 std::map<std::string, std::list<ConsoleCommandReceiver*> > Console::commands;
 227 ConsoleStreamBuffer Console::inputBuffer;
 228 ConsoleStreamBuffer Console::outputBuffer;
 229 std::ostream Console::input(&Console::inputBuffer);
 230 std::ostream Console::output(&Console::outputBuffer);
 231 int Console::offset = 0;
 232