BRE12
DefaultLogger.hpp
1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
4 
5 Copyright (c) 2006-2012, assimp team
6 All rights reserved.
7 
8 Redistribution and use of this software in source and binary forms,
9 with or without modification, are permitted provided that the
10 following conditions are met:
11 
12 * Redistributions of source code must retain the above
13  copyright notice, this list of conditions and the
14  following disclaimer.
15 
16 * Redistributions in binary form must reproduce the above
17  copyright notice, this list of conditions and the
18  following disclaimer in the documentation and/or other
19  materials provided with the distribution.
20 
21 * Neither the name of the assimp team, nor the names of its
22  contributors may be used to endorse or promote products
23  derived from this software without specific prior
24  written permission of the assimp team.
25 
26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 
38 ----------------------------------------------------------------------
39 */
43 #ifndef INCLUDED_AI_DEFAULTLOGGER
44 #define INCLUDED_AI_DEFAULTLOGGER
45 
46 #include "Logger.hpp"
47 #include "LogStream.hpp"
48 #include "NullLogger.hpp"
49 #include <vector>
50 
51 namespace Assimp {
52 // ------------------------------------------------------------------------------------
53 class IOStream;
54 struct LogStreamInfo;
55 
57 #define ASSIMP_DEFAULT_LOG_NAME "AssimpLog.txt"
58 
59 // ------------------------------------------------------------------------------------
72 class ASSIMP_API DefaultLogger :
73  public Logger {
74 
75 public:
76 
77  // ----------------------------------------------------------------------
89  static Logger *create(const char* name = ASSIMP_DEFAULT_LOG_NAME,
90  LogSeverity severity = NORMAL,
91  unsigned int defStreams = aiDefaultLogStream_DEBUGGER | aiDefaultLogStream_FILE,
92  IOSystem* io = NULL);
93 
94  // ----------------------------------------------------------------------
102  static void set (Logger *logger);
103 
104  // ----------------------------------------------------------------------
108  static Logger *get();
109 
110  // ----------------------------------------------------------------------
115  static bool isNullLogger();
116 
117  // ----------------------------------------------------------------------
120  static void kill();
121 
122  // ----------------------------------------------------------------------
124  bool attachStream(LogStream *pStream,
125  unsigned int severity);
126 
127  // ----------------------------------------------------------------------
129  bool detatchStream(LogStream *pStream,
130  unsigned int severity);
131 
132 
133 private:
134 
135  // ----------------------------------------------------------------------
138  DefaultLogger(LogSeverity severity);
139 
140  // ----------------------------------------------------------------------
142  ~DefaultLogger();
143 
144 private:
145 
147  void OnDebug(const char* message);
148 
150  void OnInfo(const char* message);
151 
153  void OnWarn(const char* message);
154 
156  void OnError(const char* message);
157 
158  // ----------------------------------------------------------------------
160  void WriteToStreams(const char* message, ErrorSeverity ErrorSev );
161 
162  // ----------------------------------------------------------------------
167  unsigned int GetThreadID();
168 
169 private:
170  // Aliases for stream container
171  typedef std::vector<LogStreamInfo*> StreamArray;
172  typedef std::vector<LogStreamInfo*>::iterator StreamIt;
173  typedef std::vector<LogStreamInfo*>::const_iterator ConstStreamIt;
174 
176  static Logger *m_pLogger;
177  static NullLogger s_pNullLogger;
178 
180  StreamArray m_StreamArray;
181 
182  bool noRepeatMsg;
183  char lastMsg[MAX_LOG_MESSAGE_LENGTH*2];
184  size_t lastLen;
185 };
186 // ------------------------------------------------------------------------------------
187 
188 } // Namespace Assimp
189 
190 #endif // !! INCLUDED_AI_DEFAULTLOGGER
Assimp&#39;s CPP-API and all internal APIs.
Definition: DefaultLogger.hpp:51
CPP-API: Class to handle file I/O for C++.
Definition: IOStream.hpp:64
CPP-API: Empty logging implementation.
Definition: NullLogger.hpp:55
ErrorSeverity
Description for severity of a log message.
Definition: Logger.hpp:84
CPP-API: Interface to the file system.
Definition: IOSystem.hpp:67
Abstract base class &#39;Logger&#39;, base of the logging system.
LogSeverity
Log severity to describe the granularity of logging.
Definition: Logger.hpp:70
CPP-API: Abstract interface for log stream implementations.
Definition: LogStream.hpp:56
CPP-API: Primary logging facility of Assimp.
Definition: DefaultLogger.hpp:72
CPP-API: Abstract interface for logger implementations.
Definition: Logger.hpp:59