Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/cleanup/src/lib/shell/shell_input.h

Last change on this file was 9869, checked in by bensch, 18 years ago

orxonox/trunk: merged the new_class_id branche back to the trunk.
merged with command:
svn merge https://svn.orxonox.net/orxonox/branches/new_class_id trunk -r9683:HEAD
no conflicts… puh..

File size: 3.0 KB
Line 
1/*!
2 * @file shell_input.h
3 * @brief Shell Input is an InputLine for the Shell.
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)
7*/
8
9#ifndef _SHELL_INPUT_H
10#define _SHELL_INPUT_H
11
12#include "text.h"
13#include "event_listener.h"
14#include "shell_completion.h"
15
16#include <list>
17
18namespace OrxShell
19{
20  // FORWARD DECLARATION
21  class ShellCompletion;
22
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  {
32    ObjectListDeclaration(ShellInput);
33
34  public:
35    ShellInput();
36    virtual ~ShellInput();
37
38    /** @returns the inputLine */
39    std::string getInput() const { return this->inputLineBegin + this->inputLineEnd; };
40
41    // InputLine
42    void setInputText(const std::string& text);
43    void addCharacter(char character);
44    void addCharacters(const std::string& characters);
45    void removeCharacters(unsigned int characterCount = 1);
46    void flush();
47
48    void setRepeatDelay(float repeatDelay, float repeatRate);
49
50    bool executeCommand();
51
52    /** sets the count of the History's entries */
53    void setHistoryLength(unsigned int historyLength) { this->historyLength = historyLength; };
54    void historyMoveUp();
55    void historyMoveDown();
56
57    void moveCursor(int chars);
58
59    void help(const std::string& className = "", const std::string& function = "");
60
61    virtual void tick(float dt);
62    virtual void process(const Event &event);
63
64  private:
65    // HANDLING TEXT INPUT
66    ShellCompletion                   completion;       //!< The Completion Interface.
67
68    std::string                       inputLineBegin;   //!< The Line up to the cursor.
69    std::string                       inputLineEnd;     //!< The Line from the cursor on
70
71    float                             repeatRate;       //!< The Repeat-Delay.
72    float                             repeatDelay;      //!< The delay of the first Character of a given Character.
73    float                             delayed;          //!< how much of the delay is remaining.
74    Uint16                            pressedKey;       //!< the pressed key that will be repeated.
75    Uint16                            pressedEvent;     //!< The Event, that lead to the pressing of the Key.
76
77    static std::list<std::string>     history;          //!< The history of given commands.
78    std::list<std::string>::iterator  historyIT;        //!< The locator that tells us, where we are in the history.
79    unsigned int                      historyLength;    //!< The maximum length of the InputHistory.
80    bool                              historyScrolling; //!< true if we are scrolling through the history.
81  };
82
83}
84
85#endif /* _SHELL_INPUT_H */
Note: See TracBrowser for help on using the repository browser.