appender.h

Go to the documentation of this file.

/*
    This file is part of Mitsuba, a physically based rendering system.

    Copyright (c) 2007-2014 by Wenzel Jakob and others.

    Mitsuba is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License Version 3
    as published by the Free Software Foundation.

    Mitsuba is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#pragma once
#if !defined(__MITSUBA_CORE_APPENDER_H_)
#define __MITSUBA_CORE_APPENDER_H_

#include <mitsuba/mitsuba.h>

MTS_NAMESPACE_BEGIN

/** \brief This class defines an abstract destination
 * for logging-relevant information
 *
 * \ingroup libcore
 * \ingroup libpython
 */
class MTS_EXPORT_CORE Appender : public Object {
public:
        /// Append a line of text with the given log level
        virtual void append(ELogLevel level, const std::string &text) = 0;

        /**
         * \brief Process a progress message
         * \param progress Percentage value in [0,100]
         * \param name Title of the progress message
         * \param formatted Formatted string representation of the message
         * \param eta Estimated time until 100% is reached.
         * \param ptr Custom pointer payload. This is used to express the
         *    context of a progress message. When rendering a scene, it
         *    will usually contain a pointer to the associated \c RenderJob.
         * \remark The \c ptr argument is missing in the Python bindings
         */
        virtual void logProgress(Float progress, const std::string &name,
                const std::string &formatted, const std::string &eta,
                const void *ptr) = 0;

        MTS_DECLARE_CLASS()
protected:
        /// Virtual destructor
        virtual ~Appender() { }
};

/** \brief %Appender implementation, which writes to an
 * arbitrary C++ output stream
 *
 * \ingroup libcore
 * \ingroup libpython
 */
class MTS_EXPORT_CORE StreamAppender : public Appender {
public:
        /**
         * Create a new stream appender
         * \remark This constructor is not exposed in the Python bindings
         */
        StreamAppender(std::ostream *pStream);

        /// Create a new stream appender logging to a file
        StreamAppender(const std::string &filename);

        /// Append a line of text
        void append(ELogLevel level, const std::string &pText);

        /// Process a progress message
        void logProgress(Float progress, const std::string &name,
                const std::string &formatted, const std::string &eta,
                const void *ptr);

        /// Does this appender log to a file
        inline bool logsToFile() const { return m_isFile; }

        /// Return the contents of the log file as a string
        void readLog(std::string &target);

        /// Return a string representation
        std::string toString() const;

        MTS_DECLARE_CLASS()
protected:
        /// Virtual destructor
        virtual ~StreamAppender();
private:
        std::ostream *m_stream;
        std::string m_fileName;
        bool m_isFile;
        bool m_lastMessageWasProgress;
};

/** \brief %Appender implementation, which writes directly
 * to an UNIX-style unbuffered file descriptor.
 *
 * \ingroup libcore
 */
class MTS_EXPORT_CORE UnbufferedAppender : public Appender {
public:
        /// Create a new appender
        UnbufferedAppender(int fd);

        /// Append a line of text
        void append(ELogLevel level, const std::string &pText);

        /// Process a progress message
        void logProgress(Float progress, const std::string &name,
                const std::string &formatted, const std::string &eta,
                const void *ptr);

        /// Return a string representation
        std::string toString() const;

        MTS_DECLARE_CLASS()
protected:
        /// Virtual destructor
        virtual ~UnbufferedAppender();
private:
        int m_fd;
        bool m_lastMessageWasProgress;
};

MTS_NAMESPACE_END

#endif /* __MITSUBA_CORE_APPENDER_H_ */