miniassimp

diff 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
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/include/miniassimp/LogStream.hpp	Mon Jan 28 18:19:26 2019 +0200
     1.3 @@ -0,0 +1,111 @@
     1.4 +/*
     1.5 +Open Asset Import Library (assimp)
     1.6 +----------------------------------------------------------------------
     1.7 +
     1.8 +Copyright (c) 2006-2018, assimp team
     1.9 +
    1.10 +
    1.11 +All rights reserved.
    1.12 +
    1.13 +Redistribution and use of this software in source and binary forms,
    1.14 +with or without modification, are permitted provided that the
    1.15 +following conditions are met:
    1.16 +
    1.17 +* Redistributions of source code must retain the above
    1.18 +  copyright notice, this list of conditions and the
    1.19 +  following disclaimer.
    1.20 +
    1.21 +* Redistributions in binary form must reproduce the above
    1.22 +  copyright notice, this list of conditions and the
    1.23 +  following disclaimer in the documentation and/or other
    1.24 +  materials provided with the distribution.
    1.25 +
    1.26 +* Neither the name of the assimp team, nor the names of its
    1.27 +  contributors may be used to endorse or promote products
    1.28 +  derived from this software without specific prior
    1.29 +  written permission of the assimp team.
    1.30 +
    1.31 +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
    1.32 +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
    1.33 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.34 +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
    1.35 +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    1.36 +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
    1.37 +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    1.38 +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    1.39 +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    1.40 +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    1.41 +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.42 +
    1.43 +----------------------------------------------------------------------
    1.44 +*/
    1.45 +
    1.46 +/** @file LogStream.hpp
    1.47 + *  @brief Abstract base class 'LogStream', representing an output log stream.
    1.48 + */
    1.49 +#ifndef INCLUDED_AI_LOGSTREAM_H
    1.50 +#define INCLUDED_AI_LOGSTREAM_H
    1.51 +
    1.52 +#include "types.h"
    1.53 +
    1.54 +namespace Assimp    {
    1.55 +
    1.56 +class IOSystem;
    1.57 +
    1.58 +// ------------------------------------------------------------------------------------
    1.59 +/** @brief CPP-API: Abstract interface for log stream implementations.
    1.60 + *
    1.61 + *  Several default implementations are provided, see #aiDefaultLogStream for more
    1.62 + *  details. Writing your own implementation of LogStream is just necessary if these
    1.63 + *  are not enough for your purpose. */
    1.64 +class ASSIMP_API LogStream
    1.65 +#ifndef SWIG
    1.66 +    : public Intern::AllocateFromAssimpHeap
    1.67 +#endif
    1.68 +{
    1.69 +protected:
    1.70 +    /** @brief  Default constructor */
    1.71 +    LogStream() AI_NO_EXCEPT;
    1.72 +
    1.73 +public:
    1.74 +    /** @brief  Virtual destructor  */
    1.75 +    virtual ~LogStream();
    1.76 +
    1.77 +    // -------------------------------------------------------------------
    1.78 +    /** @brief  Overwrite this for your own output methods
    1.79 +     *
    1.80 +     *  Log messages *may* consist of multiple lines and you shouldn't
    1.81 +     *  expect a consistent formatting. If you want custom formatting
    1.82 +     *  (e.g. generate HTML), supply a custom instance of Logger to
    1.83 +     *  #DefaultLogger:set(). Usually you can *expect* that a log message
    1.84 +     *  is exactly one line and terminated with a single \n character.
    1.85 +     *  @param message Message to be written */
    1.86 +    virtual void write(const char* message) = 0;
    1.87 +
    1.88 +    // -------------------------------------------------------------------
    1.89 +    /** @brief Creates a default log stream
    1.90 +     *  @param streams Type of the default stream
    1.91 +     *  @param name For aiDefaultLogStream_FILE: name of the output file
    1.92 +     *  @param io For aiDefaultLogStream_FILE: IOSystem to be used to open the output
    1.93 +     *   file. Pass NULL for the default implementation.
    1.94 +     *  @return New LogStream instance.  */
    1.95 +    static LogStream* createDefaultStream(aiDefaultLogStream stream,
    1.96 +        const char* name = "AssimpLog.txt",
    1.97 +        IOSystem* io = 0 );
    1.98 +
    1.99 +}; // !class LogStream
   1.100 +
   1.101 +inline
   1.102 +LogStream::LogStream() AI_NO_EXCEPT {
   1.103 +    // empty
   1.104 +}
   1.105 +
   1.106 +inline
   1.107 +LogStream::~LogStream() {
   1.108 +    // empty
   1.109 +}
   1.110 +
   1.111 +// ------------------------------------------------------------------------------------
   1.112 +} // Namespace Assimp
   1.113 +
   1.114 +#endif