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
32 #ifndef GEDCOM_INTERNAL
33 #include <gedcom-tags.h>
36 #define GEDCOM_PARSE_VERSION_MAJOR @VERSION_MAJOR@
37 #define GEDCOM_PARSE_VERSION_MINOR @VERSION_MINOR@
38 #define GEDCOM_PARSE_VERSION \
39 (GEDCOM_PARSE_VERSION_MAJOR * 1000 + GEDCOM_PARSE_VERSION_MINOR)
41 /**************************************************************************/
42 /*** First the records and elements to subscribe upon ***/
43 /**************************************************************************/
56 NR_OF_RECS /* Just a final value to be used in array boundaries */
60 ELT_HEAD_SOUR = NR_OF_RECS + 1,
65 ELT_HEAD_SOUR_DATA_DATE,
66 ELT_HEAD_SOUR_DATA_COPR,
109 ELT_SOUR_DATA_EVEN_DATE,
110 ELT_SOUR_DATA_EVEN_PLAC,
163 ELT_SUB_FAM_EVT_HUSB,
164 ELT_SUB_FAM_EVT_WIFE,
166 ELT_SUB_FAM_EVT_EVEN,
169 ELT_SUB_IDENT_REFN_TYPE,
175 ELT_SUB_INDIV_BIRT_FAMC,
178 ELT_SUB_INDIV_ADOP_FAMC,
179 ELT_SUB_INDIV_ADOP_FAMC_ADOP,
183 ELT_SUB_LIO_BAPL_STAT,
184 ELT_SUB_LIO_BAPL_DATE,
185 ELT_SUB_LIO_BAPL_TEMP,
186 ELT_SUB_LIO_BAPL_PLAC,
188 ELT_SUB_LIO_SLGC_FAMC,
191 ELT_SUB_LSS_SLGS_STAT,
192 ELT_SUB_LSS_SLGS_DATE,
193 ELT_SUB_LSS_SLGS_TEMP,
194 ELT_SUB_LSS_SLGS_PLAC,
197 ELT_SUB_MULTIM_OBJE_FORM,
198 ELT_SUB_MULTIM_OBJE_TITL,
199 ELT_SUB_MULTIM_OBJE_FILE,
204 ELT_SUB_PERS_NAME_NPFX,
205 ELT_SUB_PERS_NAME_GIVN,
206 ELT_SUB_PERS_NAME_NICK,
207 ELT_SUB_PERS_NAME_SPFX,
208 ELT_SUB_PERS_NAME_SURN,
209 ELT_SUB_PERS_NAME_NSFX,
217 ELT_SUB_SOUR_EVEN_ROLE,
219 ELT_SUB_SOUR_DATA_DATE,
225 ELT_SUB_REPO_CALN_MEDI,
231 NR_OF_ELTS /* Just a final value to be used in array boundaries */
234 /**************************************************************************/
235 /*** Definition of some auxiliary types ***/
236 /**************************************************************************/
250 typedef enum _DATE_TYPE {
251 DATE_UNRECOGNIZED, /* Neither jday1 as jday2 are significant */
252 DATE_EXACT, /* Only jday1 is significant */
253 DATE_BOUNDED /* Both jday1 and jday2 are significant */
256 typedef enum _CALENDAR_TYPE {
264 typedef enum _YEAR_TYPE {
266 YEAR_DOUBLE /* In this case, the 'year' indicates the last value */
269 typedef enum _DATE_VAL_MOD {
275 DV_BETWEEN, /* Two dates are given */
279 DV_FROM_TO, /* Two dates are given */
285 DV_INTERPRETED, /* One date and a phrase is given */
286 DV_PHRASE /* Only phrase is given */
289 /* All Unicode characters between U+0000 and U+FFFF can be encoded in
290 UTF-8 with 3 or less bytes */
293 #define MAX_DAY_LEN 2
294 #define MAX_MONTH_LEN 4
295 #define MAX_YEAR_LEN 7
296 #define MAX_PHRASE_LEN 35 * UTF_FACTOR
300 char day_str[MAX_DAY_LEN + 1];
301 char month_str[MAX_MONTH_LEN + 1];
302 char year_str[MAX_YEAR_LEN + 1];
303 int day; /* starts at 1 */
304 int month; /* starts at 1 */
305 int year; /* the highest value for double years */
313 Date_value_type type;
316 char phrase[MAX_PHRASE_LEN + 1];
319 /* Type for context handling, meant to be opaque */
320 typedef void* Gedcom_ctxt;
322 typedef enum _XREF_TYPE {
342 typedef enum _AGE_TYPE {
350 typedef enum _AGE_MODIFIER {
362 char phrase[MAX_PHRASE_LEN + 1];
365 /**************************************************************************/
366 /*** Things meant to be internal, susceptible to changes ***/
367 /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/
369 /**************************************************************************/
371 typedef enum _GEDCOM_VAL_TYPE {
379 union _Gedcom_val_union {
381 struct date_value date_val;
382 struct age_value age_val;
383 struct xref_value *xref_val;
386 typedef struct _Gedcom_val_struct {
387 Gedcom_val_type type;
388 union _Gedcom_val_union value;
391 void gedcom_cast_error(char* file, int line,
392 Gedcom_val_type tried_type,
393 Gedcom_val_type real_type);
395 extern struct date_value def_date_val;
396 extern struct age_value def_age_val;
397 extern struct xref_value def_xref_val;
399 #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \
400 ((VAL->type == TYPE) ? \
401 VAL->value.MEMBER : \
402 (gedcom_cast_error(__FILE__,__LINE__, TYPE, VAL->type), DEFVAL))
404 #define GV_IS_TYPE(VAL, TYPE) \
407 /**************************************************************************/
408 /*** Function interface ***/
409 /**************************************************************************/
411 /* Type for parsed values, meant to be opaque */
412 typedef Gedcom_val_struct* Gedcom_val;
414 /* Check to determine whether there is a parsed value or not */
415 #define GEDCOM_IS_NULL(VAL) \
416 GV_IS_TYPE(VAL, GV_NULL)
418 /* This returns the char* from a Gedcom_val, if appropriate */
419 /* It gives a gedcom_warning if the cast is not correct */
420 #define GEDCOM_STRING(VAL) \
421 GV_CHECK_CAST(VAL, GV_CHAR_PTR, string_val, "<error>")
422 #define GEDCOM_IS_STRING(VAL) \
423 GV_IS_TYPE(VAL, GV_CHAR_PTR)
425 /* This returns the struct date_value from a Gedcom_val, if appropriate */
426 /* It gives a gedcom_warning if the cast is not correct */
427 #define GEDCOM_DATE(VAL) \
428 GV_CHECK_CAST(VAL, GV_DATE_VALUE, date_val, def_date_val)
429 #define GEDCOM_IS_DATE(VAL) \
430 GV_IS_TYPE(VAL, GV_DATE_VALUE)
432 /* This returns the struct age_value from a Gedcom_val, if appropriate */
433 /* It gives a gedcom_warning if the cast is not correct */
434 #define GEDCOM_AGE(VAL) \
435 GV_CHECK_CAST(VAL, GV_AGE_VALUE, age_val, def_age_val)
436 #define GEDCOM_IS_AGE(VAL) \
437 GV_IS_TYPE(VAL, GV_AGE_VALUE)
439 /* This returns the (struct xref_value *) from a Gedcom_val, if appropriate */
440 /* It gives a gedcom_warning if the cast is not correct */
441 #define GEDCOM_XREF_PTR(VAL) \
442 GV_CHECK_CAST(VAL, GV_XREF_PTR, xref_val, &def_xref_val)
443 #define GEDCOM_IS_XREF_PTR(VAL) \
444 GV_IS_TYPE(VAL, GV_XREF_PTR)
447 (*Gedcom_msg_handler)
448 (Gedcom_msg_type type, char *msg);
451 (*Gedcom_rec_start_cb)
452 (Gedcom_rec rec, int level, Gedcom_val xref, char *tag,
453 char *raw_value, int tag_value, Gedcom_val parsed_value);
456 (Gedcom_rec rec, Gedcom_ctxt self);
459 (*Gedcom_elt_start_cb)
460 (Gedcom_elt elt, Gedcom_ctxt parent,
461 int level, char *tag, char *raw_value,
462 int tag_value, Gedcom_val parsed_value);
465 (Gedcom_elt elt, Gedcom_ctxt parent, Gedcom_ctxt self,
466 Gedcom_val parsed_value);
470 (Gedcom_elt elt, Gedcom_ctxt parent, int level, char *tag,
471 char *raw_value, int tag_value);
474 int gedcom_parse_file(char* file_name);
475 void gedcom_set_debug_level(int level, FILE* trace_output);
476 void gedcom_set_error_handling(Gedcom_err_mech mechanism);
477 void gedcom_set_compat_handling(int enable_compat);
478 void gedcom_set_message_handler(Gedcom_msg_handler func);
479 void gedcom_set_default_callback(Gedcom_def_cb func);
481 void gedcom_subscribe_to_record(Gedcom_rec rec,
482 Gedcom_rec_start_cb cb_start,
483 Gedcom_rec_end_cb cb_end);
484 void gedcom_subscribe_to_element(Gedcom_elt elt,
485 Gedcom_elt_start_cb cb_start,
486 Gedcom_elt_end_cb cb_end);
488 /* Separate value parsing functions */
489 struct date_value gedcom_parse_date(char* line_value);
490 struct age_value gedcom_parse_age(char* line_value);
491 struct xref_value *gedcom_get_by_xref(char *key);
494 int gedcom_error(char* s, ...);
495 int gedcom_warning(char* s, ...);
496 int gedcom_message(char* s, ...);
497 int gedcom_debug_print(char* s, ...);
501 #endif /* __GEDCOM_H */