1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>C Standard Library Extensions: cxmessages.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">C Standard Library Extensions
 <span id="projectnumber">1.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_c2959b2ad5731f3b356ab222d87e802c.html">cext</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">cxmessages.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* $Id: cxmessages.h,v 1.10 2011/02/21 14:15:31 rpalsa Exp $</span>
<a name="l00002"></a>00002 <span class="comment"> *</span>
<a name="l00003"></a>00003 <span class="comment"> * This file is part of the ESO C Extension Library</span>
<a name="l00004"></a>00004 <span class="comment"> * Copyright (C) 2001-2011 European Southern Observatory</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
<a name="l00007"></a>00007 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00008"></a>00008 <span class="comment"> * the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00009"></a>00009 <span class="comment"> * (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00017"></a>00017 <span class="comment"> * along with this program; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="comment">/*</span>
<a name="l00022"></a>00022 <span class="comment"> * $Author: rpalsa $</span>
<a name="l00023"></a>00023 <span class="comment"> * $Date: 2011/02/21 14:15:31 $</span>
<a name="l00024"></a>00024 <span class="comment"> * $Revision: 1.10 $</span>
<a name="l00025"></a>00025 <span class="comment"> * $Name: cpl-6_1_1 $</span>
<a name="l00026"></a>00026 <span class="comment"> */</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="preprocessor">#ifndef CX_MESSAGES_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span><span class="preprocessor">#define CX_MESSAGES_H</span>
<a name="l00030"></a>00030 <span class="preprocessor"></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdarg.h></span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="preprocessor">#include <cxmacros.h></span>
<a name="l00034"></a>00034 <span class="preprocessor">#include <cxtypes.h></span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036
<a name="l00037"></a>00037 CX_BEGIN_DECLS
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="comment">/*</span>
<a name="l00040"></a>00040 <span class="comment"> * Message level offset for user defined message levels</span>
<a name="l00041"></a>00041 <span class="comment"> * (0 - 7 are used internally).</span>
<a name="l00042"></a>00042 <span class="comment"> */</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="preprocessor">#define CX_LOG_LEVEL_USER_SHIFT (8)</span>
<a name="l00045"></a>00045 <span class="preprocessor"></span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">/*</span>
<a name="l00048"></a>00048 <span class="comment"> * Log levels and flags</span>
<a name="l00049"></a>00049 <span class="comment"> */</span>
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00052"></a>00052 {
<a name="l00053"></a>00053 <span class="comment">/* flags */</span>
<a name="l00054"></a>00054 CX_LOG_FLAG_RECURSION = 1 << 0,
<a name="l00055"></a>00055 CX_LOG_FLAG_FATAL = 1 << 1,
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="comment">/* levels */</span>
<a name="l00058"></a>00058 CX_LOG_LEVEL_ERROR = 1 << 2,
<a name="l00059"></a>00059 CX_LOG_LEVEL_CRITICAL = 1 << 3,
<a name="l00060"></a>00060 CX_LOG_LEVEL_WARNING = 1 << 4,
<a name="l00061"></a>00061 CX_LOG_LEVEL_MESSAGE = 1 << 5,
<a name="l00062"></a>00062 CX_LOG_LEVEL_INFO = 1 << 6,
<a name="l00063"></a>00063 CX_LOG_LEVEL_DEBUG = 1 << 7,
<a name="l00064"></a>00064
<a name="l00065"></a>00065 CX_LOG_LEVEL_MASK = ~(CX_LOG_FLAG_RECURSION | CX_LOG_FLAG_FATAL)
<a name="l00066"></a>00066 } cx_log_level_flags;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="preprocessor">#define CX_LOG_FATAL_MASK (CX_LOG_FLAG_RECURSION | CX_LOG_LEVEL_ERROR)</span>
<a name="l00069"></a>00069 <span class="preprocessor"></span>
<a name="l00070"></a>00070
<a name="l00071"></a>00071 <span class="comment">/*</span>
<a name="l00072"></a>00072 <span class="comment"> * Message handlers</span>
<a name="l00073"></a>00073 <span class="comment"> */</span>
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keyword">typedef</span> void (*cx_log_func) (<span class="keyword">const</span> cxchar *, cx_log_level_flags,
<a name="l00076"></a>00076 <span class="keyword">const</span> cxchar *, cxptr);
<a name="l00077"></a>00077 <span class="keyword">typedef</span> void (*cx_print_func) (<span class="keyword">const</span> cxchar *);
<a name="l00078"></a>00078
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">/*</span>
<a name="l00081"></a>00081 <span class="comment"> * Messaging mechanisms</span>
<a name="l00082"></a>00082 <span class="comment"> */</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga8ea714e9460b6f7ad71bd2083e223a5f" title="Default log handler.">cx_log_default_handler</a>(<span class="keyword">const</span> cxchar *, cx_log_level_flags,
<a name="l00085"></a>00085 <span class="keyword">const</span> cxchar *, cxptr);
<a name="l00086"></a>00086 cx_log_func <a class="code" href="group__cxmessages.html#gac7d6d283da2defe86ee32592b357d299" title="Set the default log handler.">cx_log_set_default_handler</a>(cx_log_func);
<a name="l00087"></a>00087 cxuint <a class="code" href="group__cxmessages.html#gaa41ee3d085b05e65dacc48c437380e2b" title="Set the log handler for a log domain.">cx_log_set_handler</a>(<span class="keyword">const</span> cxchar *, cx_log_level_flags,
<a name="l00088"></a>00088 cx_log_func, cxptr);
<a name="l00089"></a>00089 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga285fc56885fcb786d62dc7bc94119949" title="Remove a log handler from a domain.">cx_log_remove_handler</a>(<span class="keyword">const</span> cxchar *, cxuint);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 cx_log_level_flags <a class="code" href="group__cxmessages.html#ga64524feb88742a755fb49d2e2024618e" title="Sets the log message level which are fatal for a given domain.">cx_log_set_fatal_mask</a>(<span class="keyword">const</span> cxchar *, cx_log_level_flags);
<a name="l00092"></a>00092 cx_log_level_flags <a class="code" href="group__cxmessages.html#ga2b9a9a900fb2463559b5672d23eae621" title="Set log levels to be always fatal.">cx_log_set_always_fatal</a>(cx_log_level_flags);
<a name="l00093"></a>00093
<a name="l00094"></a>00094 cxsize <a class="code" href="group__cxmessages.html#ga59b256cd59854cd96a66fecf500b6ec3" title="Get the number of registered log domains.">cx_log_get_domain_count</a>(<span class="keywordtype">void</span>);
<a name="l00095"></a>00095 <span class="keyword">const</span> cxchar *<a class="code" href="group__cxmessages.html#ga31594ba8e069190d4f708d9f50362d11" title="Get the name of a log domain.">cx_log_get_domain_name</a>(cxsize);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga81586bd99c04f4a8e7cc5a2d55e74573" title="Log a formatted message.">cx_log</a>(<span class="keyword">const</span> cxchar *, cx_log_level_flags,
<a name="l00098"></a>00098 <span class="keyword">const</span> cxchar *, ...) CX_GNUC_PRINTF(3, 4);
<a name="l00099"></a>00099 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga7da0d562d30cfcf37a25c1e3af1dfb3b" title="Log a formatted message using a variable-length argument.">cx_logv</a>(const cxchar *, cx_log_level_flags,
<a name="l00100"></a>00100 const cxchar *, va_list) CX_GNUC_PRINTF(3, 0);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 cx_print_func <a class="code" href="group__cxmessages.html#gaa597310debec2efd1fcc90cbe2bb9737" title="Set handler for message output.">cx_print_set_handler</a>(cx_print_func);
<a name="l00103"></a>00103 cx_print_func <a class="code" href="group__cxmessages.html#gabab9205d88eccc39c650af1b5df3c0ca" title="Set handler for error message output.">cx_printerr_set_handler</a>(cx_print_func);
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga61bf6d7fbd22c7eaabc33028aae024f7" title="Output a formatted message via the print handler.">cx_print</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 2);
<a name="l00106"></a>00106 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#gadce1cff77bbf105e15da2c3fc1c9caec" title="Output a formatted message via the error message handler.">cx_printerr</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 0);
<a name="l00107"></a>00107
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">/*</span>
<a name="l00110"></a>00110 <span class="comment"> * Convenience functions</span>
<a name="l00111"></a>00111 <span class="comment"> */</span>
<a name="l00112"></a>00112
<a name="l00113"></a>00113 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#gad86cd013f05c08f9dd3b749dcd940377" title="Log an error message.">cx_error</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 2);
<a name="l00114"></a>00114 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#gae1eb53dfd889fdf06f03414292e642b3" title="Log a "critical" warning.">cx_critical</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 2);
<a name="l00115"></a>00115 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga71f3ac7c5d9726daeba0826a260fb2d3" title="Log a warning.">cx_warning</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 2);
<a name="l00116"></a>00116 <span class="keywordtype">void</span> <a class="code" href="group__cxmessages.html#ga08bec22decc20784b11901f65e4c77dc" title="Log a normal message.">cx_message</a>(const cxchar *, ...) CX_GNUC_PRINTF(1, 2);
<a name="l00117"></a>00117
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="preprocessor">#ifndef CX_LOG_DOMAIN</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span><span class="preprocessor"># define CX_LOG_DOMAIN ((cxchar *)0)</span>
<a name="l00121"></a>00121 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00122"></a>00122 <span class="preprocessor"></span>
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="comment">/*</span>
<a name="l00125"></a>00125 <span class="comment"> * Macros for error handling.</span>
<a name="l00126"></a>00126 <span class="comment"> */</span>
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="preprocessor">#ifdef CX_DISABLE_ASSERT</span>
<a name="l00129"></a>00129 <span class="preprocessor"></span>
<a name="l00130"></a>00130 <span class="preprocessor"># define cx_assert(expr) </span><span class="comment">/* empty */</span>
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="preprocessor">#else </span><span class="comment">/* !CX_DISABLE_ASSERT */</span>
<a name="l00133"></a>00133
<a name="l00134"></a>00134 <span class="preprocessor"># ifdef __GNUC__</span>
<a name="l00135"></a>00135 <span class="preprocessor"></span><span class="preprocessor"># define cx_assert(expr) \</span>
<a name="l00136"></a>00136 <span class="preprocessor"> do { \</span>
<a name="l00137"></a>00137 <span class="preprocessor"> if (expr) { \</span>
<a name="l00138"></a>00138 <span class="preprocessor"> ; \</span>
<a name="l00139"></a>00139 <span class="preprocessor"> } \</span>
<a name="l00140"></a>00140 <span class="preprocessor"> else { \</span>
<a name="l00141"></a>00141 <span class="preprocessor"> cx_log(CX_LOG_DOMAIN, CX_LOG_LEVEL_ERROR, \</span>
<a name="l00142"></a>00142 <span class="preprocessor"> "file %s: line %d (%s): assertion failed: (%s)", \</span>
<a name="l00143"></a>00143 <span class="preprocessor"> __FILE__, __LINE__, __PRETTY_FUNCTION__, #expr); \</span>
<a name="l00144"></a>00144 <span class="preprocessor"> } \</span>
<a name="l00145"></a>00145 <span class="preprocessor"> } while (0)</span>
<a name="l00146"></a>00146 <span class="preprocessor"></span><span class="preprocessor"># else </span><span class="comment">/* !__GNUC__ */</span>
<a name="l00147"></a>00147 <span class="preprocessor"># define cx_assert(expr) \</span>
<a name="l00148"></a>00148 <span class="preprocessor"> do { \</span>
<a name="l00149"></a>00149 <span class="preprocessor"> if (expr) { \</span>
<a name="l00150"></a>00150 <span class="preprocessor"> ; \</span>
<a name="l00151"></a>00151 <span class="preprocessor"> } \</span>
<a name="l00152"></a>00152 <span class="preprocessor"> else { \</span>
<a name="l00153"></a>00153 <span class="preprocessor"> cx_log(CX_LOG_DOMAIN,CX_LOG_LEVEL_ERROR, \</span>
<a name="l00154"></a>00154 <span class="preprocessor"> "file %s: line %d: assertion failed: (%s)", \</span>
<a name="l00155"></a>00155 <span class="preprocessor"> __FILE__, __LINE__, #expr); \</span>
<a name="l00156"></a>00156 <span class="preprocessor"> } \</span>
<a name="l00157"></a>00157 <span class="preprocessor"> } while (0)</span>
<a name="l00158"></a>00158 <span class="preprocessor"></span><span class="preprocessor"># endif </span><span class="comment">/* !__GNUC__ */</span>
<a name="l00159"></a>00159
<a name="l00160"></a>00160 <span class="preprocessor">#endif </span><span class="comment">/* !CX_DISABLE_ASSERT */</span>
<a name="l00161"></a>00161
<a name="l00162"></a>00162 CX_END_DECLS
<a name="l00163"></a>00163
<a name="l00164"></a>00164 <span class="preprocessor">#endif </span><span class="comment">/* CX_MESSAGES_H */</span>
<a name="l00165"></a>00165
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 22 2012 06:56:06 for C Standard Library Extensions by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>
</body>
</html>
|
