Console Class Reference

#include <console.hpp>

List of all members.

Public Member Functions
	Console ()
	~Console ()
void	init_graphics ()
void	input (char c)
	add character to inputBuffer
void	backspace ()
	delete character left of inputBufferPosition
void	eraseChar ()
	delete character at inputBufferPosition
void	enter ()
	process and clear input stream
void	scroll (int offset)
	scroll console text up or down by offset lines
void	autocomplete ()
	autocomplete current command
void	show_history (int offset)
	move offset lines forward through history; Negative offset moves backward
void	move_cursor (int offset)
	move the cursor offset chars to the right; Negative offset moves backward; 0xFFFF moves to the end
void	draw (DrawingContext &context)
	draw the console in a DrawingContext
void	update (float elapsed_time)
void	show ()
	display the console
void	open ()
	open the console for viewing for 6 seconds
void	hide ()
	hide the console
void	toggle ()
	display the console if hidden, hide otherwise
bool	hasFocus ()
	true if characters should be sent to the console instead of their normal target
Static Public Member Functions
template<typename T>
static bool	string_is (std::string s)
template<typename T>
static T	string_to (std::string s)
Static Public Attributes
static Console *	instance
static std::ostream	output
	stream of characters to output to the console.
Private Member Functions
void	addLines (std::string s)
	display a string of (potentially) multiple lines in the console
void	addLine (std::string s)
	display a line in the console
void	parse (std::string s)
	react to a given command
void	ready_vm ()
	ready a virtual machine instance, creating a new thread and loading default .nut files if needed
void	execute_script (const std::string &s)
	execute squirrel script and output result
bool	consoleCommand (std::string command, std::vector< std::string > arguments)
	process internal command; return false if command was unknown, true otherwise
void	flush (ConsoleStreamBuffer *buffer)
	act upon changes in a ConsoleStreamBuffer
	Console (const Console &)
Console &	operator= (const Console &)
Private Attributes
std::list< std::string >	history
	command history.
std::list< std::string >::iterator	history_position
	item of command history that is currently displayed
std::list< std::string >	lines
	backbuffer of lines sent to the console.
SurfacePtr	background
	console background image
SurfacePtr	background2
	second, moving console background image
HSQUIRRELVM	vm
	squirrel thread for the console (with custom roottable)
HSQOBJECT	vm_object
int	backgroundOffset
	current offset of scrolling background image
float	height
	height of the console in px
float	alpha
int	offset
	decrease to scroll text up
bool	focused
	true if console has input focus
FontPtr	font
float	fontheight
	height of the font (this is a separate var, because the font could not be initialized yet but is needed in the addLine message
float	stayOpen
Static Private Attributes
static int	inputBufferPosition
	position in inputBuffer before which to append new characters
static std::string	inputBuffer
	string used for keyboard input
static ConsoleStreamBuffer	outputBuffer
	stream buffer used by output stream
Friends
class	ConsoleStreamBuffer

---

Detailed Description

Definition at line 34 of file console.hpp.

---

Constructor & Destructor Documentation

Console::Console

(

)

Definition at line 31 of file console.cpp.

References fontheight.

                 :
  history(),
  history_position(history.end()), 
  lines(),
  background(),
  background2(),
  vm(NULL), 
  vm_object(),
  backgroundOffset(0),
  height(0),
  alpha(1.0), 
  offset(0), 
  focused(false), 
  font(),
  fontheight(),
  stayOpen(0) 
{
  fontheight = 8;
}

Console::~Console

(

)

Definition at line 51 of file console.cpp.

References scripting::global_vm, vm, and vm_object.

{
  if(vm != NULL) {
    sq_release(scripting::global_vm, &vm_object);
  }
}

Console::Console

(

const Console &

)

[private]

---

Member Function Documentation

void Console::init_graphics

(

)

Definition at line 59 of file console.cpp.

References background, background2, Surface::create(), Font::FIXED, font, and fontheight.

Referenced by Main::run().

{
  font.reset(new Font(Font::FIXED,"fonts/andale12.stf",1));
  fontheight = font->get_height();
  background = Surface::create("images/engine/console.png");
  background2 = Surface::create("images/engine/console2.png");
}

void Console::input

(

char

c

)

add character to inputBuffer

Definition at line 147 of file console.cpp.

References inputBuffer, and inputBufferPosition.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  inputBuffer.insert(inputBufferPosition, 1, c);
  inputBufferPosition++;
}

