Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/UtilPrereqs.h @ 9476

Last change on this file since 9476 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: 3.4 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 *      Reto Grieder
24 *   Co-authors:
25 *      Fabian 'x3n' Landau
26 *
27 */
28
29/**
30@file
31@brief
32    Shared library macros, enums, constants and forward declarations for the util library
33*/
34
35#ifndef _UtilPrereqs_H__
36#define _UtilPrereqs_H__
37
38#include "OrxonoxConfig.h"
39
40//-----------------------------------------------------------------------
41// Shared library settings
42//-----------------------------------------------------------------------
43
44#if defined(ORXONOX_PLATFORM_WINDOWS) && !defined( UTIL_STATIC_BUILD )
45#  ifdef UTIL_SHARED_BUILD
46#    define _UtilExport __declspec(dllexport)
47#  else
48#    if defined( __MINGW32__ )
49#      define _UtilExport
50#    else
51#      define _UtilExport __declspec(dllimport)
52#    endif
53#  endif
54#  define _UtilPrivate
55#elif defined (ORXONOX_GCC_VISIBILITY)
56#  define _UtilExport  __attribute__ ((visibility("default")))
57#  define _UtilPrivate __attribute__ ((visibility("hidden")))
58#else
59#  define _UtilExport
60#  define _UtilPrivate
61#endif
62
63//-----------------------------------------------------------------------
64// Enums
65//-----------------------------------------------------------------------
66
67namespace orxonox
68{
69    namespace ScopeID
70    {
71        //!A list of available scopes for the Scope template.
72        enum Value
73        {
74            Root,
75            Graphics
76        };
77    }
78}
79
80//-----------------------------------------------------------------------
81// Forward declarations
82//-----------------------------------------------------------------------
83
84namespace orxonox
85{
86    class Clock;
87    class Exception;
88    class ExprParser;
89    class MultiType;
90    class OutputListener;
91    class OutputManager;
92    class OutputStream;
93    template <ScopeID::Value>
94    class Scope;
95    template <class, ScopeID::Value>
96    class ScopedSingleton;
97    class ScopeListener;
98    class SignalHandler;
99    template <class T>
100    class Singleton;
101    class SubString;
102}
103
104namespace Ogre
105{
106    class Radian;
107    class Degree;
108    class Vector2;
109    class Vector3;
110    class Vector4;
111    class Matrix3;
112    class Matrix4;
113    class Quaternion;
114    class ColourValue;
115}
116namespace orxonox
117{
118    using Ogre::Radian;
119    using Ogre::Degree;
120    using Ogre::Vector2;
121    using Ogre::Vector3;
122    using Ogre::Vector4;
123    using Ogre::Matrix3;
124    using Ogre::Matrix4;
125    using Ogre::Quaternion;
126    using Ogre::ColourValue;
127}
128
129namespace Loki
130{
131    class ScopeGuardImplBase;
132    typedef const ScopeGuardImplBase& ScopeGuard;
133}
134
135// Just so you don't have to include StringUtils.h everywhere just for this
136namespace orxonox
137{
138    extern _UtilExport std::string BLANKSTRING;
139}
140
141
142#endif /* _UtilPrereqs_H__ */
Note: See TracBrowser for help on using the repository browser.