Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/output/src/libraries/util/Output.h @ 8853

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

documented the remaining code of the output system
created a build unit for the output system

  • Property svn:eol-style set to native
File size: 3.9 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    @defgroup Output Output system
31    @ingroup Util
32*/
33
34/**
35    @file
36    @ingroup Output
37    @brief Defines the helper function orxout() and includes all necessary headers to use the output system.
38
39    The output system is used to write output to the console, the logfile, and
40    other instances of orxonox::OutputListener. Each line of output is assigned
41    a level and a context. The level defines the type and importance of a
42    message, e.g. if it's a fatal error or just some internal information.
43    The context defines to which part of the program the output belongs.
44    Levels and contexts are defined in OutputDefinitions.h
45
46    Each orxonox::OutputListener can define a mask of desired levels and
47    contexts, to receive only a part of the output. Instances of
48    orxonox::SubcontextOutputListener are even able to filter sub-contexts.
49    A derivative of orxonox::BaseWriter is able to define these levels and
50    contexts through config values.
51
52    @attention
53    A message sent to the output system MUST end with "endl" or the message
54    won't be flushed.
55
56    @code
57    orxout() << "Debug output" << endl;
58    orxout(user_info) << "Orxonox version 1.2.3" << endl;
59    orxout(internal_status, context::input) << "Loading joystick" << endl;
60    @endcode
61*/
62
63#ifndef _Output_H__
64#define _Output_H__
65
66#include "UtilPrereqs.h"
67#include "output/OutputStream.h"
68
69namespace orxonox
70{
71    // Just for convenience
72    using std::endl;
73
74    /**
75        @brief This helper function returns a reference to a commonly used
76        instance of OutputStream.
77
78        It can be used like std::cout except that it is a function. You can
79        pass level and context of the following output as function arguments.
80    */
81    inline OutputStream& orxout(OutputLevel level = level::debug_output, const OutputContextContainer& context = context::undefined())
82    {
83        static OutputStream stream;
84        stream.setOutputAttributes(level, context);
85        return stream;
86    }
87
88    /**
89        @brief Shortcut for orxout() to allow passing contexts directly as
90        functions without using "()".
91
92        @code
93        orxout(user_info, context::example) << "Hello World" << endl; // calls this function
94        orxout(user_info, context::example()) << "Hello World" << endl; // calls the other orxout function
95        @endcode
96    */
97    inline OutputStream& orxout(OutputLevel level, OutputContextFunction context)
98    {
99        return orxout(level, context());
100    }
101
102    // COUT() is deprecated, please use orxout()
103    inline __DEPRECATED__(OutputStream& COUT(int level));
104
105    /**
106        @brief Writes output to the orxonox console. This function is deprecated, please use orxout()
107        @note The output level argument is ignored since it's not supported anymore. See orxout() for the new output levels.
108        @deprecated This function is deprecated. Use orxout() instead.
109    */
110    inline OutputStream& COUT(int)
111    {
112        return orxout();
113    }
114}
115
116#endif /* _Output_H__ */
Note: See TracBrowser for help on using the repository browser.