a7e9c9db431e2cc79d50d1a9807a5275803e13ac
[yaz-moved-to-github.git] / include / log.h
1 /*
2  * Copyright (c) 1995-1998, 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  * $Log: log.h,v $
27  * Revision 1.14  1998-10-28 10:26:59  adam
28  * New functions log_init_file, log_init_level, log_init_prefix.
29  *
30  * Revision 1.13  1998/10/13 16:11:11  adam
31  * Added printf-format check for logf when using GNUC.
32  *
33  * Revision 1.12  1997/09/04 07:59:02  adam
34  * Added include of xmalloc.h.
35  *
36  * Revision 1.11  1997/09/01 08:49:48  adam
37  * New windows NT/95 port using MSV5.0. To export DLL functions the
38  * YAZ_EXPORT modifier was added. Defined in yconfig.h.
39  *
40  * Revision 1.10  1997/05/14 06:53:40  adam
41  * C++ support.
42  *
43  * Revision 1.9  1997/05/01 15:06:42  adam
44  * Added log_mask_str_x routine.
45  *
46  * Revision 1.8  1996/05/01 12:45:00  quinn
47  * *** empty log message ***
48  *
49  * Revision 1.7  1996/02/05  12:24:26  adam
50  * Implemented log_event_{start,end}-functions.
51  *
52  * Revision 1.6  1995/10/10  16:27:06  quinn
53  * *** empty log message ***
54  *
55  * Revision 1.5  1995/09/29  17:12:03  quinn
56  * Smallish
57  *
58  * Revision 1.4  1995/09/27  15:02:47  quinn
59  * Modified function heads & prototypes.
60  *
61  * Revision 1.3  1995/06/19  12:38:25  quinn
62  * Reorganized include-files. Added small features.
63  *
64  * Revision 1.2  1995/05/16  08:50:31  quinn
65  * License, documentation, and memory fixes
66  *
67  * Revision 1.1  1995/03/30  09:39:41  quinn
68  * Moved .h files to include directory
69  *
70  * Revision 1.4  1994/09/28  13:07:22  adam
71  * Added log_mask_str.
72  *
73  * Revision 1.3  1994/08/18  08:18:45  quinn
74  * Added prefix to log_init.
75  *
76  * Revision 1.2  1994/08/17  14:27:46  quinn
77  * added LOG_ERRNO
78  *
79  * Revision 1.1  1994/08/17  13:22:52  quinn
80  * First version
81  *
82  */
83
84 #ifndef LOG_H
85 #define LOG_H
86
87 #include <yconfig.h>
88 #include <xmalloc.h>
89 #include <stdio.h>
90
91 #ifdef __cplusplus
92 extern "C" {
93 #endif
94
95 #define LOG_FATAL 0x0001
96 #define LOG_DEBUG 0x0002
97 #define LOG_WARN  0x0004
98 #define LOG_LOG   0x0008
99 #define LOG_ERRNO 0x0010     /* append strerror to message */
100 #define LOG_FILE  0x0020
101
102 #define LOG_ALL   0xffff
103
104 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
105
106 YAZ_EXPORT void log_init(int level, const char *prefix, const char *name);
107 YAZ_EXPORT void log_init_file (const char *fname);
108 YAZ_EXPORT void log_init_level (int level);
109 YAZ_EXPORT void log_init_prefix (const char *prefix);
110
111 YAZ_EXPORT void logf(int level, const char *fmt, ...)
112 #ifdef __GNUC__
113         __attribute__ ((format (printf, 2, 3)))
114 #endif
115         ;
116 YAZ_EXPORT int log_mask_str (const char *str);
117 YAZ_EXPORT int log_mask_str_x (const char *str, int level);
118 YAZ_EXPORT FILE *log_file(void);
119
120 YAZ_EXPORT void log_event_start (void (*func)(int level, const char *msg, void *info),
121         void *info);
122 YAZ_EXPORT void log_event_end (void (*func)(int level, const char *msg, void *info),
123         void *info);
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif