logger.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  This file is part of The ManaPlus Client.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  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 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/>.
 */
 
#ifndef LOGGER_H
#define LOGGER_H
 
#include "localconsts.h"
 
#include "utils/vector.h"
 
PRAGMA48(GCC diagnostic push)
PRAGMA48(GCC diagnostic ignored "-Wshadow")
#include <SDL_mutex.h>
PRAGMA48(GCC diagnostic pop)
 
#include <string>
 
#ifdef ENABLEDEBUGLOG
#define DEBUGLOG(str) \
    if (logger && !mIgnore) \
        logger->dlog(str)
#define DEBUGLOG2(str, pos, comment) \
    if (logger && !mIgnore) \
        logger->dlog2(str, pos, comment)
#define DEBUGLOGSTR(str) \
    if (logger) \
        logger->dlog(str)
#define IGNOREDEBUGLOG mIgnore = Net::isIgnorePacket(mId)
#else  // ENABLEDEBUGLOG
#define DEBUGLOG(str) {}
#define DEBUGLOG2(str, comment) {}
#define DEBUGLOGSTR(str)
#define IGNOREDEBUGLOG {}
#endif  // ENABLEDEBUGLOG
 
#define UNIMPLEMENTEDPACKET \
    logger->unimplemented(msg.getId())
 
#define UNIMPLEMENTEDPACKETFIELD(field) \
    logger->unimplemented(msg.getId(), field)
 
#define WRONGPACKETSIZE \
    logger->unimplemented(CAST_U32(mId), mLength, mPos)
 
class Logger final
{
    public:
        Logger();
 
        A_DELETE_COPY(Logger)
 
        
        ~Logger();
 
        void setLogFile(const std::string &logFilename);
 
        void setLogToStandardOut(const bool value)
        { mLogToStandardOut = value; }
 
        void log(const char *const log_text, ...) A_NONNULL(2)
#ifdef __GNUC__
#ifdef __OpenBSD__
 
            __attribute__((__format__(printf, 2, 3)))
#else  // __OpenBSD__
 
#ifdef BAD_CILKPLUS
            __attribute__((__format__(gnu_printf, 1, 2)))
#else  // BAD_CILKPLUS
 
            __attribute__((__format__(gnu_printf, 2, 3)))
#endif  // BAD_CILKPLUS
 
#endif  // __OpenBSD__
#endif  // __GNUC__
            ;
 
        void assertLog(const char *const log_text, ...) A_NONNULL(2)
#ifdef __GNUC__
#ifdef __OpenBSD__
 
            __attribute__((__format__(printf, 2, 3)))
#else  // __OpenBSD__
 
#ifdef BAD_CILKPLUS
            __attribute__((__format__(gnu_printf, 1, 2)))
#else  // BAD_CILKPLUS
 
            __attribute__((__format__(gnu_printf, 2, 3)))
#endif  // BAD_CILKPLUS
 
#endif  // __OpenBSD__
#endif  // __GNUC__
            ;
 
        void log_r(const char *const log_text, ...) A_NONNULL(2)
#ifdef __GNUC__
#ifdef __OpenBSD__
            __attribute__((__format__(printf, 2, 3)))
#else  // __OpenBSD__
 
#ifdef BAD_CILKPLUS
            __attribute__((__format__(gnu_printf, 1, 2)))
#else  // BAD_CILKPLUS
 
            __attribute__((__format__(gnu_printf, 2, 3)))
#endif  // BAD_CILKPLUS
 
#endif  // __OpenBSD__
#endif  // __GNUC__
            ;
 
        void log1(const char *const log_text) A_NONNULL(2);
 
        void log(const std::string &str);
 
        void flush();
 
#ifdef ENABLEDEBUGLOG
        void dlog(const std::string &str);
 
        void dlog2(const std::string &str,
                   const int pos,
                   const char* const comment);
#endif  // ENABLEDEBUGLOG
 
        void closeFile();
 
        void setDebugLog(const bool n)
        { mDebugLog = n; }
 
        void setReportUnimplemented(const bool n)
        { mReportUnimplemented = n; }
 
        void error(const std::string &error_text)
#ifndef BAD_CILKPLUS
        __attribute__ ((noreturn))
#endif  // BAD_CILKPLUS
        ;
 
        void safeError(const std::string &error_text)
#ifndef BAD_CILKPLUS
        __attribute__ ((noreturn))
#endif  // BAD_CILKPLUS
        ;
 
        void unimplemented(const int id);
 
        void unimplemented(const int id,
                           const int id2);
 
        void unimplemented(const uint32_t id,
                           const uint32_t id2,
                           const uint32_t id3) const;
 
        FILE *getFile() const;
 
    private:
        FILE *mLogFile;
        STD_VECTOR<std::string> mDelayedLog;
        SDL_mutex *mMutex;
        volatile bool mThreadLocked;
        bool mLogToStandardOut;
        bool mDebugLog;
        bool mReportUnimplemented;
};
 
extern Logger *logger;
 
#endif  // LOGGER_H