src/verbose.h

   1 /*
   2  Copyright (C) 2016-2019 "IoT.bzh"
   3
   4  author: José Bollo <jose.bollo@iot.bzh>
   5
   6  Licensed under the Apache License, Version 2.0 (the "License");
   7  you may not use this file except in compliance with the License.
   8  You may obtain a copy of the License at
   9
  10      http://www.apache.org/licenses/LICENSE-2.0
  11
  12  Unless required by applicable law or agreed to in writing, software
  13  distributed under the License is distributed on an "AS IS" BASIS,
  14  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  See the License for the specific language governing permissions and
  16  limitations under the License.
  17 */
  18
  19 #pragma once
  20
  21 #include <stdarg.h>
  22
  23 /*
  24   verbosity tune the count of reported messages
  25
  26    verbosity value : reported messages
  27    ----------------+------------------------
  28     lesser than 0  : no message at all
  29          0         : ERROR
  30          1         : ERROR, WARNING
  31          2         : ERROR, WARNING, NOTICE
  32          3         : ERROR, WARNING, NOTICE, INFO
  33     greater than 3 : ERROR, WARNING, NOTICE, INFO, DEBUG
  34
  35 extern int verbosity;
  36
  37 enum verbosity_levels
  38 {
  39         Verbosity_Level_Error = 0,
  40         Verbosity_Level_Warning = 1,
  41         Verbosity_Level_Notice = 2,
  42         Verbosity_Level_Info = 3,
  43         Verbosity_Level_Debug = 4
  44 };
  45 */
  46
  47 extern void verbose_set_name(const char *name, int authority);
  48
  49 /*
  50  Log level is defined by syslog standard:
  51        KERN_EMERG             0        System is unusable
  52        KERN_ALERT             1        Action must be taken immediately
  53        KERN_CRIT              2        Critical conditions
  54        KERN_ERR               3        Error conditions
  55        KERN_WARNING           4        Warning conditions
  56        KERN_NOTICE            5        Normal but significant condition
  57        KERN_INFO              6        Informational
  58        KERN_DEBUG             7        Debug-level messages
  59 */
  60
  61 enum
  62 {
  63         Log_Level_Emergency = 0,
  64         Log_Level_Alert = 1,
  65         Log_Level_Critical = 2,
  66         Log_Level_Error = 3,
  67         Log_Level_Warning = 4,
  68         Log_Level_Notice = 5,
  69         Log_Level_Info = 6,
  70         Log_Level_Debug = 7
  71 };
  72
  73 extern int logmask;
  74
  75 extern void verbose(int loglevel, const char *file, int line, const char *function, const char *fmt, ...) __attribute__((format(printf, 5, 6)));
  76 extern void vverbose(int loglevel, const char *file, int line, const char *function, const char *fmt, va_list args);
  77
  78 #if defined(VERBOSE_NO_DATA)
  79 # define __VERBOSE__(lvl,...)      do{if((lvl)<=Log_Level_Error) verbose(lvl, __FILE__, __LINE__, NULL, __VA_ARGS__)\
  80                                         else verbose(lvl, __FILE__, __LINE__, NULL, NULL);}while(0)
  81 #elif defined(VERBOSE_NO_DETAILS)
  82 # define __VERBOSE__(lvl,...)      verbose(lvl, NULL, 0, NULL, __VA_ARGS__)
  83 #else
  84 # define __VERBOSE__(lvl,...)      verbose(lvl, __FILE__, __LINE__, __func__, __VA_ARGS__)
  85 #endif
  86
  87 #define _LOGMASK_(lvl)          ((lvl) < 0 ? -1 : (1 << (lvl)))
  88 #define _WANTLOG_(lvl)          (logmask & _LOGMASK_(lvl))
  89 #define _VERBOSE_(lvl,...)      do{ if (_WANTLOG_(lvl)) __VERBOSE__((lvl), __VA_ARGS__); } while(0)
  90
  91 #define EMERGENCY(...)            _VERBOSE_(Log_Level_Emergency, __VA_ARGS__)
  92 #define ALERT(...)                _VERBOSE_(Log_Level_Alert, __VA_ARGS__)
  93 #define CRITICAL(...)             _VERBOSE_(Log_Level_Critical, __VA_ARGS__)
  94 #define ERROR(...)                _VERBOSE_(Log_Level_Error, __VA_ARGS__)
  95 #define WARNING(...)              _VERBOSE_(Log_Level_Warning, __VA_ARGS__)
  96 #define NOTICE(...)               _VERBOSE_(Log_Level_Notice, __VA_ARGS__)
  97 #define INFO(...)                 _VERBOSE_(Log_Level_Info, __VA_ARGS__)
  98 #define DEBUG(...)                _VERBOSE_(Log_Level_Debug, __VA_ARGS__)
  99
 100 #define LOGUSER(app)              verbose_set_name(app,0)
 101 #define LOGAUTH(app)              verbose_set_name(app,1)
 102
 103 extern void (*verbose_observer)(int loglevel, const char *file, int line, const char *function, const char *fmt, va_list args);
 104
 105 static inline int verbose_wants(int lvl) { return _WANTLOG_(lvl); }
 106
 107 extern void verbose_dec();
 108 extern void verbose_inc();
 109 extern void verbose_clear();
 110 extern void verbose_add(int level);
 111 extern void verbose_sub(int level);
 112 extern void verbose_colorize();
 113 extern int verbose_is_colorized();
 114
 115 extern int verbose_level_of_name(const char *name);
 116 extern const char *verbose_name_of_level(int level);
 117
 118 #define _DEVERBOSITY_(vlvl)     ((vlvl) + Log_Level_Error)
 119 #define _VERBOSITY_(llvl)       ((llvl) - Log_Level_Error)
 120 extern int verbosity_get();
 121 extern void verbosity_set(int verbo);
 122 extern int verbosity_from_mask(int mask);
 123 extern int verbosity_to_mask(int verbo);
 124
 125 #define COLOR_EMERGENCY "\x1B[101m"
 126 #define COLOR_ALERT     "\x1B[43m"
 127 #define COLOR_CRITICAL  "\x1B[41m"
 128 #define COLOR_ERROR     "\x1B[91m"
 129 #define COLOR_WARNING   "\x1B[93m"
 130 #define COLOR_NOTICE    "\x1B[94m"
 131 #define COLOR_INFO      "\x1B[96m"
 132 #define COLOR_DEBUG     "\x1B[95m"
 133 #define COLOR_API       "\x1B[1m"
 134 #define COLOR_FILE      "\x1B[90m"
 135 #define COLOR_DEFAULT   "\x1B[0m"
 136