omLog.h

Go to the documentation of this file.

 
// Copyright (c) 2013-2015 OpenM++
// This code is licensed under the MIT license (see LICENSE.txt for details)
 
#ifndef OM_H_LOG_H
#define OM_H_LOG_H
 
#include <string>
#include <list>
#include <unordered_map>
#include <source_location>
 
namespace openm
{
    struct ILogBase
    {
        virtual ~ILogBase(void) noexcept = 0;
 
        virtual const bool isEnabled(void) noexcept = 0;
 
        virtual void logMsg(const char * i_msg, const char * i_extra = NULL) noexcept = 0;
 
        virtual void logFormatted(const char * i_format, ...) noexcept = 0;
 
        virtual const std::string timeStamp(void) noexcept = 0;
 
        virtual void setRank(int i_rank, int i_worldSize) noexcept = 0;
    };
 
    struct ILog : public virtual ILogBase
    {
        virtual ~ILog(void) noexcept = 0;
 
        virtual void logErr(const std::exception & i_ex, const char * i_msg = NULL) noexcept = 0;
 
        virtual void logSql(const char * i_sql) noexcept = 0;
 
        virtual void init(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp = false, 
            bool i_usePidStamp = false, 
            bool i_noMsgTime = false,
            bool i_isLogSql = false
            ) noexcept = 0;
 
        virtual const std::string lastLogPath(void) noexcept = 0;
 
        virtual const std::string stampedLogPath(void) noexcept = 0;
 
        virtual const std::string getMessage(const char * i_sourceMsg) noexcept = 0;
 
        virtual const std::list<std::string> getLanguages(void) noexcept = 0;
 
        virtual const std::unordered_map<std::string, std::string> getLanguageMessages(void) noexcept = 0;
 
        virtual void swapLanguageMessages(const std::list<std::string> & i_langLst, std::unordered_map<std::string, std::string> & io_msgMap) noexcept = 0;
    };
 
    struct ITrace : public virtual ILogBase
    {
        virtual ~ITrace(void) noexcept = 0;
 
        virtual void init(
            bool i_logToConsole,
            const char * i_basePath,
            bool i_logToFile,
            bool i_useTimeStamp = false,
            bool i_usePidStamp = false,
            bool i_noMsgTime = false
            ) noexcept = 0;
    };
 
    inline thread_local const char * the_checkpoint_message = "";
 
    inline thread_local std::source_location the_checkpoint_location;
}
 
#define CHECKPOINT(x) { openm::the_checkpoint_location = std::source_location::current(); openm::the_checkpoint_message = x; }
 
#define LOG_CHECKPOINT \
    theLog->logFormatted("%s: [%d,%d] %s", \
        the_checkpoint_message, \
        the_checkpoint_location.line(), the_checkpoint_location.column(), the_checkpoint_location.file_name());
 
//
// OpenM++ common library export
//
#ifdef __cplusplus
    extern "C" {
#endif
 
extern openm::ILog * theLog;
 
extern openm::ITrace * theTrace;
 
#ifdef __cplusplus
    }
#endif
 
#define LT(sourceMessage) ((theLog->getMessage(sourceMessage)).c_str())
 
#define NO_LT(sourceMessage) sourceMessage
 
#endif  // OM_H_LOG_H