logger.h

Go to the documentation of this file.

/*
 *
 *                 #####    #####   ######  ######  ###   ###
 *               ##   ##  ##   ##  ##      ##      ## ### ##
 *              ##   ##  ##   ##  ####    ####    ##  #  ##
 *             ##   ##  ##   ##  ##      ##      ##     ##
 *            ##   ##  ##   ##  ##      ##      ##     ##
 *            #####    #####   ##      ######  ##     ##
 *
 *
 *             OOFEM : Object Oriented Finite Element Code
 *
 *               Copyright (C) 1993 - 2025   Borek Patzak
 *
 *
 *
 *       Czech Technical University, Faculty of Civil Engineering,
 *   Department of Structural Mechanics, 166 29 Prague, Czech Republic
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This program 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef logger_h
#define logger_h
 
#include "oofemenv.h"
//#include "util.h"
 
#include <cstdio>
#include <string>
#ifdef __MPI_PARALLEL_MODE
#include <mpi.h>
#endif
 
// MSVC doesn't properly implement C99. (might need to wrap __func__ behind a macro to support all platforms correctly(?))
#ifdef _MSC_VER
# define __func__ __FUNCTION__
#endif
 
namespace oofem {
class OOFEM_EXPORT Logger
{
public:
    enum logLevelType {
        LOG_LEVEL_FORCED=-1,
        LOG_LEVEL_FATAL=0, LOG_LEVEL_ERROR=0,
        LOG_LEVEL_WARNING = 1,
        LOG_LEVEL_RELEVANT = 2,
        LOG_LEVEL_INFO = 3,
        LOG_LEVEL_ALL = 4, LOG_LEVEL_DEBUG = 4
    };
protected:
    FILE *logStream, *errStream;
    bool closeFlag, errCloseFlag;
    logLevelType logLevel;
    int numberOfWrn, numberOfErr;
#ifdef __MPI_PARALLEL_MODE
    MPI_Comm comm;
#endif
public:
    Logger(logLevelType level);
    ~Logger();
    void appendLogTo(const std :: string &fname);
    void appendErrorTo(const std :: string &fname);
    void appendLogTo(FILE* stream);
    void appendErrorTo(FILE* stream);
#ifdef __MPI_PARALLEL_MODE
    void setComm(MPI_Comm comm);
#endif

    void writeLogMsg(logLevelType level, const char *format, ...)
        #if defined(__GNUC__) || defined (__clang)
            __attribute__((format(printf, 3, 4)))
    #endif
    ;
    void writeELogMsg(logLevelType level, const char *_func, const char *_file, int _line, const char *format, ...)
        #if defined(__GNUC__) || defined (__clang)
            __attribute__((format(printf, 6, 7)))
        #endif
    ;
    void flush() { fflush(logStream); fflush(errStream); }

    void setLogLevel(logLevelType level) { logLevel = level; }
    void setLogLevel(int level);
    void incrementErrorCounter() {numberOfErr++;}
    void printStatistics();
    void getNumberOfWarningsAndErrors(int& nwrns, int &nerrs) {
      nwrns = numberOfWrn;
      nerrs = numberOfErr;
    }
 
protected:
    const char *giveLevelName(logLevelType l) const;
};
 
extern OOFEM_EXPORT Logger oofem_logger;

#define OOFEM_LOG_FATAL(...) oofem_logger.writeELogMsg(Logger :: LOG_LEVEL_FATAL, __func__, __FILE__, __LINE__, __VA_ARGS__)
#define OOFEM_LOG_ERROR(...) oofem_logger.writeELogMsg(Logger :: LOG_LEVEL_ERROR, __func__, __FILE__, __LINE__, __VA_ARGS__)
#define OOFEM_LOG_WARNING(...) oofem_logger.writeELogMsg(Logger :: LOG_LEVEL_WARNING,  __func__, __FILE__, __LINE__, __VA_ARGS__)
 
#define OOFEM_LOG_FORCED(...) oofem_logger.writeLogMsg(Logger :: LOG_LEVEL_FORCED, __VA_ARGS__)
#define OOFEM_LOG_RELEVANT(...) oofem_logger.writeLogMsg(Logger :: LOG_LEVEL_RELEVANT, __VA_ARGS__)
#define OOFEM_LOG_INFO(...) oofem_logger.writeLogMsg(Logger :: LOG_LEVEL_INFO, __VA_ARGS__)
#define OOFEM_LOG_DEBUG(...) oofem_logger.writeLogMsg(Logger :: LOG_LEVEL_DEBUG, __VA_ARGS__)
} // end namespace oofem
#endif // logger_h