Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/core/Shell.h @ 3328

Last change on this file since 3328 was 3280, checked in by rgrieder, 15 years ago

Merged most of the core4 revisions back to the trunk except for:

  • orxonox_cast
  • all the radical changes in the input library
  • Property svn:eol-style set to native
File size: 4.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _Shell_H__
30#define _Shell_H__
31
32#include "CorePrereqs.h"
33
34#include <cassert>
35#include <list>
36#include <string>
37#include <vector>
38
39#include "util/OutputBuffer.h"
40#include "input/InputBuffer.h"
41#include "OrxonoxClass.h"
42#include "ConfigFileManager.h"
43
44namespace orxonox
45{
46    class _CoreExport ShellListener
47    {
48        friend class Shell;
49
50        public:
51            virtual ~ShellListener() {}
52
53        private:
54            virtual void linesChanged() {}
55            virtual void onlyLastLineChanged() {}
56            virtual void lineAdded() {}
57            virtual void inputChanged() {}
58            virtual void cursorChanged() {}
59            virtual void exit() {}
60    };
61
62    class _CoreExport Shell : virtual public OrxonoxClass, public OutputBufferListener
63    {
64        public:
65            Shell();
66            virtual ~Shell();
67
68            static Shell& getInstance() { assert(singletonRef_s); return *singletonRef_s; }
69
70            static void clearShell();
71            static void history();
72
73            virtual void setConfigValues();
74            void commandHistoryOffsetChanged();
75            void commandHistoryLengthChanged();
76
77            void registerListener(ShellListener* listener);
78            void unregisterListener(ShellListener* listener);
79
80            inline InputBuffer* getInputBuffer()
81                { return this->inputBuffer_; }
82            inline OutputBuffer& getOutputBuffer()
83                { return this->outputBuffer_; }
84
85            void setCursorPosition(unsigned int cursor);
86            inline unsigned int getCursorPosition() const
87                { return this->inputBuffer_->getCursorPosition(); }
88
89            void setInput(const std::string& input);
90
91            inline void clearInput()
92                { this->setInput(""); }
93            inline std::string getInput() const
94                { return this->inputBuffer_->get(); }
95
96            std::list<std::string>::const_iterator getNewestLineIterator() const;
97            std::list<std::string>::const_iterator getEndIterator() const;
98
99            void addLine(const std::string& line, int level = 0);
100            void clearLines();
101
102            inline unsigned int getNumLines() const
103                { return this->lines_.size(); }
104            inline unsigned int getScrollPosition() const
105                { return this->scrollPosition_; }
106
107            inline void addOutputLevel(bool bAddOutputLevel)
108                { this->bAddOutputLevel_ = bAddOutputLevel; }
109
110        private:
111            Shell(const Shell& other);
112
113            void configureInputBuffer();
114
115            void addToHistory(const std::string& command);
116            std::string getFromHistory() const;
117
118            virtual void outputChanged();
119            void inputChanged();
120            void execute();
121            void hintandcomplete();
122            void backspace();
123            void deletechar();
124            void clear();
125            void cursor_right();
126            void cursor_left();
127            void cursor_end();
128            void cursor_home();
129            void history_up();
130            void history_down();
131            void scroll_up();
132            void scroll_down();
133            void exit();
134
135            std::list<ShellListener*> listeners_;
136            InputBuffer* inputBuffer_;
137            OutputBuffer outputBuffer_;
138            bool finishedLastLine_;
139            std::list<std::string> lines_;
140            std::list<std::string>::const_iterator scrollIterator_;
141            unsigned int scrollPosition_;
142            std::vector<std::string> commandHistory_;
143            unsigned int maxHistoryLength_;
144            unsigned int historyPosition_;
145            unsigned int historyOffset_;
146            bool bAddOutputLevel_;
147
148            ConfigFileType commandHistoryConfigFileType_;
149
150            static Shell* singletonRef_s;
151    };
152}
153
154#endif /* _Shell_H__ */
Note: See TracBrowser for help on using the repository browser.