Changeset 5994 for code/branches/console/src/libraries/core

Timestamp:

Oct 27, 2009, 2:47:14 PM (15 years ago)

Author:

rgrieder

Message:

Changed Output concept a little bit to allow for more general use.
Every output (log) target has to be implemented as OutputListener. There is already a LogFileWriter and a MemoryLogWriter (stores ALL the log in a vector and provides iterators).
The OutputListener has a unique and constant name, a stream pointer and a soft debug level (that can only be changed via OutputHandler::setSoftDebugLevel(name, level)).
This concept doesn't require the OutputBuffer anymore, so I deleted it.

The adjustments in the Shell are just preliminary for this commit.

Location:

code/branches/console/src/libraries/core

Files:

• ConfigValueIncludes.h (modified) (1 diff)
• Core.cc (modified) (5 diffs)
• Core.h (modified) (1 diff)
• GUIManager.cc (modified) (3 diffs)
• GraphicsManager.cc (modified) (1 diff)
• IOConsole.cc (modified) (5 diffs)
• LuaState.cc (modified) (1 diff)
• Shell.cc (modified) (7 diffs)
• Shell.h (modified) (7 diffs)

code/branches/console/src/libraries/core/ConfigValueIncludes.h

@@ -47 +47 @@
     @param defvalue The default-value of the variable
 */
-#define SetConfigValueGeneric(type, varname, defvalue) \
+#define SetConfigValueGeneric(type, varname, entryname, sectionname, defvalue) \
     static orxonox::Identifier* identifier##varname = this->getIdentifier(); \
     orxonox::ConfigValueContainer* container##varname = identifier##varname->getConfigValueContainer(#varname); \
     if (!container##varname) \
     { \
-        container##varname = new orxonox::ConfigValueContainer(type, identifier##varname, identifier##varname->getName(), #varname, defvalue, varname); \
+        container##varname = new orxonox::ConfigValueContainer(type, identifier##varname, sectionname, entryname, defvalue, varname); \
         identifier##varname->addConfigValueContainer(#varname, container##varname); \
     } \
     container##varname->getValue(&varname, this)
 
-#define SetConfigValue(varname, defvalue) SetConfigValueGeneric(ConfigFileType::Settings, varname, defvalue)
+#define SetConfigValue(varname, defvalue) SetConfigValueGeneric(ConfigFileType::Settings, varname, identifier##varname->getName(), #varname, defvalue)
 
 

code/branches/console/src/libraries/core/Core.cc

@@ -106 +106 @@
         void setConfigValues()
         {
-#ifdef NDEBUG
-            const unsigned int defaultLevelConsole = 1;
-            const unsigned int defaultLevelLogfile = 3;
-            const unsigned int defaultLevelShell   = 1;
+#ifdef ORXONOX_RELEASE
+            const unsigned int defaultLevelLogFile = 3;
 #else
-            const unsigned int defaultLevelConsole = 3;
-            const unsigned int defaultLevelLogfile = 4;
-            const unsigned int defaultLevelShell   = 3;
-#endif
-            SetConfigValue(softDebugLevelConsole_, defaultLevelConsole)
-                .description("The maximal level of debug output shown in the console")
-                .callback(this, &CoreConfiguration::debugLevelChanged);
-            SetConfigValue(softDebugLevelLogfile_, defaultLevelLogfile)
-                .description("The maximal level of debug output shown in the logfile")
-                .callback(this, &CoreConfiguration::debugLevelChanged);
-            SetConfigValue(softDebugLevelShell_, defaultLevelShell)
-                .description("The maximal level of debug output shown in the ingame shell")
-                .callback(this, &CoreConfiguration::debugLevelChanged);
+            const unsigned int defaultLevelLogFile = 4;
+#endif
+            SetConfigValueGeneric(ConfigFileType::Settings, softDebugLevelLogFile_, "softDebugLevelLogFile", "OutputHandler", defaultLevelLogFile)
+                .description("The maximum level of debug output shown in the log file");
+            OutputHandler::getInstance().setSoftDebugLevel(OutputHandler::logFileOutputListenerName_s, this->softDebugLevelLogFile_);
 
             SetConfigValue(language_, Language::getInstance().defaultLanguage_)
@@ -131 +121 @@
                 .description("If true, all random actions are different each time you start the game")
                 .callback(this, &CoreConfiguration::initializeRandomNumberGenerator);
-        }
-
-        /**
-            @brief Callback function if the debug level has changed.
-        */
-        void debugLevelChanged()
-        {
-            // softDebugLevel_ is the maximum of the 3 variables
-            this->softDebugLevel_ = this->softDebugLevelConsole_;
-            if (this->softDebugLevelLogfile_ > this->softDebugLevel_)
-                this->softDebugLevel_ = this->softDebugLevelLogfile_;
-            if (this->softDebugLevelShell_ > this->softDebugLevel_)
-                this->softDebugLevel_ = this->softDebugLevelShell_;
-
-            OutputHandler::setSoftDebugLevel(OutputHandler::LD_All,     this->softDebugLevel_);
-            OutputHandler::setSoftDebugLevel(OutputHandler::LD_Console, this->softDebugLevelConsole_);
-            OutputHandler::setSoftDebugLevel(OutputHandler::LD_Logfile, this->softDebugLevelLogfile_);
-            OutputHandler::setSoftDebugLevel(OutputHandler::LD_Shell,   this->softDebugLevelShell_);
         }
 
@@ -179 +151 @@
         }
 
