Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/OutputStream.cc @ 10068

Last change on this file since 10068 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.6 KB
RevLine 
[8765]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
[8848]29/**
30    @file
31    @brief Implementation of the non-generic functions of the OutputStream class.
32*/
33
[8765]34#include "OutputStream.h"
35
36#include "OutputManager.h"
37
38namespace orxonox
39{
[8848]40    /**
41        @brief Default constructor, initializes level and context with default values.
42    */
[8765]43    OutputStream::OutputStream()
44    {
[8789]45        this->setOutputAttributes(level::debug_output, context::undefined());
[8765]46    }
47
[8848]48    /**
49        @brief Constructor, initializes level and context with the provided values.
50    */
[8833]51    OutputStream::OutputStream(OutputLevel level, const OutputContextContainer& context)
[8789]52    {
53        this->setOutputAttributes(level, context);
54    }
55
[8848]56    /**
[8849]57        @brief Destructor, sends remaining output to OutputManager (if any).
58    */
59    OutputStream::~OutputStream()
60    {
61        if (this->str() != "")
62            *this << " [missing endl]" << std::endl;
63    }
64
65    /**
[8848]66        @brief Sends the buffered message to OutputManager together with the stored level and context.
67        Additionally empties the buffer.
68    */
[8765]69    void OutputStream::sendMessage()
70    {
[8833]71        OutputManager::getInstanceAndCreateListeners().pushMessage(this->level_, *this->context_, this->str());
[8765]72        this->str("");
73    }
74
[8848]75    /**
76        @brief Defines level and context of the following output.
77        Also sets the bAcceptsOutput_ flag according to the masks defined in OutputManager.
78    */
[8833]79    void OutputStream::setOutputAttributes(OutputLevel level, const OutputContextContainer& context)
[8765]80    {
81        this->level_ = level;
[8833]82        this->context_ = &context;
[8765]83
[8789]84        this->bAcceptsOutput_ = OutputManager::getInstanceAndCreateListeners().acceptsOutput(level, context);
[8765]85    }
86}
Note: See TracBrowser for help on using the repository browser.