Angel 3.2
A 2D Game Prototyping Engine
Console.h
1 
2 // Copyright (C) 2008-2013, Shane Liesegang
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 // notice, this list of conditions and the following disclaimer in the
12 // documentation and/or other materials provided with the distribution.
13 // * Neither the name of the copyright holder nor the names of any
14 // contributors may be used to endorse or promote products derived from
15 // this software without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21 // LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 // SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 // POSSIBILITY OF SUCH DAMAGE.
29 
30 #pragma once
31 
32 #include "../Util/StringUtil.h"
33 #include "../Infrastructure/Vector2.h"
34 
35 
37 
55 class Console
56 {
57 public:
62  Console();
63 
67  virtual ~Console();
68 
73  void Render();
74 
81  void Update( float /*dt*/ );
82 
89  void Enable( bool bEnable = true );
90 
96  bool IsEnabled() {return _enabled;}
97 
106  bool GetInput(int key);
107 
116  bool GetSpecialInputDown( int key );
117 
121  void ToggleConsole();
122 
129  unsigned char GetToggleConsoleKey() {return '`';}
130 
137  void WriteToOutput(String output);
138 
146  void SetPrompt(const String& prompt);
147 
151  const unsigned int GetTabWidth();
152 
158  void SetTabWidth(unsigned int newTabWidth);
159 
166  void AdvanceInputHistory( int byVal );
167 
171  void AcceptAutocomplete();
172 
180  virtual void Execute(String input) = 0;
181 
191  virtual StringList GetCompletions(const String& input) = 0;
192 
193 protected:
194  bool IsTextKey(unsigned char key);
195  void AcceptCurrentInput();
196  String _currentInput;
197  StringList _inputHistory;
198  int _inputHistoryPos;
199  String _prompt;
200  StringList _buffer;
201  String _unsplitBuffer;
202  float _lineHeight;
203  StringList _autoCompleteList;
204  int _cursorPos;
205  unsigned int _tabWidth;
206 
207 private:
208  void RefreshAutoCompletes();
209  float _cursorDispTime;
210  bool _bCursorDisp;
211 
212  bool _enabled;
213 };
214 
216 
220 class TestConsole : public Console
221 {
222 public:
227  {
228  SetPrompt("::>");
229  }
230 
236  virtual void Execute(String input) { WriteToOutput("Test Console Echo: " + input); }
237 
244  virtual StringList GetCompletions(const String& input) { return StringList(); }
245 };