void Console::backspace

(

)

delete character left of inputBufferPosition

Definition at line 154 of file console.cpp.

References inputBuffer, and inputBufferPosition.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  if ((inputBufferPosition > 0) && (inputBuffer.length() > 0)) {
    inputBuffer.erase(inputBufferPosition-1, 1);
    inputBufferPosition--;
  }
}

void Console::eraseChar

(

)

delete character at inputBufferPosition

Definition at line 163 of file console.cpp.

References inputBuffer, and inputBufferPosition.

{
  if (inputBufferPosition < (int)inputBuffer.length()) {
    inputBuffer.erase(inputBufferPosition, 1);
  }
}

void Console::enter

(

)

process and clear input stream

Definition at line 171 of file console.cpp.

References addLines(), inputBuffer, inputBufferPosition, and parse().

Referenced by JoystickKeyboardController::process_console_key_event().

{
  addLines("> "+inputBuffer);
  parse(inputBuffer);
  inputBuffer = "";
  inputBufferPosition = 0;
}

void Console::scroll

(

int

offset

)

scroll console text up or down by offset lines

Definition at line 180 of file console.cpp.

References offset.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  offset += numLines;
  if (offset > 0) offset = 0;
}

void Console::autocomplete

(

)

autocomplete current command

Definition at line 282 of file console.cpp.

References addLines(), inputBuffer, inputBufferPosition, ready_vm(), sq_insert_commands(), and vm.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  //int autocompleteFrom = inputBuffer.find_last_of(" ();+", inputBufferPosition);
  int autocompleteFrom = inputBuffer.find_last_not_of("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_->.", inputBufferPosition);
  if (autocompleteFrom != (int)std::string::npos) {
    autocompleteFrom += 1;
  } else {
    autocompleteFrom = 0;
  }
  std::string prefix = inputBuffer.substr(autocompleteFrom, inputBufferPosition - autocompleteFrom);
  addLines("> "+prefix);

  std::list<std::string> cmds;

  ready_vm();

  // append all keys of the current root table to list
  sq_pushroottable(vm); // push root table
  while(true) {
    // check all keys (and their children) for matches
    sq_insert_commands(cmds, vm, "", prefix);

    // cycle through parent(delegate) table
    SQInteger oldtop = sq_gettop(vm);
    if(SQ_FAILED(sq_getdelegate(vm, -1)) || oldtop == sq_gettop(vm)) {
      break;
    }
    sq_remove(vm, -2); // remove old table
  }
  sq_pop(vm, 1); // remove table

  // depending on number of hits, show matches or autocomplete
  if (cmds.size() == 0) addLines("No known command starts with \""+prefix+"\"");
  if (cmds.size() == 1) {
    // one match: just replace input buffer with full command
    std::string replaceWith = cmds.front();
    inputBuffer.replace(autocompleteFrom, prefix.length(), replaceWith);
    inputBufferPosition += (replaceWith.length() - prefix.length());
  }
  if (cmds.size() > 1) {
    // multiple matches: show all matches and set input buffer to longest common prefix
    std::string commonPrefix = cmds.front();
    while (cmds.begin() != cmds.end()) {
      std::string cmd = cmds.front();
      cmds.pop_front();
      addLines(cmd);
      for (int n = commonPrefix.length(); n >= 1; n--) {
        if (cmd.compare(0, n, commonPrefix) != 0) commonPrefix.resize(n-1); else break;
      }
    }
    std::string replaceWith = commonPrefix;
    inputBuffer.replace(autocompleteFrom, prefix.length(), replaceWith);
    inputBufferPosition += (replaceWith.length() - prefix.length());
  }
}

