vrshoot

view libs/assimp/assimp/LogStream.hpp @ 0:b2f14e535253

find changesets by author, revision, files, or words in the commit message
initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
line source
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 */
40
41 /** @file LogStream.h
42 * @brief Abstract base class 'LogStream', representing an output log stream.
43 */
44 #ifndef INCLUDED_AI_LOGSTREAM_H
45 #define INCLUDED_AI_LOGSTREAM_H
46 #include "types.h"
47 namespace Assimp {
48 class IOSystem;
49
50 // ------------------------------------------------------------------------------------
51 /** @brief CPP-API: Abstract interface for log stream implementations.
52 *
53 * Several default implementations are provided, see #aiDefaultLogStream for more
54 * details. Writing your own implementation of LogStream is just necessary if these
55 * are not enough for your purpose. */
56 class ASSIMP_API LogStream
57 : public Intern::AllocateFromAssimpHeap {
58 protected:
59 /** @brief Default constructor */
60 LogStream() {
61 }
62 public:
63 /** @brief Virtual destructor */
64 virtual ~LogStream() {
65 }
66
67 // -------------------------------------------------------------------
68 /** @brief Overwrite this for your own output methods
69 *
70 * Log messages *may* consist of multiple lines and you shouldn't
71 * expect a consistent formatting. If you want custom formatting
72 * (e.g. generate HTML), supply a custom instance of Logger to
73 * #DefaultLogger:set(). Usually you can *expect* that a log message
74 * is exactly one line and terminated with a single \n character.
75 * @param message Message to be written */
76 virtual void write(const char* message) = 0;
77
78 // -------------------------------------------------------------------
79 /** @brief Creates a default log stream
80 * @param streams Type of the default stream
81 * @param name For aiDefaultLogStream_FILE: name of the output file
82 * @param io For aiDefaultLogStream_FILE: IOSystem to be used to open the output
83 * file. Pass NULL for the default implementation.
84 * @return New LogStream instance. */
85 static LogStream* createDefaultStream(aiDefaultLogStream stream,
86 const char* name = "AssimpLog.txt",
87 IOSystem* io = NULL);
88
89 }; // !class LogStream
90 // ------------------------------------------------------------------------------------
91 } // Namespace Assimp
92
93 #endif