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 I3_LOG_H
  11 #define I3_LOG_H
  12
  13 #include <stdarg.h>
  14 #include <stdbool.h>
  15
  16 /* We will include libi3.h which define its own version of LOG, ELOG.
  17  * We want *our* version, so we undef the libi3 one. */
  18 #if defined(LOG)
  19 #undef LOG
  20 #endif
  21 #if defined(ELOG)
  22 #undef ELOG
  23 #endif
  24 /** ##__VA_ARGS__ means: leave out __VA_ARGS__ completely if it is empty, that
  25    is, delete the preceding comma */
  26 #define LOG(fmt, ...) verboselog(fmt, ##__VA_ARGS__)
  27 #define ELOG(fmt, ...) errorlog("ERROR: " fmt, ##__VA_ARGS__)
  28 #define DLOG(fmt, ...) debuglog("%s:%s:%d - " fmt, I3__FILE__, __FUNCTION__, __LINE__, ##__VA_ARGS__)
  29
  30 extern char *errorfilename;
  31 extern char *shmlogname;
  32 extern int shmlog_size;
  33
  34 /**
  35  * Initializes logging by creating an error logfile in /tmp (or
  36  * XDG_RUNTIME_DIR, see get_process_filename()).
  37  *
  38  */
  39 void init_logging(void);
  40
  41 /**
  42  * Opens the logbuffer.
  43  *
  44  */
  45 void open_logbuffer(void);
  46
  47 /**
  48  * Closes the logbuffer.
  49  *
  50  */
  51 void close_logbuffer(void);
  52
  53 /**
  54  * Checks if debug logging is active.
  55  *
  56  */
  57 bool get_debug_logging(void);
  58
  59 /**
  60  * Set debug logging.
  61  *
  62  */
  63 void set_debug_logging(const bool _debug_logging);
  64
  65 /**
  66  * Set verbosity of i3. If verbose is set to true, informative messages will
  67  * be printed to stdout. If verbose is set to false, only errors will be
  68  * printed.
  69  *
  70  */
  71 void set_verbosity(bool _verbose);
  72
  73 /**
  74  * Logs the given message to stdout while prefixing the current time to it,
  75  * but only if debug logging was activated.
  76  *
  77  */
  78 void debuglog(char *fmt, ...)
  79     __attribute__ ((format (printf, 1, 2)));
  80
  81 /**
  82  * Logs the given message to stdout while prefixing the current time to it.
  83  *
  84  */
  85 void errorlog(char *fmt, ...)
  86     __attribute__ ((format (printf, 1, 2)));
  87
  88 /**
  89  * Logs the given message to stdout while prefixing the current time to it,
  90  * but only if verbose mode is activated.
  91  *
  92  */
  93 void verboselog(char *fmt, ...)
  94     __attribute__ ((format (printf, 1, 2)));
  95
  96 /**
  97  * Deletes the unused log files. Useful if i3 exits immediately, eg.
  98  * because --get-socketpath was called. We don't care for syscall
  99  * failures. This function is invoked automatically when exiting.
 100  */
 101 void purge_zerobyte_logfile(void);
 102
 103 #endif