void Console::show_history

(

int

offset

)

move offset lines forward through history; Negative offset moves backward

Definition at line 187 of file console.cpp.

References history, history_position, inputBuffer, and inputBufferPosition.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  while ((offset > 0) && (history_position != history.end())) {
    history_position++;
    offset--;
  }
  while ((offset < 0) && (history_position != history.begin())) {
    history_position--;
    offset++;
  }
  if (history_position == history.end()) {
    inputBuffer = "";
    inputBufferPosition = 0;
  } else {
    inputBuffer = *history_position;
    inputBufferPosition = inputBuffer.length();
  }
}

void Console::move_cursor

(

int

offset

)

move the cursor offset chars to the right; Negative offset moves backward; 0xFFFF moves to the end

Definition at line 207 of file console.cpp.

References inputBuffer, and inputBufferPosition.

Referenced by JoystickKeyboardController::process_console_key_event().

{
  if (offset == -65535) inputBufferPosition = 0;
  if (offset == +65535) inputBufferPosition = inputBuffer.length();
  inputBufferPosition+=offset;
  if (inputBufferPosition < 0) inputBufferPosition = 0;
  if (inputBufferPosition > (int)inputBuffer.length()) inputBufferPosition = inputBuffer.length();
}

void Console::draw

(

DrawingContext &

context

)

draw the console in a DrawingContext

Definition at line 485 of file console.cpp.

References ALIGN_LEFT, alpha, background, background2, backgroundOffset, DrawingContext::draw_surface(), DrawingContext::draw_text(), focused, font, height, inputBuffer, inputBufferPosition, LAYER_GUI, lines, offset, DrawingContext::pop_transform(), DrawingContext::push_transform(), SCREEN_WIDTH, and DrawingContext::set_alpha().

Referenced by ScreenManager::draw().

{
  if (height == 0)
    return;

  int layer = LAYER_GUI + 1;

  context.push_transform();
  context.set_alpha(alpha);
  context.draw_surface(background2, Vector(SCREEN_WIDTH/2 - background->get_width()/2 - background->get_width() + backgroundOffset, height - background->get_height()), layer);
  context.draw_surface(background2, Vector(SCREEN_WIDTH/2 - background->get_width()/2 + backgroundOffset, height - background->get_height()), layer);
  for (int x = (SCREEN_WIDTH/2 - background->get_width()/2 - (static_cast<int>(ceilf((float)SCREEN_WIDTH / (float)background->get_width()) - 1) * background->get_width())); x < SCREEN_WIDTH; x+=background->get_width()) {
    context.draw_surface(background, Vector(x, height - background->get_height()), layer);
  }
  backgroundOffset+=10;
  if (backgroundOffset > (int)background->get_width()) backgroundOffset -= (int)background->get_width();

  int lineNo = 0;

  if (focused) {
    lineNo++;
    float py = height-4-1 * font->get_height();
    context.draw_text(font, "> "+inputBuffer, Vector(4, py), ALIGN_LEFT, layer);
    if (SDL_GetTicks() % 1000 < 750) {
      int cursor_px = 2 + inputBufferPosition;
      context.draw_text(font, "_", Vector(4 + (cursor_px * font->get_text_width("X")), py), ALIGN_LEFT, layer);
    }
  }

  int skipLines = -offset;
  for (std::list<std::string>::iterator i = lines.begin(); i != lines.end(); i++) {
    if (skipLines-- > 0) continue;
    lineNo++;
    float py = height - 4 - lineNo*font->get_height();
    if (py < -font->get_height()) break;
    context.draw_text(font, *i, Vector(4, py), ALIGN_LEFT, layer);
  }
  context.pop_transform();
}

void Console::update

(

float

elapsed_time

)

Definition at line 469 of file console.cpp.

References alpha, FADE_SPEED, focused, height, and stayOpen.

Referenced by ScreenManager::update_gamelogic().

