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

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)

Location:

orxonox/trunk/src/util

Files:

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

orxonox/trunk/src/util/shell.cc

@@ -10 +10 @@
 
    ### File Specific:
-   main-programmer: ...
+   main-programmer: Benjamin Grauer
    co-programmer: ...
 */
@@ -16 +16 @@
 //#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_
 
-#include "proto_class.h"
+#include "shell.h"
 
 using namespace std;
@@ -23 +23 @@
 /**
  * standard constructor
- * @todo this constructor is not jet implemented - do it
-*/
-ProtoClass::ProtoClass ()
+ */
+Shell::Shell ()
 {
-   this->setClassID(CL_PROTO_ID, "ProtoClass");
+   this->setClassID(CL_SHELL, "Shell");
+}
 
-   /* If you make a new class, what is most probably the case when you write this file
-      don't forget to:
-       1. Add the new file new_class.cc to the ./src/Makefile.am
-       2. Add the class identifier to ./src/class_id.h eg. CL_NEW_CLASS
 
-      Advanced Topics:
-      - if you want to let your object be managed via the ObjectManager make sure to read
-        the object_manager.h header comments. You will use this most certanly only if you
-        make many objects of your class, like a weapon bullet.
-   */
+Shell* Shell::singletonRef = NULL;
+
+/**
+ * standard deconstructor
+ */
+Shell::~Shell ()
+{
+  // delete what has to be deleted here
+
+  Shell::singletonRef = NULL;
+}
+
+
+
+
+void setBufferDisplaySize(unsigned int bufferDisplaySize);
+
+/**
+ * deletes all the Buffers
+ */
+void Shell::flushBuffers()
+{
+
+}
+
+/**
+ * adds a new Line to the List of Buffers
+ * @param line the Line as in the first argument in printf
+ * @param args the arguments as a va_list
+ */
+void Shell::addBufferLine(const char* line, va_list args)
+{
+}
+
+/**
+ * moves the buffer around lineCount lines upwards (negative values move down)
+ * @param lineCount the Count of lines to move upwards
+ */
+void Shell::moveBuffer(int lineCount)
+{
+}
+
+/**
+ * @param lineNumber the n-th line from the bottom
+ * @returns the Buffer at Line lineNumber
+ */
+const char* Shell::getBufferLine(unsigned int lineNumber)
+{
 }
 
 
 /**
- * standard deconstructor
-*/
-ProtoClass::~ProtoClass ()
+ * deletes the InputLine
+ */
+void Shell::flushInputLine()
 {
-  // delete what has to be deleted here
 }
+
+/**
+ * adds one character to the inputLine
+ * @param character the character to add to the inputLine
+ */
+void Shell::addCharacter(char character)
+{
+}
+
+/**
+ * adds multiple Characters to thr inputLine
+ * @param characters a '\0' terminated char-array to add to the InputLine
+ */
+void Shell::addCharacters(const char* characters)
+{
+}
+
+/**
+ * removes characterCount characters from the InputLine
+ * @param characterCount the count of Characters to remove from the input Line
+ */
+void Shell::removeCharacters(unsigned int characterCount)
+{
+}
+
+
+/**
+ * ticks the Shell for dt Seconds
+ * @param dt the elapsed time since the last tick();
+ */
+void Shell::tick(float dt)
+{
+}
+
+/**
+ * displays the Shell
+ */
+void Shell::draw() const
+{
+}
+
+
+/**
+ * autocompletes the Shell's inputLine
+ * @returns true, if a result was found, false otherwise
+ */
+bool Shell::autoComplete()
+{
+
+}
+
+/**
+ * displays some nice output from the Shell
+ */
+void Shell::debug() const
+{
+
+}

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 */