renamed the package to libgedcom-dev

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

diff --git a/gom/gom.c b/gom/gom.c
index 3e604159bc9f5a7849e88d003204c72e20302cad..630fe6852ef7fb8198a7f7d9acf129769968cef2 100644 (file)
--- a/gom/gom.c
+++ b/gom/gom.c
@@ -105,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) {
@@ -130,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;
@@ -174,6 +202,26 @@ void gom_default_callback (Gedcom_elt elt UNUSED, Gedcom_ctxt parent UNUSED,
                  level, tag, raw_value);
 }
 
+void gom_mem_error(const char *filename, int line)
+{
+  gedcom_error(_("Could not allocate memory at %s, %d"), filename, line);
+}
+
+void gom_xref_already_in_use(const char *xrefstr)
+{
+  gedcom_error(_("Cross-reference key '%s' is already in use"), xrefstr);
+}
+
+void gom_move_error(const char* type)
+{
+  gedcom_warning(_("Could not move struct of type %s"), type);
+}
+
+void gom_find_error(const char* type)
+{
+  gedcom_warning(_("Could not find struct of type %s in chain"), type);
+}
+
 void set_xref_type(struct xref_value* xr, const char *str)
 {
   if (!strcasecmp(str, "FAM"))