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 typedef enum _REC {
  30   REC_HEAD,
  31   REC_FAM,
  32   REC_INDI,
  33   REC_OBJE,
  34   REC_NOTE,
  35   REC_REPO,
  36   REC_SOUR,
  37   REC_SUBN,
  38   REC_SUBM,
  39   REC_USER,
  40   LAST_REC
  41 } Gedcom_rec;
  42
  43 typedef enum _ELT {
  44   ELT_HEAD_SOUR,
  45   ELT_HEAD_SOUR_VERS,
  46   ELT_HEAD_SOUR_NAME,
  47   ELT_HEAD_SOUR_CORP,
  48   ELT_HEAD_SOUR_DATA,
  49   ELT_HEAD_SOUR_DATA_DATE,
  50   ELT_HEAD_SOUR_DATA_COPR,
  51   ELT_HEAD_DEST,
  52   ELT_HEAD_DATE,
  53   ELT_HEAD_DATE_TIME,
  54   ELT_HEAD_SUBM,
  55   ELT_HEAD_SUBN,
  56   ELT_HEAD_FILE,
  57   ELT_HEAD_COPR,
  58   ELT_HEAD_GEDC,
  59   ELT_HEAD_GEDC_VERS,
  60   ELT_HEAD_GEDC_FORM,
  61   ELT_HEAD_CHAR,
  62   ELT_HEAD_CHAR_VERS,
  63   ELT_HEAD_LANG,
  64   ELT_HEAD_PLAC,
  65   ELT_HEAD_PLAC_FORM,
  66   ELT_HEAD_NOTE,
  67   ELT_USER,
  68   LAST_ELT
  69 } Gedcom_elt;
  70
  71 typedef enum _MECH {
  72   IMMED_FAIL,
  73   DEFER_FAIL,
  74   IGNORE_ERRORS
  75 } Gedcom_err_mech;
  76
  77 typedef enum _MSG {
  78   ERROR,
  79   WARNING,
  80   MESSAGE
  81 } Gedcom_msg_type;
  82
  83 typedef void* Gedcom_ctxt;
  84 typedef void* Gedcom_val;
  85
  86 typedef void
  87         (*Gedcom_msg_handler)
  88         (Gedcom_msg_type type, char *msg);
  89
  90 typedef Gedcom_ctxt
  91         (*Gedcom_rec_start_cb)
  92         (int level, char *xref, char *tag);
  93 typedef void
  94         (*Gedcom_rec_end_cb)
  95         (Gedcom_ctxt self);
  96
  97 typedef Gedcom_ctxt
  98         (*Gedcom_elt_start_cb)
  99         (Gedcom_ctxt parent,
 100          int level, char *tag, char *raw_value, Gedcom_val parsed_value);
 101 typedef void
 102         (*Gedcom_elt_end_cb)
 103         (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value);
 104
 105 typedef void
 106         (*Gedcom_def_cb)
 107         (Gedcom_ctxt parent, int level, char *tag, char *raw_value);
 108
 109 int     gedcom_parse_file(char* file_name);
 110 void    gedcom_set_debug_level(int level, FILE* trace_output);
 111 void    gedcom_set_error_handling(Gedcom_err_mech mechanism);
 112 void    gedcom_set_compat_handling(int enable_compat);
 113 void    gedcom_set_message_handler(Gedcom_msg_handler func);
 114 void    gedcom_set_default_callback(Gedcom_def_cb func);
 115
 116 void    gedcom_subscribe_to_record(Gedcom_rec rec,
 117                                    Gedcom_rec_start_cb cb_start,
 118                                    Gedcom_rec_end_cb cb_end);
 119 void    gedcom_subscribe_to_element(Gedcom_elt elt,
 120                                     Gedcom_elt_start_cb cb_start,
 121                                     Gedcom_elt_end_cb cb_end);
 122
 123 #endif /* __GEDCOM_H */