Changeset 1322

Timestamp:

May 19, 2008, 2:33:09 AM (17 years ago)

Author:

landauf

Message:

The InGameConsole is now using the new Shell. There's a clear separation between the two classes: InGameConsole implements all graphical parts of the console (and has a tick), while Shell handles the internal actions (like listening on input and output changes). That's why InGameConsole has no longer it's own InputBuffer and doesn't care about command-executing or anything else.

There are currently three new features:

• Every output through COUT(level) is now visible in the InGameConsole, provided the configured output-level for the shell matches. default: 1 (only forced output and errors)
• The cursor in the input-line is movable with the left and right arrow keys (home and end works too)
• You can scroll through all output-lines by pressing page up and page down

There's another feature to come, providing a command history, accessible with up and down arrow keys, but I couldn't finish it yet, because there's still a bug, causing Orxonox to scroll through the entire memory - that's maybe a bit too much history

Location:

code/branches/console/src

Files:

• core/InputBuffer.h (modified) (1 diff)
• core/InputHandler.cc (modified) (2 diffs)
• core/InputManager.cc (modified) (1 diff)
• core/OutputBuffer.cc (modified) (2 diffs)
• core/OutputBuffer.h (modified) (3 diffs)
• core/OutputHandler.cc (modified) (3 diffs)
• core/Shell.cc (modified) (11 diffs)
• core/Shell.h (modified) (1 diff)
• orxonox/console/InGameConsole.cc (modified) (13 diffs)
• orxonox/console/InGameConsole.h (modified) (2 diffs)

code/branches/console/src/core/InputBuffer.h

@@ -62 +62 @@
             InputBuffer();
             InputBuffer(const std::string allowedChars);
+
+            inline void setKeyboard(OIS::Keyboard* keyboard)
+                { this->keyboard_ = keyboard; }
 
             template <class T>

code/branches/console/src/core/InputHandler.cc

@@ -39 +39 @@
 #include "InputEvent.h"
 #include "InputManager.h"
+#include "CommandExecutor.h"
 
 namespace orxonox
@@ -89 +90 @@
     {
       InputManager::getSingleton().setInputMode(IM_KEYBOARD);
+      CommandExecutor::execute("openConsole");
     }
     else

code/branches/console/src/core/InputManager.cc

@@ -105 +105 @@
         // create a keyboard. If none are available the exception is caught.
         keyboard_ = static_cast<OIS::Keyboard*>(inputSystem_->createInputObject(OIS::OISKeyboard, true));
-        COUT(ORX_DEBUG) << "*** InputManager: Created OIS mouse" << std::endl;
+        COUT(ORX_DEBUG) << "*** InputManager: Created OIS keyboard" << std::endl;
+
+        if (this->handlerBuffer_)
+            this->handlerBuffer_->setKeyboard(this->keyboard_);
 
         // create a mouse. If none are available the exception is caught.
         mouse_ = static_cast<OIS::Mouse*>(inputSystem_->createInputObject(OIS::OISMouse, true));
-        COUT(ORX_DEBUG) << "*** InputManager: Created OIS keyboard" << std::endl;
+        COUT(ORX_DEBUG) << "*** InputManager: Created OIS mouse" << std::endl;
 
         // Set mouse region

code/branches/console/src/core/OutputBuffer.cc

@@ -49 +49 @@
     }
 
+    OutputBuffer& OutputBuffer::operator<<(std::ostream& (*manipulator)(std::ostream&))
+    {
+                this->stream_ << manipulator;
+                this->callListeners();
+                return *this;
+    }
+
+    OutputBuffer& OutputBuffer::operator<<(std::ios& (*manipulator)(std::ios&))
+    {
+                this->stream_ << manipulator;
+                this->callListeners();
+                return *this;
+    }
+
+    OutputBuffer& OutputBuffer::operator<<(std::ios_base& (*manipulator)(std::ios_base&))
+    {
+                this->stream_ << manipulator;
+                this->callListeners();
+                return *this;
+    }
+
     bool OutputBuffer::getLine(std::string* output)
     {
@@ -59 +80 @@
 
         if (eof)
+        {
             this->stream_.flush();
+            this->stream_.clear();
+        }
 
-        // Return true if this was a whole new line, ended by \n
         return (!eof);
     }

code/branches/console/src/core/OutputBuffer.h

@@ -32 +32 @@
 #include <list>
 #include <sstream>
+#include <iostream>
 
 #include "CorePrereqs.h"
@@ -57 +58 @@
                 return *this;
             }
