vrshoot

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

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