Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/output/src/libraries/util/output/OutputManager.cc @ 8805

Last change on this file since 8805 was 8805, checked in by landauf, 13 years ago

added new output level "message" for output directed to the user

  • Property svn:eol-style set to native
File size: 7.5 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#include "OutputManager.h"
30
31#include "MemoryWriter.h"
32#include "ConsoleWriter.h"
33#include "LogWriter.h"
34#include "util/StringUtils.h"
35
36namespace orxonox
37{
38    OutputManager::OutputManager()
39    {
40        this->combinedLevelMask_ = 0;
41        this->combinedContextMask_ = 0;
42    }
43
44    OutputManager::~OutputManager()
45    {
46    }
47
48    /*static*/ OutputManager& OutputManager::getInstance()
49    {
50        static OutputManager instance;
51        return instance;
52    }
53
54    /*static*/ OutputManager& OutputManager::getInstanceAndCreateListeners()
55    {
56        static OutputManager& instance = OutputManager::getInstance();
57
58        static MemoryWriter& memoryWriterInstance = MemoryWriter::getInstance(); (void)memoryWriterInstance;
59        static ConsoleWriter& consoleWriterInstance = ConsoleWriter::getInstance(); (void)consoleWriterInstance;
60        static LogWriter& logWriterInstance = LogWriter::getInstance(); (void)logWriterInstance;
61
62        return instance;
63    }
64
65    void OutputManager::pushMessage(OutputLevel level, OutputContext context, const std::string& message)
66    {
67        std::vector<std::string> lines;
68        vectorize(message, '\n', &lines);
69
70        for (size_t i = 0; i < this->listeners_.size(); ++i)
71            this->listeners_[i]->unfilteredOutput(level, context, lines);
72    }
73
74    void OutputManager::registerListener(OutputListener* listener)
75    {
76        this->listeners_.push_back(listener);
77        this->updateMasks();
78    }
79
80    void OutputManager::unregisterListener(OutputListener* listener)
81    {
82        for (std::vector<OutputListener*>::iterator it = this->listeners_.begin(); it != this->listeners_.end(); ++it)
83        {
84            if (*it == listener)
85            {
86                this->listeners_.erase(it);
87                break;
88            }
89        }
90        this->updateMasks();
91    }
92
93    void OutputManager::updateMasks()
94    {
95        this->updateCombinedLevelMask();
96        this->updateCombinedContextMask();
97    }
98
99    void OutputManager::updateCombinedLevelMask()
100    {
101        this->combinedLevelMask_ = 0;
102        for (size_t i = 0; i < this->listeners_.size(); ++i)
103            this->combinedLevelMask_ |= this->listeners_[i]->getLevelMask();
104    }
105
106    void OutputManager::updateCombinedContextMask()
107    {
108        this->combinedContextMask_ = 0;
109        for (size_t i = 0; i < this->listeners_.size(); ++i)
110            this->combinedContextMask_ |= this->listeners_[i]->getContextMask();
111    }
112
113    OutputContext OutputManager::registerContext(const std::string& name)
114    {
115        boost::bimap<OutputContext, std::string>::right_map::iterator it = this->contexts_.right.find(name);
116        if (it == this->contexts_.right.end())
117        {
118            OutputContext context = 0x1 << this->contexts_.size();
119            this->contexts_.insert(boost::bimap<OutputContext, std::string>::value_type(context, name));
120            return context;
121        }
122        else
123        {
124            return it->second;
125        }
126    }
127
128    OutputContext registerContext(const std::string& name)
129    {
130        return OutputManager::getInstance().registerContext(name);
131    }
132
133    const std::string& OutputManager::getLevelName(OutputLevel level) const
134    {
135        switch (level)
136        {
137            case level::none:               { static std::string name = "None"; return name; }
138            case level::message:            { static std::string name = "Message"; return name; }
139            case level::debug_output:       { static std::string name = "Debug"; return name; }
140            case level::user_error:         { static std::string name = "Error"; return name; }
141            case level::user_warning:       { static std::string name = "Warning"; return name; }
142            case level::user_status:        { static std::string name = "Status"; return name; }
143            case level::user_info:          { static std::string name = "Info"; return name; }
144            case level::internal_error:     { static std::string name = "Error (internal)"; return name; }
145            case level::internal_warning:   { static std::string name = "Warning (internal)"; return name; }
146            case level::internal_status:    { static std::string name = "Status (internal)"; return name; }
147            case level::internal_info:      { static std::string name = "Info (internal)"; return name; }
148            case level::verbose:            { static std::string name = "Verbose"; return name; }
149            case level::verbose_more:       { static std::string name = "Verbose (more)"; return name; }
150            case level::verbose_ultra:      { static std::string name = "Verbose (ultra)"; return name; }
151            default:                        { static std::string name = ""; return name; }
152        }
153    }
154
155    const std::string& OutputManager::getContextName(OutputContext context) const
156    {
157        if (context != context::undefined())
158        {
159            boost::bimap<OutputContext, std::string>::left_map::const_iterator it = this->contexts_.left.find(context);
160            if (it != this->contexts_.left.end())
161                return it->second;
162        }
163        return BLANKSTRING;
164    }
165
166    OutputContext OutputManager::getContextValue(const std::string& name) const
167    {
168        boost::bimap<OutputContext, std::string>::right_map::const_iterator it = this->contexts_.right.find(name);
169        if (it != this->contexts_.right.end())
170            return it->second;
171        else
172            return context::none;
173    }
174
175    std::string OutputManager::getComposedContextName(OutputContext context) const
176    {
177        std::string name;
178        size_t counter = 0;
179        for (OutputContext context_test = 0x1; context_test != 0x0; context_test = context_test << 1)
180        {
181            if (context & context_test)
182            {
183                boost::bimap<OutputContext, std::string>::left_map::const_iterator it = this->contexts_.left.find(context_test);
184                if (it != this->contexts_.left.end())
185                {
186                    if (counter)
187                        name += ", ";
188
189                    name += it->second;
190                    ++counter;
191                }
192            }
193        }
194        return name;
195    }
196
197    std::string OutputManager::getDefaultPrefix(OutputLevel level, OutputContext context) const
198    {
199        std::string prefix = this->getLevelName(level) + ": ";
200        if (context != context::undefined())
201        {
202            std::string context_name = this->getContextName(context);
203            if (context_name == "")
204                context_name = this->getComposedContextName(context);
205            prefix += "[" + context_name + "] ";
206        }
207        return prefix;
208    }
209}
Note: See TracBrowser for help on using the repository browser.