Log.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018 Istituto Italiano di Tecnologia (IIT)
 * All rights reserved.
 *
 * This software may be modified and distributed under the terms of the
 * GNU Lesser General Public License v2.1 or any later version.
 */

#ifndef BLOCKFACTORY_CORE_LOG_H
#define BLOCKFACTORY_CORE_LOG_H

#include <memory>
#include <sstream>
#include <string>

#ifdef NDEBUG
#define BF_LOG_VERBOSITY blockfactory::core::Log::Verbosity::RELEASE
#else
#define BF_LOG_VERBOSITY blockfactory::core::Log::Verbosity::DEBUG
#endif

#ifndef bfError
#define bfError                                                 \
    blockfactory::core::Log::getSingleton().getLogStringStream( \
        blockfactory::core::Log::Type::ERROR, __FILE__, __LINE__, __FUNCTION__)
#endif

#ifndef bfWarning
#define bfWarning                                               \
    blockfactory::core::Log::getSingleton().getLogStringStream( \
        blockfactory::core::Log::Type::WARNING, __FILE__, __LINE__, __FUNCTION__)
#endif

namespace blockfactory {
    namespace core {
        class Log;
    } // namespace core
} // namespace blockfactory

class blockfactory::core::Log
{
public:
    enum class Type
    {
        ERROR,
        WARNING
    };

    enum class Verbosity
    {
        RELEASE,
        DEBUG
    };

private:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    class impl;
    std::unique_ptr<impl> pImpl;
#endif

public:
    Log();
    ~Log() = default;

    static blockfactory::core::Log& getSingleton();

    std::stringstream& getLogStringStream(const Type& type,
                                          const std::string& file,
                                          const unsigned& line,
                                          const std::string& function);

    std::string getErrors() const;

    std::string getWarnings() const;

    void clearErrors();

    void clearWarnings();

    void clear();
};

#endif // BLOCKFACTORY_CORE_LOG_H