blob: f709bbd078ca6e360ef59be9578e8d014d03f80e [file] [log] [blame]
Owen Taylor3473f882001-02-23 17:55:21 +00001/*
2 * error.c: module displaying/handling XML parser errors
3 *
4 * See Copyright for the status of this software.
5 *
Daniel Veillardc5d64342001-06-24 12:13:24 +00006 * Daniel Veillard <daniel@veillard.com>
Owen Taylor3473f882001-02-23 17:55:21 +00007 */
8
Daniel Veillard34ce8be2002-03-18 19:37:11 +00009#define IN_LIBXML
Bjorn Reese70a9da52001-04-21 16:57:29 +000010#include "libxml.h"
Owen Taylor3473f882001-02-23 17:55:21 +000011
Owen Taylor3473f882001-02-23 17:55:21 +000012#include <stdarg.h>
13#include <libxml/parser.h>
14#include <libxml/xmlerror.h>
Daniel Veillarde356c282001-03-10 12:32:04 +000015#include <libxml/xmlmemory.h>
Daniel Veillard3c01b1d2001-10-17 15:58:35 +000016#include <libxml/globals.h>
Owen Taylor3473f882001-02-23 17:55:21 +000017
Daniel Veillard635ef722001-10-29 11:48:19 +000018void xmlGenericErrorDefaultFunc (void *ctx ATTRIBUTE_UNUSED,
19 const char *msg,
20 ...);
21
Daniel Veillard1c43dbf2001-06-05 17:12:52 +000022#define XML_GET_VAR_STR(msg, str) { \
23 int size; \
24 int chars; \
25 char *larger; \
26 va_list ap; \
27 \
28 str = (char *) xmlMalloc(150); \
29 if (str == NULL) \
30 return; \
31 \
32 size = 150; \
33 \
34 while (1) { \
35 va_start(ap, msg); \
36 chars = vsnprintf(str, size, msg, ap); \
37 va_end(ap); \
38 if ((chars > -1) && (chars < size)) \
39 break; \
40 if (chars > -1) \
41 size += chars + 1; \
42 else \
43 size += 100; \
44 if ((larger = (char *) xmlRealloc(str, size)) == NULL) {\
45 xmlFree(str); \
46 return; \
47 } \
48 str = larger; \
49 } \
50}
Bjorn Reese570ff082001-06-05 12:45:55 +000051
Owen Taylor3473f882001-02-23 17:55:21 +000052/************************************************************************
53 * *
54 * Handling of out of context errors *
55 * *
56 ************************************************************************/
57
58/**
59 * xmlGenericErrorDefaultFunc:
60 * @ctx: an error context
61 * @msg: the message to display/transmit
62 * @...: extra parameters for the message display
63 *
64 * Default handler for out of context error messages.
65 */
Daniel Veillard635ef722001-10-29 11:48:19 +000066void
Daniel Veillardc86a4fa2001-03-26 16:28:29 +000067xmlGenericErrorDefaultFunc(void *ctx ATTRIBUTE_UNUSED, const char *msg, ...) {
Owen Taylor3473f882001-02-23 17:55:21 +000068 va_list args;
69
70 if (xmlGenericErrorContext == NULL)
71 xmlGenericErrorContext = (void *) stderr;
72
73 va_start(args, msg);
74 vfprintf((FILE *)xmlGenericErrorContext, msg, args);
75 va_end(args);
76}
77
Daniel Veillard9d06d302002-01-22 18:15:52 +000078/**
79 * initGenericErrorDefaultFunc:
80 * @handler: the handler
81 *
82 * Set or reset (if NULL) the default handler for generic errors
Daniel Veillard7424eb62003-01-24 14:14:52 +000083 * to the builtin error function.
Daniel Veillard9d06d302002-01-22 18:15:52 +000084 */
Daniel Veillardd0463562001-10-13 09:15:48 +000085void
Daniel Veillarddb5850a2002-01-18 11:49:26 +000086initGenericErrorDefaultFunc(xmlGenericErrorFunc * handler)
Daniel Veillardd0463562001-10-13 09:15:48 +000087{
Daniel Veillarddb5850a2002-01-18 11:49:26 +000088 if (handler == NULL)
89 xmlGenericError = xmlGenericErrorDefaultFunc;
90 else
91 (*handler) = xmlGenericErrorDefaultFunc;
Daniel Veillardd0463562001-10-13 09:15:48 +000092}
Owen Taylor3473f882001-02-23 17:55:21 +000093
94/**
95 * xmlSetGenericErrorFunc:
96 * @ctx: the new error handling context
97 * @handler: the new handler function
98 *
99 * Function to reset the handler and the error context for out of
100 * context error messages.
101 * This simply means that @handler will be called for subsequent
102 * error messages while not parsing nor validating. And @ctx will
103 * be passed as first argument to @handler
104 * One can simply force messages to be emitted to another FILE * than
105 * stderr by setting @ctx to this file handle and @handler to NULL.
106 */
107void
108xmlSetGenericErrorFunc(void *ctx, xmlGenericErrorFunc handler) {
109 xmlGenericErrorContext = ctx;
110 if (handler != NULL)
111 xmlGenericError = handler;
112 else
113 xmlGenericError = xmlGenericErrorDefaultFunc;
114}
115
116/************************************************************************
117 * *
118 * Handling of parsing errors *
119 * *
120 ************************************************************************/
121
122/**
123 * xmlParserPrintFileInfo:
124 * @input: an xmlParserInputPtr input
125 *
126 * Displays the associated file and line informations for the current input
127 */
128
129void
130xmlParserPrintFileInfo(xmlParserInputPtr input) {
131 if (input != NULL) {
132 if (input->filename)
133 xmlGenericError(xmlGenericErrorContext,
134 "%s:%d: ", input->filename,
135 input->line);
136 else
137 xmlGenericError(xmlGenericErrorContext,
138 "Entity: line %d: ", input->line);
139 }
140}
141
142/**
143 * xmlParserPrintFileContext:
144 * @input: an xmlParserInputPtr input
145 *
146 * Displays current context within the input content for error tracking
147 */
148
149void
Daniel Veillard561b7f82002-03-20 21:55:57 +0000150xmlParserPrintFileContext(xmlParserInputPtr input) {
151 const xmlChar *cur, *base;
William M. Brack3dd57f72003-05-13 02:06:18 +0000152 int n, col;
153 xmlChar content[81]; /* space for 80 chars + line terminator */
Daniel Veillard2be30642001-03-27 00:32:28 +0000154 xmlChar *ctnt;
Owen Taylor3473f882001-02-23 17:55:21 +0000155
Daniel Veillard561b7f82002-03-20 21:55:57 +0000156 if (input == NULL) return;
Owen Taylor3473f882001-02-23 17:55:21 +0000157 cur = input->cur;
158 base = input->base;
Daniel Veillard2be30642001-03-27 00:32:28 +0000159 /* skip backwards over any end-of-lines */
Daniel Veillard561b7f82002-03-20 21:55:57 +0000160 while ((cur > base) && ((*cur == '\n') || (*cur == '\r'))) {
161 cur--;
Owen Taylor3473f882001-02-23 17:55:21 +0000162 }
163 n = 0;
William M. Brack3dd57f72003-05-13 02:06:18 +0000164 /* search backwards for beginning-of-line (to max buff size) */
165 while ((n++ < sizeof(content)-1) && (cur > base) && (*cur != '\n') && (*cur != '\r'))
Owen Taylor3473f882001-02-23 17:55:21 +0000166 cur--;
Daniel Veillard561b7f82002-03-20 21:55:57 +0000167 if ((*cur == '\n') || (*cur == '\r')) cur++;
William M. Brack3dd57f72003-05-13 02:06:18 +0000168 /* calculate the error position in terms of the current position */
169 col = input->cur - cur;
170 /* search forward for end-of-line (to max buff size) */
Owen Taylor3473f882001-02-23 17:55:21 +0000171 n = 0;
Daniel Veillard2be30642001-03-27 00:32:28 +0000172 ctnt = content;
William M. Brack3dd57f72003-05-13 02:06:18 +0000173 /* copy selected text to our buffer */
174 while ((*cur != 0) && (*cur != '\n') && (*cur != '\r') && (n < sizeof(content)-1)) {
Daniel Veillard561b7f82002-03-20 21:55:57 +0000175 *ctnt++ = *cur++;
176 n++;
Owen Taylor3473f882001-02-23 17:55:21 +0000177 }
Daniel Veillard2be30642001-03-27 00:32:28 +0000178 *ctnt = 0;
William M. Brack3dd57f72003-05-13 02:06:18 +0000179 /* print out the selected text */
Daniel Veillard561b7f82002-03-20 21:55:57 +0000180 xmlGenericError(xmlGenericErrorContext,"%s\n", content);
Daniel Veillard2be30642001-03-27 00:32:28 +0000181 /* create blank line with problem pointer */
Owen Taylor3473f882001-02-23 17:55:21 +0000182 n = 0;
Daniel Veillard7533cc82001-04-24 15:52:00 +0000183 ctnt = content;
William M. Brack3dd57f72003-05-13 02:06:18 +0000184 /* (leave buffer space for pointer + line terminator) */
185 while ((n<col) && (n++ < sizeof(content)-2) && (*ctnt != 0)) {
186 if (*ctnt!='\t')
187 *ctnt = ' ';
188 *ctnt++;
Owen Taylor3473f882001-02-23 17:55:21 +0000189 }
William M. Brack3dd57f72003-05-13 02:06:18 +0000190 *ctnt++ = '^';
191 *ctnt = 0;
Daniel Veillard561b7f82002-03-20 21:55:57 +0000192 xmlGenericError(xmlGenericErrorContext,"%s\n", content);
Owen Taylor3473f882001-02-23 17:55:21 +0000193}
194
Daniel Veillard561b7f82002-03-20 21:55:57 +0000195#if 0
196/**
197 * xmlGetVarStr:
198 * @msg: the message format
199 * @args: a va_list argument list
200 *
201 * SGS contribution
202 * Get an arbitrary-sized string for an error argument
203 * The caller must free() the returned string
204 */
205static char *
206xmlGetVarStr(const char * msg, va_list args) {
207 int size;
208 int length;
209 int chars, left;
210 char *str, *larger;
211 va_list ap;
212
213 str = (char *) xmlMalloc(150);
214 if (str == NULL)
215 return(NULL);
216
217 size = 150;
218 length = 0;
219
220 while (1) {
221 left = size - length;
222 /* Try to print in the allocated space. */
223 va_start(msg, ap);
224 chars = vsnprintf(str + length, left, msg, ap);
225 va_end(ap);
226 /* If that worked, we're done. */
227 if ((chars > -1) && (chars < left ))
228 break;
229 /* Else try again with more space. */
230 if (chars > -1) /* glibc 2.1 */
231 size += chars + 1; /* precisely what is needed */
232 else /* glibc 2.0 */
233 size += 100;
234 if ((larger = (char *) xmlRealloc(str, size)) == NULL) {
235 xmlFree(str);
236 return(NULL);
237 }
238 str = larger;
239 }
240 return(str);
241}
242#endif
243
Daniel Veillarde356c282001-03-10 12:32:04 +0000244/**
Owen Taylor3473f882001-02-23 17:55:21 +0000245 * xmlParserError:
246 * @ctx: an XML parser context
247 * @msg: the message to display/transmit
248 * @...: extra parameters for the message display
249 *
250 * Display and format an error messages, gives file, line, position and
251 * extra parameters.
252 */
253void
254xmlParserError(void *ctx, const char *msg, ...)
255{
256 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
257 xmlParserInputPtr input = NULL;
258 xmlParserInputPtr cur = NULL;
Daniel Veillarde356c282001-03-10 12:32:04 +0000259 char * str;
Owen Taylor3473f882001-02-23 17:55:21 +0000260
261 if (ctxt != NULL) {
262 input = ctxt->input;
263 if ((input != NULL) && (input->filename == NULL) &&
264 (ctxt->inputNr > 1)) {
265 cur = input;
266 input = ctxt->inputTab[ctxt->inputNr - 2];
267 }
268 xmlParserPrintFileInfo(input);
269 }
270
271 xmlGenericError(xmlGenericErrorContext, "error: ");
Daniel Veillard1c43dbf2001-06-05 17:12:52 +0000272 XML_GET_VAR_STR(msg, str);
Daniel Veillard635ef722001-10-29 11:48:19 +0000273 xmlGenericError(xmlGenericErrorContext, "%s", str);
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000274 if (str != NULL)
275 xmlFree(str);
Owen Taylor3473f882001-02-23 17:55:21 +0000276
277 if (ctxt != NULL) {
278 xmlParserPrintFileContext(input);
279 if (cur != NULL) {
280 xmlParserPrintFileInfo(cur);
281 xmlGenericError(xmlGenericErrorContext, "\n");
282 xmlParserPrintFileContext(cur);
283 }
284 }
285}
286
287/**
288 * xmlParserWarning:
289 * @ctx: an XML parser context
290 * @msg: the message to display/transmit
291 * @...: extra parameters for the message display
292 *
293 * Display and format a warning messages, gives file, line, position and
294 * extra parameters.
295 */
296void
297xmlParserWarning(void *ctx, const char *msg, ...)
298{
299 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
300 xmlParserInputPtr input = NULL;
301 xmlParserInputPtr cur = NULL;
Daniel Veillarde356c282001-03-10 12:32:04 +0000302 char * str;
Owen Taylor3473f882001-02-23 17:55:21 +0000303
304 if (ctxt != NULL) {
305 input = ctxt->input;
306 if ((input != NULL) && (input->filename == NULL) &&
307 (ctxt->inputNr > 1)) {
308 cur = input;
309 input = ctxt->inputTab[ctxt->inputNr - 2];
310 }
311 xmlParserPrintFileInfo(input);
312 }
313
314 xmlGenericError(xmlGenericErrorContext, "warning: ");
Daniel Veillard1c43dbf2001-06-05 17:12:52 +0000315 XML_GET_VAR_STR(msg, str);
Daniel Veillard635ef722001-10-29 11:48:19 +0000316 xmlGenericError(xmlGenericErrorContext, "%s", str);
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000317 if (str != NULL)
318 xmlFree(str);
Owen Taylor3473f882001-02-23 17:55:21 +0000319
320 if (ctxt != NULL) {
321 xmlParserPrintFileContext(input);
322 if (cur != NULL) {
323 xmlParserPrintFileInfo(cur);
324 xmlGenericError(xmlGenericErrorContext, "\n");
325 xmlParserPrintFileContext(cur);
326 }
327 }
328}
329
330/************************************************************************
331 * *
332 * Handling of validation errors *
333 * *
334 ************************************************************************/
335
336/**
337 * xmlParserValidityError:
338 * @ctx: an XML parser context
339 * @msg: the message to display/transmit
340 * @...: extra parameters for the message display
341 *
342 * Display and format an validity error messages, gives file,
343 * line, position and extra parameters.
344 */
345void
346xmlParserValidityError(void *ctx, const char *msg, ...)
347{
348 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
349 xmlParserInputPtr input = NULL;
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000350 char * str;
Daniel Veillard76575762002-09-05 14:21:15 +0000351 int len = xmlStrlen((const xmlChar *) msg);
352 static int had_info = 0;
353 int need_context = 0;
Owen Taylor3473f882001-02-23 17:55:21 +0000354
Daniel Veillard76575762002-09-05 14:21:15 +0000355 if ((len > 1) && (msg[len - 2] != ':')) {
356 if (ctxt != NULL) {
357 input = ctxt->input;
358 if ((input->filename == NULL) && (ctxt->inputNr > 1))
359 input = ctxt->inputTab[ctxt->inputNr - 2];
360
361 if (had_info == 0) {
362 xmlParserPrintFileInfo(input);
363 }
364 }
365 xmlGenericError(xmlGenericErrorContext, "validity error: ");
366 need_context = 1;
367 had_info = 0;
368 } else {
369 had_info = 1;
Owen Taylor3473f882001-02-23 17:55:21 +0000370 }
371
Daniel Veillard1c43dbf2001-06-05 17:12:52 +0000372 XML_GET_VAR_STR(msg, str);
Daniel Veillard635ef722001-10-29 11:48:19 +0000373 xmlGenericError(xmlGenericErrorContext, "%s", str);
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000374 if (str != NULL)
375 xmlFree(str);
Owen Taylor3473f882001-02-23 17:55:21 +0000376
Daniel Veillard76575762002-09-05 14:21:15 +0000377 if ((ctxt != NULL) && (input != NULL)) {
Owen Taylor3473f882001-02-23 17:55:21 +0000378 xmlParserPrintFileContext(input);
379 }
380}
381
382/**
383 * xmlParserValidityWarning:
384 * @ctx: an XML parser context
385 * @msg: the message to display/transmit
386 * @...: extra parameters for the message display
387 *
388 * Display and format a validity warning messages, gives file, line,
389 * position and extra parameters.
390 */
391void
392xmlParserValidityWarning(void *ctx, const char *msg, ...)
393{
394 xmlParserCtxtPtr ctxt = (xmlParserCtxtPtr) ctx;
395 xmlParserInputPtr input = NULL;
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000396 char * str;
Daniel Veillard76575762002-09-05 14:21:15 +0000397 int len = xmlStrlen((const xmlChar *) msg);
Owen Taylor3473f882001-02-23 17:55:21 +0000398
Daniel Veillard76575762002-09-05 14:21:15 +0000399 if ((ctxt != NULL) && (len != 0) && (msg[len - 1] != ':')) {
Owen Taylor3473f882001-02-23 17:55:21 +0000400 input = ctxt->input;
401 if ((input->filename == NULL) && (ctxt->inputNr > 1))
402 input = ctxt->inputTab[ctxt->inputNr - 2];
403
404 xmlParserPrintFileInfo(input);
405 }
406
407 xmlGenericError(xmlGenericErrorContext, "validity warning: ");
Daniel Veillard1c43dbf2001-06-05 17:12:52 +0000408 XML_GET_VAR_STR(msg, str);
Daniel Veillard635ef722001-10-29 11:48:19 +0000409 xmlGenericError(xmlGenericErrorContext, "%s", str);
Daniel Veillard9e7160d2001-03-18 23:17:47 +0000410 if (str != NULL)
411 xmlFree(str);
Owen Taylor3473f882001-02-23 17:55:21 +0000412
413 if (ctxt != NULL) {
414 xmlParserPrintFileContext(input);
415 }
416}
417
418