renamed the package to libgedcom-dev

[gedcom-parse.git] / gom / gom.c

diff --git a/gom/gom.c b/gom/gom.c
index b34d59e1e5fcefefa12abf8b22b31a41a2914295..630fe6852ef7fb8198a7f7d9acf129769968cef2 100644 (file)
--- a/gom/gom.c
+++ b/gom/gom.c
@@ -52,19 +52,6 @@
 #include "gom.h"
 #include "gom_internal.h"
 
-const char* ctxt_names[] =
-{
-  "NULL",
-  
-  "header", "submission", "submitter", "family", "individual",
-  "multimedia", "note", "repository", "source", "user_rec",
-  
-  "address", "event", "place", "source_citation", "text",
-  "note_sub", "multimedia_link", "lds_event", "user_ref_number",
-  "change_date", "personal_name", "family_link", "pedigree",
-  "association", "source_event", "source_description"
-};
-
 void gom_default_callback (Gedcom_elt elt, Gedcom_ctxt parent, int level,
                           char* tag, char* raw_value, int parsed_tag);
 
@@ -118,19 +105,37 @@ void subscribe_all()
 
 int gom_active = 0;
 
+/** This function initializes the object model by parsing the given GEDCOM
+    file.
+
+    \param file_name  The input file
+
+    \retval 0 on success
+    \retval 1 on failure
+*/
 int gom_parse_file(const char* file_name)
 {
   if (gom_active) {
     gom_cleanup();
   }
   else {
+    gedcom_set_compat_options(COMPAT_ALLOW_OUT_OF_CONTEXT);
     subscribe_all();
   }
   gom_active = 1;
-  gedcom_set_compat_options(0);
   return gedcom_parse_file(file_name);
 }
 
+/** This function starts an empty model.  It does this by parsing the
+    \c new.ged
+    file in the data directory of the library (\c $PREFIX/share/gedcom-parse).
+    This can be used to start from an empty model, and to build up the model
+    by adding new records yourself.
+
+    \retval 0 on success
+    \retval nonzero on errors (mainly the errors from
+            \ref gedcom_parse_file()).
+*/
 int gom_new_model()
 {
   if (gom_active) {
@@ -143,6 +148,16 @@ int gom_new_model()
   return gedcom_new_model();
 }
 
+/** This function writes the current Gedcom model to a file.
+
+    \param file_name  The name of the file to write to
+    \param total_conv_fails Pass a pointer to an integer if you want to know
+    the number of conversion failures (filled in on return).  You can pass
+    \c NULL if you're not interested.
+
+    \retval 0 on success
+    \retval nonzero on errors
+*/
 int gom_write_file(const char* file_name, int *total_conv_fails)
 {
   Gedcom_write_hndl hndl;
@@ -179,41 +194,12 @@ int gom_write_xref_list(Gedcom_write_hndl hndl,
   return result;
 }
 
-Gom_ctxt make_gom_ctxt(int ctxt_type, OBJ_TYPE obj_type, void *ctxt_ptr)
-{
-  Gom_ctxt ctxt   = (Gom_ctxt)malloc(sizeof(struct Gom_ctxt_struct));
-  if (! ctxt)
-    MEMORY_ERROR;
-  else {
-    ctxt->ctxt_type = ctxt_type;
-    ctxt->obj_type  = obj_type;
-    ctxt->ctxt_ptr  = ctxt_ptr;
-  }
-  return ctxt;
-}
-
-void NULL_DESTROY(void* anything UNUSED)
-{
-}
-
-void destroy_gom_ctxt(Gom_ctxt ctxt)
-{
-  SAFE_FREE(ctxt);
-}
-
-void gom_cast_error(const char* file, int line,
-                   OBJ_TYPE expected, OBJ_TYPE found)
+void gom_default_callback (Gedcom_elt elt UNUSED, Gedcom_ctxt parent UNUSED,
+                          int level, char* tag, char* raw_value,
+                          int parsed_tag UNUSED)
 {
-  const char* expected_name = "<out-of-bounds>";
-  const char* found_name    = "<out-of-bounds>";
-  if (expected < T_LAST)
-    expected_name = ctxt_names[expected];
-  if (found < T_LAST)
-    found_name = ctxt_names[found];
-  fprintf(stderr,
-         "Wrong gom ctxt cast at %s, line %d: expected %s, found %s\n",
-         file, line, expected_name, found_name);
-  abort();
+  gedcom_warning(_("Data loss in import: \"%d %s %s\""),
+                 level, tag, raw_value);
 }
 
 void gom_mem_error(const char *filename, int line)
@@ -226,21 +212,6 @@ void gom_xref_already_in_use(const char *xrefstr)
   gedcom_error(_("Cross-reference key '%s' is already in use"), xrefstr);
 }
 
-void gom_unexpected_context(const char* file, int line, OBJ_TYPE found)
-{
-  const char* found_name    = "<out-of-bounds>";
-  if (found < T_LAST)
-    found_name = ctxt_names[found];
-  gedcom_warning(_("Internal error: Unexpected context at %s, line %d: %s"),
-                file, line, found_name);
-}
-
-void gom_no_context(const char* file, int line)
-{
-  gedcom_warning(_("Internal error: No context at %s, line %d"),
-                file, line);
-}
-
 void gom_move_error(const char* type)
 {
   gedcom_warning(_("Could not move struct of type %s"), type);
@@ -251,28 +222,6 @@ void gom_find_error(const char* type)
   gedcom_warning(_("Could not find struct of type %s in chain"), type);
 }
 
-void gom_default_callback (Gedcom_elt elt UNUSED, Gedcom_ctxt parent UNUSED,
-                          int level, char* tag, char* raw_value,
-                          int parsed_tag UNUSED)
-{
-  gedcom_warning(_("Data loss in import: \"%d %s %s\""),
-                 level, tag, raw_value);
-}
-
-void def_rec_end(Gedcom_rec rec UNUSED, Gedcom_ctxt self,
-                Gedcom_val parsed_value UNUSED)
-{
-  Gom_ctxt ctxt = (Gom_ctxt)self;
-  destroy_gom_ctxt(ctxt);
-}
-
-void def_elt_end(Gedcom_elt elt UNUSED, Gedcom_ctxt parent UNUSED,
-                Gedcom_ctxt self, Gedcom_val parsed_value UNUSED)
-{
-  Gom_ctxt ctxt = (Gom_ctxt)self;
-  destroy_gom_ctxt(ctxt);
-}
-
 void set_xref_type(struct xref_value* xr, const char *str)
 {
   if (!strcasecmp(str, "FAM"))