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
34 #ifndef GEDCOM_INTERNAL
35 #include <gedcom-tags.h>
38 #define GEDCOM_PARSE_VERSION_MAJOR @VERSION_MAJOR@
39 #define GEDCOM_PARSE_VERSION_MINOR @VERSION_MINOR@
40 #define GEDCOM_PARSE_VERSION_PATCH 0
41 #define GEDCOM_PARSE_VERSION \
42 (GEDCOM_PARSE_VERSION_MAJOR * 1000 + GEDCOM_PARSE_VERSION_MINOR)
44 int gedcom_check_version(int major, int minor, int patch);
46 /**************************************************************************/
47 /*** First the records and elements to subscribe upon ***/
48 /**************************************************************************/
61 NR_OF_RECS /* Just a final value to be used in array boundaries */
65 ELT_HEAD_SOUR = NR_OF_RECS,
70 ELT_HEAD_SOUR_DATA_DATE,
71 ELT_HEAD_SOUR_DATA_COPR,
114 ELT_SOUR_DATA_EVEN_DATE,
115 ELT_SOUR_DATA_EVEN_PLAC,
168 ELT_SUB_FAM_EVT_HUSB,
169 ELT_SUB_FAM_EVT_WIFE,
171 ELT_SUB_FAM_EVT_EVEN,
174 ELT_SUB_IDENT_REFN_TYPE,
180 ELT_SUB_INDIV_BIRT_FAMC,
183 ELT_SUB_INDIV_ADOP_FAMC,
184 ELT_SUB_INDIV_ADOP_FAMC_ADOP,
188 ELT_SUB_LIO_BAPL_STAT,
189 ELT_SUB_LIO_BAPL_DATE,
190 ELT_SUB_LIO_BAPL_TEMP,
191 ELT_SUB_LIO_BAPL_PLAC,
193 ELT_SUB_LIO_SLGC_FAMC,
196 ELT_SUB_LSS_SLGS_STAT,
197 ELT_SUB_LSS_SLGS_DATE,
198 ELT_SUB_LSS_SLGS_TEMP,
199 ELT_SUB_LSS_SLGS_PLAC,
202 ELT_SUB_MULTIM_OBJE_FORM,
203 ELT_SUB_MULTIM_OBJE_TITL,
204 ELT_SUB_MULTIM_OBJE_FILE,
209 ELT_SUB_PERS_NAME_NPFX,
210 ELT_SUB_PERS_NAME_GIVN,
211 ELT_SUB_PERS_NAME_NICK,
212 ELT_SUB_PERS_NAME_SPFX,
213 ELT_SUB_PERS_NAME_SURN,
214 ELT_SUB_PERS_NAME_NSFX,
222 ELT_SUB_SOUR_EVEN_ROLE,
224 ELT_SUB_SOUR_DATA_DATE,
230 ELT_SUB_REPO_CALN_MEDI,
236 NR_OF_ELTS /* Just a final value to be used in array boundaries */
239 /**************************************************************************/
240 /*** Definition of some auxiliary types ***/
241 /**************************************************************************/
255 typedef enum _DATE_TYPE {
256 DATE_UNRECOGNIZED, /* Neither jday1 as jday2 are significant */
257 DATE_EXACT, /* Only jday1 is significant */
258 DATE_BOUNDED /* Both jday1 and jday2 are significant */
261 typedef enum _CALENDAR_TYPE {
269 typedef enum _YEAR_TYPE {
271 YEAR_DOUBLE /* In this case, the 'year' indicates the last value */
274 typedef enum _DATE_VAL_MOD {
280 DV_BETWEEN, /* Two dates are given */
284 DV_FROM_TO, /* Two dates are given */
290 DV_INTERPRETED, /* One date and a phrase is given */
291 DV_PHRASE /* Only phrase is given */
294 /* All Unicode characters between U+0000 and U+FFFF can be encoded in
295 UTF-8 with 3 or less bytes */
298 #define MAX_DAY_LEN 2
299 #define MAX_MONTH_LEN 4
300 #define MAX_YEAR_LEN 7
301 #define MAX_PHRASE_LEN 35 * UTF_FACTOR
305 char day_str[MAX_DAY_LEN + 1];
306 char month_str[MAX_MONTH_LEN + 1];
307 char year_str[MAX_YEAR_LEN + 1];
308 int day; /* starts at 1 */
309 int month; /* starts at 1 */
310 int year; /* the highest value for double years */
318 Date_value_type type;
321 char phrase[MAX_PHRASE_LEN + 1];
324 /* Type for context handling, meant to be opaque */
325 typedef void* Gedcom_ctxt;
327 typedef enum _XREF_TYPE {
347 typedef enum _AGE_TYPE {
355 typedef enum _AGE_MODIFIER {
367 char phrase[MAX_PHRASE_LEN + 1];
372 TWO_BYTE_HILO = 0x01,
376 typedef enum _ENC_BOM {
381 typedef enum _ENC_LINE_END {
388 /**************************************************************************/
389 /*** Things meant to be internal, susceptible to changes ***/
390 /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/
392 /**************************************************************************/
394 typedef enum _GEDCOM_VAL_TYPE {
397 GV_DATE_VALUE = 0x04,
402 union _Gedcom_val_union {
404 struct date_value date_val;
405 struct age_value age_val;
406 struct xref_value *xref_val;
409 typedef struct _Gedcom_val_struct {
410 Gedcom_val_type type;
411 union _Gedcom_val_union value;
414 void gedcom_cast_error(const char* file, int line,
415 Gedcom_val_type tried_type,
416 Gedcom_val_type real_type);
418 extern struct date_value def_date_val;
419 extern struct age_value def_age_val;
420 extern struct xref_value def_xref_val;
422 #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \
423 ((VAL->type == TYPE) ? \
424 VAL->value.MEMBER : \
425 (gedcom_cast_error(__FILE__,__LINE__, TYPE, VAL->type), DEFVAL))
427 #define GV_IS_TYPE(VAL, TYPE) \
430 /**************************************************************************/
431 /*** Function interface ***/
432 /**************************************************************************/
434 /* Type for parsed values, meant to be opaque */
435 typedef Gedcom_val_struct* Gedcom_val;
437 /* Type for write handle, meant to be opaque */
438 struct Gedcom_write_struct;
439 typedef struct Gedcom_write_struct* Gedcom_write_hndl;
441 /* Check to determine whether there is a parsed value or not */
442 #define GEDCOM_IS_NULL(VAL) \
443 GV_IS_TYPE(VAL, GV_NULL)
445 /* This returns the char* from a Gedcom_val, if appropriate */
446 /* It gives a gedcom_warning if the cast is not correct */
447 #define GEDCOM_STRING(VAL) \
448 GV_CHECK_CAST(VAL, GV_CHAR_PTR, string_val, "<error>")
449 #define GEDCOM_IS_STRING(VAL) \
450 GV_IS_TYPE(VAL, GV_CHAR_PTR)
452 /* This returns the struct date_value from a Gedcom_val, if appropriate */
453 /* It gives a gedcom_warning if the cast is not correct */
454 #define GEDCOM_DATE(VAL) \
455 GV_CHECK_CAST(VAL, GV_DATE_VALUE, date_val, def_date_val)
456 #define GEDCOM_IS_DATE(VAL) \
457 GV_IS_TYPE(VAL, GV_DATE_VALUE)
459 /* This returns the struct age_value from a Gedcom_val, if appropriate */
460 /* It gives a gedcom_warning if the cast is not correct */
461 #define GEDCOM_AGE(VAL) \
462 GV_CHECK_CAST(VAL, GV_AGE_VALUE, age_val, def_age_val)
463 #define GEDCOM_IS_AGE(VAL) \
464 GV_IS_TYPE(VAL, GV_AGE_VALUE)
466 /* This returns the (struct xref_value *) from a Gedcom_val, if appropriate */
467 /* It gives a gedcom_warning if the cast is not correct */
468 #define GEDCOM_XREF_PTR(VAL) \
469 GV_CHECK_CAST(VAL, GV_XREF_PTR, xref_val, &def_xref_val)
470 #define GEDCOM_IS_XREF_PTR(VAL) \
471 GV_IS_TYPE(VAL, GV_XREF_PTR)
474 (*Gedcom_msg_handler)
475 (Gedcom_msg_type type, char *msg);
478 (*Gedcom_rec_start_cb)
479 (Gedcom_rec rec, int level, Gedcom_val xref, char *tag,
480 char *raw_value, int tag_value, Gedcom_val parsed_value);
483 (Gedcom_rec rec, Gedcom_ctxt self, Gedcom_val parsed_value);
486 (*Gedcom_elt_start_cb)
487 (Gedcom_elt elt, Gedcom_ctxt parent,
488 int level, char *tag, char *raw_value,
489 int tag_value, Gedcom_val parsed_value);
492 (Gedcom_elt elt, Gedcom_ctxt parent, Gedcom_ctxt self,
493 Gedcom_val parsed_value);
497 (Gedcom_elt elt, Gedcom_ctxt parent, int level, char *tag,
498 char *raw_value, int tag_value);
501 int gedcom_parse_file(const char* file_name);
502 int gedcom_new_model();
503 void gedcom_set_debug_level(int level, FILE* trace_output);
504 void gedcom_set_error_handling(Gedcom_err_mech mechanism);
505 void gedcom_set_compat_handling(int enable_compat);
506 void gedcom_set_message_handler(Gedcom_msg_handler func);
507 void gedcom_set_default_callback(Gedcom_def_cb func);
509 void gedcom_subscribe_to_record(Gedcom_rec rec,
510 Gedcom_rec_start_cb cb_start,
511 Gedcom_rec_end_cb cb_end);
512 void gedcom_subscribe_to_element(Gedcom_elt elt,
513 Gedcom_elt_start_cb cb_start,
514 Gedcom_elt_end_cb cb_end);
516 /* Separate value parsing functions */
517 struct date_value gedcom_parse_date(const char* line_value);
518 struct age_value gedcom_parse_age(const char* line_value);
520 /* Handling cross-references */
521 struct xref_value *gedcom_get_by_xref(const char *key);
522 struct xref_value *gedcom_add_xref(Xref_type type, const char* xrefstr,
524 struct xref_value *gedcom_link_xref(Xref_type type, const char* xrefstr);
525 struct xref_value *gedcom_unlink_xref(Xref_type type, const char* xrefstr);
526 int gedcom_delete_xref(const char* xrefstr);
528 /* Writing support */
529 Gedcom_write_hndl gedcom_write_open(const char* filename);
530 int gedcom_write_close(Gedcom_write_hndl hndl, int *total_conv_fails);
531 int gedcom_write_set_encoding(const char* charset, Encoding width,
533 int gedcom_write_set_line_terminator(Enc_line_end end);
535 int gedcom_write_record_str(Gedcom_write_hndl hndl,
536 Gedcom_rec rec, int parsed_tag,
537 char* xrefstr, char* val);
538 int gedcom_write_element_str(Gedcom_write_hndl hndl, Gedcom_elt elt,
539 int parsed_tag, int parent_rec_or_elt,
542 int gedcom_write_record_xref(Gedcom_write_hndl hndl,
543 Gedcom_rec rec, int parsed_tag,
544 char* xrefstr, struct xref_value* val);
545 int gedcom_write_element_xref(Gedcom_write_hndl hndl, Gedcom_elt elt,
546 int parsed_tag, int parent_rec_or_elt,
547 struct xref_value* val);
549 int gedcom_write_user_str(Gedcom_write_hndl hndl, int level, char* tag,
550 char* xrefstr, char* value);
551 int gedcom_write_user_xref(Gedcom_write_hndl hndl, int level, char* tag,
552 char* xrefstr, struct xref_value* val);
555 int gedcom_error(const char* s, ...);
556 int gedcom_warning(const char* s, ...);
557 int gedcom_message(const char* s, ...);
558 int gedcom_debug_print(const char* s, ...);
564 #endif /* __GEDCOM_H */