-        int softDebugLevel_;                            //!< The debug level
-        int softDebugLevelConsole_;                     //!< The debug level for the console
-        int softDebugLevelLogfile_;                     //!< The debug level for the logfile
-        int softDebugLevelShell_;                       //!< The debug level for the ingame shell
+        int softDebugLevelLogFile_;                     //!< The debug level for the log file (belongs to OutputHandler)
         std::string language_;                          //!< The language
         bool bInitializeRandomNumberGenerator_;         //!< If true, srand(time(0)) is called
@@ -228 +197 @@
 
         // Set the correct log path. Before this call, /tmp (Unix) or %TEMP% (Windows) was used
-        OutputHandler::getOutStream().setLogPath(PathConfig::getLogPathString());
+        OutputHandler::getInstance().setLogPath(PathConfig::getLogPathString());
 
         // Parse additional options file now that we know its path
@@ -328 +297 @@
         bGraphicsLoaded_ = false;
         GameMode::bShowsGraphics_s = false;
-    }
-
-    /**
-        @brief Returns the softDebugLevel for the given device (returns a default-value if the class is right about to be created).
-        @param device The device
-        @return The softDebugLevel
-    */
-    /*static*/ int Core::getSoftDebugLevel(OutputHandler::OutputDevice device)
-    {
-        switch (device)
-        {
-        case OutputHandler::LD_All:
-            return Core::getInstance().configuration_->softDebugLevel_;
-        case OutputHandler::LD_Console:
-            return Core::getInstance().configuration_->softDebugLevelConsole_;
-        case OutputHandler::LD_Logfile:
-            return Core::getInstance().configuration_->softDebugLevelLogfile_;
-        case OutputHandler::LD_Shell:
-            return Core::getInstance().configuration_->softDebugLevelShell_;
-        default:
-            assert(0);
-            return 2;
-        }
-    }
-
-     /**
-        @brief Sets the softDebugLevel for the given device. Please use this only temporary and restore the value afterwards, as it overrides the configured value.
-        @param device The device
-        @param level The level
-    */
-    /*static*/ void Core::setSoftDebugLevel(OutputHandler::OutputDevice device, int level)
-    {
-        if (device == OutputHandler::LD_All)
-            Core::getInstance().configuration_->softDebugLevel_ = level;
-        else if (device == OutputHandler::LD_Console)
-            Core::getInstance().configuration_->softDebugLevelConsole_ = level;
-        else if (device == OutputHandler::LD_Logfile)
-            Core::getInstance().configuration_->softDebugLevelLogfile_ = level;
-        else if (device == OutputHandler::LD_Shell)
-            Core::getInstance().configuration_->softDebugLevelShell_ = level;
-
-        OutputHandler::setSoftDebugLevel(device, level);
     }
 

code/branches/console/src/libraries/core/Core.h

@@ -69 +69 @@
             void setConfigValues();
 
