Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/presentation2012/src/libraries/util/output/ConsoleWriter.cc @ 9189

Last change on this file since 9189 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
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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      Reto Grieder
26 *
27 */
28
29/**
30    @file
31    @brief Implementation of the ConsoleWriter singleton.
32*/
33
34#include "ConsoleWriter.h"
35
36#include <iostream>
37
38#include "OutputManager.h"
39
40namespace orxonox
41{
42    /**
43        @brief Constructor, initializes the output level.
44
45        In debug builds, it writes output up to level::internal_warning to the
46        console, in release builds only up to level::user_info.
47
48        After creation, the instance is enabled.
49    */
50    ConsoleWriter::ConsoleWriter() : BaseWriter("Console")
51    {
52#ifdef ORXONOX_RELEASE
53        this->setLevelMax(level::user_info);
54#else
55        this->setLevelMax(level::internal_warning);
56#endif
57        this->bEnabled_ = true;
58    }
59
60    /**
61        @brief Destructor.
62    */
63    ConsoleWriter::~ConsoleWriter()
64    {
65    }
66
67    /**
68        @brief Returns the only existing instance of this class.
69    */
70    /*static*/ ConsoleWriter& ConsoleWriter::getInstance()
71    {
72        static ConsoleWriter instance;
73        return instance;
74    }
75
76    /**
77        @brief Inherited function from BaseWriter, writes output to the console using std::cout.
78    */
79    void ConsoleWriter::printLine(const std::string& line, OutputLevel)
80    {
81        std::cout << line << std::endl;
82    }
83
84    /**
85        @brief Enables the instance by registering itself as listener at OutputManager.
86    */
87    void ConsoleWriter::enable()
88    {
89        if (!this->bEnabled_)
90        {
91            OutputManager::getInstance().registerListener(this);
92            this->bEnabled_ = true;
93        }
94    }
95
96    /**
97        @brief Disables the instance by unregistering itself from OutputManager.
98    */
99    void ConsoleWriter::disable()
100    {
101        if (this->bEnabled_)
102        {
103            OutputManager::getInstance().unregisterListener(this);
104            this->bEnabled_ = false;
105        }
106    }
107}
Note: See TracBrowser for help on using the repository browser.