include/gedcom.h

   1 /* External header for the Gedcom parser library.
   2    Copyright (C) 2001 The Genes Development Team
   3    This file is part of the Gedcom parser library.
   4    Contributed by Peter Verthez <Peter.Verthez@advalvas.be>, 2001.
   5
   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.
  10
  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.
  15
  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
  19    02111-1307 USA.  */
  20
  21 /* $Id$ */
  22 /* $Name$ */
  23
  24 #ifndef __GEDCOM_H
  25 #define __GEDCOM_H
  26
  27 #include <stdio.h>
  28
  29 __BEGIN_DECLS
  30
  31 typedef enum _REC {
  32   REC_HEAD,
  33   REC_FAM,
  34   REC_INDI,
  35   REC_OBJE,
  36   REC_NOTE,
  37   REC_REPO,
  38   REC_SOUR,
  39   REC_SUBN,
  40   REC_SUBM,
  41   REC_USER,
  42   NR_OF_RECS     /* Just a final value to be used in array boundaries */
  43 } Gedcom_rec;
  44
  45 typedef enum _ELT {
  46   ELT_HEAD_SOUR,
  47   ELT_HEAD_SOUR_VERS,
  48   ELT_HEAD_SOUR_NAME,
  49   ELT_HEAD_SOUR_CORP,
  50   ELT_HEAD_SOUR_DATA,
  51   ELT_HEAD_SOUR_DATA_DATE,
  52   ELT_HEAD_SOUR_DATA_COPR,
  53   ELT_HEAD_DEST,
  54   ELT_HEAD_DATE,
  55   ELT_HEAD_DATE_TIME,
  56   ELT_HEAD_SUBM,
  57   ELT_HEAD_SUBN,
  58   ELT_HEAD_FILE,
  59   ELT_HEAD_COPR,
  60   ELT_HEAD_GEDC,
  61   ELT_HEAD_GEDC_VERS,
  62   ELT_HEAD_GEDC_FORM,
  63   ELT_HEAD_CHAR,
  64   ELT_HEAD_CHAR_VERS,
  65   ELT_HEAD_LANG,
  66   ELT_HEAD_PLAC,
  67   ELT_HEAD_PLAC_FORM,
  68   ELT_HEAD_NOTE,
  69
  70   ELT_FAM_HUSB,
  71   ELT_FAM_WIFE,
  72   ELT_FAM_CHIL,
  73   ELT_FAM_NCHI,
  74   ELT_FAM_SUBM,
  75
  76   ELT_INDI_RESN,
  77   ELT_INDI_SEX,
  78   ELT_INDI_SUBM,
  79   ELT_INDI_ALIA,
  80   ELT_INDI_ANCI,
  81   ELT_INDI_DESI,
  82   ELT_INDI_RFN,
  83   ELT_INDI_AFN,
  84
  85   ELT_OBJE_FORM,
  86   ELT_OBJE_TITL,
  87   ELT_OBJE_BLOB,
  88   ELT_OBJE_BLOB_CONT,
  89   ELT_OBJE_OBJE,
  90
  91   ELT_REPO_NAME,
  92
  93   ELT_USER,
  94
  95   NR_OF_ELTS     /* Just a final value to be used in array boundaries */
  96 } Gedcom_elt;
  97
  98 typedef enum _MECH {
  99   IMMED_FAIL,
 100   DEFER_FAIL,
 101   IGNORE_ERRORS
 102 } Gedcom_err_mech;
 103
 104 typedef enum _MSG {
 105   ERROR,
 106   WARNING,
 107   MESSAGE
 108 } Gedcom_msg_type;
 109
 110 typedef void* Gedcom_ctxt;
 111 typedef void* Gedcom_val;
 112
 113 typedef void
 114         (*Gedcom_msg_handler)
 115         (Gedcom_msg_type type, char *msg);
 116
 117 typedef Gedcom_ctxt
 118         (*Gedcom_rec_start_cb)
 119         (int level, char *xref, char *tag);
 120 typedef void
 121         (*Gedcom_rec_end_cb)
 122         (Gedcom_ctxt self);
 123
 124 typedef Gedcom_ctxt
 125         (*Gedcom_elt_start_cb)
 126         (Gedcom_ctxt parent,
 127          int level, char *tag, char *raw_value, Gedcom_val parsed_value);
 128 typedef void
 129         (*Gedcom_elt_end_cb)
 130         (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value);
 131
 132 typedef void
 133         (*Gedcom_def_cb)
 134         (Gedcom_ctxt parent, int level, char *tag, char *raw_value);
 135
 136 int     gedcom_parse_file(char* file_name);
 137 void    gedcom_set_debug_level(int level, FILE* trace_output);
 138 void    gedcom_set_error_handling(Gedcom_err_mech mechanism);
 139 void    gedcom_set_compat_handling(int enable_compat);
 140 void    gedcom_set_message_handler(Gedcom_msg_handler func);
 141 void    gedcom_set_default_callback(Gedcom_def_cb func);
 142
 143 void    gedcom_subscribe_to_record(Gedcom_rec rec,
 144                                    Gedcom_rec_start_cb cb_start,
 145                                    Gedcom_rec_end_cb cb_end);
 146 void    gedcom_subscribe_to_element(Gedcom_elt elt,
 147                                     Gedcom_elt_start_cb cb_start,
 148                                     Gedcom_elt_end_cb cb_end);
 149
 150 __END_DECLS
 151
 152 #endif /* __GEDCOM_H */