{
  if(stayOpen > 0) {
    stayOpen -= elapsed_time;
    if(stayOpen < 0)
      stayOpen = 0;
  } else if(!focused && height > 0) {
    alpha -= elapsed_time * FADE_SPEED;
    if(alpha < 0) {
      alpha = 0;
      height = 0;
    }
  }
}

void Console::show

(

)

display the console

Definition at line 426 of file console.cpp.

References alpha, Config::console_enabled, focused, g_config, and height.

Referenced by toggle().

{
  if(!g_config->console_enabled)
    return;

  focused = true;
  height = 256;
  alpha = 1.0;
  SDL_EnableKeyRepeat(SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL);
}

void Console::open

(

)

open the console for viewing for 6 seconds

Definition at line 438 of file console.cpp.

References stayOpen.

{
  if(stayOpen < 2)
    stayOpen += 1.5;
}

void Console::hide

(

)

hide the console

Definition at line 445 of file console.cpp.

References focused, height, inputBuffer, inputBufferPosition, and stayOpen.

Referenced by toggle().

{
  focused = false;
  height = 0;
  stayOpen = 0;

  // clear input buffer
  inputBuffer = "";
  inputBufferPosition = 0;
  SDL_EnableKeyRepeat(0, SDL_DEFAULT_REPEAT_INTERVAL);
}

void Console::toggle

(

)

display the console if hidden, hide otherwise

Definition at line 458 of file console.cpp.

References hasFocus(), hide(), and show().

Referenced by ScreenManager::process_events(), and JoystickKeyboardController::process_key_event().

{
  if (Console::hasFocus()) {
    Console::hide();
  }
  else {
    Console::show();
  }
}

bool Console::hasFocus

(

)

true if characters should be sent to the console instead of their normal target

Definition at line 420 of file console.cpp.

References focused.

Referenced by toggle().

{
  return focused;
}

template<typename T>

static bool Console::string_is

(

std::string

s

)

[inline, static]

Definition at line 65 of file console.hpp.

                                                          {
    std::istringstream iss(s);
    T i;
    if ((iss >> i) && iss.eof()) {
      return true;
    } else {
      return false;
    }
  }

template<typename T>

static T Console::string_to

(

std::string

s

)

[inline, static]

Definition at line 75 of file console.hpp.

                                                       {
    std::istringstream iss(s);
    T i;
    if ((iss >> i) && iss.eof()) {
      return i;
    } else {
      return T();
    }
  }

void Console::addLines

(

std::string

s

)

[private]

display a string of (potentially) multiple lines in the console

Definition at line 339 of file console.cpp.

References addLine().

Referenced by autocomplete(), enter(), execute_script(), flush(), and parse().

{
  std::istringstream iss(s);
  std::string line;
  while (std::getline(iss, line, '\n')) addLine(line);
}

void Console::addLine

(

std::string

s

)

[private]

display a line in the console

Definition at line 347 of file console.cpp.

References alpha, fontheight, height, lines, stayOpen, and Font::wrap_to_chars().

Referenced by addLines().

{
  // output line to stderr
  std::cerr << s << std::endl;

  // wrap long lines
  std::string overflow;
  unsigned int line_count = 0;
  do {
    lines.push_front(Font::wrap_to_chars(s, 99, &overflow));
    line_count++;
    s = overflow;
  } while (s.length() > 0);

  // trim scrollback buffer
  while (lines.size() >= 1000)
    lines.pop_back();

  // increase console height if necessary
  if ((stayOpen > 0) && (height < 64)) {
    if(height < 4)
      height = 4;
    height += fontheight * line_count;
  }

  // reset console to full opacity
  alpha = 1.0;
}

void Console::parse

(

std::string

s

)

[private]

react to a given command

Definition at line 377 of file console.cpp.

References addLines(), consoleCommand(), execute_script(), history, and history_position.

Referenced by enter().

