include/yaz/log.h

   1 /*
   2  * Copyright (c) 1995-2003, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: log.h,v 1.14 2004-11-02 11:37:21 heikki Exp $
  27  */
  28
  29 /**
  30  * \file log.h
  31  * \brief Header for logging utility
  32  */
  33
  34 #ifndef LOG_H
  35 #define LOG_H
  36
  37 #include <stdio.h>
  38 #include <yaz/yconfig.h>
  39 #include <yaz/xmalloc.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 #define LOG_FATAL  0x0001
  44 #define LOG_DEBUG  0x0002
  45 #define LOG_WARN   0x0004
  46 #define LOG_LOG    0x0008
  47 #define LOG_ERRNO  0x0010     /* append strerror to message */
  48 #define LOG_FILE   0x0020
  49 #define LOG_APP    0x0040     /* For application level events such as new-connection */
  50 #define LOG_MALLOC 0x0080     /* debugging mallocs */
  51 #define LOG_NOTIME 0x0100     /* do not output date and time */
  52 #define LOG_APP2   0x0200     /* For application-level events, such as api calls */
  53 #define LOG_APP3   0x0400     /* For more application-level events */
  54
  55 #define LOG_ALL   (0xffff&~LOG_MALLOC&~LOG_NOTIME)
  56
  57 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
  58
  59 #define logf yaz_log
  60
  61 YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name);
  62 YAZ_EXPORT void yaz_log_init_file (const char *fname);
  63 YAZ_EXPORT void yaz_log_init_level (int level);
  64 YAZ_EXPORT void yaz_log_init_prefix (const char *prefix);
  65 YAZ_EXPORT void yaz_log_init_prefix2 (const char *prefix);
  66 /**
  67  * yaz_log_time_format sets the format of the timestamp. See man 3 strftime
  68  * Calling with "old" sets to the old format "11:55:06-02/11"
  69  * Calling with NULL or "" sets to the new format "20041102-115719"
  70  * If not called at all, the old format is used, for backward compatibility
  71  *
  72  * */
  73 YAZ_EXPORT void yaz_log_time_format(const char *fmt);
  74
  75 YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
  76 #ifdef __GNUC__
  77         __attribute__ ((format (printf, 2, 3)))
  78 #endif
  79         ;
  80 YAZ_EXPORT int yaz_log_mask_str (const char *str);
  81 YAZ_EXPORT int yaz_log_mask_str_x (const char *str, int level);
  82 YAZ_EXPORT FILE *yaz_log_file(void);
  83
  84 YAZ_EXPORT void log_event_start (void (*func)(int level, const char *msg, void *info),
  85         void *info);
  86 YAZ_EXPORT void log_event_end (void (*func)(int level, const char *msg, void *info),
  87         void *info);
  88
  89 YAZ_EXPORT void yaz_log_reopen(void);
  90 YAZ_END_CDECL
  91
  92 #endif