-            static int   getSoftDebugLevel(OutputHandler::OutputDevice device = OutputHandler::LD_All);
-            static void  setSoftDebugLevel(OutputHandler::OutputDevice device, int level);
             static const std::string& getLanguage();
             static void  resetLanguage();

code/branches/console/src/libraries/core/GUIManager.cc

@@ -53 +53 @@
 #include "util/Exception.h"
 #include "util/OrxAssert.h"
-#include "Core.h"
 #include "LuaState.h"
 #include "PathConfig.h"
@@ -75 +74 @@
                 default: OrxAssert(false, "CEGUI log level out of range, inpect immediately!");
             }
-            OutputHandler::getOutStream().setOutputLevel(orxonoxLevel)
+            OutputHandler::getOutStream(orxonoxLevel)
                 << "CEGUI: " << message << std::endl;
 
@@ -121 +120 @@
         // set the log level according to ours (translate by subtracting 1)
         ceguiLogger->setLoggingLevel(
-            static_cast<LoggingLevel>(Core::getSoftDebugLevel(OutputHandler::LD_Logfile) - 1));
+            static_cast<LoggingLevel>(OutputHandler::getInstance().getSoftDebugLevel("logFile") - 1));
         this->ceguiLogger_ = ceguiLogger.release();
 

code/branches/console/src/libraries/core/GraphicsManager.cc

@@ -408 +408 @@
             orxonoxLevel = 0;
         }
-        OutputHandler::getOutStream().setOutputLevel(orxonoxLevel)
+        OutputHandler::getOutStream(orxonoxLevel)
             << "Ogre: " << message << std::endl;
     }

code/branches/console/src/libraries/core/IOConsole.cc

@@ -62 +62 @@
         this->originalTerminalSettings_ = new termios;
         this->setTerminalMode();
-                this->shell_.registerListener(this);
+        this->shell_.registerListener(this);
     }
 
@@ -234 +234 @@
     }
 
+#elif defined(ORXONOX_PLATFORM_WINDOWS)
+
+    IOConsole::IOConsole()
+        : shell_(Shell::getInstance())
+        , buffer_(Shell::getInstance().getInputBuffer())
+    {
+        this->setTerminalMode();
+    }
+
+    IOConsole::~IOConsole()
+    {
+    }
+
+    void IOConsole::setTerminalMode()
+    {
+    }
+
+    void IOConsole::resetTerminalMode()
+    {
+    }
+
+    void IOConsole::update(const Clock& time)
+    {
+    }
+
+    void IOConsole::print(const std::string& text)
+    {
+    }
+
+    void IOConsole::printInputLine()
+    {
+    }
+
 #endif /* ORXONOX_PLATFORM_UNIX */
 
@@ -256 +289 @@
     void IOConsole::onlyLastLineChanged()
     {
-                // Save cursor position and move it the beginning of the second to last line
-                std::cout << "\033[s\033[1F";
-                // Erase the second to last line
-                std::cout << "\033[K";
-                this->print(*(this->shell_.getNewestLineIterator()));
-                // Restore cursor
-                std::cout << "\033[u";
-                std::cout.flush();
+        // Save cursor position and move it the beginning of the second to last line
+        std::cout << "\033[s\033[1F";
+        // Erase the second to last line
+        std::cout << "\033[K";
+        this->print(*(this->shell_.getNewestLineIterator()));
+        // Restore cursor
+        std::cout << "\033[u";
+        std::cout.flush();
     }
 
@@ -272 +305 @@
     void IOConsole::lineAdded()
     {
-                // Move curosr the beginning of the line and erase it
-                std::cout << "\033[1G\033[K";
-                this->print(*(this->shell_.getNewestLineIterator()));
-                std::cout << std::endl;
-                this->printInputLine();
+        // Move curosr the beginning of the line and erase it
+        std::cout << "\033[1G\033[K";
+        this->print(*(this->shell_.getNewestLineIterator()));
+        std::cout << std::endl;
+        this->printInputLine();
     }
 
@@ -303 +336 @@
     void IOConsole::executed()
     {
-                // Move curosr the beginning of the line
-                std::cout << "\033[1G";
-        // Print command so the user knows what he typed
+        // Move cursor the beginning of the line
+        std::cout << "\033[1G";
+        // Print command so the user knows what he has typed
         std::cout << "orxonox>" << this->shell_.getInput() << std::endl;
-                this->printInputLine();
+        this->printInputLine();
     }
 

