Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/SuperOrxoBros_HS18/src/libraries/util/output/MemoryWriter.h @ 12177

Last change on this file since 12177 was 12177, checked in by siramesh, 5 years ago

Super Orxo Bros Final (Sidharth Ramesh, Nisa Balta, Jeff Ren)

File size: 3.0 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    @ingroup Output
32    @brief Declaration of the MemoryWriter singleton.
33*/
34
35#ifndef _MemoryWriter_H__
36#define _MemoryWriter_H__
37
38#include "util/UtilPrereqs.h"
39#include "OutputListener.h"
40
41namespace orxonox
42{
43    /**
44        @brief MemoryWriter is a singleton which is derived from OutputListener and writes all output to a list.
45
46        This list can be used to re-send old output to other instances of
47        OutputListener, e.g. if they were newly created or to re-write the
48        log-file.
49
50        Since MemoryWriter receives output of all levels, this means also that
51        all possible output needs to be generated as long as MemoryWriter stays
52        active. Hence disable() should be called as soon as possible.
53    */
54    class _UtilExport MemoryWriter : public OutputListener
55    {
56        /// @brief A helper struct which is used to store output and its properties.
57        struct Message
58        {
59            /// @brief Constructor, assigns all values.
60            Message(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines)
61                : level(level), context(&context), lines(lines) {}
62
63            OutputLevel level;                      ///< The level of the output message
64            const OutputContextContainer* context;  ///< The context of the output message
65            std::vector<std::string> lines;         ///< The lines of text of the output message
66        };
67
68        public:
69            MemoryWriter();
70            virtual ~MemoryWriter();
71
72            void resendOutput(OutputListener* listener) const;
73            void disable();
74
75        protected:
76            virtual void output(OutputLevel level, const OutputContextContainer& context, const std::vector<std::string>& lines) override;
77
78        private:
79            // non-copyable:
80            MemoryWriter(const MemoryWriter&) = delete;
81            MemoryWriter& operator=(const MemoryWriter&) = delete;
82
83            std::vector<Message> messages_; ///< Stores all output messages from the creation of this instance until disable() is called.
84    };
85}
86
87#endif /* _MemoryWriter_H__ */
Note: See TracBrowser for help on using the repository browser.