Doxyfile file description. Indentation. No change of code.
[yaz-moved-to-github.git] / include / yaz / log.h
index c2ff896..25b31d0 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995-2000, Index Data.
+ * Copyright (c) 1995-2003, Index Data.
  *
  * Permission to use, copy, modify, distribute, and sell this software and
  * its documentation, in whole or in part, for any purpose, is hereby granted,
  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  * OF THIS SOFTWARE.
  *
- * $Log: log.h,v $
- * Revision 1.2  2000-02-28 11:20:06  adam
- * Using autoconf. New definitions: YAZ_BEGIN_CDECL/YAZ_END_CDECL.
- *
- * Revision 1.1  1999/11/30 13:47:11  adam
- * Improved installation. Moved header files to include/yaz.
- *
- * Revision 1.15  1999/08/27 09:40:32  adam
- * Renamed logf function to yaz_log. Removed VC++ project files.
- *
- * Revision 1.14  1998/10/28 10:26:59  adam
- * New functions log_init_file, log_init_level, log_init_prefix.
- *
- * Revision 1.13  1998/10/13 16:11:11  adam
- * Added printf-format check for logf when using GNUC.
- *
- * Revision 1.12  1997/09/04 07:59:02  adam
- * Added include of xmalloc.h.
- *
- * Revision 1.11  1997/09/01 08:49:48  adam
- * New windows NT/95 port using MSV5.0. To export DLL functions the
- * YAZ_EXPORT modifier was added. Defined in yconfig.h.
- *
- * Revision 1.10  1997/05/14 06:53:40  adam
- * C++ support.
- *
- * Revision 1.9  1997/05/01 15:06:42  adam
- * Added log_mask_str_x routine.
- *
- * Revision 1.8  1996/05/01 12:45:00  quinn
- * *** empty log message ***
- *
- * Revision 1.7  1996/02/05  12:24:26  adam
- * Implemented log_event_{start,end}-functions.
- *
- * Revision 1.6  1995/10/10  16:27:06  quinn
- * *** empty log message ***
- *
- * Revision 1.5  1995/09/29  17:12:03  quinn
- * Smallish
- *
- * Revision 1.4  1995/09/27  15:02:47  quinn
- * Modified function heads & prototypes.
- *
- * Revision 1.3  1995/06/19  12:38:25  quinn
- * Reorganized include-files. Added small features.
- *
- * Revision 1.2  1995/05/16  08:50:31  quinn
- * License, documentation, and memory fixes
- *
- * Revision 1.1  1995/03/30  09:39:41  quinn
- * Moved .h files to include directory
- *
- * Revision 1.4  1994/09/28  13:07:22  adam
- * Added log_mask_str.
- *
- * Revision 1.3  1994/08/18  08:18:45  quinn
- * Added prefix to log_init.
- *
- * Revision 1.2  1994/08/17  14:27:46  quinn
- * added LOG_ERRNO
- *
- * Revision 1.1  1994/08/17  13:22:52  quinn
- * First version
- *
+ * $Id: log.h,v 1.13 2004-10-15 00:18:59 adam Exp $
+ */
+
+/**
+ * \file log.h
+ * \brief Header for logging utility
  */
 
 #ifndef LOG_H
 
 YAZ_BEGIN_CDECL
 
-#define LOG_FATAL 0x0001
-#define LOG_DEBUG 0x0002
-#define LOG_WARN  0x0004
-#define LOG_LOG   0x0008
-#define LOG_ERRNO 0x0010     /* append strerror to message */
-#define LOG_FILE  0x0020
+#define LOG_FATAL  0x0001
+#define LOG_DEBUG  0x0002
+#define LOG_WARN   0x0004
+#define LOG_LOG    0x0008
+#define LOG_ERRNO  0x0010     /* append strerror to message */
+#define LOG_FILE   0x0020
+#define LOG_APP    0x0040     /* For application level events such as new-connection */
+#define LOG_MALLOC 0x0080     /* debugging mallocs */
+#define LOG_NOTIME 0x0100     /* do not output date and time */
+#define LOG_APP2   0x0200     /* For application-level events, such as api calls */
+#define LOG_APP3   0x0400     /* For more application-level events */
 
-#define LOG_ALL   0xffff
+#define LOG_ALL   (0xffff&~LOG_MALLOC&~LOG_NOTIME)
 
 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
 
 #define logf yaz_log
 
-YAZ_EXPORT void log_init(int level, const char *prefix, const char *name);
-YAZ_EXPORT void log_init_file (const char *fname);
-YAZ_EXPORT void log_init_level (int level);
-YAZ_EXPORT void log_init_prefix (const char *prefix);
+YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name);
+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(int level, const char *fmt, ...)
 #ifdef __GNUC__
        __attribute__ ((format (printf, 2, 3)))
 #endif
        ;
-YAZ_EXPORT int log_mask_str (const char *str);
-YAZ_EXPORT int log_mask_str_x (const char *str, int level);
-YAZ_EXPORT FILE *log_file(void);
+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 FILE *yaz_log_file(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_reopen(void);
 YAZ_END_CDECL
 
 #endif