nuclear@0: /*
nuclear@0: Open Asset Import Library (assimp)
nuclear@0: ----------------------------------------------------------------------
nuclear@0: 
nuclear@0: Copyright (c) 2006-2018, assimp team
nuclear@0: 
nuclear@0: 
nuclear@0: All rights reserved.
nuclear@0: 
nuclear@0: Redistribution and use of this software in source and binary forms,
nuclear@0: with or without modification, are permitted provided that the
nuclear@0: following conditions are met:
nuclear@0: 
nuclear@0: * Redistributions of source code must retain the above
nuclear@0:   copyright notice, this list of conditions and the
nuclear@0:   following disclaimer.
nuclear@0: 
nuclear@0: * Redistributions in binary form must reproduce the above
nuclear@0:   copyright notice, this list of conditions and the
nuclear@0:   following disclaimer in the documentation and/or other
nuclear@0:   materials provided with the distribution.
nuclear@0: 
nuclear@0: * Neither the name of the assimp team, nor the names of its
nuclear@0:   contributors may be used to endorse or promote products
nuclear@0:   derived from this software without specific prior
nuclear@0:   written permission of the assimp team.
nuclear@0: 
nuclear@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0: A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0: OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0: OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0: 
nuclear@0: ----------------------------------------------------------------------
nuclear@0: */
nuclear@0: 
nuclear@0: /** @file LogStream.hpp
nuclear@0:  *  @brief Abstract base class 'LogStream', representing an output log stream.
nuclear@0:  */
nuclear@0: #ifndef INCLUDED_AI_LOGSTREAM_H
nuclear@0: #define INCLUDED_AI_LOGSTREAM_H
nuclear@0: 
nuclear@0: #include "types.h"
nuclear@0: 
nuclear@0: namespace Assimp    {
nuclear@0: 
nuclear@0: class IOSystem;
nuclear@0: 
nuclear@0: // ------------------------------------------------------------------------------------
nuclear@0: /** @brief CPP-API: Abstract interface for log stream implementations.
nuclear@0:  *
nuclear@0:  *  Several default implementations are provided, see #aiDefaultLogStream for more
nuclear@0:  *  details. Writing your own implementation of LogStream is just necessary if these
nuclear@0:  *  are not enough for your purpose. */
nuclear@0: class ASSIMP_API LogStream
nuclear@0: #ifndef SWIG
nuclear@0:     : public Intern::AllocateFromAssimpHeap
nuclear@0: #endif
nuclear@0: {
nuclear@0: protected:
nuclear@0:     /** @brief  Default constructor */
nuclear@0:     LogStream() AI_NO_EXCEPT;
nuclear@0: 
nuclear@0: public:
nuclear@0:     /** @brief  Virtual destructor  */
nuclear@0:     virtual ~LogStream();
nuclear@0: 
nuclear@0:     // -------------------------------------------------------------------
nuclear@0:     /** @brief  Overwrite this for your own output methods
nuclear@0:      *
nuclear@0:      *  Log messages *may* consist of multiple lines and you shouldn't
nuclear@0:      *  expect a consistent formatting. If you want custom formatting
nuclear@0:      *  (e.g. generate HTML), supply a custom instance of Logger to
nuclear@0:      *  #DefaultLogger:set(). Usually you can *expect* that a log message
nuclear@0:      *  is exactly one line and terminated with a single \n character.
nuclear@0:      *  @param message Message to be written */
nuclear@0:     virtual void write(const char* message) = 0;
nuclear@0: 
nuclear@0:     // -------------------------------------------------------------------
nuclear@0:     /** @brief Creates a default log stream
nuclear@0:      *  @param streams Type of the default stream
nuclear@0:      *  @param name For aiDefaultLogStream_FILE: name of the output file
nuclear@0:      *  @param io For aiDefaultLogStream_FILE: IOSystem to be used to open the output
nuclear@0:      *   file. Pass NULL for the default implementation.
nuclear@0:      *  @return New LogStream instance.  */
nuclear@0:     static LogStream* createDefaultStream(aiDefaultLogStream stream,
nuclear@0:         const char* name = "AssimpLog.txt",
nuclear@0:         IOSystem* io = 0 );
nuclear@0: 
nuclear@0: }; // !class LogStream
nuclear@0: 
nuclear@0: inline
nuclear@0: LogStream::LogStream() AI_NO_EXCEPT {
nuclear@0:     // empty
nuclear@0: }
nuclear@0: 
nuclear@0: inline
nuclear@0: LogStream::~LogStream() {
nuclear@0:     // empty
nuclear@0: }
nuclear@0: 
nuclear@0: // ------------------------------------------------------------------------------------
nuclear@0: } // Namespace Assimp
nuclear@0: 
nuclear@0: #endif