Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/tutorial2/src/libraries/core/command/IOConsolePOSIX.h

Last change on this file was 8858, checked in by landauf, 13 years ago

merged output branch back to trunk.

Changes:

  • you have to include util/Output.h instead of util/Debug.h
  • COUT(x) is now called orxout(level)
  • output levels are now defined by an enum instead of numbers. see util/Output.h for the definition
  • it's possible to use output contexts with orxout(level, context). see util/Output.h for some common contexts. you can define more contexts
  • you must use 'endl' at the end of an output message, '\n' does not flush the message

Output levels:

  • instead of COUT(0) use orxout()
  • instead of COUT(1) use orxout(user_error) or orxout(internal_error)
  • instead of COUT(2) use orxout(user_warning) or orxout(internal_warning)
  • instead of COUT(3) use orxout(user_status/user_info) or orxout(internal_status/internal_info)
  • instead of COUT(4) use orxout(verbose)
  • instead of COUT(5) use orxout(verbose_more)
  • instead of COUT(6) use orxout(verbose_ultra)

Guidelines:

  • user_* levels are for the user, visible in the console and the log-file
  • internal_* levels are for developers, visible in the log-file
  • verbose_* levels are for debugging, only visible if the context of the output is activated

Usage in C++:

  • orxout() << "message" << endl;
  • orxout(level) << "message" << endl;
  • orxout(level, context) << "message" << endl;

Usage in Lua:

  • orxout("message")
  • orxout(orxonox.level.levelname, "message")
  • orxout(orxonox.level.levelname, "context", "message")

Usage in Tcl (and in the in-game-console):

  • orxout levelname message
  • orxout_context levelname context message
  • shortcuts: log message, error message, warning message, status message, info message, debug message
  • Property svn:eol-style set to native
File size: 2.8 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 *      Oliver Scheuss
24 *      Reto Grieder
25 *   Co-authors:
26 *      ...
27 *
28 */
29
30/**
31    @file
32    @ingroup Command ShellConsole
33*/
34
35#ifndef _IOConsole_H__
36#define _IOConsole_H__
37
38#include "core/CorePrereqs.h"
39
40#include <sstream>
41#include <string>
42#include <vector>
43#include "util/Singleton.h"
44#include "Shell.h"
45
46struct termios;
47
48namespace orxonox
49{
50    class _CoreExport IOConsole : public Singleton<IOConsole>, public ShellListener
51    {
52        friend class Singleton<IOConsole>;
53
54    public:
55        IOConsole();
56        ~IOConsole();
57
58        void preUpdate(const Clock& time);
59
60    private:
61        void setTerminalMode();
62        void getTerminalSize();
63        void printStatusLines();
64        static int extractLogLevel(std::string* text);
65
66        // Methods from ShellListener
67        void linesChanged();
68        void lineAdded();
69        void inputChanged();
70        void cursorChanged();
71        void executed();
72        void exit();
73
74        bool willPrintStatusLines();
75        void printInputLine();
76        void printOutputLine(const std::string& line, Shell::LineType type);
77        static void resetTerminalMode();
78
79        Shell*                  shell_;
80        InputBuffer*            buffer_;
81        std::ostream            cout_;
82        std::ostringstream      origCout_;
83        int                     terminalWidth_;
84        int                     terminalHeight_;
85        int                     lastTerminalWidth_;
86        int                     lastTerminalHeight_;
87        const std::string       promptString_;
88
89        bool                    bPrintStatusLine_;
90        bool                    bStatusPrinted_;
91        std::vector<int>        statusLineWidths_;
92        int                     statusLineMaxWidth_;
93        static const int        minOutputLines_ = 3;
94        termios*                originalTerminalSettings_;
95
96        static IOConsole* singletonPtr_s;
97    };
98}
99
100#endif /* _IOConsole_H__ */
Note: See TracBrowser for help on using the repository browser.