X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fgom.html;h=857e7452eaa63b7b539fffdebdc94ef05e9f33ab;hb=866835ac8928d7e40919c2ca59799cb37023856f;hp=f36dbd0c33ab5c7be3ac8c22fed8f4a2c06167d0;hpb=5d16fb60418c30cd6693556ac6d56d6c0f8cd7a6;p=gedcom-parse.git diff --git a/doc/gom.html b/doc/gom.html index f36dbd0..857e745 100644 --- a/doc/gom.html +++ b/doc/gom.html @@ -22,12 +22,18 @@
-@@ -125,7 +131,8 @@ tags is. Each element of the linked list has:struct XXX* gom_get_first_XXX();
-struct XXX* gom_get_XXX_by_xref(char* xref);
+struct XXX* gom_get_XXX_by_xref(const char* xref);
The first function is in fact superfluous, because it just returns thechar* gom_get_string (char* data);
-char* gom_set_string (char** data, const char* utf8_str);
+char* gom_set_string (char** data, const char* str_in_utf8);
data
, but it is there for symmetry with the functions given below for the locale-defined input and output. NULL
-if an error occurred (e.g. failure to allocate memory). It makes a
+if an error occurred (e.g. failure to allocate memory or the given string is not a valid UTF-8 string). It makes a
copy of the input string to store it in the object model. It also takes
care of deallocating the old value of the data if needed. Note that
the set function needs the address of the data variable, to be able to modify
-it.struct header* head = gom_get_header();
@@ -157,17 +164,95 @@ char* newvalue = "My_Gedcom_Tool";
A second couple of functions retrieve and set the string in the format defined by the current locale:
The use of these functions is the same as the previous ones, but e.g. in the "en_US" locale the string will be returned by the first function in the -ISO-8859-1 encoding and the second function expects thechar* gom_get_string_for_locale (char* data, int* conversion_failures);
;
-char* gom_set_string_for_locale (char** data, const char* locale_str)
+char* gom_set_string_for_locale (char** data, const char* str_in_locale);
locale_str
to be in this encoding. Conversion to and from UTF-8 for the object model is done on the fly.
+ISO-8859-1 encoding and the second function expects thestr_in_locale
to be in this encoding. Conversion to and from UTF-8 for the object model is done on the fly.
Since the conversion from UTF-8 to the locale encoding is not always possible, the get function has a second parameter that can return the number of conversion failures for the result string. Pass a pointer to an integer if you -want to know this. You can passNULL
if you're not interested.
+want to know this. You can passNULL
if you're not interested. The function returnsNULL
+if an error occurred (e.g. if the given string is not a valid string for +the current locale); in that case the target data variable is not modified.
+
+Adding and removing records
+For each of the record types, there are two functions to add and remove records: ++ + +Thestruct XXX* gom_new_XXX(const char* xref);
+int gom_delete_XXX(struct XXX* obj);
+XXX
stands for one of the following:family,
individual, multimedia, note, repository, source, submitter, user_rec
.
+
+For submission records, thegom_delete_submission()
has no parameters (since there can be only one such object anyway).
+
+When creating new records, the application is responsible for making sure +that mandatory fields (according to the GEDCOM spec) are filled in afterwards. + In a later release, there will be checks ingom_write_file
when something is missing.
+
+Adding, removing and moving cross-references
+For struct members that are of type
+struct xref_value
, the following function is available:
++This function modifies thestruct xref_value* gom_set_xref(struct xref_value** data, const char* xref);
+data
variable to point to the givenxref
, taking care of unreferencing the old value, and referencing the new value. If an error occurs,NULL
is returned (and thedata
variable is not changed). If xref isNULL
, the data is set toNULL
.
+
+For struct members that are of typestruct xref_list
, the following functions are available:
++The first function adds the givenstruct xref_list* gom_add_xref(struct xref_list** data, const char* xref);
+int gom_remove_xref(struct xref_list** data, const char* xref);
+int gom_move_xref(Gom_direction dir,struct xref_list** data, const char* xref);
+xref
to the end of thedata
list. The second function removes the givenxref
from thedata
list (if present; if not present an error is generated and 1 is returned).
+
+The third function moves the givenxref
up or down thedata
list, depending on thedir
parameter, which can be:
++
+Again, an error is generated and 1 is returned if the given xref is not part +of the list. If the xref cannot be moved up (because the first in the +list) or down (because the last in the list), a warning is generated, but +the function still returns success (0).- +
MOVE_UP
- +
MOVE_DOWN
+Adding, removing and moving substructures
+For struct members that are just a single value, the following functions are available:
+
++This is the case forstruct XXX* gom_set_new_XXX(struct XXX** data);
+int gom_delete_XXX(struct XXX** data);
+XXX
equal toaddress
,change_date
orplace
. The first function creates a new substructure and assigns it todata
(NULL
is returned if there was already a value). The second function deletes the value fromdata
.
+
+Note: forchange_date
structs there is also the following short-cut function, which updates the date and time directly:
++For struct members that are a list (as described here), the following functions are available:int gom_update_timestamp (struct change_date** obj, time_t tval);
++ +This is the case for allstruct XXX* gom_add_new_XXX(struct XXX** data);
+int gom_remove_XXX(struct XXX** data, struct XXX* obj);
+int gom_move_XXX(Gom_direction dir, struct XXX** data, struct XXX* obj);
+XXX
structs that have anext
andprevious
member. The first function creates a new substructure and adds it to the end of thedata
list. The second function deletes the object from thedata
list (if present; if not present, an error is generated and 1 is returned).
+
+The third function moves the givenobj
up or down thedata
list, depending on thedir
parameter, similar to the xref functions above.
+
+
+Writing the object model to file
+Writing the current object model to a file is simply done using the following function:
+
++This writes the model to the fileint gom_write_file (const char* filename, int* total_conv_fails);
filename
. The second parameter can return the total number of conversion failures (passNULL
if you're not interested). The functions in this section can be used before
gom_write_file
to control some settings.
+
+Before you write the file, you can update the timestamp in the header using the following function:
++This sets theint gom_header_update_timestamp (time_t tval);
date
andtime
fields of the header to the time indicated bytval
. + The function returns 0 on success, non-zero if an error occurred. Typically, +the function would be used as follows, to set the current time in the timestamp:
++int result;
+result = gom_header_update_timestamp(time(NULL));
+
+$Id$@@ -175,6 +260,12 @@ want to know this. You can pass
$Name$NULL
if you're not interested+
+
+
+
+
+