code/branches/console/src/libraries/core/LuaState.cc

@@ -182 +182 @@
     void LuaState::luaLog(unsigned int level, const std::string& message)
     {
-        OutputHandler::getOutStream().setOutputLevel(level) << message << std::endl;
+        OutputHandler::getOutStream(level) << message << std::endl;
     }
 

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

@@ -51 +51 @@
 
     Shell::Shell()
-    {
-        int level = Core::getSoftDebugLevel(OutputHandler::LD_Shell);
-        Core::setSoftDebugLevel(OutputHandler::LD_Shell, -1);
-
+        : OutputListener("shell")
+    {
         RegisterRootObject(Shell);
 
@@ -69 +67 @@
         this->configureInputBuffer();
 
-        this->outputBuffer_.registerListener(this);
-        OutputHandler::getOutStream().setOutputBuffer(&this->outputBuffer_);
-
         // Get a config file for the command history
         this->commandHistoryConfigFileType_ = ConfigFileManager::getInstance().getNewConfigFileType();
         ConfigFileManager::getInstance().setFilename(this->commandHistoryConfigFileType_, "commandHistory.ini");
 
+        // Use a stringstream object to buffer the output and get it line by line in update()
+        this->outputStream_ = &this->outputBuffer_;
+
         this->setConfigValues();
 
-        Core::setSoftDebugLevel(OutputHandler::LD_Shell, level);
+        // Get the previous output and add it to the Shell
+        for (OutputHandler::OutputVectorIterator it = OutputHandler::getInstance().getOutputVectorBegin();
+            it != OutputHandler::getInstance().getOutputVectorEnd(); ++it)
+            this->addLine(it->second, it->first);
+
+        // Register the shell as output listener
+        OutputHandler::getInstance().registerOutputListener(this);
     }
 
     Shell::~Shell()
     {
-        OutputHandler::getOutStream().setOutputBuffer(0);
-        if (this->inputBuffer_)
-            this->inputBuffer_->destroy();
+        OutputHandler::getInstance().unregisterOutputListener(this);
+        this->inputBuffer_->destroy();
     }
 
     void Shell::setConfigValues()
     {
-        SetConfigValueGeneric(commandHistoryConfigFileType_, maxHistoryLength_, 100)
+        SetConfigValueGeneric(commandHistoryConfigFileType_, maxHistoryLength_, "maxHistoryLength_", "Shell", 100)
             .callback(this, &Shell::commandHistoryLengthChanged);
-        SetConfigValueGeneric(commandHistoryConfigFileType_, historyOffset_, 0)
+        SetConfigValueGeneric(commandHistoryConfigFileType_, historyOffset_, "historyOffset_", "Shell", 0)
             .callback(this, &Shell::commandHistoryOffsetChanged);
         SetConfigValueVectorGeneric(commandHistoryConfigFileType_, commandHistory_, std::vector<std::string>());
+
+#ifdef ORXONOX_RELEASE
+        const unsigned int defaultLevel = 1;
+#else
+        const unsigned int defaultLevel = 3;
+#endif
+        SetConfigValueGeneric(ConfigFileType::Settings, softDebugLevel_, "softDebugLevelShell", "OutputHandler", defaultLevel)
+            .description("The maximal level of debug output shown in the Shell");
+        OutputHandler::getInstance().setSoftDebugLevel("shell", this->softDebugLevel_);
     }
 
@@ -182 +194 @@
     void Shell::addLine(const std::string& line, int level)
     {
-        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);
+        if (level <= this->softDebugLevel_)
+            this->lines_.push_front(line);
+        this->updateListeners<&ShellListener::lineAdded>();
     }
 
