git.sur5r.net Git - i3/i3/blob - include/log.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * log.c: Logging functions.
   8  *
   9  */
  10 #ifndef _LOG_H
  11 #define _LOG_H
  12
  13 #include <stdarg.h>
  14 #include <stdbool.h>
  15
  16 /** ##__VA_ARGS__ means: leave out __VA_ARGS__ completely if it is empty, that
  17    is, delete the preceding comma */
  18 #define LOG(fmt, ...) verboselog(fmt, ##__VA_ARGS__)
  19 #define ELOG(fmt, ...) errorlog("ERROR: " fmt, ##__VA_ARGS__)
  20 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, __FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
  21
  22 extern char *errorfilename;
  23 extern char *shmlogname;
  24 extern int shmlog_size;
  25
  26 /**
  27  * Initializes logging by creating an error logfile in /tmp (or
  28  * XDG_RUNTIME_DIR, see get_process_filename()).
  29  *
  30  */
  31 void init_logging(void);
  32
  33 /**
  34  * Set debug logging.
  35  *
  36  */
  37 void set_debug_logging(const bool _debug_logging);
  38
  39 /**
  40  * Set verbosity of i3. If verbose is set to true, informative messages will
  41  * be printed to stdout. If verbose is set to false, only errors will be
  42  * printed.
  43  *
  44  */
  45 void set_verbosity(bool _verbose);
  46
  47 /**
  48  * Logs the given message to stdout while prefixing the current time to it,
  49  * but only if debug logging was activated.
  50  *
  51  */
  52 void debuglog(char *fmt, ...);
  53
  54 /**
  55  * Logs the given message to stdout while prefixing the current time to it.
  56  *
  57  */
  58 void errorlog(char *fmt, ...);
  59
  60 /**
  61  * Logs the given message to stdout while prefixing the current time to it,
  62  * but only if verbose mode is activated.
  63  *
  64  */
  65 void verboselog(char *fmt, ...);
  66
  67 /**
  68  * Logs the given message to stdout while prefixing the current time to it.
  69  * This is to be called by LOG() which includes filename/linenumber
  70  *
  71  */
  72 void slog(char *fmt, va_list args);
  73
  74 #endif