{
  // make sure we actually have something to parse
  if (s.length() == 0) return;

  // add line to history
  history.push_back(s);
  history_position = history.end();

  // split line into list of args
  std::vector<std::string> args;
  size_t start = 0;
  size_t end = 0;
  while (1) {
    start = s.find_first_not_of(" ,", end);
    end = s.find_first_of(" ,", start);
    if (start == s.npos) break;
    args.push_back(s.substr(start, end-start));
  }

  // command is args[0]
  if (args.size() == 0) return;
  std::string command = args.front();
  args.erase(args.begin());

  // ignore if it's an internal command
  if (consoleCommand(command,args)) return;

  try {
    execute_script(s);
  } catch(std::exception& e) {
    addLines(e.what());
  }

}

void Console::ready_vm

(

)

[private]

ready a virtual machine instance, creating a new thread and loading default .nut files if needed

Definition at line 81 of file console.cpp.

References scripting::compile_and_run(), scripting::global_vm, log_warning, vm, and vm_object.

Referenced by autocomplete(), and execute_script().

{
  if(vm == NULL) {
    vm = scripting::global_vm;
    HSQUIRRELVM new_vm = sq_newthread(vm, 16);
    if(new_vm == NULL)
      throw scripting::SquirrelError(vm, "Couldn't create new VM thread for console");

    // store reference to thread
    sq_resetobject(&vm_object);
    if(SQ_FAILED(sq_getstackobj(vm, -1, &vm_object)))
      throw scripting::SquirrelError(vm, "Couldn't get vm object for console");
    sq_addref(vm, &vm_object);
    sq_pop(vm, 1);

    // create new roottable for thread
    sq_newtable(new_vm);
    sq_pushroottable(new_vm);
    if(SQ_FAILED(sq_setdelegate(new_vm, -2)))
      throw scripting::SquirrelError(new_vm, "Couldn't set console_table delegate");

    sq_setroottable(new_vm);

    vm = new_vm;

    try {
      std::string filename = "scripts/console.nut";
      IFileStream stream(filename);
      scripting::compile_and_run(vm, stream, filename);
    } catch(std::exception& e) {
      log_warning << "Couldn't load console.nut: " << e.what() << std::endl;
    }
  }
}

void Console::execute_script

(

const std::string &

s

)

[private]

execute squirrel script and output result

Definition at line 117 of file console.cpp.

References addLines(), log_fatal, ready_vm(), scripting::squirrel2string(), and vm.

Referenced by parse().

{
  using namespace scripting;

  ready_vm();

  SQInteger oldtop = sq_gettop(vm);
  try {
    if(SQ_FAILED(sq_compilebuffer(vm, command.c_str(), command.length(),
                                  "", SQTrue)))
      throw SquirrelError(vm, "Couldn't compile command");

    sq_pushroottable(vm);
    if(SQ_FAILED(sq_call(vm, 1, SQTrue, SQTrue)))
      throw SquirrelError(vm, "Problem while executing command");

    if(sq_gettype(vm, -1) != OT_NULL)
      addLines(squirrel2string(vm, -1));
  } catch(std::exception& e) {
    addLines(e.what());
  }
  SQInteger newtop = sq_gettop(vm);
  if(newtop < oldtop) {
    log_fatal << "Script destroyed squirrel stack..." << std::endl;
  } else {
    sq_settop(vm, oldtop);
  }
}

bool Console::consoleCommand	(	std::string	command,
		std::vector< std::string >	arguments
	)			[private]

process internal command; return false if command was unknown, true otherwise

Definition at line 414 of file console.cpp.

Referenced by parse().

{
  return false;
}

void Console::flush

(

ConsoleStreamBuffer *

buffer

)

[private]

act upon changes in a ConsoleStreamBuffer

Definition at line 68 of file console.cpp.

References addLines(), and outputBuffer.

Referenced by ConsoleStreamBuffer::sync().

{
  if (buffer == &outputBuffer) {
    std::string s = outputBuffer.str();
    if ((s.length() > 0) && ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r'))) {
      while ((s[s.length()-1] == '\n') || (s[s.length()-1] == '\r')) s.erase(s.length()-1);
      addLines(s);
      outputBuffer.str(std::string());
    }
  }
}