@@ -238 +245 @@
         do
         {
-            newline = this->outputBuffer_.getLine(&output);
+            std::getline(this->outputBuffer_, output);
+
+            bool eof = this->outputBuffer_.eof();
+            bool fail = this->outputBuffer_.fail();
+            if (eof)
+                this->outputBuffer_.flush();
+            if (eof || fail)
+                this->outputBuffer_.clear();
+            newline = (!eof && !fail);
 
             if (!newline && output == "")
@@ -246 +261 @@
             {
                 if (this->bAddOutputLevel_)
-                    output.insert(0, 1, static_cast<char>(OutputHandler::getOutStream().getOutputLevel()));
-
-                this->lines_.insert(this->lines_.begin(), output);
+                    output.insert(0, 1, static_cast<char>(OutputHandler::getInstance().getOutputLevel()));
+
+                this->lines_.push_front(output);
 
                 if (this->scrollPosition_)
@@ -365 +380 @@
             return;
         unsigned int cursorPosition = this->getCursorPosition();
-        std::string input_str( this->getInput().substr(0,cursorPosition) ); //only search for the expression from the beginning of the inputline untill the cursor position
-        for (unsigned int newPos = this->historyPosition_+1; newPos<=this->historyOffset_; newPos++)
-        {
-            if (getLowercase(this->commandHistory_[this->historyOffset_ - newPos]).find(getLowercase(input_str)) == 0) //search case insensitive
+        std::string input_str(this->getInput().substr(0, cursorPosition)); // only search for the expression from the beginning of the inputline untill the cursor position
+        for (unsigned int newPos = this->historyPosition_ + 1; newPos <= this->historyOffset_; newPos++)
+        {
+            if (getLowercase(this->commandHistory_[this->historyOffset_ - newPos]).find(getLowercase(input_str)) == 0) // search case insensitive
             {
                 this->historyPosition_ = newPos;
                 this->inputBuffer_->set(this->getFromHistory());
-                this->setCursorPosition( cursorPosition );
+                this->setCursorPosition(cursorPosition);
                 return;
             }
@@ -383 +398 @@
             return;
         unsigned int cursorPosition = this->getCursorPosition();
-        std::string input_str( this->getInput().substr(0,cursorPosition) ); //only search for the expression from the beginn$
-        for (unsigned int newPos = this->historyPosition_-1; newPos>0; newPos--)
-        {
-            if (getLowercase(this->commandHistory_[this->historyOffset_ - newPos]).find(getLowercase(input_str)) == 0) //sear$
+        std::string input_str(this->getInput().substr(0, cursorPosition)); // only search for the expression from the beginn$
+        for (unsigned int newPos = this->historyPosition_ - 1; newPos > 0; newPos--)
+        {
+            if (getLowercase(this->commandHistory_[this->historyOffset_ - newPos]).find(getLowercase(input_str)) == 0) // sear$
             {
                 this->historyPosition_ = newPos;
                 this->inputBuffer_->set(this->getFromHistory());
-                this->setCursorPosition( cursorPosition );
+                this->setCursorPosition(cursorPosition);
                 return;
             }

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

@@ -34 +34 @@
 #include <cassert>
 #include <list>
+#include <sstream>
 #include <string>
 #include <vector>
 
-#include "util/OutputBuffer.h"
+#include "util/OutputHandler.h"
 #include "input/InputBuffer.h"
 #include "OrxonoxClass.h"
@@ -61 +62 @@
     };
 
-    class _CoreExport Shell : public Singleton<Shell>, virtual public OrxonoxClass, public OutputBufferListener
+    class _CoreExport Shell : public Singleton<Shell>, virtual public OrxonoxClass, public OutputListener
     {
         friend class Singleton<Shell>;
@@ -71 +72 @@
             static void history();
 
-            virtual void setConfigValues();
+            void setConfigValues();
             void commandHistoryOffsetChanged();
             void commandHistoryLengthChanged();
@@ -80 +81 @@
             inline InputBuffer* getInputBuffer()
                 { return this->inputBuffer_; }
-            inline OutputBuffer& getOutputBuffer()
-                { return this->outputBuffer_; }
 
             void setCursorPosition(unsigned int cursor);
@@ -117 +116 @@
 
             virtual void outputChanged();
+
             void inputChanged();
             void execute();
@@ -144 +144 @@
             std::list<ShellListener*> listeners_;
             InputBuffer* inputBuffer_;
-            OutputBuffer outputBuffer_;
+            std::stringstream outputBuffer_;
             bool finishedLastLine_;
             std::list<std::string> lines_;
@@ -154 +154 @@
             unsigned int historyOffset_;
             bool bAddOutputLevel_;
+            int softDebugLevel_;
 
             ConfigFileType commandHistoryConfigFileType_;