[4838] | 1 | /*! |
---|
[5178] | 2 | * @file shell_input.h |
---|
[5245] | 3 | * @brief Shell Input is an InputLine for the Shell. |
---|
[5254] | 4 | * |
---|
| 5 | * @todo move around in the InputText with the cursor (SDLK_LEFT/SDLK_RIGHT) |
---|
| 6 | * @todo blinking curson (can blink with the speed of the RepeatDelay) |
---|
[3245] | 7 | */ |
---|
[1853] | 8 | |
---|
[5178] | 9 | #ifndef _SHELL_INPUT_H |
---|
| 10 | #define _SHELL_INPUT_H |
---|
[1853] | 11 | |
---|
[5344] | 12 | #include "text.h" |
---|
[5180] | 13 | #include "event_listener.h" |
---|
[7343] | 14 | #include "shell_completion.h" |
---|
| 15 | |
---|
[5784] | 16 | #include <list> |
---|
[5179] | 17 | |
---|
[7374] | 18 | namespace OrxShell |
---|
| 19 | { |
---|
| 20 | // FORWARD DECLARATION |
---|
| 21 | class ShellCompletion; |
---|
[3543] | 22 | |
---|
[7374] | 23 | //! An InputLine for the Shell |
---|
| 24 | /** |
---|
| 25 | * The ShellInput has the ability to catch and display user input. |
---|
| 26 | * The ShellInput is auto-completed after the user presses [TAB] |
---|
| 27 | * The ShellInput is executed (and sent back to the Application) on Pressing [ENTER] |
---|
| 28 | * [UP] and [DOWN] move through the history of allready given commands. |
---|
| 29 | */ |
---|
| 30 | class ShellInput : public Text, public EventListener |
---|
| 31 | { |
---|
[1853] | 32 | |
---|
[7374] | 33 | public: |
---|
| 34 | ShellInput(); |
---|
| 35 | virtual ~ShellInput(); |
---|
[1853] | 36 | |
---|
[7374] | 37 | /** @returns the inputLine */ |
---|
| 38 | const std::string& getInput() const { return this->inputLine; }; |
---|
[3245] | 39 | |
---|
[7374] | 40 | // InputLine |
---|
| 41 | void setInputText(const std::string& text); |
---|
| 42 | void addCharacter(char character); |
---|
| 43 | void addCharacters(const std::string& characters); |
---|
| 44 | void removeCharacters(unsigned int characterCount = 1); |
---|
[7403] | 45 | void flush(); |
---|
| 46 | |
---|
[7374] | 47 | void setRepeatDelay(float repeatDelay, float repeatRate); |
---|
[7393] | 48 | |
---|
[7374] | 49 | bool executeCommand(); |
---|
[5243] | 50 | |
---|
[7374] | 51 | /** sets the count of the History's entries */ |
---|
| 52 | void setHistoryLength(unsigned int historyLength) { this->historyLength = historyLength; }; |
---|
| 53 | void historyMoveUp(); |
---|
| 54 | void historyMoveDown(); |
---|
[5243] | 55 | |
---|
[7374] | 56 | void help(const std::string& className = "", const std::string& function = ""); |
---|
[5178] | 57 | |
---|
[7374] | 58 | virtual void tick(float dt); |
---|
| 59 | virtual void process(const Event &event); |
---|
[5180] | 60 | |
---|
[7374] | 61 | private: |
---|
[5178] | 62 | // HANDLING TEXT INPUT |
---|
[7374] | 63 | ShellCompletion completion; //!< The Completion Interface. |
---|
[5181] | 64 | |
---|
[7374] | 65 | std::string inputLine; //!< the Char-Array of the Buffer |
---|
| 66 | float repeatRate; //!< The Repeat-Delay. |
---|
| 67 | float repeatDelay; //!< The delay of the first Character of a given Character. |
---|
| 68 | float delayed; //!< how much of the delay is remaining. |
---|
| 69 | Uint16 pressedKey; //!< the pressed key that will be repeated. |
---|
[3245] | 70 | |
---|
[7374] | 71 | std::list<std::string> history; //!< The history of given commands. |
---|
| 72 | std::list<std::string>::iterator historyIT; //!< The locator that tells us, where we are in the history. |
---|
| 73 | unsigned int historyLength; //!< The maximum length of the InputHistory. |
---|
| 74 | bool historyScrolling; //!< true if we are scrolling through the history. |
---|
| 75 | }; |
---|
[1853] | 76 | |
---|
[7374] | 77 | } |
---|
| 78 | |
---|
[5178] | 79 | #endif /* _SHELL_INPUT_H */ |
---|