Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/BaseWriter.cc @ 10679

Last change on this file since 10679 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: 5.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    @brief Implementation of the BaseWriter class.
32*/
33
34#include "BaseWriter.h"
35
36#include "OutputManager.h"
37
38namespace orxonox
39{
40    /**
41        @brief Constructor: Initializes the config-values.
42    */
43    BaseWriter::BaseWriter(const std::string& name, bool bRegister) : SubcontextOutputListener(bRegister)
44    {
45        this->name_ = name;
46
47        this->configurableMaxLevel_ = level::none;
48        this->configurableAdditionalContextsMaxLevel_ = level::verbose;
49        this->configurableAdditionalContexts_.push_back("example");
50
51        this->changedConfigurableLevel();
52        this->changedConfigurableAdditionalContextsLevel();
53        this->changedConfigurableAdditionalContexts();
54    }
55
56    /**
57        @brief Destructor.
58    */
59    BaseWriter::~BaseWriter()
60    {
61    }
62
63    /**
64        @brief This function is inherited from OutputListener, each message is split into lines and sent to printLine().
65    */
66    void BaseWriter::output(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines)
67    {
68        const std::string& prefix = OutputManager::getInstance().getDefaultPrefix(level, context);
69        std::string blanks(prefix.length(), ' ');
70
71        for (size_t i = 0; i < lines.size(); ++i)
72            this->printLine((i == 0 ? prefix : blanks) + lines[i], level);
73    }
74
75    /**
76        @brief Overwritten implementation of the function inherited from OutputListener, sets also the corresponding config-value.
77    */
78    void BaseWriter::setLevelMax(OutputLevel max)
79    {
80        this->configurableMaxLevel_ = max;
81        this->changedConfigurableLevel();
82    }
83
84    /**
85        @brief Overwritten implementation of the function inherited from OutputListener, sets also the corresponding config-value.
86    */
87    void BaseWriter::setAdditionalContextsLevelMax(OutputLevel max)
88    {
89        this->configurableAdditionalContextsMaxLevel_ = max;
90        this->changedConfigurableAdditionalContextsLevel();
91    }
92
93    /**
94        @brief Called if the config value has changed, updates the corresponding mask in OutputListener.
95    */
96    void BaseWriter::changedConfigurableLevel()
97    {
98        OutputListener::setLevelMax(static_cast<OutputLevel>(this->configurableMaxLevel_));
99    }
100
101    /**
102        @brief Called if the config value has changed, updates the corresponding mask in OutputListener.
103    */
104    void BaseWriter::changedConfigurableAdditionalContextsLevel()
105    {
106        OutputListener::setAdditionalContextsLevelMax(static_cast<OutputLevel>(this->configurableAdditionalContextsMaxLevel_));
107    }
108
109    /**
110        @brief Called if the config-vector of accepted contexts has changed, updates the masks in SubcontextOutputListener.
111    */
112    void BaseWriter::changedConfigurableAdditionalContexts()
113    {
114        OutputContextMask main_contexts = context::none;
115        std::set<const OutputContextContainer*> sub_contexts;
116
117        // iterate over all strings in the config-vector
118        for (size_t i = 0; i < this->configurableAdditionalContexts_.size(); ++i)
119        {
120            const std::string& full_name = this->configurableAdditionalContexts_[i];
121
122            // split the name into main-name and sub-name (if given; otherwise sub-name remains empty). both names are separated by ::
123            std::string name = full_name;
124            std::string subname;
125
126            size_t pos = full_name.find("::");
127            if (pos != std::string::npos)
128            {
129                name = full_name.substr(0, pos);
130                subname = full_name.substr(pos + 2);
131            }
132
133            // get the context defined by this name
134            const OutputContextContainer& context = OutputManager::getInstance().registerContext(name, subname);
135
136            // if the context is a sub-context, insert it to the set of sub-contexts. Otherwise add it's mask to the mask of main-contexts.
137            if (context.sub_id == context::no_subcontext)
138                main_contexts |= context.mask;
139            else
140                sub_contexts.insert(&context);
141        }
142
143        // pass main-contexts and sub-contexts to SubcontextOutputListener
144        this->setAdditionalContextsMask(main_contexts);
145        this->setAdditionalSubcontexts(sub_contexts);
146    }
147}
Note: See TracBrowser for help on using the repository browser.