Skip to content

Commit

Permalink
GUI: Use Common::String for console history, to ensure buffer safety.
Browse files Browse the repository at this point in the history
Previously, if the user enters a command that is more than 256
characters, it will overflow the history buffer.

By using a Common::String, this is not possible.
  • Loading branch information
klusark authored and digitall committed Nov 14, 2013
1 parent 0ccc918 commit 51dceaf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
23 changes: 8 additions & 15 deletions gui/console.cpp
Expand Up @@ -82,8 +82,6 @@ ConsoleDialog::ConsoleDialog(float widthPercent, float heightPercent)
_historyIndex = 0;
_historyLine = 0;
_historySize = 0;
for (int i = 0; i < kHistorySize; i++)
_history[i][0] = '\0';

// Display greetings & prompt
print(gScummVMFullVersion);
Expand Down Expand Up @@ -274,24 +272,19 @@ void ConsoleDialog::handleKeyDown(Common::KeyState state) {

if (len > 0) {

// We have to allocate the string buffer with new, since VC++ sadly does not
// comply to the C++ standard, so we can't use a dynamic sized stack array.
char *str = new char[len + 1];
Common::String str;

// Copy the user input to str
for (i = 0; i < len; i++)
str[i] = buffer(_promptStartPos + i);
str[len] = '\0';
str.insertChar(buffer(_promptStartPos + i), i);

// Add the input to the history
addToHistory(str);

// Pass it to the input callback, if any
if (_callbackProc)
keepRunning = (*_callbackProc)(this, str, _callbackRefCon);
keepRunning = (*_callbackProc)(this, str.c_str(), _callbackRefCon);

// Get rid of the string buffer
delete[] str;
}

print(PROMPT);
Expand Down Expand Up @@ -575,8 +568,8 @@ void ConsoleDialog::killLastWord() {
}
}

void ConsoleDialog::addToHistory(const char *str) {
strcpy(_history[_historyIndex], str);
void ConsoleDialog::addToHistory(const Common::String &str) {
_history[_historyIndex] = str;
_historyIndex = (_historyIndex + 1) % kHistorySize;
_historyLine = 0;
if (_historySize < kHistorySize)
Expand All @@ -590,8 +583,7 @@ void ConsoleDialog::historyScroll(int direction) {
if (_historyLine == 0 && direction > 0) {
int i;
for (i = 0; i < _promptEndPos - _promptStartPos; i++)
_history[_historyIndex][i] = buffer(_promptStartPos + i);
_history[_historyIndex][i] = '\0';
_history[_historyIndex].insertChar(buffer(_promptStartPos + i), i);
}

// Advance to the next line in the history
Expand All @@ -617,7 +609,8 @@ void ConsoleDialog::historyScroll(int direction) {
idx = (_historyIndex - _historyLine + _historySize) % _historySize;
else
idx = _historyIndex;
for (int i = 0; i < kLineBufferSize && _history[idx][i] != '\0'; i++)
int length = _history[idx].size();
for (int i = 0; i < length; i++)
printCharIntern(_history[idx][i]);
_promptEndPos = _currentPos;

Expand Down
6 changes: 3 additions & 3 deletions gui/console.h
Expand Up @@ -23,6 +23,7 @@
#define CONSOLE_DIALOG_H

#include "gui/dialog.h"
#include "common/str.h"

namespace GUI {

Expand Down Expand Up @@ -69,7 +70,6 @@ class ConsoleDialog : public Dialog {
enum {
kBufferSize = 32768,
kCharsPerLine = 128,
kLineBufferSize = 256,

kHistorySize = 20
};
Expand Down Expand Up @@ -112,7 +112,7 @@ class ConsoleDialog : public Dialog {
CompletionCallbackProc _completionCallbackProc;
void *_completionCallbackRefCon;

char _history[kHistorySize][kLineBufferSize];
Common::String _history[kHistorySize];
int _historySize;
int _historyIndex;
int _historyLine;
Expand Down Expand Up @@ -184,7 +184,7 @@ class ConsoleDialog : public Dialog {
void killLastWord();

// History
void addToHistory(const char *str);
void addToHistory(const Common::String &str);
void historyScroll(int direction);
};

Expand Down

0 comments on commit 51dceaf

Please sign in to comment.