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   LAST_REC
  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   ELT_USER,
  70   LAST_ELT
  71 } Gedcom_elt;
  72
  73 typedef enum _MECH {
  74   IMMED_FAIL,
  75   DEFER_FAIL,
  76   IGNORE_ERRORS
  77 } Gedcom_err_mech;
  78
  79 typedef enum _MSG {
  80   ERROR,
  81   WARNING,
  82   MESSAGE
  83 } Gedcom_msg_type;
  84
  85 typedef void* Gedcom_ctxt;
  86 typedef void* Gedcom_val;
  87
  88 typedef void
  89         (*Gedcom_msg_handler)
  90         (Gedcom_msg_type type, char *msg);
  91
  92 typedef Gedcom_ctxt
  93         (*Gedcom_rec_start_cb)
  94         (int level, char *xref, char *tag);
  95 typedef void
  96         (*Gedcom_rec_end_cb)
  97         (Gedcom_ctxt self);
  98
  99 typedef Gedcom_ctxt
 100         (*Gedcom_elt_start_cb)
 101         (Gedcom_ctxt parent,
 102          int level, char *tag, char *raw_value, Gedcom_val parsed_value);
 103 typedef void
 104         (*Gedcom_elt_end_cb)
 105         (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value);
 106
 107 typedef void
 108         (*Gedcom_def_cb)
 109         (Gedcom_ctxt parent, int level, char *tag, char *raw_value);
 110
 111 int     gedcom_parse_file(char* file_name);
 112 void    gedcom_set_debug_level(int level, FILE* trace_output);
 113 void    gedcom_set_error_handling(Gedcom_err_mech mechanism);
 114 void    gedcom_set_compat_handling(int enable_compat);
 115 void    gedcom_set_message_handler(Gedcom_msg_handler func);
 116 void    gedcom_set_default_callback(Gedcom_def_cb func);
 117
 118 void    gedcom_subscribe_to_record(Gedcom_rec rec,
 119                                    Gedcom_rec_start_cb cb_start,
 120                                    Gedcom_rec_end_cb cb_end);
 121 void    gedcom_subscribe_to_element(Gedcom_elt elt,
 122                                     Gedcom_elt_start_cb cb_start,
 123                                     Gedcom_elt_end_cb cb_end);
 124
 125 __END_DECLS
 126
 127 #endif /* __GEDCOM_H */