logging.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef ROFL_PIPELINE_LOG_H_
#define ROFL_PIPELINE_LOG_H_

#include <stdlib.h>
#include <stdio.h>
#include "rofl.h"

//If DEBUG is not defined, set pipeline to NOT log
#ifdef DEBUG
        #define ROFL_PIPELINE_LOGGING_ENABLED
#endif

//Define debug levels
enum rofl_pipeline_debug_levels {
        PIPELINE_UNDEF_DEBUG_LEVEL = -1,        /* Undefined debug level */
        //PIPELINE_EMERGENCY,                   /* system is unusable */
        //PIPELINE_ALERT,                       /* action must be taken immediately */
        //PIPELINE_CRITICAL,                    /* critical conditions */
        PIPELINE_ERROR,                         /* error conditions */
        PIPELINE_WARN,                          /* warning conditions */
        //PIPELINE_NOTICE,                      /* normal but significant condition */
        PIPELINE_INFO,                          /* informational */
        PIPELINE_DBG,                           /* debug-level messages */
        PIPELINE_MAX_DEBUG_LEVEL                /* DO NOT USE */

        /* do not put anything beyond MAX_DEBUG_LEVEL! */
};

//Debug classes (not used currently)
enum rofl_pipeline_debug_class {
        PIPELINE_UNDEF_DEBUG_CLASS = -1,        /* Undefined debug level */
        PIPELINE_DEFAULT = 0,                   /* todo name it correct */
        PIPELINE_MAX_DEBUG_CLASS                /* DO NOT USE */

        /* do not put anything beyond MAX_DEBUG_CLASS! */
};

//Default value DBG
#define ROFL_PIPELINE_DBG_DEFAULT { PIPELINE_DBG } /* default for each class */

//Fwd declarations
extern enum rofl_pipeline_debug_levels rofl_pipeline_debug_level[PIPELINE_MAX_DEBUG_CLASS];
extern int (*rofl_pipeline_debug_print)(FILE *stream, const char *format, ...);

//Define macros
#ifdef ROFL_PIPELINE_LOGGING_ENABLED
        #define ROFL_PIPELINE_DEBUG_CHECK(cn, level)  \
            ( rofl_pipeline_debug_level[cn] >= level )
        #define ROFL_PIPELINE_DEBUG_PRINT(fd, cn, level, stuff, ...)  \
            do{\
                if (ROFL_PIPELINE_DEBUG_CHECK(cn, level) && *rofl_pipeline_debug_print != NULL){ \
                        rofl_pipeline_debug_print(fd,"[rofl-pipeline] "stuff, ##__VA_ARGS__);\
                }\
            }while(0)

        #define ROFL_PIPELINE_DEBUG_PRINT_NO_PREFIX(fd, cn, level, stuff, ...)  \
            do{\
                if (ROFL_PIPELINE_DEBUG_CHECK(cn, level) && *rofl_pipeline_debug_print != NULL){ \
                        rofl_pipeline_debug_print(fd,stuff, ##__VA_ARGS__);\
                }\
            }while(0)


        #define ROFL_PIPELINE_WARN(stuff,...) \
                ROFL_PIPELINE_DEBUG_PRINT(stderr, PIPELINE_DEFAULT, PIPELINE_WARN, stuff, ##__VA_ARGS__)

        #define ROFL_PIPELINE_ERR(stuff, ...)          \
                ROFL_PIPELINE_DEBUG_PRINT(stderr, PIPELINE_DEFAULT, PIPELINE_ERROR, stuff, ##__VA_ARGS__)

        #define ROFL_PIPELINE_INFO(stuff,...) \
                ROFL_PIPELINE_DEBUG_PRINT(stderr, PIPELINE_DEFAULT, PIPELINE_INFO, stuff, ##__VA_ARGS__)

        #define ROFL_PIPELINE_INFO_NO_PREFIX(stuff,...) \
                ROFL_PIPELINE_DEBUG_PRINT_NO_PREFIX(stderr, PIPELINE_DEFAULT, PIPELINE_INFO, stuff, ##__VA_ARGS__)

        #define ROFL_PIPELINE_DEBUG(stuff, ...)        \
                ROFL_PIPELINE_DEBUG_PRINT(stderr, PIPELINE_DEFAULT, PIPELINE_DBG, stuff, ##__VA_ARGS__)

        #define ROFL_PIPELINE_DEBUG_NO_PREFIX(stuff, ...)        \
                ROFL_PIPELINE_DEBUG_PRINT_NO_PREFIX(stderr, PIPELINE_DEFAULT, PIPELINE_DBG, stuff, ##__VA_ARGS__)
#else
        //No logging
        #define ROFL_PIPELINE_DEBUG_CHECK(stuff, ...) do{}while(0)
        #define ROFL_PIPELINE_DEBUG_PRINT(stuff, ...) do{}while(0)             /* ROFL_PIPELINE_DEBUG_CHECK */
        #define ROFL_PIPELINE_WARN(stuff, ...) do{}while(0)
        #define ROFL_PIPELINE_ERR(stuff, ...) do{}while(0)
        #define ROFL_PIPELINE_INFO(stuff,...) do{}while(0)
        #define ROFL_PIPELINE_INFO_NO_PREFIX(stuff,...) do{}while(0)
        #define ROFL_PIPELINE_DEBUG(stuff, ...) do{}while(0)
        #define ROFL_PIPELINE_DEBUG_NO_PREFIX(stuff, ...) do{}while(0)
#endif //ROFL_PIPELINE_NO_LOGGING

//C++ extern C
ROFL_BEGIN_DECLS

//API to capture logging events in the pipeline 
void rofl_pipeline_set_logging_function(int (*logging_func)(FILE *stream, const char *format, ...));

//API to set level 
void rofl_pipeline_set_logging_level(/*cn,*/ enum rofl_pipeline_debug_levels level);

//C++ extern C
ROFL_END_DECLS

#endif /* ROFL_PIPELINE_LOG_H_ */