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 */
59 ELT_HEAD_SOUR = NR_OF_RECS + 1,
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 {
341 typedef enum _AGE_TYPE {
349 typedef enum _AGE_MODIFIER {
361 char phrase[MAX_PHRASE_LEN + 1];
364 /**************************************************************************/
365 /*** Things meant to be internal, susceptible to changes ***/
366 /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/
368 /**************************************************************************/
370 typedef enum _GEDCOM_VAL_TYPE {
378 union _Gedcom_val_union {
380 struct date_value date_val;
381 struct age_value age_val;
382 struct xref_value *xref_val;
385 typedef struct _Gedcom_val_struct {
386 Gedcom_val_type type;
387 union _Gedcom_val_union value;
390 void gedcom_cast_error(char* file, int line,
391 Gedcom_val_type tried_type,
392 Gedcom_val_type real_type);
394 extern struct date_value def_date_val;
395 extern struct age_value def_age_val;
396 extern struct xref_value def_xref_val;
398 #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \
399 ((VAL->type == TYPE) ? \
400 VAL->value.MEMBER : \
401 (gedcom_cast_error(__FILE__,__LINE__, TYPE, VAL->type), DEFVAL))
403 #define GV_IS_TYPE(VAL, TYPE) \
406 /**************************************************************************/
407 /*** Function interface ***/
408 /**************************************************************************/
410 /* Type for parsed values, meant to be opaque */
411 typedef Gedcom_val_struct* Gedcom_val;
413 /* Check to determine whether there is a parsed value or not */
414 #define GEDCOM_IS_NULL(VAL) \
415 GV_IS_TYPE(VAL, GV_NULL)
417 /* This returns the char* from a Gedcom_val, if appropriate */
418 /* It gives a gedcom_warning if the cast is not correct */
419 #define GEDCOM_STRING(VAL) \
420 GV_CHECK_CAST(VAL, GV_CHAR_PTR, string_val, "<error>")
421 #define GEDCOM_IS_STRING(VAL) \
422 GV_IS_TYPE(VAL, GV_CHAR_PTR)
424 /* This returns the struct date_value from a Gedcom_val, if appropriate */
425 /* It gives a gedcom_warning if the cast is not correct */
426 #define GEDCOM_DATE(VAL) \
427 GV_CHECK_CAST(VAL, GV_DATE_VALUE, date_val, def_date_val)
428 #define GEDCOM_IS_DATE(VAL) \
429 GV_IS_TYPE(VAL, GV_DATE_VALUE)
431 /* This returns the struct age_value from a Gedcom_val, if appropriate */
432 /* It gives a gedcom_warning if the cast is not correct */
433 #define GEDCOM_AGE(VAL) \
434 GV_CHECK_CAST(VAL, GV_AGE_VALUE, age_val, def_age_val)
435 #define GEDCOM_IS_AGE(VAL) \
436 GV_IS_TYPE(VAL, GV_AGE_VALUE)
438 /* This returns the (struct xref_value *) from a Gedcom_val, if appropriate */
439 /* It gives a gedcom_warning if the cast is not correct */
440 #define GEDCOM_XREF_PTR(VAL) \
441 GV_CHECK_CAST(VAL, GV_XREF_PTR, xref_val, &def_xref_val)
442 #define GEDCOM_IS_XREF_PTR(VAL) \
443 GV_IS_TYPE(VAL, GV_XREF_PTR)
446 (*Gedcom_msg_handler)
447 (Gedcom_msg_type type, char *msg);
450 (*Gedcom_rec_start_cb)
451 (Gedcom_rec rec, int level, Gedcom_val xref, char *tag,
452 char *raw_value, int tag_value, Gedcom_val parsed_value);
455 (Gedcom_rec rec, Gedcom_ctxt self);
458 (*Gedcom_elt_start_cb)
459 (Gedcom_elt elt, Gedcom_ctxt parent,
460 int level, char *tag, char *raw_value,
461 int tag_value, Gedcom_val parsed_value);
464 (Gedcom_elt elt, Gedcom_ctxt parent, Gedcom_ctxt self,
465 Gedcom_val parsed_value);
469 (Gedcom_elt elt, Gedcom_ctxt parent, int level, char *tag,
470 char *raw_value, int tag_value);
473 int gedcom_parse_file(char* file_name);
474 void gedcom_set_debug_level(int level, FILE* trace_output);
475 void gedcom_set_error_handling(Gedcom_err_mech mechanism);
476 void gedcom_set_compat_handling(int enable_compat);
477 void gedcom_set_message_handler(Gedcom_msg_handler func);
478 void gedcom_set_default_callback(Gedcom_def_cb func);
480 void gedcom_subscribe_to_record(Gedcom_rec rec,
481 Gedcom_rec_start_cb cb_start,
482 Gedcom_rec_end_cb cb_end);
483 void gedcom_subscribe_to_element(Gedcom_elt elt,
484 Gedcom_elt_start_cb cb_start,
485 Gedcom_elt_end_cb cb_end);
487 /* Separate value parsing functions */
488 struct date_value gedcom_parse_date(char* line_value);
489 struct age_value gedcom_parse_age(char* line_value);
490 struct xref_value *gedcom_get_by_xref(char *key);
494 #endif /* __GEDCOM_H */