csvlog.h

Go to the documentation of this file.

/********************************************************************************
 * Copyright (C) 2017-2020 German Aerospace Center (DLR). 
 * Eclipse ADORe, Automated Driving Open Research https://eclipse.org/adore
 *
 * This program and the accompanying materials are made available under the 
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 
 *
 * Contributors: 
 *   Robert Markowski - initial API and implementation
 ********************************************************************************/
 
#pragma once
 
#include <stdarg.h>
#include <stdio.h>
#include <string>
#include <sstream>
#include <iostream>
#include <ctime>
 
#define LOG_T(...)  if (CSVLog::getCurrentLogLevelConsole()<=CSVLog::_TRACE) \
                            CSVLog::getInstance().logTraceConsole(__VA_ARGS__); \
                    if (CSVLog::getInstance().hasFile() && CSVLog::getCurrentLogLevelFile()<=CSVLog::_TRACE) \
                            CSVLog::getInstance().logTraceFile(__VA_ARGS__)
 
#define LOG_I(...)  if (CSVLog::getCurrentLogLevelConsole()<=CSVLog::_INFO) \
                            CSVLog::getInstance().logInfoConsole(__VA_ARGS__); \
                    if (CSVLog::getInstance().hasFile() && CSVLog::getCurrentLogLevelFile()<=CSVLog::_INFO) \
                            CSVLog::getInstance().logInfoFile(__VA_ARGS__)
 
#define LOG_W(...)  if (CSVLog::getCurrentLogLevelConsole()<=CSVLog::_WARNING) \
                            CSVLog::getInstance().logWarningConsole(__VA_ARGS__); \
                    if (CSVLog::getInstance().hasFile() && CSVLog::getCurrentLogLevelFile()<=CSVLog::_WARNING) \
                            CSVLog::getInstance().logWarningFile(__VA_ARGS__)
 
#define LOG_E(...)  if (CSVLog::getCurrentLogLevelConsole()<=CSVLog::_ERROR) \
                            CSVLog::getInstance().logErrorConsole(__VA_ARGS__); \
                    if (CSVLog::getInstance().hasFile() && CSVLog::getCurrentLogLevelFile()<=CSVLog::_ERROR) \
                            CSVLog::getInstance().logErrorFile(__VA_ARGS__)
 
#define LOG_SET_LVL_FROM_CONSOLE(...) CSVLog::getInstance().setLogLevelFromConsole()
 
#define LOG_SET_LVL_T(...) CSVLog::getInstance().setLogLevel(CSVLog::_TRACE)
 
#define LOG_SET_LVL_I(...) CSVLog::getInstance().setLogLevel(CSVLog::_INFO)
 
#define LOG_SET_LVL_W(...) CSVLog::getInstance().setLogLevel(CSVLog::_WARNING)
 
#define LOG_SET_LVL_E(...) CSVLog::getInstance().setLogLevel(CSVLog::_ERROR)
 
#define LOG_SET_LVL_CONSOLE_T(...) CSVLog::getInstance().setLogLevelConsole(CSVLog::_TRACE)
 
#define LOG_SET_LVL_CONSOLE_I(...) CSVLog::getInstance().setLogLevelConsole(CSVLog::_INFO)
 
#define LOG_SET_LVL_CONSOLE_W(...) CSVLog::getInstance().setLogLevelConsole(CSVLog::_WARNING)
 
#define LOG_SET_LVL_CONSOLE_E(...) CSVLog::getInstance().setLogLevelConsole(CSVLog::_ERROR)
 
#define LOG_SET_LVL_FILE_T(...) CSVLog::getInstance().setLogLevelFile(CSVLog::_TRACE)
 
#define LOG_SET_LVL_FILE_I(...) CSVLog::getInstance().setLogLevelFile(CSVLog::_INFO)
 
#define LOG_SET_LVL_FILE_W(...) CSVLog::getInstance().setLogLevelFile(CSVLog::_WARNING)
 
