logger.h

Go to the documentation of this file.

/***************************************************************************\
* Copyright (c) 2008, Claudio Pica                                          *   
* All rights reserved.                                                      * 
\***************************************************************************/
 
#ifndef LOGGER_H
#define LOGGER_H
 
#include "input_par.h"
#include <stdarg.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ***********************************************
 * Simple output logging facility
 * ***********************************************
 * SYNOPIS: 
 *
 * Messages outputted through the function
 * 
 * int lprintf(char *name, int level, char*, ...);
 * 
 * where name is an ID, level defines a log level,
 * can be written to file streams according to a
 * specified map. The map name => filename is 
 * defined (and can be modified) using the library
 * functions:
 *
 * int logger_map(char *name, char *filename);
 * int logger_unmap(char *name);
 * int logger_unmap_all();
 *
 * All unmapped IDs are written to the logger
 * stdout stream which can be set using:
 *
 * int logger_stdout(char *filename);
 *
 * (default = program stdout)
 *
 * ***********************************************/
 
/* map the ID name to the file with name filename 
 * filename can start with ">>" in which case the file
 * is open in append mode
 *
 * Returns:
 * 0 => success
 * 1 => invalid name
 * 2 => invalid filename
 * 3 => cannot open new file
 */
int logger_map(char *name, char *filename);
 
/* unmap the ID name
 * all subsequent calls to lprintf with this ID
 * are mapped to the logger stdout
 * If the function fails the mapping is unchanged
 *
 * Returns:
 * 0 => success
 * 1 => invalid name
 */
int logger_unmap(char *name);
 
/* reset the logger:
 * all mappings are deleted
 * all verbosity levels are deleted
 * default verbosity level is set to 0
 * logger stdout is mapped to application stdout
 */
int logger_reset();
 
/* set the logger stdout stream
 * if filename=0 this function reset the stream to the 
 * program stdout
 * NB: if filename is already open as a logger stream that stream become
 * the logger stdout and all previously names mapped to that stream now write
 * to stdout. If stdout is then changed all those names are written to a different 
 * stream.
 *
 * return codes:
 * 0 => success
 * 1 => failed to open new file (old logger stdout remains unchanged)
 */
int logger_stdout(char *filename);
 
void logger_set_input(input_logger *logger);
 
/* set verbosity level of the logger 
 * if name==0 then set the default level
 */
void logger_setlevel(char *name, int v);
int logger_getlevel(char *name);
/* reset verbosity level for name to stardard level */
void logger_rmlevel(char *name);
 
/* Global enable/disable functions */
void logger_enable();
void logger_disable();
 
/* log function 
 * write to the mapped stream if message level
 * is not bigger than the logger verbosity level
 *
 * arguments:
 * name -> ID of the log stream 
 * level -> log level of the message
 * format -> the same as printf
 *
 * return value:
 * the same as printf
 *
 */
int lprintf(const char *name, int level, const char *format, ...);
 
int vlprintf(const char *name, int level, const char *format, va_list args);
 
#ifdef __cplusplus
}
#endif
#endif