logsys.h

Go to the documentation of this file.

/*
    ------------------------------------------------------------------------------------
    LICENSE:
    ------------------------------------------------------------------------------------
    This file is part of EVEmu: EVE Online Server Emulator
    Copyright 2006 - 2021 The EVEmu Team
    For the latest information visit https://evemu.dev
    ------------------------------------------------------------------------------------
    This program 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 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
    Place - Suite 330, Boston, MA 02111-1307, USA, or go to
    http://www.gnu.org/copyleft/lesser.txt.
    ------------------------------------------------------------------------------------
    Author:     Zhur
*/


#ifndef LOGSYS_H_
#define LOGSYS_H_

/*
 *
 * Usage:
 *
 *  These are the main functions provided by logsys:
 *      - _log(TYPE, fmt, ...) - Log a message in any context
 *      - _hex(TYPE, data, length) - Log hex dump in any context.
 * Types are defined in logtypes.h
 *
 *
 *
 *
 * this is very C-ish, not C++ish, but thats how I felt like writting it
 *
 *
 *
 */

#include <execinfo.h>


#define LOG_CATEGORY(category) LOG_ ##category ,
enum LogCategory
{
    #include "logtypes.h"
    NUMBER_OF_LOG_CATEGORIES
};

#define LOG_TYPE(category, type, enabled, str) category##__##type ,
enum LogType
{
    #include "logtypes.h"
    NUMBER_OF_LOG_TYPES
};

extern const char* log_category_names[NUMBER_OF_LOG_CATEGORIES];

struct LogTypeStatus
{
    bool enabled;
    LogCategory category;
    const char *name;
    const char *display_name;
};

//expose a read-only pointer
extern const LogTypeStatus* log_type_info;

#define is_log_enabled( type ) \
    ( log_type_info[ ( type ) ].enabled )

extern void log_enable( LogType t );
extern void log_disable( LogType t );
extern void log_toggle( LogType t );

extern bool log_open_logfile( const char* filename );
extern bool log_close_logfile();

extern bool load_log_settings( const char* filename );

extern void log_message(LogType type, const char *fmt, ...);
extern void log_messageVA(LogType type, const char *fmt, va_list args);
extern void log_messageVA(LogType type, uint32 iden, const char *fmt, va_list args);
extern void log_hex(LogType type, const void *data, unsigned long length, unsigned char padding=4);
extern void log_phex(LogType type, const void *data, unsigned long length, unsigned char padding=4);

#if defined ( DISABLE_LOGSYS )
//completely disabled, this is the best I can come up with since we have no variadic macros
#   define _log( type, fmt, ... )
#   define codelog( type, fmt, ... )
#elif defined ( NO_VARIADIC_MACROS )
inline void _log( LogType type, const char* fmt, ... )
{
    va_list args;
    va_start( args, fmt );

    if( is_log_enabled( type ) )
        log_messageVA( type, fmt, args );

    va_end( args );
}
//we cannot actually implement this one without variadic
inline void codelog( LogType type, const char* fmt, ... )
{
    va_list args;
    va_start( args, fmt );

    if( is_log_enabled( type ) )
        log_messageVA( type, fmt, args );

    va_end(args);
}
#else
//we have variadic macros, hooray!
#   define _log( type, fmt, ... ) \
        if ( is_log_enabled( type ) ) \
            log_message( type, fmt, ##__VA_ARGS__ )

#   define codelog( type, fmt, ... ) \
        if ( is_log_enabled( type ) ) \
            log_message( type, "%s(%s:%d): " fmt, __FUNCTION__, __FILE__, __LINE__, ##__VA_ARGS__ )
#endif

#define _hex( type, data, len) \
    if ( is_log_enabled( type ) ) \
        log_hex( type, (const char*)data, len )

#define phex( type, data, len) \
    if ( is_log_enabled( type ) ) \
        log_phex( type, (const char*)data, len )


#endif /*LOGSYS_H_*/