#define LOG_SET_LVL_FILE_E(...) CSVLog::getInstance().setLogLevelFile(CSVLog::_ERROR)
 
 
#define LOG_SET_SEPERATOR(char_seperator) CSVLog::getInstance().setSeperator(char_seperator)
 
#define LOG_SET_MAXLINES_FILE(int_maxLines) CSVLog::getInstance().setMaxLinesFile(int_maxLines)
 
#define LOG_SET_MAXLINES_BUFFER(int_maxLines) CSVLog::getInstance().setMaxLinesBuffer(int_maxLines)
 
#define LOG_SET_TIMESTAMPVERSION(timestampversion_tsv) CSVLog::getInstance().setTimestampVersion(timestampversion_tsv)
 
#define LOG_SET_LOWTHROUGHPUTMODE(bool_active) CSVLog::getInstance().setLowThroughputMode(bool_active)
 
#define LOG_SET_MAXTIMEBETWEENWRITES(double_time_seconds) CSVLog::getInstance().setTimeBetweenWrites(double_time_seconds)
 
#define LOG_INIT(string_filename) CSVLog::getInstance().init(string_filename)
 
class CSVLog
{
public:
    CSVLog();
 
    virtual ~CSVLog();
 
    static CSVLog& getInstance();
 
    enum LogLevel{
        _TRACE,
        _INFO,
        _WARNING,
        _ERROR
    };
 
    enum TimestampVersion{
        _TIMEOFDAY,
        _EPOCH
    };
    
    void init(std::string filename);
 
    void setLogLevel(LogLevel lvl);
 
    void setLogLevelFromConsole();
 
    void setLogLevelFile(LogLevel lvl);
 
    void setLogLevelConsole(LogLevel lvl);
 
    void setTimestampVersion(TimestampVersion tsv);
 
    void setSeperator(char seperator);
 
    void setMaxLinesBuffer(int numLines);
 
    void setMaxLinesFile(int numLines);
 
    void setLowThroughputMode(bool b);
 
    void setTimeBetweenWrites(double time_seconds);
 
    static LogLevel& getCurrentLogLevelFile();
 
    static LogLevel& getCurrentLogLevelConsole();
    
    void logTrace(const char *format, ...);
 
    void logTraceConsole(const char *format, ...);
 
    void logTraceFile(const char *format, ...);
 
    void logInfo(const char *format, ...);
 
    void logInfoConsole(const char *format, ...);
 
    void logInfoFile(const char *format, ...);
 
    void logWarning(const char *format, ...);
 
    void logWarningConsole(const char *format, ...);
 
    void logWarningFile(const char *format, ...);
 
    void logError(const char *format, ...);
 
    void logErrorConsole(const char *format, ...);
 
    void logErrorFile(const char *format, ...);
 
    bool hasFile();
 
private:
    CSVLog(const CSVLog&);
    void operator=(CSVLog const&);
 
    char _seperator;
    int _linecountBuffer;
    int _linecountFile;
    int _maxLinesBuffer;
    int _maxLinesFile;
    double _maxTimeBetweenWrites;
    bool _useFile;
    bool _lowThroughputMode;
    TimestampVersion _timestampVersion;
    std::string _filename;
    std::string _currentFilename;
    std::ostringstream os;
 
    std::clock_t _lastWriteTime;
    
    void writeLog(std::string msg, LogLevel lvl);   
 
    void writeLogToConsole(std::string time, std::string msg, LogLevel lvl);
 
    void writeLogToBuffer(std::string time, std::string msg, LogLevel lvl);
 
    void writeBufferToFile();
 
    void logConsole(std::string msg, LogLevel lvl);
 
    void logFile(std::string msg, LogLevel lvl);
 
    std::string getCurrentTime();
 
    std::string getCurrentTimeEpoch();
 
    std::string lvlToString(LogLevel lvl);
 
    int lvlToConsoleColor(LogLevel lvl);
 
    std::string lvlToConsoleColorLinux(LogLevel lvl);
};