+
+            OutputBuffer& operator<<(std::ostream& (*manipulator)(std::ostream&));
+            OutputBuffer& operator<<(std::ios& (*manipulator)(std::ios&));
+            OutputBuffer& operator<<(std::ios_base& (*manipulator)(std::ios_base&));
 
             template <class T>
@@ -88 +93 @@
             void unregisterListener(OutputBufferListener* listener);
 
-            inline operator std::stringstream&()
-            {
-                return this->stream_;
-            }
-
         private:
             void callListeners();

code/branches/console/src/core/OutputHandler.cc

@@ -124 +124 @@
 
         if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Shell) >= this->outputLevel_)
-            manipulator(Shell::getInstance().getOutputBuffer());
+            Shell::getInstance().getOutputBuffer() << manipulator;
 
         return *this;
@@ -146 +146 @@
 
         if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Shell) >= this->outputLevel_)
-            manipulator(Shell::getInstance().getOutputBuffer());
+            Shell::getInstance().getOutputBuffer() << manipulator;
 
         return *this;
@@ -168 +168 @@
 
         if (OutputHandler::getSoftDebugLevel(OutputHandler::LD_Shell) >= this->outputLevel_)
-            manipulator(Shell::getInstance().getOutputBuffer());
+            Shell::getInstance().getOutputBuffer() << manipulator;
 
         return *this;

code/branches/console/src/core/Shell.cc

@@ -46 +46 @@
         this->historyPosition_ = 0;
         this->historyOffset_ = 0;
+        this->finishedLastLine_ = true;
 
         this->clearLines();
-/*
+
         this->inputBuffer_.registerListener(this, &Shell::inputChanged, true);
         this->inputBuffer_.registerListener(this, &Shell::execute, '\r', false);
@@ -63 +64 @@
         this->inputBuffer_.registerListener(this, &Shell::scroll_up, OIS::KC_PGUP);
         this->inputBuffer_.registerListener(this, &Shell::scroll_down, OIS::KC_PGDOWN);
-*/
+
+        this->outputBuffer_.registerListener(this);
+
         this->setConfigValues();
     }
@@ -77 +80 @@
         SetConfigValue(maxHistoryLength_, 100);
         SetConfigValue(historyOffset_, 0);
-        SetConfigValueVector(commandHistory_, std::vector<std::string>(1, ""));
+        SetConfigValueVector(commandHistory_, std::vector<std::string>());
+
+std::cout << "gaga1: " << this->commandHistory_[this->historyOffset_] << std::endl;
 
         if (this->historyOffset_ >= this->maxHistoryLength_)
@@ -88 +93 @@
             ModifyConfigValue(commandHistory_, remove, index);
         }
+
+std::cout << "gaga2: " << this->commandHistory_[this->historyOffset_] << std::endl;
     }
 
@@ -120 +127 @@
     void Shell::addLine(const std::string& line, unsigned int level)
     {
-        if ((*this->lines_.begin()) != "")
-        {
-            orxonox::OutputHandler::getOutStream().setOutputLevel(level) << std::endl;
-        }
-        orxonox::OutputHandler::getOutStream().setOutputLevel(level) << line << std::endl;
+        int original_level = OutputHandler::getOutStream().getOutputLevel();
+        OutputHandler::getOutStream().setOutputLevel(level);
+
+        if (!this->finishedLastLine_)
+            this->outputBuffer_ << std::endl;
+
+        this->outputBuffer_ << line << std::endl;
+        OutputHandler::getOutStream().setOutputLevel(original_level);
     }
 
