X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Flog.h;h=cee998a2969f7f8db8948042676b9d4f2d31806b;hp=fb3b161a7f97c4964195b60af30fbb8f968bcd37;hb=d71e0f5445235ed25ab633d73a26bb4f01a0885f;hpb=34841706b5b43761ba4a3f3c6b0fd667b775654e diff --git a/include/yaz/log.h b/include/yaz/log.h index fb3b161..cee998a 100644 --- a/include/yaz/log.h +++ b/include/yaz/log.h @@ -1,29 +1,28 @@ -/* - * Copyright (C) 1995-2006, Index Data ApS - * - * Permission to use, copy, modify, distribute, and sell this software and - * its documentation, in whole or in part, for any purpose, is hereby granted, - * provided that: - * - * 1. This copyright and permission notice appear in all copies of the - * software and its documentation. Notices of copyright or attribution - * which appear at the beginning of any file must remain unchanged. - * - * 2. The name of Index Data or the individual authors may not be used to - * endorse or promote products derived from this software without specific - * prior written permission. +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2012 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: * - * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND, - * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY - * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. - * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL, - * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES - * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR - * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF - * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE - * OF THIS SOFTWARE. + * * 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. * - * $Id: log.h,v 1.37 2006-05-07 18:26:25 adam Exp $ + * 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. */ /** @@ -49,6 +48,8 @@ YAZ_BEGIN_CDECL #define YLOG_LOG 0x00000008 /** \brief log level: append system error message */ #define YLOG_ERRNO 0x00000010 +/** \brief log level: append thread Id */ +#define YLOG_TID 0x00000020 /** \brief log level: application */ #define YLOG_APP 0x00000040 /** \brief log level: malloc debug */ @@ -79,12 +80,19 @@ YAZ_BEGIN_CDECL /** \brief sets level, prefix and filename for logging \param level log level \param prefix log message prefix - \param fname filename + \param fname filename + + If fname is NULL, the filename logging is not changed. */ YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *fname); -/** \brief sets log to a file - \param fname filename +/** \brief sets log file + \param fname filename + + A filename of NULL makes the log to be completely disabled. + A filename which is the empty string ("") makes the system + log to stderr (which is also the default). Otherwise the + filename given is used. */ YAZ_EXPORT void yaz_log_init_file(const char *fname); @@ -153,13 +161,13 @@ YAZ_EXPORT int yaz_log_mask_str(const char *str); \return log level mask yaz_log_mask_str_x() is like yaz_log_mask_str(), but with a given start - value + value. */ YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level); - /** \brief returns level for module \param name module name + \returns log level for module yaz_log_module_level() returns a log level mask corresponding to the module name. If that had been specified on the -v arguments (that is @@ -170,7 +178,7 @@ YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level); YAZ_EXPORT int yaz_log_module_level(const char *name); /** \brief returns FILE handle for log or NULL if no file is in use - \retval FILE FILE handle in use + \retval FILE FILE handle in use (possibly stderr) \retval NULL log is currently not written to a file */ YAZ_EXPORT FILE *yaz_log_file(void); @@ -185,58 +193,32 @@ YAZ_EXPORT FILE *yaz_log_file(void); YAZ_EXPORT void yaz_log_set_handler(void (*func)(int, const char *, void *), void *info); +/** \brief reopen current log file (unless disabled or stderr) + */ YAZ_EXPORT void yaz_log_reopen(void); +/** \brief Truncate the log file */ +YAZ_EXPORT void yaz_log_trunc(void); + +/** \brief installs hook to be called before each log msg + \param func function to be called + \param info user data to be passed to function + */ YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg, void *info), void *info); +/** \brief installs hook to be called after each log msg + \param func function to be called + \param info user data to be passed to function + */ YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg, void *info), void *info); -#if YAZ_USE_NEW_LOG - -#else - -#include - -/** The old LOG_ bit names are here for compatibility only. They may - conflict with bits defined in syslog.h, or other places. 'LOG' - really is not such a good name. YLOG must be more unique +/** \brief Makes Libxml2 and Libxslt log errors through yaz_log + \param prefix prefix to use for log messages (may be 0) + \param log_level log level to use for Libxml2/Libxslt messages */ - -/** \brief old log level */ -#define LOG_FATAL YLOG_FATAL -/** \brief old log level */ -#define LOG_DEBUG YLOG_DEBUG -/** \brief old log level */ -#define LOG_WARN YLOG_WARN -/** \brief old log level */ -#define LOG_LOG YLOG_LOG -/** \brief old log level */ -#define LOG_ERRNO YLOG_ERRNO -/** \brief old log level */ -#define LOG_FILE 0x00000020 -/** \brief old log level */ -#define LOG_APP YLOG_APP -/** \brief old log level */ -#define LOG_MALLOC YLOG_MALLOC -/** \brief old log level */ -#define LOG_NOTIME YLOG_NOTIME -/** \brief old log level */ -#define LOG_APP2 YLOG_APP2 -/** \brief old log level */ -#define LOG_APP3 YLOG_APP3 -/** \brief old log level */ -#define LOG_FLUSH YLOG_FLUSH -/** \brief old log level */ -#define LOG_ALL YLOG_ALL -/** \brief old log level */ -#define LOG_DEFAULT_LEVEL YLOG_DEFAULT_LEVEL - -/** \brief logf is deprecated, as it conflicts with a math function */ -#define logf yaz_log - -#endif /* if YAZ_USE_NEW_LOG */ +YAZ_EXPORT void yaz_log_xml_errors(const char *prefix, int log_level); YAZ_END_CDECL @@ -244,6 +226,7 @@ YAZ_END_CDECL /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab