ctb_log.h

Go to the documentation of this file.
00001 #ifndef __CTB_LOG_H__
00002 #define __CTB_LOG_H__
00003 
00004 /**
00005  * File Name  : ctb_log.h
00006  *
00007  * Description: Macros for debug printing
00008  *
00009  * The value of XXX_ON (with XXX one of LOGGING, WARNING or ERROR)
00010  * determines whether a message will be printed. The value as defined
00011  * in this file can be overruled by defining them before the inclusion of this file.
00012  *
00013  * This file is best included in c files only.
00014  */
00015 
00016 /*
00017  * This file is part of ctb.
00018  *
00019  * ctb is free software: you can redistribute it and/or modify
00020  * it under the terms of the GNU General Public License as published by
00021  * the Free Software Foundation, either version 2 of the License, or
00022  * (at your option) any later version.
00023  *
00024  * ctb is distributed in the hope that it will be useful,
00025  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00026  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00027  * GNU General Public License for more details.
00028  *
00029  * You should have received a copy of the GNU General Public License
00030  * along with this program. If not, see <http://www.gnu.org/licenses/>.
00031  */
00032 
00033 /**
00034  * Copyright (C) 2008 iRex Technologies B.V.
00035  * All rights reserved.
00036  */
00037 
00038 #include <stdio.h>
00039 #include "config.h"
00040 
00041 #define LOG_PREFIX PACKAGE_NAME
00042 
00043 #ifndef USE_SYSLOG
00044 #define USE_SYSLOG 0
00045 #endif
00046  
00047 #ifndef LOGGING_ON
00048 #define LOGGING_ON 0
00049 #endif
00050 
00051 #ifndef TIMING_ON
00052 #define TIMING_ON 0
00053 #endif
00054 
00055 #ifndef WARNING_ON
00056 #define WARNING_ON 1
00057 #endif
00058 
00059 #ifndef ERROR_ON
00060 #define ERROR_ON 1
00061 #endif
00062 
00063 #if (TIMING_ON)
00064 #define START_TIMER() start_duration_timer()
00065 #define STOP_TIMER() stop_duration_timer()
00066 #else
00067 #define START_TIMER()  do {} while(0)
00068 #define STOP_TIMER() do {} while(0)
00069 #endif
00070 
00071 #if (USE_SYSLOG)
00072 #include <syslog.h>
00073 #define LOG_OPEN(X) openlog(X, LOG_PID | LOG_NDELAY, LOG_USER)
00074 #define LOG_CLOSE() closelog()
00075 #else
00076 #define LOG_OPEN(X) do {} while (0)
00077 #define LOG_CLOSE() do {} while (0)
00078 #endif
00079 
00080 #if (LOGGING_ON)
00081 #if (USE_SYSLOG)
00082 #define LOGPRINTF(format, args...) syslog(LOG_INFO | LOG_USER, __FILE__ ":%d,%s() " format "\n", __LINE__, __func__ , ##args)
00083 #else
00084 #define LOGPRINTF(format, args...) fprintf(stderr, "(" LOG_PREFIX "_L)" __FILE__ ":%d,%s() " format "\n", __LINE__, __func__ , ##args)
00085 #endif
00086 #else
00087 #define LOGPRINTF(format, args...) do {} while (0)
00088 #endif
00089 
00090 #if (WARNING_ON)
00091 #if (USE_SYSLOG)
00092 #define WARNPRINTF(format, args...) syslog(LOG_WARNING | LOG_USER, __FILE__ ":%d,%s() " format "\n", __LINE__, __func__ , ##args)
00093 #else
00094 #define WARNPRINTF(format, args...) fprintf(stderr, "(" LOG_PREFIX "_W)" __FILE__ ":%d,%s() " format "\n", __LINE__, __func__ , ##args)
00095 #endif
00096 #else
00097 #define WARNPRINTF(format, args...) do {} while (0)
00098 #endif
00099 
00100 #if (ERROR_ON)
00101 #include <errno.h>
00102 #include <string.h>
00103 #if (USE_SYSLOG)
00104 #define ERRORPRINTF(format, args...) syslog(LOG_ERR | LOG_USER, __FILE__ ":%d,%s() --- " format "\n", __LINE__, __func__ , ##args)
00105 #define ERRNOPRINTF(format, args...) syslog(LOG_ERR | LOG_USER, __FILE__ ":%d,%s() --- " format ", errno [%d] [%s]\n", __LINE__, __func__ , ##args, errno, strerror(errno))
00106 #else
00107 #define ERRORPRINTF(format, args...) fprintf(stderr, "(" LOG_PREFIX "_E)" __FILE__ ":%d,%s() --- " format "\n", __LINE__, __func__ , ##args)
00108 #define ERRNOPRINTF(format, args...) fprintf(stderr, "(" LOG_PREFIX "_E)" __FILE__ ":%d,%s() --- " format ", errno [%d] [%s]\n", __LINE__, __func__ , ##args, errno, strerror(errno))
00109 #endif
00110 #else
00111 #define ERRORPRINTF(format, args...) do {} while (0)
00112 #define ERRNOPRINTF(format, args...) do {} while (0)
00113 #endif
00114 
00115 #endif // __CTB_LOG_H__