@@ -130 +140 @@
     {
         this->lines_.clear();
-        this->lines_.insert(this->lines_.begin(), "");
         this->scrollIterator_ = this->lines_.begin();
 
         this->scrollPosition_ = 0;
+        this->finishedLastLine_ = true;
 
         SHELL_UPDATE_LISTENERS(linesChanged);
@@ -141 +151 @@
     {
         if (this->scrollPosition_)
-        {
             return this->scrollIterator_;
-        }
         else
-        {
-            if ((*this->lines_.begin()) == "" && this->lines_.size() > 1)
-                return (++this->lines_.begin());
-            else
-                return this->lines_.begin();
-        }
+            return this->lines_.begin();
     }
 
@@ -160 +163 @@
     void Shell::addToHistory(const std::string& command)
     {
-        this->historyOffset_ = (this->historyOffset_ + 1) % this->maxHistoryLength_;
+std::cout << "command: " << command << std::endl;
+std::cout << "offset: " << this->historyOffset_ << std::endl;
         ModifyConfigValue(commandHistory_, set, this->historyOffset_, command);
-        this->commandHistory_[this->historyOffset_] = command;
+//        this->commandHistory_[this->historyOffset_] = command;
         this->historyPosition_ = 0;
+std::cout << "gaga3: " << this->commandHistory_[this->historyOffset_] << std::endl;
+        ModifyConfigValue(historyOffset_, set, (this->historyOffset_ + 1) % this->maxHistoryLength_);
+std::cout << "offset new: " << this->historyOffset_ << std::endl;
     }
 
@@ -174 +181 @@
     {
         std::string output;
-        while (this->outputBuffer_.getLine(&output))
-        {
-            bool newline = false;
-            if ((*this->lines_.begin()) == "")
-                newline = true;
-
-            (*this->lines_.begin()) += output;
-
-            SHELL_UPDATE_LISTENERS(onlyLastLineChanged);
-
-            this->lines_.insert(this->lines_.begin(), "");
-
-            if (this->scrollPosition_)
-                this->scrollPosition_++;
-            else
-                this->scrollIterator_ = this->lines_.begin();
-
-            if (newline)
+        bool newline;
+        do
+        {
+            newline = this->outputBuffer_.getLine(&output);
+
+            if (!newline && output == "")
+                break;
+
+            if (this->finishedLastLine_)
             {
+                this->lines_.insert(this->lines_.begin(), output);
+
+                if (this->scrollPosition_)
+                    this->scrollPosition_++;
+                else
+                    this->scrollIterator_ = this->lines_.begin();
+
+                this->finishedLastLine_ = newline;
                 SHELL_UPDATE_LISTENERS(lineAdded);
             }
-        }
-
-        (*this->lines_.begin()) += output;
-        SHELL_UPDATE_LISTENERS(onlyLastLineChanged);
+            else
+            {
+                (*this->lines_.begin()) += output;
+                this->finishedLastLine_ = newline;
+                SHELL_UPDATE_LISTENERS(onlyLastLineChanged);
+            }
+
+        } while (newline);
     }
 
@@ -209 +219 @@
     void Shell::execute()
     {
-        if (CommandExecutor::execute(this->inputBuffer_.get()))
-            this->addLine(this->inputBuffer_.get(), 0);
-        else
+//        this->addToHistory(this->inputBuffer_.get());
+        this->addLine(this->inputBuffer_.get(), 0);
+
+        if (!CommandExecutor::execute(this->inputBuffer_.get()))
             this->addLine("Error: Can't execute \"" + this->inputBuffer_.get() + "\".", 1);
 
@@ -282 +293 @@
         if (this->historyPosition_ > 0)
         {
-            this->historyPosition_++;
+            this->historyPosition_--;
             this->inputBuffer_.set(this->getFromHistory());
         }

code/branches/console/src/core/Shell.h

@@ -118 +118 @@
             InputBuffer inputBuffer_;
             OutputBuffer outputBuffer_;
+            bool finishedLastLine_;
             std::list<std::string> lines_;
             std::list<std::string>::const_iterator scrollIterator_;

code/branches/console/src/orxonox/console/InGameConsole.cc

@@ -42 +42 @@
 #include "core/ConfigValueIncludes.h"
 #include "core/ConsoleCommand.h"
+#include "core/InputManager.h"
 #include "GraphicsEngine.h"
 
@@ -48 +49 @@
 namespace orxonox
 {
+    ConsoleCommand(InGameConsole, openConsole, AccessLevel::None, true);
+    ConsoleCommand(InGameConsole, closeConsole, AccessLevel::None, true);
+
     using namespace Ogre;
 
     float InGameConsole::REL_WIDTH = 0.8;
     float InGameConsole::REL_HEIGHT = 0.4;
-    float InGameConsole::BLINK = 0.25;
+    float InGameConsole::BLINK = 0.5;
 
     /**
@@ -63 +67 @@
         this->active_ = false;
         this->cursor_ = 0.0;
+        this->cursorSymbol_ = '|';
 
         this->init();
         this->setConfigValues();
+
+        Shell::getInstance().registerListener(this);
     }
 
@@ -95 +102 @@
         SetConfigValue(REL_WIDTH, 0.8);
         SetConfigValue(REL_HEIGHT, 0.4);
-        SetConfigValue(BLINK, 0.25);
+        SetConfigValue(BLINK, 0.5);
     }
 
@@ -104 +111 @@
     {
         std::list<std::string>::const_iterator it = Shell::getInstance().getNewestLineIterator();
-        for (int i = 1; i < LINES && it != Shell::getInstance().getEndIterator(); i++)
-        {
-            this->consoleOverlayTextAreas_[i]->setCaption(*it);
-            ++it;
+        for (int i = 1; i < LINES; i++)
+        {
+            if (it != Shell::getInstance().getEndIterator())
+            {
+                this->print(*it, i);
+                ++it;
+            }
+            else
+            {
+                this->print("", i);
+            }
         }
     }
@@ -117 +131 @@
     {
         if (LINES > 1)
-            this->consoleOverlayTextAreas_[1]->setCaption(*Shell::getInstance().getNewestLineIterator());
+            this->print(*Shell::getInstance().getNewestLineIterator(), 1);
     }
 
@@ -125 +139 @@
     void InGameConsole::lineAdded()
     {
-        for (int i = LINES - 1; i > 1; i--)
-            this->consoleOverlayTextAreas_[i]->setCaption(this->consoleOverlayTextAreas_[i - 1]->getCaption());
-
-        if (LINES > 1)
-            this->consoleOverlayTextAreas_[1]->setCaption(*Shell::getInstance().getNewestLineIterator());
+        this->linesChanged();
     }
 
@@ -138 +148 @@
     {
         if (LINES > 0)
-            this->consoleOverlayTextAreas_[0]->setCaption(Shell::getInstance().getInput());
+            this->print(Shell::getInstance().getInput(), 0);
     }
 
@@ -147 +157 @@
     {
         std::string input = Shell::getInstance().getInput();
-        input.insert(Shell::getInstance().getCursorPosition(), 1, '|');
+        input.insert(Shell::getInstance().getCursorPosition(), 1, this->cursorSymbol_);
         if (LINES > 0)
-            this->consoleOverlayTextAreas_[0]->setCaption(input);
+            this->print(input, 0);
     }
 
@@ -158 +168 @@
     {
         this->deactivate();
-        CommandExecutor::execute("set InputMode 2");
+        InputManager::getSingleton().setInputMode(IM_INGAME);
     }
 
@@ -266 +276 @@
         if (this->cursor_ >= 2 * InGameConsole::BLINK)
             this->cursor_ = 0;
-//        print(convert2UTF(this->ib_->get()));
+
+        if (this->cursor_ >= InGameConsole::BLINK && this->cursorSymbol_ == '|')
+        {
+            this->cursorSymbol_ = ' ';
+            this->cursorChanged();
+        }
+        else if (this->cursor_ < InGameConsole::BLINK && this->cursorSymbol_ == ' ')
+        {
+            this->cursorSymbol_ = '|';
+            this->cursorChanged();
+        }
 
         // this creates a flickering effect
@@ -296 +316 @@
     void InGameConsole::activate()
     {
+        this->linesChanged();
+
         this->consoleOverlay_->show();
         // just in case window size has changed...
@@ -334 +356 @@
         @param s String to be printed
     */
-    void InGameConsole::print(Ogre::UTFString s)
-    {
-        if (this->cursor_ > InGameConsole::BLINK)
-            this->consoleOverlayTextAreas_[0]->setCaption(">" + s);
-        else
-            this->consoleOverlayTextAreas_[0]->setCaption(">" + s + "_");
-    }
-
-    /**
-        @brief Shifts all lines up and clears the bottom line.
-    */
-    void InGameConsole::newline()
-    {
-        Ogre::UTFString line;
-        for (int i = LINES - 1; i >= 1; i--)
-        {
-            line = this->consoleOverlayTextAreas_[i - 1]->getCaption();
-            // don't copy the cursor...
-            int l = line.length();
-            if (!line.empty() && line.substr(l-1) == "_")
-                line.erase(l-1);
-            this->consoleOverlayTextAreas_[i]->setCaption(line);
-        }
-        this->consoleOverlayTextAreas_[0]->setCaption(">");
+    void InGameConsole::print(const std::string& text, int index)
+    {
+        if (LINES > index)
+            this->consoleOverlayTextAreas_[index]->setCaption(convert2UTF(text));
     }
 

code/branches/console/src/orxonox/console/InGameConsole.h

@@ -71 +71 @@
             void init();
             void resize();
-            void print(Ogre::UTFString s);
-            void newline();
+            void print(const std::string& text, int index);
             static Ogre::UTFString convert2UTF(std::string s);
 
@@ -84 +83 @@
             float scrollTimer_;
             float cursor_;
+            char cursorSymbol_;
             bool active_;
             Ogre::OverlayManager* om_;