Changeset 5068 in orxonox.OLD for orxonox/trunk/src/util/shell.h

Timestamp:

Aug 18, 2005, 3:51:43 PM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: added Shell Class to the utils.
This class should enable us to print all the output from orxonox directly onto the screen.
Also it should allow inputting some little Commands, so that we have more force over our little project

Also added a new Function to tList, removeLast, that is very quick in deleting the last element, as this is used inside of the Shell (deleting the Last Element is a major issue)

File:

• orxonox/trunk/src/util/shell.h (copied) (copied from orxonox/trunk/src/proto/proto_class.h) (1 diff)

orxonox/trunk/src/util/shell.h

@@ -1 +1 @@
 /*!
- * @file proto_class.h
- * @brief Definition of ...
+ * @file shell.h
+ * Definition of a on-screen-shell
 */
 
-#ifndef _PROTO_CLASS_H
-#define _PROTO_CLASS_H
+#ifndef _SHELL_H
+#define _SHELL_H
 
-#include "base_object.h"
+#include "element_2d.h"
+
+#include <stdio.h>
+#include <stdarg.h>
+
 
 // FORWARD DECLARATION
+class Text;
+template<class T> class tList;
+
+//! A class that is able to redirect all output to a openGL-Shell, and that one can use to input some commands
+/**
+ * the major idea is, that all the Output can be redirected to the Shell,
+ * and does not have to be displayed to the opening Shell, this is good,
+ * for developers using Windows, where all output is otherwise redirected
+ * to stdout.txt
+ *
+ * Furthermore the Shell should enable us, to input some simple commands
+ * Each Class can tell check itself in to the Shell, and listen for commands.
+ *
+ * @todo implement what is written above :/
+ */
+class Shell : public Element2D {
+
+  public:
+    virtual ~Shell();
+    /** @returns a Pointer to the only object of this Class */
+    inline static Shell* getInstance(void) { if (!Shell::singletonRef) Shell::singletonRef = new Shell();  return Shell::singletonRef; };
 
 
+    void setBufferSize(unsigned int bufferSize) { this->bufferSize = bufferSize; };
 
-//! A class for ...
-class ProtoClass : public BaseObject {
+    void setBufferDisplaySize(unsigned int bufferDisplaySize);
 
- public:
-  ProtoClass();
-  virtual ~ProtoClass();
+    // BUFFER //
+    void flushBuffers();
+    void addBufferLine(const char* Line, va_list args);
+    void moveBuffer(int lineCount);
+    const char* getBufferLine(unsigned int lineNumber);
+
+  // inputLine
+    void flushInputLine();
+    void addCharacter(char character);
+    void addCharacters(const char* characters);
+    void removeCharacters(unsigned int characterCount = 1);
 
 
- private:
+    // Element2D-functions
+    void tick(float dt);
+    virtual void draw() const;
 
+    void debug() const;
+
+  private:
+    bool autoComplete();
+
+
+  private:
+    Shell();
+    static Shell*          singletonRef;
+
+    unsigned int           bufferSize;
+    unsigned int           bufferDisplaySize;
+
+    char*                  inputLine;
+
+    tList<const char>*     buffer;
+
+    tList<Text>*           bufferText;             //!< A list of sored bufferLines of the Shell
+    Text*                  inputLineText;          //!< The inputLine of the Shell
 };
 
-#endif /* _PROTO_CLASS_H */
+#endif /* _SHELL_H */