1 /* External header for the Gedcom parser library.
2 Copyright (C) 2001,2002 The Genes Development Team
3 This file is part of the Gedcom parser library.
4 Contributed by Peter Verthez <Peter.Verthez@advalvas.be>, 2001.
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.
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.
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
31 #ifndef GEDCOM_INTERNAL
32 #include <gedcom-tags.h>
35 #define GEDCOM_PARSE_VERSION_MAJOR @VERSION_MAJOR@
36 #define GEDCOM_PARSE_VERSION_MINOR @VERSION_MINOR@
37 #define GEDCOM_PARSE_VERSION \
38 (GEDCOM_PARSE_VERSION_MAJOR * 1000 + GEDCOM_PARSE_VERSION_MINOR)
40 /**************************************************************************/
41 /*** First the records and elements to subscribe upon ***/
42 /**************************************************************************/
55 NR_OF_RECS /* Just a final value to be used in array boundaries */
64 ELT_HEAD_SOUR_DATA_DATE,
65 ELT_HEAD_SOUR_DATA_COPR,
108 ELT_SOUR_DATA_EVEN_DATE,
109 ELT_SOUR_DATA_EVEN_PLAC,
162 ELT_SUB_FAM_EVT_HUSB,
163 ELT_SUB_FAM_EVT_WIFE,
165 ELT_SUB_FAM_EVT_EVEN,
168 ELT_SUB_IDENT_REFN_TYPE,
174 ELT_SUB_INDIV_BIRT_FAMC,
177 ELT_SUB_INDIV_ADOP_FAMC,
178 ELT_SUB_INDIV_ADOP_FAMC_ADOP,
182 ELT_SUB_LIO_BAPL_STAT,
183 ELT_SUB_LIO_BAPL_DATE,
184 ELT_SUB_LIO_BAPL_TEMP,
185 ELT_SUB_LIO_BAPL_PLAC,
187 ELT_SUB_LIO_SLGC_FAMC,
190 ELT_SUB_LSS_SLGS_STAT,
191 ELT_SUB_LSS_SLGS_DATE,
192 ELT_SUB_LSS_SLGS_TEMP,
193 ELT_SUB_LSS_SLGS_PLAC,
196 ELT_SUB_MULTIM_OBJE_FORM,
197 ELT_SUB_MULTIM_OBJE_TITL,
198 ELT_SUB_MULTIM_OBJE_FILE,
203 ELT_SUB_PERS_NAME_NPFX,
204 ELT_SUB_PERS_NAME_GIVN,
205 ELT_SUB_PERS_NAME_NICK,
206 ELT_SUB_PERS_NAME_SPFX,
207 ELT_SUB_PERS_NAME_SURN,
208 ELT_SUB_PERS_NAME_NSFX,
216 ELT_SUB_SOUR_EVEN_ROLE,
218 ELT_SUB_SOUR_DATA_DATE,
224 ELT_SUB_REPO_CALN_MEDI,
230 NR_OF_ELTS /* Just a final value to be used in array boundaries */
233 /**************************************************************************/
234 /*** Definition of some auxiliary types ***/
235 /**************************************************************************/
249 typedef enum _DATE_TYPE {
250 DATE_UNRECOGNIZED, /* Neither jday1 as jday2 are significant */
251 DATE_EXACT, /* Only jday1 is significant */
252 DATE_BOUNDED /* Both jday1 and jday2 are significant */
255 typedef enum _CALENDAR_TYPE {
263 typedef enum _YEAR_TYPE {
265 YEAR_DOUBLE /* In this case, the 'year' indicates the last value */
268 typedef enum _DATE_VAL_MOD {
274 DV_BETWEEN, /* Two dates are given */
278 DV_FROM_TO, /* Two dates are given */
284 DV_INTERPRETED, /* One date and a phrase is given */
285 DV_PHRASE /* Only phrase is given */
288 /* All Unicode characters between U+0000 and U+FFFF can be encoded in
289 UTF-8 with 3 or less bytes */
292 #define MAX_DAY_LEN 2
293 #define MAX_MONTH_LEN 4
294 #define MAX_YEAR_LEN 7
295 #define MAX_PHRASE_LEN 35 * UTF_FACTOR
299 char day_str[MAX_DAY_LEN + 1];
300 char month_str[MAX_MONTH_LEN + 1];
301 char year_str[MAX_YEAR_LEN + 1];
302 int day; /* starts at 1 */
303 int month; /* starts at 1 */
304 int year; /* the highest value for double years */
312 Date_value_type type;
315 char phrase[MAX_PHRASE_LEN + 1];
318 /* Type for context handling, meant to be opaque */
319 typedef void* Gedcom_ctxt;
321 typedef enum _XREF_TYPE {
340 /**************************************************************************/
341 /*** Things meant to be internal, susceptible to changes ***/
342 /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/
344 /**************************************************************************/
346 typedef enum _GEDCOM_VAL_TYPE {
353 union _Gedcom_val_union {
355 struct date_value date_val;
356 struct xref_value *xref_val;
359 typedef struct _Gedcom_val_struct {
360 Gedcom_val_type type;
361 union _Gedcom_val_union value;
364 void gedcom_cast_error(char* file, int line,
365 Gedcom_val_type tried_type,
366 Gedcom_val_type real_type);
368 extern struct date_value def_date_val;
369 extern struct xref_value def_xref_val;
371 #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \
372 ((VAL->type == TYPE) ? \
373 VAL->value.MEMBER : \
374 (gedcom_cast_error(__FILE__,__LINE__, TYPE, VAL->type), DEFVAL))
376 #define GV_IS_TYPE(VAL, TYPE) \
379 /**************************************************************************/
380 /*** Function interface ***/
381 /**************************************************************************/
383 /* Type for parsed values, meant to be opaque */
384 typedef Gedcom_val_struct* Gedcom_val;
386 /* Check to determine whether there is a parsed value or not */
387 #define GEDCOM_IS_NULL(VAL) \
388 GV_IS_TYPE(VAL, GV_NULL)
390 /* This returns the char* from a Gedcom_val, if appropriate */
391 /* It gives a gedcom_warning if the cast is not correct */
392 #define GEDCOM_STRING(VAL) \
393 GV_CHECK_CAST(VAL, GV_CHAR_PTR, string_val, "<error>")
394 #define GEDCOM_IS_STRING(VAL) \
395 GV_IS_TYPE(VAL, GV_CHAR_PTR)
397 /* This returns the struct date_value from a Gedcom_val, if appropriate */
398 /* It gives a gedcom_warning if the cast is not correct */
399 #define GEDCOM_DATE(VAL) \
400 GV_CHECK_CAST(VAL, GV_DATE_VALUE, date_val, def_date_val)
401 #define GEDCOM_IS_DATE(VAL) \
402 GV_IS_TYPE(VAL, GV_DATE_VALUE)
404 /* This returns the (struct xref_value *) from a Gedcom_val, if appropriate */
405 /* It gives a gedcom_warning if the cast is not correct */
406 #define GEDCOM_XREF_PTR(VAL) \
407 GV_CHECK_CAST(VAL, GV_XREF_PTR, xref_val, &def_xref_val)
408 #define GEDCOM_IS_XREF_PTR(VAL) \
409 GV_IS_TYPE(VAL, GV_XREF_PTR)
412 (*Gedcom_msg_handler)
413 (Gedcom_msg_type type, char *msg);
416 (*Gedcom_rec_start_cb)
417 (int level, Gedcom_val xref, char *tag, char *raw_value,
418 int tag_value, Gedcom_val parsed_value);
424 (*Gedcom_elt_start_cb)
426 int level, char *tag, char *raw_value,
427 int tag_value, Gedcom_val parsed_value);
430 (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value);
434 (Gedcom_ctxt parent, int level, char *tag, char *raw_value,
438 int gedcom_parse_file(char* file_name);
439 void gedcom_set_debug_level(int level, FILE* trace_output);
440 void gedcom_set_error_handling(Gedcom_err_mech mechanism);
441 void gedcom_set_compat_handling(int enable_compat);
442 void gedcom_set_message_handler(Gedcom_msg_handler func);
443 void gedcom_set_default_callback(Gedcom_def_cb func);
445 void gedcom_subscribe_to_record(Gedcom_rec rec,
446 Gedcom_rec_start_cb cb_start,
447 Gedcom_rec_end_cb cb_end);
448 void gedcom_subscribe_to_element(Gedcom_elt elt,
449 Gedcom_elt_start_cb cb_start,
450 Gedcom_elt_end_cb cb_end);
452 /* Separate value parsing functions */
453 struct date_value gedcom_parse_date(char* line_value);
457 #endif /* __GEDCOM_H */