-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
- <title>Using the GEDCOM parser library</title>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"><html><head><title>Using the GEDCOM parser library</title>
+
- <meta http-equiv="content-type"
- content="text/html; charset=ISO-8859-1">
-</head>
- <body text="#000000" bgcolor="#ffffff" link="#000099" vlink="#990099"
- alink="#000099">
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></head><body text="#000000" bgcolor="#ffffff" link="#000099" vlink="#990099" alink="#000099">
<h1 align="center">Using the GEDCOM parser library</h1>
<br>
<li><a href="#Start_and_end_callbacks">Start and end callbacks</a></li>
<li><a href="#Default_callbacks">Default callbacks</a></li>
+ </ul><li><a href="#C_object_model">C object model</a></li>
+ <ul>
+ <li><a href="#Main_functions">Main functions</a></li>
+ <li><a href="#Object_model_structure">Object model structure</a></li>
+ <li><a href="#User_data">User data</a><br>
+ </li>
</ul>
+
<li><a href="#Other_API_functions">Other API functions</a></li>
<ul>
</ul>
<li><a href="#Converting_character_sets">Converting character sets</a></li>
<li><a href="#Support_for_configure.in">Support for configure.in</a><br>
+<br>
</li>
- <li><a href="interface.html">Interface details</a><br>
+ <li><a href="interface.html">Interface details of the callback parser</a></li><li><a href="gomxref.html">C object model details</a><br>
</li>
+
</ul>
<hr width="100%" size="2">
<h2><a name="Overview"></a>Overview<br>
- </h2>
- The GEDCOM parser library is built as a callback-based parser (comparable
- to the SAX interface of XML). It comes with:<br>
+ </h2> The GEDCOM
+parser library provides two interfaces. At the one hand, it can be
+used as a callback-based parser (comparable to the SAX interface of
+XML); at the other hand, the parser can be used to convert the GEDCOM file
+into an object model (comparable to the DOM interface of XML). It comes
+with:<br>
<ul>
<li>a library (<code>libgedcom.so</code>), to be linked in the
-application program</li>
+application program, which implements the callback parser</li>
<li>a header file (<code>gedcom.h</code>), to be used in the sources
of the application program</li>
<li>a header file (<code>gedcom-tags.h</code>) that is also installed,
- but that is automatically included via <code>gedcom.h</code><br>
- </li>
+ but that is automatically included via <code>gedcom.h</code></li></ul>Additionally, if you want to use the GEDCOM C object model, the following should be used (note that <code>libgedcom.so</code> is also needed in this case, because the object model uses the callback parser internally):<br>
+<ul>
+ <li>a library (<code>libgedcom_gom.so</code>), to be linked in the application program, which implements the C object model</li>
+ <li>a header file (<code>gom.h</code>), to be used in the sources of the application program<br>
+ </li>
+
</ul>
+
Next to these, there is also a data directory in <code>$PREFIX/share/gedcom-parse</code>
that contains some additional stuff, but which is not immediately
important at first. I'll leave the description of the data directory
for later.<br>
<br>
- The very simplest call of the gedcom parser is simply the following
- piece of code (include of the gedcom header is assumed, as everywhere
+ The very simplest call of the gedcom callback parser is simply the following
+ piece of code (include of the <code>gedcom.h</code> header is assumed, as everywhere
in this manual):<br>
<blockquote><code>int result;<br>
is parse the entire file and return the result. The function returns
0 on success and 1 on failure. No other information is available
using this function only.<br>
- <br>
- The call to <code>gedcom_init</code>() should be one of the first calls
+<br>
+Alternatively, programs using the C object model should use the following (in this case, the inclusion of both <code>gedcom.h</code> and <code>gom.h</code> is required):<br>
+
+<blockquote><code>int result;<br>
+ ...<br>
+ <b>gedcom_init</b>();<br>
+ ...<br>
+ result = <b>gom_parse_file</b>("myfamily.ged");<br>
+ </code> </blockquote>
+The call to <code>gom_parse_file</code> will build the C object model, which is then a complete representation of the GEDCOM file.<br>
+<br>
+No matter which of the interfaces you use, the call to <code>gedcom_init</code>() should be one of the first calls
in your program. The requirement is that it should come before the first
call to <code>iconv_open</code> (part of the generic character set conversion
feature) in the program, either by your program itself, or indirectly by
the library calls it makes. Practically, it should e.g. come before
any calls to any GTK functions, because GTK uses <code>iconv_open</code>
- in its initialization. For the same reason it is also advised to put
-the <code>-lgedcom</code> option on the linking of the program as the last
-option, so that it's initialization code is run first.<br>
+ in its initialization.<br>
+ <br>
+For the same reason it is also advised to put
+the <code>-lgedcom</code> option
+on the linking of the program as the last option, so that its initialization
+code is run first. In the case of using the C object model, the linking
+options should be: <code>-lgedcom_gom -lgedcom</code><br>
<br>
The next sections will refine this piece of code to be able to have
meaningful errors and the actual data that is in the file.<br>
<hr width="100%" size="2">
-<h2><a name="Error_handling"></a>Error handling</h2>
- Since this is a relatively simple topic, it is discussed before the
- actual callback mechanism, although it also uses a callback...<br>
- <br>
- The library can be used in several different circumstances, both
+<h2><a name="Error_handling"></a>Error handling</h2>The library can be used in several different circumstances, both
terminal-based as GUI-based. Therefore, it leaves the actual display
of the error message up to the application. For this, the application
needs to register a callback before parsing the GEDCOM file, which will
be called by the library on errors, warnings and messages.<br>
<br>
- A typical piece of code would be:<br>
+ A typical piece of code would be (<code>gom_parse_file</code> would be called in case the C object model is used):<br>
<blockquote><code>void <b>my_message_handler</b> (Gedcom_msg_type type,
char *msg)<br>
<hr width="100%" size="2">
<h2><a name="Data_callback_mechanism"></a>Data callback mechanism</h2>
The most important use of the parser is of course to get the data
-out of the GEDCOM file. As already mentioned, the parser uses a callback
- mechanism for that. In fact, the mechanism involves two levels.<br>
+out of the GEDCOM file. This section focuses on the callback mechanism (see the <a href="#C_object_model">next section</a> for the C object model). In fact, the mechanism involves two levels.<br>
<br>
The primary level is that each of the sections in a GEDCOM file is
notified to the application code via a "start element" callback and an
As a simple example, we will get some information from the header
of a GEDCOM file. First, have a look at the following piece of code:<br>
-<blockquote><code>Gedcom_ctxt <b>my_header_start_cb</b> (int level, <br>
+<blockquote><code>Gedcom_ctxt <b>my_header_start_cb</b> (Gedcom_rec rec,<br>
+ int level, <br>
Gedcom_val xref, <br>
return (Gedcom_ctxt)1;<br>
}<br>
<br>
- void <b>my_header_end_cb</b> (Gedcom_ctxt self)<br>
+ void <b>my_header_end_cb</b> (Gedcom_rec rec, Gedcom_ctxt self)<br>
{<br>
printf("The header ends, context is %d\n", (int)self);
/* context will print as "1" */<br>
if you are not interested in the end callback. The identifiers
to use as first argument to the function (here <code>REC_HEAD</code>)
are described in the <a href="interface.html#Record_identifiers"> interface
-details</a> .<br>
+details</a> . These are also passed as first argument in the callbacks (the <code>Gedcom_rec</code> argument).<br>
<br>
From the name of the function it becomes clear that this function
is specific to complete records. For the separate elements in records
We will now retrieve the SOUR field (the name of the program that
wrote the file) from the header:<br>
-<blockquote><code>Gedcom_ctxt <b>my_header_source_start_cb</b>(Gedcom_ctxt
+<blockquote><code>Gedcom_ctxt <b>my_header_source_start_cb</b>(Gedcom_elt elt,<br>
+
+ Gedcom_ctxt
parent,<br>
int
return parent;<br>
}<br>
<br>
- void <b>my_header_source_end_cb</b>(Gedcom_ctxt parent,<br>
+ void <b>my_header_source_end_cb</b>(Gedcom_elt elt,<br>
+ Gedcom_ctxt parent,<br>
Gedcom_ctxt self,<br>
can be its own context object of course. The end callback is called
with both the context of the parent and the context of itself, which in this
example will be the same. Again, the list of identifiers to use as
-a first argument for the subscription function are detailed in the <a
- href="interface.html#Element_identifiers"> interface details</a> .<br>
+a first argument for the subscription function are detailed in the <a href="interface.html#Element_identifiers"> interface details</a> . Again, these are passed as first argument in the callback (the <code>Gedcom_elt</code> argument).<br>
<br>
If we look at the other arguments of the start callback, we see the
level number (the initial number of the line in the GEDCOM file), the tag
The <code>Gedcom_val</code> type is meant to be an opaque type. The
only thing that needs to be known about it is that it can contain specific
data types, which have to be retrieved from it using pre-defined macros.
- These data types are described in the <a
- href="interface.html#Gedcom_val_types"> interface details</a>.
+ These data types are described in the <a href="interface.html#Gedcom_val_types"> interface details</a>.
<br>
<br>
Some extra notes:<br>
applications. To preserve this extra data anyway, a default callback
can be registered by the application, as in the following example:<br>
-<blockquote><code>void <b>my_default_cb</b> (Gedcom_ctxt parent, int level,
+<blockquote><code>void <b>my_default_cb</b> (Gedcom_elt elt, Gedcom_ctxt parent, int level,
char* tag, char* raw_value, int parsed_tag)<br>
{<br>
...<br>
char* extra_text;<br>
};<br>
<br>
- Gedcom_ctxt my_header_start_cb(int level, Gedcom_val xref, char* tag,
+ Gedcom_ctxt my_header_start_cb(Gedcom_rec rec, int level, Gedcom_val xref, char* tag,
char *raw_value,<br>
int parsed_tag, Gedcom_val parsed_value)<br>
return (Gedcom_ctxt)head;<br>
}<br>
<br>
- void my_default_cb(Gedcom_ctxt parent, int level, char* tag, char*
+ void my_default_cb(Gedcom_elt elt, Gedcom_ctxt parent, int level, char* tag, char*
raw_value, int parsed_tag)<br>
{<br>
struct header head = (struct header)parent;<br>
of the "upper" tags has been subscribed upon.<br>
+<hr width="100%" size="2"><br>
+<h2><a name="C_object_model"></a>C object model</h2>
+In the GEDCOM object model, all the data is immediately available after calling <code>gom_parse_file()</code>. For this, an entire model based on C structs is used. These structs are documented <a href="gomxref.html">here</a>,
+and follow the GEDCOM syntax quite closely. Each of the records in
+a GEDCOM file are modelled by a separate struct, and some common sub-structures
+have their own struct definition.<br>
+<br>
+<h3><a name="Main_functions"></a>Main functions<br>
+</h3>
+The following functions are available to get at these structs:<br>
+<ul>
+ <li>First, there are two functions to get the header record and the submission
+record (there can be only one of them in a GEDCOM file):<br>
+ <blockquote><code>struct header* gom_get_header();<br>
+struct submission* gom_get_submission();<br>
+ </code></blockquote>
+ </li>
+ <li>Further, for each of the other records, there are two functions, one
+to get the first of such records, and one to get a record via its cross-reference
+tag in the GEDCOM file:<br>
+ <blockquote><code>struct XXX* gom_get_first_XXX();<br>
+struct XXX* gom_get_XXX_by_xref(char* xref);</code><br>
+ </blockquote>
+ </li>
+</ul>
+<blockquote>The XXX stands for one of the following: <code>family, </code><code>individual, multimedia, note, repository, source, submitter, user_rec</code>.<br>
+</blockquote>
+<h3><a name="Object_model_structure"></a>Object model structure<br>
+</h3>
+All records of a certain type are linked together in a linked list. The
+above functions only give access to the first record of each linked list.
+ The others can be accessed by traversing the linked list via the <code>next</code> member of the structs. This means that e.g. the following piece of code will traverse the linked list of family records:<br>
+<blockquote><code>struct family* fam;<br>
+ <br>
+for (fam = gom_get_first_family() ; fam ; fam = fam->next) {<br>
+ ...<br>
+}</code><br>
+</blockquote>
+The <code>next</code> member of the last element in the list is guaranteed to have the <code>NULL</code> value.<br>
+<br>
+Actually, the linked list is a doubly-linked list: each record also has a <code>previous</code> member. But for implementation reasons the behaviour of this <code>previous</code> member on the edges of the linked list will not be guaranteed, i.e. it can be circular or terminated with <code>NULL</code>, no assumptions can be made in the application code.<br>
+<br>
+This linked-list model applies also to all sub-structures of the main record structs, i.e. each struct that has a <code>next </code>and <code>previous</code>
+member following the above conventions. This means that the following
+piece of code traverses all children of a family (see the details of the
+different structs <a href="gomxref.html">here</a>):<br>
+<blockquote><code>struct family* fam = ...;<br>
+ <br>
+struct xref_list* xrl;<br>
+for (xrl = fam->children ; xrl ; xrl = xrl->next) {<br>
+ ...<br>
+}</code> <br>
+</blockquote>
+Note that all character strings in the object model are encoded in UTF-8 (<a href="file:///home/verthezp/src/external/gedcom-parse/doc/encoding.html">Why UTF-8?</a>).<br>
+<h3><a name="User_data"></a>User data</h3>
+Each of the structs has an extra member called <code>extra</code> (of type <code>struct user_data*</code>).
+ This gathers all non-standard GEDCOM tags within the scope of the struct
+in a flat linked list, no matter what the internal structure of the non-standard
+tags is. Each element of the linked list has:<br>
+<ul>
+ <li>a level: the level number in the GEDCOM file</li>
+ <li>a tag: the tag given in the GEDCOM file</li>
+ <li>a value: the value, which can be a string value or a cross-reference value (one of the two will be non-NULL)<br>
+ </li>
+</ul>
+This way, none of the information in the GEDCOM file is lost, even the non-standard information.<br>
<hr width="100%" size="2">
<h2><a name="Other_API_functions"></a>Other API functions<br>
</h2>
- Although the above describes the basic interface of libgedcom, there
+
+ Although the above describes the basic interface of the gedcom parser, there
are some other functions that allow to customize the behaviour of the library.
These will be explained in the current section.<br>
</ul>
- Note that, currently, no actual compatibility code is present, but
-this is on the to-do list.<br>
+ Currently, there is a beginning for compatibility for ftree and Lifelines (3.0.2).<br>
<hr width="100%" size="2">
<h2><a name="Converting_character_sets"></a>Converting character sets</h2>
implementation, the following steps need to be taken by the application
(more detailed info can be found in the info file of the GNU libc library
in the "Generic Charset Conversion" section under "Character Set Handling"
-or online <a
- href="http://www.gnu.org/manual/glibc-2.2.3/html_chapter/libc_6.html#SEC99">
+or online <a href="http://www.gnu.org/manual/glibc-2.2.3/html_chapter/libc_6.html#SEC99">
here</a>):<br>
<ul>
<li>Skip over the character that
can't be converted and append a "?" to the output buffer, then call <code>
iconv</code> again. Skipping over a UTF-8 character is fairly simple,
- as follows from the <a
- href="http://www.cl.cam.ac.uk/%7Emgk25/unicode.html#utf-8">encoding rules</a>
+ as follows from the <a href="http://www.cl.cam.ac.uk/%7Emgk25/unicode.html#utf-8">encoding rules</a>
:</li>
</ul>
<pre> </pre>
-</body>
-</html>
+<br>
+<br>
+</body></html>
\ No newline at end of file
projects / gedcom-parse.git / blobdiff