log.h

Go to the documentation of this file.

/* This file is part of the YAZ toolkit.
 * Copyright (C) Index Data.
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of Index Data nor the names of its contributors
 *       may be used to endorse or promote products derived from this
 *       software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef YAZ_LOG_H
#define YAZ_LOG_H
 
#include <stdio.h>
#include <yaz/yconfig.h>
 
YAZ_BEGIN_CDECL
 
#define YLOG_FATAL  0x00000001
#define YLOG_DEBUG  0x00000002
#define YLOG_WARN   0x00000004
#define YLOG_LOG    0x00000008
#define YLOG_ERRNO  0x00000010
#define YLOG_TID    0x00000020
#define YLOG_APP    0x00000040
#define YLOG_MALLOC 0x00000080
#define YLOG_NOTIME 0x00000100
#define YLOG_APP2   0x00000200
#define YLOG_APP3   0x00000400
#define YLOG_FLUSH  0x00000800
#define YLOG_LOGLVL 0x00001000 /* log when modules query log levels */
                              /* this has to be a hard-coded bit, not to loop*/
 
#define YLOG_ALL   (0xffff&~YLOG_MALLOC&~YLOG_NOTIME)
 
#define YLOG_DEFAULT_LEVEL \
    (YLOG_FATAL | YLOG_ERRNO | YLOG_LOG | YLOG_WARN | YLOG_FLUSH)
/* not having flush here confuses Solaris users, who won't see any logs until
 * (and if) the program exits normally */
 
#define YLOG_LAST_BIT YLOG_LOGLVL
 
YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *fname);
 
YAZ_EXPORT void yaz_log_init_file(const char *fname);
 
YAZ_EXPORT void yaz_log_init_level(int level);
 
YAZ_EXPORT void yaz_log_init_prefix(const char *prefix);
 
YAZ_EXPORT void yaz_log_init_prefix2(const char *prefix);
 
YAZ_EXPORT void yaz_log_time_format(const char *fmt);
 
YAZ_EXPORT void yaz_log_init_max_size(int mx);
 
YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
#ifdef __GNUC__
        __attribute__ ((format (printf, 2, 3)))
#endif
        ;
 
YAZ_EXPORT int yaz_log_mask_str(const char *str);
 
YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level);
 
YAZ_EXPORT int yaz_log_module_level(const char *name);
 
YAZ_EXPORT FILE *yaz_log_file(void);
 
YAZ_EXPORT void yaz_log_set_handler(void (*func)(int, const char *,
                                                 void *), void *info);
 
YAZ_EXPORT void yaz_log_reopen(void);
 
YAZ_EXPORT void yaz_log_trunc(void);
 
YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg,
                                             void *info), void *info);
 
YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg,
                                           void *info), void *info);
 
YAZ_EXPORT void yaz_log_xml_errors(const char *prefix, int log_level);
 
YAZ_EXPORT void yaz_log_lock(void);
 
YAZ_EXPORT void yaz_log_unlock(void);
YAZ_END_CDECL
 
#endif
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */