Changeset 7744 in orxonox.OLD for trunk/src/lib/shell/shell_buffer.h

Timestamp:

May 20, 2006, 6:09:17 PM (18 years ago)

Author:

bensch

Message:

trunk: the Buffer is moving pretty smoothly

File:

• trunk/src/lib/shell/shell_buffer.h (modified) (4 diffs)

trunk/src/lib/shell/shell_buffer.h

@@ -18 +18 @@
 
   //! A class handling output from orxonox via debug.h
+  /**
+   * the ShellBuffer redirects output from PRINTF(x) to the Shell and STDOUT
+   * the ShellBuffer is a front-filling queue of limited length, that has the
+   * youngest added Entry at the beginning, and the oldest at the end.
+   */
   class ShellBuffer
   {
@@ -26 +31 @@
     inline static ShellBuffer* getInstance() { if (!ShellBuffer::singletonRef) ShellBuffer::singletonRef = new ShellBuffer();  return ShellBuffer::singletonRef; };
     /** @returns true if this class is instanciated, false otherwise */
-inline static bool isInstanciated() { return (ShellBuffer::singletonRef == NULL)?false:true; };
+    inline static bool isInstanciated() { return (ShellBuffer::singletonRef == NULL)?false:true; };
 
     void registerShell(Shell* shell);
     void unregisterShell(Shell* shell);
+
+    static bool addBufferLineStatic(const char* line, ...);
+    void addBufferLine(const char* line, va_list arg);
 
     // BUFFER //
@@ -35 +43 @@
     void setBufferSize(unsigned int bufferSize) { this->bufferSize = bufferSize; };
     void flush();
-    static bool addBufferLineStatic(const char* line, ...);
-    void addBufferLine(const char* line, va_list arg);
+
     /** @returns the List of stings from the Buffer */
     const std::list<std::string>& getBuffer() const { return this->buffer; };
     /** @returns the Count of lines processed by the Shell. */
-    inline long getLineCount() const { return this->lineCount; };
+    inline unsigned long getLineCount() const { return this->lineCount; };
 
     void debug() const;
@@ -58 +65 @@
     unsigned long                 lineCount;                          //!< how many Lines have been written out so far.
 
+    // The Beginning of buffer (buffer.front()) is the last added line.
     static std::list<std::string> buffer;                             //!< A list of stored char-arrays(strings) to store the history
   };