Mercurial > fife-parpg

comparison engine/core/gui/console.h @ 697:ecaa4d98f05f tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Abstracted the GUI code and refactored the GUIChan-specific code into its own module. * Most of the GUIChan code has been refactored into its own gui/guichan module. However, references to the GuiFont class still persist in the Engine and GuiManager code and these will need further refactoring. * GuiManager is now an abstract base class which specific implementations (e.g. GUIChan) should subclass. * The GUIChan GUI code is now a concrete implementation of GuiManager, most of which is in the new GuiChanGuiManager class. * The GUI code in the Console class has been refactored out of the Console and into the GUIChan module as its own GuiChanConsoleWidget class. The rest of the Console class related to executing commands was left largely unchanged. * Existing client code may need to downcast the GuiManager pointer received from FIFE::Engine::getGuiManager() to GuiChanGuiManager, since not all functionality is represented in the GuiManager abstract base class. Python client code can use the new GuiChanGuiManager.castTo static method for this purpose.
author M. George Hansen <technopolitica@gmail.com>
date Sat, 18 Jun 2011 00:28:40 -1000
parents engine/core/gui/console/console.h@bb9902910067
children
comparison
equal deleted inserted replaced
696:e201abd8c807 697:ecaa4d98f05f
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or *
7 * modify it under the terms of the GNU Lesser General Public *
8 * License as published by the Free Software Foundation; either *
9 * version 2.1 of the License, or (at your option) any later version. *
10 * *
11 * This library is distributed in the hope that it will be useful, *
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14 * Lesser General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU Lesser General Public *
17 * License along with this library; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_GUI_CONSOLE_H
23 #define FIFE_GUI_CONSOLE_H
24
25 // Standard C++ library includes
26 #include <string>
27
28 // 3rd party library includes
29
30 // FIFE includes
31 // These includes are split up in two parts, separated by one empty line
32 // First block: files included from the FIFE root src directory
33 // Second block: files included from the same folder
34
35 namespace FIFE {
36 /**
37 * Console executer is listener interface for console activity
38 */
39 class ConsoleExecuter {
40 public:
41 /** Destructor
42 */
43 virtual ~ConsoleExecuter() {}
44
45 /** Called when console tools button is clicked
46 */
47 virtual void onToolsClick() = 0;
48
49 /** Called when user has typed command to console and pressed enter
50 * @return response from executer
51 */
52 virtual std::string onConsoleCommand(const std::string& command) = 0;
53 };
54
55 /** Ingame Console
56 */
57 class Console {
58 public:
59 /** Constructor
60 */
61 Console();
62
63 /** Destructor
64 */
65 virtual ~Console();
66
67 /** Execute a command
68 * Normally just sends the command to runString()
69 * Checks whether the cmd is just one token
70 * and print it's value rather than throw an
71 * useless error.
72 *
73 * @param cmd String representing the command to execute.
74 *
75 * @return Output from the command.
76 *
77 * @todo generalize the generated command and the regexp used.
78 */
79 std::string execute(std::string cmd);
80
81 /** Get the executer for the console.
82 */
83 ConsoleExecuter* getConsoleExecuter() const {
84 return m_consoleexec;
85 }
86
87 /** Sets executer for the console
88 */
89 void setConsoleExecuter(ConsoleExecuter* const consoleexec);
90
91 /** Removes executer for the console
92 */
93 void removeConsoleExecuter();
94
95 private:
96 ConsoleExecuter* m_consoleexec;
97 };
98 }
99 #endif
100 /* vim: set noexpandtab: set shiftwidth=2: set tabstop=2: */