1/*
2Open Asset Import Library (assimp)
3----------------------------------------------------------------------
4
5Copyright (c) 2006-2017, assimp team
6
7All rights reserved.
8
9Redistribution and use of this software in source and binary forms,
10with or without modification, are permitted provided that the
11following conditions are met:
12
13* Redistributions of source code must retain the above
14 copyright notice, this list of conditions and the
15 following disclaimer.
16
17* Redistributions in binary form must reproduce the above
18 copyright notice, this list of conditions and the
19 following disclaimer in the documentation and/or other
20 materials provided with the distribution.
21
22* Neither the name of the assimp team, nor the names of its
23 contributors may be used to endorse or promote products
24 derived from this software without specific prior
25 written permission of the assimp team.
26
27THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
28"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
29LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
30A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
31OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
32SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
34DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
35THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
36(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
39----------------------------------------------------------------------
40*/
41
42/** @file LogStream.hpp
43 * @brief Abstract base class 'LogStream', representing an output log stream.
44 */
45#ifndef INCLUDED_AI_LOGSTREAM_H
46#define INCLUDED_AI_LOGSTREAM_H
47
48#include "types.h"
49
50namespace Assimp {
51
52class IOSystem;
53
54// ------------------------------------------------------------------------------------
55/** @brief CPP-API: Abstract interface for log stream implementations.
56 *
57 * Several default implementations are provided, see #aiDefaultLogStream for more
58 * details. Writing your own implementation of LogStream is just necessary if these
59 * are not enough for your purpose. */
60class ASSIMP_API LogStream
61#ifndef SWIG
62 : public Intern::AllocateFromAssimpHeap
63#endif
64{
65protected:
66 /** @brief Default constructor */
67 LogStream();
68
69public:
70 /** @brief Virtual destructor */
71 virtual ~LogStream();
72
73 // -------------------------------------------------------------------
74 /** @brief Overwrite this for your own output methods
75 *
76 * Log messages *may* consist of multiple lines and you shouldn't
77 * expect a consistent formatting. If you want custom formatting
78 * (e.g. generate HTML), supply a custom instance of Logger to
79 * #DefaultLogger:set(). Usually you can *expect* that a log message
80 * is exactly one line and terminated with a single \n character.
81 * @param message Message to be written */
82 virtual void write(const char* message) = 0;
83
84 // -------------------------------------------------------------------
85 /** @brief Creates a default log stream
86 * @param streams Type of the default stream
87 * @param name For aiDefaultLogStream_FILE: name of the output file
88 * @param io For aiDefaultLogStream_FILE: IOSystem to be used to open the output
89 * file. Pass NULL for the default implementation.
90 * @return New LogStream instance. */
91 static LogStream* createDefaultStream(aiDefaultLogStream stream,
92 const char* name = "AssimpLog.txt",
93 IOSystem* io = NULL);
94
95}; // !class LogStream
96
97inline
98LogStream::LogStream() {
99 // empty
100}
101
102inline
103LogStream::~LogStream() {
104 // empty
105}
106
107// ------------------------------------------------------------------------------------
108} // Namespace Assimp
109
110#endif
111