Console& Console::operator=

(

const Console &

)

[private]

---

Friends And Related Function Documentation

friend class ConsoleStreamBuffer [friend]

Definition at line 122 of file console.hpp.

---

Member Data Documentation

Console * Console::instance [static]

Definition at line 40 of file console.hpp.

Referenced by ScreenManager::draw(), get_logging_instance(), JoystickKeyboardController::process_console_key_event(), ScreenManager::process_events(), JoystickKeyboardController::process_key_event(), Main::run(), ConsoleStreamBuffer::sync(), and ScreenManager::update_gamelogic().

std::ostream Console::output [static]

stream of characters to output to the console.

Do not forget to send std::endl or to flush the stream.

Definition at line 42 of file console.hpp.

Referenced by scripting::display(), get_logging_instance(), and scripting::printfunc().

std::list<std::string> Console::history [private]

command history.

New lines get added to back.

Definition at line 86 of file console.hpp.

Referenced by parse(), and show_history().

std::list<std::string>::iterator Console::history_position [private]

item of command history that is currently displayed

Definition at line 87 of file console.hpp.

Referenced by parse(), and show_history().

std::list<std::string> Console::lines [private]

backbuffer of lines sent to the console.

New lines get added to front.

Definition at line 88 of file console.hpp.

Referenced by addLine(), and draw().

SurfacePtr Console::background [private]

console background image

Definition at line 90 of file console.hpp.

Referenced by draw(), and init_graphics().

SurfacePtr Console::background2 [private]

second, moving console background image

Definition at line 91 of file console.hpp.

Referenced by draw(), and init_graphics().

HSQUIRRELVM Console::vm [private]

squirrel thread for the console (with custom roottable)

Definition at line 93 of file console.hpp.

Referenced by autocomplete(), execute_script(), ready_vm(), and ~Console().

HSQOBJECT Console::vm_object [private]

Definition at line 94 of file console.hpp.

Referenced by ready_vm(), and ~Console().

int Console::backgroundOffset [private]

current offset of scrolling background image

Definition at line 96 of file console.hpp.

Referenced by draw().

float Console::height [private]

height of the console in px

Definition at line 97 of file console.hpp.

Referenced by addLine(), draw(), hide(), show(), and update().

float Console::alpha [private]

Definition at line 98 of file console.hpp.

Referenced by addLine(), draw(), show(), and update().

int Console::offset [private]

decrease to scroll text up

Definition at line 99 of file console.hpp.

Referenced by draw(), and scroll().

bool Console::focused [private]

true if console has input focus

Definition at line 100 of file console.hpp.

Referenced by draw(), hasFocus(), hide(), show(), and update().

FontPtr Console::font [private]

Definition at line 101 of file console.hpp.

Referenced by draw(), and init_graphics().

float Console::fontheight [private]

height of the font (this is a separate var, because the font could not be initialized yet but is needed in the addLine message

Definition at line 102 of file console.hpp.

Referenced by addLine(), Console(), and init_graphics().

float Console::stayOpen [private]

Definition at line 104 of file console.hpp.

Referenced by addLine(), hide(), open(), and update().

int Console::inputBufferPosition [static, private]

position in inputBuffer before which to append new characters

Definition at line 106 of file console.hpp.

Referenced by autocomplete(), backspace(), draw(), enter(), eraseChar(), hide(), input(), move_cursor(), and show_history().

std::string Console::inputBuffer [static, private]

string used for keyboard input

Definition at line 107 of file console.hpp.

Referenced by autocomplete(), backspace(), draw(), enter(), eraseChar(), hide(), input(), move_cursor(), and show_history().

ConsoleStreamBuffer Console::outputBuffer [static, private]

stream buffer used by output stream

Definition at line 108 of file console.hpp.

Referenced by flush().

---

The documentation for this class was generated from the following files:

• src/supertux/console.hpp
• src/supertux/console.cpp

---