1 | /*! |
---|
2 | * @file shell.h |
---|
3 | * Definition of a on-screen-shell |
---|
4 | */ |
---|
5 | |
---|
6 | #ifndef _SHELL_H |
---|
7 | #define _SHELL_H |
---|
8 | |
---|
9 | #include "element_2d.h" |
---|
10 | #include "event_listener.h" |
---|
11 | //#include "shell_buffer.h" |
---|
12 | |
---|
13 | #include <stdarg.h> |
---|
14 | |
---|
15 | #define SHELL_BUFFER_SIZE 16384 |
---|
16 | |
---|
17 | // FORWARD DECLARATION |
---|
18 | class Text; |
---|
19 | class ShellCommandBase; |
---|
20 | template<class T> class tList; |
---|
21 | template<class T> class tIterator; |
---|
22 | |
---|
23 | //! A class that is able to redirect all output to a openGL-Shell, and that one can use to input some commands |
---|
24 | /** |
---|
25 | * the major idea is, that all the Output can be redirected to the Shell, |
---|
26 | * and does not have to be displayed to the opening Shell, this is good, |
---|
27 | * for developers using Windows, where all output is otherwise redirected |
---|
28 | * to stdout.txt |
---|
29 | * |
---|
30 | * Furthermore the Shell should enable us, to input some simple commands |
---|
31 | * Each Class can tell check itself in to the Shell, and listen for commands. |
---|
32 | * |
---|
33 | * @todo implement what is written above :/ |
---|
34 | */ |
---|
35 | class Shell : public Element2D, public EventListener { |
---|
36 | |
---|
37 | public: |
---|
38 | virtual ~Shell(); |
---|
39 | /** @returns a Pointer to the only object of this Class */ |
---|
40 | inline static Shell* getInstance() { if (!Shell::singletonRef) Shell::singletonRef = new Shell(); return Shell::singletonRef; }; |
---|
41 | /** @returns true if this class is instanciated, false otherwise */ |
---|
42 | inline static bool isInstanciated() { return (Shell::singletonRef == NULL)?true:false; }; |
---|
43 | |
---|
44 | void activate(); |
---|
45 | void deactivate(); |
---|
46 | |
---|
47 | void setTextSize(unsigned int textSize, unsigned int lineSpacing = 1); |
---|
48 | void rebuildText(); |
---|
49 | |
---|
50 | // BUFFERS |
---|
51 | void setBufferDisplaySize(unsigned int bufferDisplaySize); |
---|
52 | void flush(); |
---|
53 | void printToDisplayBuffer(const char* text); |
---|
54 | |
---|
55 | // InputLine |
---|
56 | void flushInputLine(); |
---|
57 | void addCharacter(char character); |
---|
58 | void addCharacters(const char* characters); |
---|
59 | void removeCharacters(unsigned int characterCount = 1); |
---|
60 | bool executeCommand(); |
---|
61 | |
---|
62 | void clear(); |
---|
63 | |
---|
64 | void setRepeatDelay(float repeatDelay, float repeatRate); |
---|
65 | |
---|
66 | // EventListener |
---|
67 | virtual void process(const Event &event); |
---|
68 | |
---|
69 | // Element2D-functions |
---|
70 | void tick(float dt); |
---|
71 | virtual void draw() const; |
---|
72 | |
---|
73 | void help() const; |
---|
74 | void debug() const; |
---|
75 | |
---|
76 | private: |
---|
77 | bool autoComplete(); |
---|
78 | bool classComplete(const char* classBegin); |
---|
79 | bool objectComplete(const char* objectBegin, long classID); |
---|
80 | bool functionComplete(const char* functionBegin); |
---|
81 | |
---|
82 | bool generalComplete(const tList<const char>* stringList, const char* begin, const char* displayAs = "%s", const char* addBack = NULL, const char* addFront = NULL); |
---|
83 | |
---|
84 | const tList<const char>* createCompleteList(const tList<const char>* inputList, const char* classNameBegin); |
---|
85 | const tList<const char>* createCompleteList(const tList<BaseObject>* inputList, const char* classNameBegin); |
---|
86 | // const tList<const char>* createCompleteList(const tList<ShellCommandBase>* inputList, const char* classNameBegin); |
---|
87 | |
---|
88 | // helpers // |
---|
89 | Vector calculateLinePosition(unsigned int lineNumber); |
---|
90 | // void testI (int i); |
---|
91 | // void testS (const char* s); |
---|
92 | // void testB (bool b); |
---|
93 | // void testF (float f); |
---|
94 | // void testSF (const char* s, float f); |
---|
95 | |
---|
96 | private: |
---|
97 | Shell(); |
---|
98 | static Shell* singletonRef; //!< The singleton-reference to the only memeber of this class. |
---|
99 | |
---|
100 | unsigned int bufferDisplaySize; //!< The Size of the Display-buffer, in lines (not in characters) |
---|
101 | |
---|
102 | // HANDLING TEXT INPUT |
---|
103 | Text* inputLineText; //!< The inputLine of the Shell |
---|
104 | char* inputLine; //!< the Char-Array of the Buffer |
---|
105 | float repeatRate; //!< The Repeat-Delay. |
---|
106 | float repeatDelay; //!< The delay of the first Character of a given Character. |
---|
107 | float delayed; //!< how much of the delay is remaining. |
---|
108 | int pressedKey; //!< the pressed key that will be repeated. |
---|
109 | |
---|
110 | tList<char>* inputHistory; //!< The history of given commands. |
---|
111 | |
---|
112 | Text** bufferText; //!< A list of stored bufferTexts for the display of the buffer |
---|
113 | unsigned int textSize; //!< The size of the text. |
---|
114 | unsigned int lineSpacing; //!< The Spacing between lines. |
---|
115 | unsigned int shellHeight; //!< The hight of the Shell in Pixels |
---|
116 | bool bActive; //!< if the shell is active; |
---|
117 | |
---|
118 | // completion |
---|
119 | tList<const char>* completionList; //!< A list of completions, that are io. |
---|
120 | }; |
---|
121 | |
---|
122 | #endif /* _SHELL_H */ |
---|