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 /**************************************************************************/
36 /*** First the records and elements to subscribe upon ***/
37 /**************************************************************************/
50 NR_OF_RECS /* Just a final value to be used in array boundaries */
59 ELT_HEAD_SOUR_DATA_DATE,
60 ELT_HEAD_SOUR_DATA_COPR,
103 ELT_SOUR_DATA_EVEN_DATE,
104 ELT_SOUR_DATA_EVEN_PLAC,
157 ELT_SUB_FAM_EVT_HUSB,
158 ELT_SUB_FAM_EVT_WIFE,
160 ELT_SUB_FAM_EVT_EVEN,
163 ELT_SUB_IDENT_REFN_TYPE,
169 ELT_SUB_INDIV_BIRT_FAMC,
172 ELT_SUB_INDIV_ADOP_FAMC,
173 ELT_SUB_INDIV_ADOP_FAMC_ADOP,
177 ELT_SUB_LIO_BAPL_STAT,
178 ELT_SUB_LIO_BAPL_DATE,
179 ELT_SUB_LIO_BAPL_TEMP,
180 ELT_SUB_LIO_BAPL_PLAC,
182 ELT_SUB_LIO_SLGC_FAMC,
185 ELT_SUB_LSS_SLGS_STAT,
186 ELT_SUB_LSS_SLGS_DATE,
187 ELT_SUB_LSS_SLGS_TEMP,
188 ELT_SUB_LSS_SLGS_PLAC,
191 ELT_SUB_MULTIM_OBJE_FORM,
192 ELT_SUB_MULTIM_OBJE_TITL,
193 ELT_SUB_MULTIM_OBJE_FILE,
198 ELT_SUB_PERS_NAME_NPFX,
199 ELT_SUB_PERS_NAME_GIVN,
200 ELT_SUB_PERS_NAME_NICK,
201 ELT_SUB_PERS_NAME_SPFX,
202 ELT_SUB_PERS_NAME_SURN,
203 ELT_SUB_PERS_NAME_NSFX,
211 ELT_SUB_SOUR_EVEN_ROLE,
213 ELT_SUB_SOUR_DATA_DATE,
219 ELT_SUB_REPO_CALN_MEDI,
225 NR_OF_ELTS /* Just a final value to be used in array boundaries */
228 /**************************************************************************/
229 /*** Definition of some auxiliary types ***/
230 /**************************************************************************/
244 typedef enum _DATE_TYPE {
245 DATE_UNRECOGNIZED, /* Neither jday1 as jday2 are significant */
246 DATE_EXACT, /* Only jday1 is significant */
247 DATE_BOUNDED /* Both jday1 and jday2 are significant */
250 typedef enum _CALENDAR_TYPE {
258 typedef enum _YEAR_TYPE {
260 YEAR_DOUBLE /* In this case, the 'year' indicates the last value */
263 typedef enum _DATE_VAL_MOD {
269 DV_BETWEEN, /* Two dates are given */
273 DV_FROM_TO, /* Two dates are given */
279 DV_INTERPRETED, /* One date and a phrase is given */
280 DV_PHRASE /* Only phrase is given */
283 /* All Unicode characters between U+0000 and U+FFFF can be encoded in
284 UTF-8 with 3 or less bytes */
287 #define MAX_DAY_LEN 2
288 #define MAX_MONTH_LEN 4
289 #define MAX_YEAR_LEN 7
290 #define MAX_PHRASE_LEN 35 * UTF_FACTOR
294 char day_str[MAX_DAY_LEN + 1];
295 char month_str[MAX_MONTH_LEN + 1];
296 char year_str[MAX_YEAR_LEN + 1];
297 int day; /* starts at 1 */
298 int month; /* starts at 1 */
299 int year; /* the highest value for double years */
307 Date_value_type type;
310 char phrase[MAX_PHRASE_LEN + 1];
313 /* Type for context handling, meant to be opaque */
314 typedef void* Gedcom_ctxt;
316 /**************************************************************************/
317 /*** Things meant to be internal, susceptible to changes ***/
318 /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/
320 /**************************************************************************/
322 typedef enum _GEDCOM_VAL_TYPE {
328 union _Gedcom_val_union {
330 struct date_value date_val;
333 typedef struct _Gedcom_val_struct {
334 Gedcom_val_type type;
335 union _Gedcom_val_union value;
338 void gedcom_cast_error(char* file, int line,
339 Gedcom_val_type tried_type,
340 Gedcom_val_type real_type);
342 extern struct date_value def_date_val;
344 #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \
345 ((VAL->type == TYPE) ? \
346 VAL->value.MEMBER : \
347 (gedcom_cast_error(__FILE__,__LINE__, TYPE, VAL->type), DEFVAL))
349 #define GV_IS_TYPE(VAL, TYPE) \
352 /**************************************************************************/
353 /*** Function interface ***/
354 /**************************************************************************/
356 /* Type for parsed values, meant to be opaque */
357 typedef Gedcom_val_struct* Gedcom_val;
359 /* Check to determine whether there is a parsed value or not */
360 #define GEDCOM_IS_NULL(VAL) \
361 GV_IS_TYPE(VAL, GV_NULL)
363 /* This returns the char* from a Gedcom_val, if appropriate */
364 /* It gives a gedcom_warning if the cast is not correct */
365 #define GEDCOM_STRING(VAL) \
366 GV_CHECK_CAST(VAL, GV_CHAR_PTR, string_val, "<error>")
367 #define GEDCOM_IS_STRING(VAL) \
368 GV_IS_TYPE(VAL, GV_CHAR_PTR)
370 /* This returns the struct date_value from a Gedcom_val, if appropriate */
371 /* It gives a gedcom_warning if the cast is not correct */
372 #define GEDCOM_DATE(VAL) \
373 GV_CHECK_CAST(VAL, GV_DATE_VALUE, date_val, def_date_val)
374 #define GEDCOM_IS_DATE(VAL) \
375 GV_IS_TYPE(VAL, GV_DATE_VALUE)
378 (*Gedcom_msg_handler)
379 (Gedcom_msg_type type, char *msg);
382 (*Gedcom_rec_start_cb)
383 (int level, Gedcom_val xref, char *tag, char *raw_value,
384 int tag_value, Gedcom_val parsed_value);
390 (*Gedcom_elt_start_cb)
392 int level, char *tag, char *raw_value,
393 int tag_value, Gedcom_val parsed_value);
396 (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value);
400 (Gedcom_ctxt parent, int level, char *tag, char *raw_value,
403 int gedcom_parse_file(char* file_name);
404 void gedcom_set_debug_level(int level, FILE* trace_output);
405 void gedcom_set_error_handling(Gedcom_err_mech mechanism);
406 void gedcom_set_compat_handling(int enable_compat);
407 void gedcom_set_message_handler(Gedcom_msg_handler func);
408 void gedcom_set_default_callback(Gedcom_def_cb func);
410 void gedcom_subscribe_to_record(Gedcom_rec rec,
411 Gedcom_rec_start_cb cb_start,
412 Gedcom_rec_end_cb cb_end);
413 void gedcom_subscribe_to_element(Gedcom_elt elt,
414 Gedcom_elt_start_cb cb_start,
415 Gedcom_elt_end_cb cb_end);
417 /* Separate value parsing functions */
418 struct date_value gedcom_parse_date(char* line_value);
422 #endif /* __GEDCOM_H */