lib/logging.h

   1 /** \file logging.h
   2  *  \brief Header: provides a log file to ease tracing the program
   3  */
   4
   5 #ifndef MC_LOGGING_H
   6 #define MC_LOGGING_H
   7
   8 /*
   9    This file provides an easy-to-use function for writing all kinds of
  10    events into a central log file that can be used for debugging.
  11  */
  12
  13 /*** typedefs(not structures) and defined constants **********************************************/
  14
  15 #define mc_log_mark() mc_log("%s:%d\n",__FILE__,__LINE__)
  16
  17 /*** enums ***************************************************************************************/
  18
  19 /*** structures declarations (and typedefs of structures)*****************************************/
  20
  21 /*** global variables defined in .c file *********************************************************/
  22
  23 /*** declarations of public functions ************************************************************/
  24
  25 /* *INDENT-OFF* */
  26 void mc_log (const char *fmt, ...) G_GNUC_PRINTF (1, 2);
  27 void mc_always_log (const char *fmt, ...) G_GNUC_PRINTF (1, 2);
  28 /* *INDENT-ON* */
  29
  30 /*** inline functions ****************************************************************************/
  31
  32 #endif