Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/output/LogWriter.h @ 8989

Last change on this file since 8989 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: 2.5 KB
RevLine 
[8774]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
[8848]29/**
30    @file
31    @ingroup Output
32    @brief Declaration of the LogWriter singleton which writes output to a log-file.
33*/
34
[8774]35#ifndef _LogWriter_H__
36#define _LogWriter_H__
37
38#include "util/UtilPrereqs.h"
39
40#include <fstream>
41
[8794]42#include "BaseWriter.h"
[8774]43
44namespace orxonox
45{
[8848]46    /**
47        @brief The LogWriter class inherits from BaseWriter and writes output to a log-file.
48
49        It is implemented as singleton because we (currently) use only one
50        log-file. The path of the file can be changed, in which case the file
51        is rewritten by using the output stored by MemoryWriter. This adds the
52        possibility to change the desired output levels before changing the
53        path in order to get the complete output with the new output levels
54        at the new path.
55    */
[8794]56    class _UtilExport LogWriter : public BaseWriter
[8774]57    {
58        public:
59            static LogWriter& getInstance();
60
61            void setLogPath(const std::string& path);
62
63        protected:
[8795]64            virtual void printLine(const std::string& line, OutputLevel level);
[8774]65
66        private:
67            LogWriter();
68            LogWriter(const LogWriter&);
[8794]69            virtual ~LogWriter();
[8774]70
71            void openFile();
72            void closeFile();
73
[8848]74            std::string filename_;  ///< The name of the log-file (without directories)
75            std::string path_;      ///< The path of the log-file (without file-name)
76            bool bDefaultPath_;     ///< If true, the log-file resides at the default path (which is usually a temporary directory)
[8774]77
[8848]78            std::ofstream file_;    ///< The output file stream.
[8774]79    };
80}
81
82#endif /* _LogWriter_H__ */
Note: See TracBrowser for help on using the repository browser.