Copied from old documentation. Removed all Gedcom_val details.
[gedcom-parse.git] / gedcom / message.c
1 /* Implementation of the messaging API to applications.
2    Copyright (C) 2001 The Genes Development Team
3    This file is part of the Gedcom parser library.
4    Contributed by Peter Verthez <Peter.Verthez@advalvas.be>, 2001.
5
6    The Gedcom parser library is free software; you can redistribute it
7    and/or modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The Gedcom parser library is distributed in the hope that it will be
12    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the Gedcom parser library; if not, write to the
18    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 /* $Id$ */
22 /* $Name$ */
23
24 #include "gedcom_internal.h"
25 #include "gedcom.h"
26 #include "buffer.h"
27
28 void cleanup_mess_buffer();
29
30 struct safe_buffer mess_buffer = { NULL, 0, NULL, 0, cleanup_mess_buffer };
31 Gedcom_msg_handler msg_handler = NULL;
32
33 /** This function registers a callback that is called if there are errors,
34     warnings or just messages coming from the parser.  See
35     \ref Gedcom_msg_handler for the signature of the callback.
36
37     For errors, the \c msg passed to the callback will have the format:
38     \code
39       Error on line <lineno>: <actual_message>
40     \endcode
41     Note that the entire string will be properly internationalized, and
42     encoded in UTF-8 (<a href=encoding.html>Why UTF-8?</a>).
43     Also, no newline is appended, so that
44     the application program can use it in any way it wants.  Warnings are
45     similar, but use "Warning" instead of "Error".  Messages are plain
46     text, without any prefix.
47 */
48 void gedcom_set_message_handler(Gedcom_msg_handler func)
49 {
50   msg_handler = func;
51 }
52
53 void cleanup_mess_buffer()
54 {
55   cleanup_buffer(&mess_buffer);
56 }
57
58 int gedcom_message(const char* s, ...)
59 {
60   int res;
61   va_list ap;
62
63   va_start(ap, s);
64   reset_buffer(&mess_buffer);
65   res = safe_buf_vappend(&mess_buffer, s, ap);
66   va_end(ap);
67   if (msg_handler)
68     (*msg_handler)(MESSAGE, get_buf_string(&mess_buffer));
69   return res;
70 }
71
72 int gedcom_warning(const char* s, ...)
73 {
74   int res;
75   va_list ap;
76
77   reset_buffer(&mess_buffer);
78   if (line_no != 0) 
79     safe_buf_append(&mess_buffer, _("Warning on line %d: "), line_no);
80   else
81     safe_buf_append(&mess_buffer, _("Warning: "));
82   va_start(ap, s);
83   res = safe_buf_vappend(&mess_buffer, s, ap);
84   va_end(ap);
85   if (msg_handler)
86     (*msg_handler)(WARNING, get_buf_string(&mess_buffer));
87   
88   return res;
89 }
90
91 int gedcom_error(const char* s, ...)
92 {
93   int res;
94   va_list ap;
95
96   reset_buffer(&mess_buffer);
97   if (line_no != 0)
98     safe_buf_append(&mess_buffer, _("Error on line %d: "), line_no);
99   else
100     safe_buf_append(&mess_buffer, _("Error: "));
101   va_start(ap, s);
102   res = safe_buf_vappend(&mess_buffer, s, ap);
103   va_end(ap);
104   if (msg_handler)
105     (*msg_handler)(ERROR, get_buf_string(&mess_buffer));
106   
107   return res;
108 }
109
110 void gedcom_mem_error(const char *filename, int line)
111 {
112   gedcom_error(_("Could not allocate memory at %s, %d"), filename, line);
113 }