ccl-log.h

Go to the documentation of this file.

/*
 * ccl-log.h -- Message displayer 
 * 
 * This file is a part of the C Common Library (CCL) project. 
 * 
 * Copyright (C) 2010 CNRS UMR 5800 & Université Bordeaux I (see AUTHORS file).
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the AltaRica Public License that comes with this
 * package.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
 */

#ifndef __CCL_LOG_H__
# define __CCL_LOG_H__

# include <stdio.h>
# include <ccl/ccl-common.h>

BEGIN_C_DECLS

enum ccl_log_type_enum {
  CCL_LOG_DISPLAY = 0, 
  CCL_LOG_WARNING,     
  CCL_LOG_ERROR,       
  CCL_LOG_DEBUG,       
  CCL_LOG_PANIC,       
  CCL_LOG_USR1,        
  CCL_LOG_USR2,        
  CCL_LOG_NB_TYPES
};

typedef enum ccl_log_type_enum ccl_log_type;

typedef void ccl_log_proc (ccl_log_type type, const char  *msg, void *data);

extern int ccl_debug_is_on;

extern void
ccl_log_add_listener (ccl_log_proc *proc, void *data);

extern void
ccl_log_remove_listener (ccl_log_proc *proc);

extern int
ccl_log_has_listener (void);

extern void
ccl_log_push_redirection (ccl_log_type type, ccl_log_proc *proc, void *data);

extern void
ccl_log_pop_redirection (ccl_log_type type);

extern void
ccl_log (ccl_log_type type, const char *fmt, ...);

extern void
ccl_log_va (ccl_log_type type, const char *fmt, va_list pa);

extern void
ccl_display (const char *fmt, ...);

extern void
ccl_warning (const char *fmt, ...);
 
extern void
ccl_panic (const char *fmt, ...);

extern void
ccl_error (const char *fmt, ...);

extern void
ccl_debug (const char *fmt, ...);

extern void
ccl_debug_max_level (int maxlevel);

extern void
ccl_debug_push_tab_level (void);

extern void
ccl_debug_pop_tab_level (void);

extern void
ccl_debug_start_timed_block (const char *fmt, ...);

extern void
ccl_debug_end_timed_block (void);

# define CCL_DEBUG_START_TIMED_BLOCK(_args) \
  CCL_DEBUG_COND_START_TIMED_BLOCK (ccl_debug_is_on, _args)

# define CCL_DEBUG_END_TIMED_BLOCK() \
  CCL_DEBUG_COND_END_TIMED_BLOCK (ccl_debug_is_on)

# define CCL_DEBUG_COND_START_TIMED_BLOCK(_cond,_args)                  \
  do { if (_cond) ccl_debug_start_timed_block _args ; } while (0)

# define CCL_DEBUG_COND_END_TIMED_BLOCK(_cond)                          \
  do { if (_cond) ccl_debug_end_timed_block () ; } while (0)


extern void
ccl_log_redirect_to_string (ccl_log_type type, char **dst);

extern void
ccl_log_redirect_to_FILE (ccl_log_type type, FILE *output);

END_C_DECLS

#endif /* ! __CCL_LOG_H__ */