Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/leveljoemeHS14/src/libraries/core/command/ConsoleCommandCompilation.h @ 10241

Last change on this file since 10241 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.1 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/**
30    @file
31    @ingroup Command ConsoleCommand
32    @brief Declaration of some console commands.
33*/
34
35#ifndef _ConsoleCommandCompilation_H__
36#define _ConsoleCommandCompilation_H__
37
38#include "core/CorePrereqs.h"
39
40namespace orxonox
41{
42    _CoreExport void source(const std::string& filename);
43    _CoreExport std::string echo(const std::string& text);
44
45    _CoreExport void orxout_level(const std::string& level_name, const std::string& text);
46    _CoreExport void orxout_level_context(const std::string& level_name, const std::string& context_name, const std::string& text);
47
48    _CoreExport void log(const std::string& text);
49    _CoreExport void error(const std::string& text);
50    _CoreExport void warning(const std::string& text);
51    _CoreExport void status(const std::string& text);
52    _CoreExport void info(const std::string& text);
53    _CoreExport void debug(const std::string& text);
54
55    _CoreExport void write(const std::string& filename, const std::string& text);
56    _CoreExport void append(const std::string& filename, const std::string& text);
57    _CoreExport std::string read(const std::string& filename);
58
59    _CoreExport float calculate(const std::string& calculation);
60}
61
62#endif /* _ConsoleCommandCompilation_H__ */
Note: See TracBrowser for help on using the repository browser.