miniassimp

annotate include/miniassimp/LogStream.hpp @ 0:879c81d94345

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