Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/MemoryWriter.cc @ 9083

Last change on this file since 9083 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.7 KB
RevLine 
[8774]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
[8848]29/**
30    @file
31    @brief Implementation of the MemoryWriter singleton.
32*/
33
[8774]34#include "MemoryWriter.h"
35#include "OutputManager.h"
36
37namespace orxonox
38{
[8848]39    /**
40        @brief Constructor, initializes the level mask with all levels activated.
41    */
[8774]42    MemoryWriter::MemoryWriter()
43    {
44        this->setLevelMask(level::all);
45    }
46
[8848]47    /**
48        @brief Destructor.
49    */
[8774]50    MemoryWriter::~MemoryWriter()
51    {
52    }
53
[8848]54    /**
55        @brief Returns the only existing instance of this singleton class.
56    */
[8774]57    /*static*/ MemoryWriter& MemoryWriter::getInstance()
58    {
59        static MemoryWriter instance;
60        return instance;
61    }
62
[8848]63    /**
64        @brief Implementation of the output() function inherited from OutputListener, stores the received output in memory.
65    */
[8833]66    void MemoryWriter::output(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines)
[8774]67    {
68        this->messages_.push_back(Message(level, context, lines));
69    }
70
[8848]71    /**
72        @brief Iterates over all stored output messages and sends them to the OutputListener.
73    */
[8774]74    void MemoryWriter::resendOutput(OutputListener* listener) const
75    {
76        for (size_t i = 0; i < this->messages_.size(); ++i)
77        {
78            const Message& message = this->messages_[i];
[8833]79            listener->unfilteredOutput(message.level, *message.context, message.lines);
[8774]80        }
81    }
82
[8848]83    /**
84        @brief Unregisters the instance from OutputManager, hence it will not receive any further output.
85    */
[8774]86    void MemoryWriter::disable()
87    {
88        OutputManager::getInstance().unregisterListener(this);
[8777]89        this->output(level::debug_output, context::undefined(), std::vector<std::string>(1, "MemoryWriter disabled, further messages may be lost"));
[8774]90    }
91}
Note: See TracBrowser for help on using the repository browser.