Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/archive/tutorial2/src/libraries/core/command/IOConsoleWindows.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: 3.2 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 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Command ShellConsole
32*/
33
34#ifndef _IOConsole_H__
35#define _IOConsole_H__
36
37#include "core/CorePrereqs.h"
38
39#include <sstream>
40#include <string>
41#include "util/Singleton.h"
42#include "Shell.h"
43
44#define WIN32_LEAN_AND_MEAN
45#ifndef NOMINMAX
46#define NOMINMAX
47#endif
48#include <windows.h>
49
50namespace orxonox
51{
52    class _CoreExport IOConsole : public Singleton<IOConsole>, public ShellListener
53    {
54        friend class Singleton<IOConsole>;
55
56    public:
57        IOConsole();
58        ~IOConsole();
59
60        void preUpdate(const Clock& time);
61
62    private:
63        void setTerminalMode();
64        void getTerminalSize();
65        void printStatusLines();
66        static int extractLogLevel(std::string* text);
67
68        // Methods from ShellListener
69        void linesChanged();
70        void lineAdded();
71        void inputChanged();
72        void cursorChanged();
73        void executed();
74        void exit();
75
76        void resetTerminalMode();
77        void moveCursor(int dx, int dy);
78        void writeText(const std::string& text, const COORD& pos, WORD attributes = FOREGROUND_BLUE | FOREGROUND_GREEN | FOREGROUND_RED);
79        void createNewOutputLines(int lines);
80        void printOutputLine(const std::string& line, Shell::LineType type, const COORD& pos);
81
82        static inline COORD makeCOORD(int x, int y)
83        {
84            COORD val = {x, y};
85            return val;
86        }
87
88        Shell*                  shell_;
89        InputBuffer*            buffer_;
90        std::ostream            cout_;
91        std::ostringstream      origCout_;
92        int                     terminalWidth_;
93        int                     terminalHeight_;
94        int                     lastTerminalWidth_;
95        int                     lastTerminalHeight_;
96        const std::string       promptString_;
97
98        DWORD                   originalTerminalSettings_;
99        HANDLE                  stdInHandle_;
100        HANDLE                  stdOutHandle_;
101        int                     inputLineRow_;
102        int                     inputLineHeight_;
103        const int               statusLines_;
104        int                     lastOutputLineHeight_;
105        uint64_t                lastRefreshTime_;
106
107        static IOConsole* singletonPtr_s;
108    };
109}
110
111#endif /* _IOConsole_H__ */
Note: See TracBrowser for help on using the repository browser.