X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=doc%2Fusage.html;h=00bddefbfd66c45b1cc5413ff52315aab964ce9c;hb=68591c9aab2c2f87640bbea49220f860b09bb39c;hp=ee3e248bae1331b1f9d175c2320c416ef024881d;hpb=7372fd1bb10934271adbb12fe27f45df8ea225d2;p=gedcom-parse.git
diff --git a/doc/usage.html b/doc/usage.html
index ee3e248..00bddef 100644
--- a/doc/usage.html
+++ b/doc/usage.html
@@ -17,15 +17,7 @@
Start and end callbacks
Default callbacks
- C object model
-
-
- Other API functions
+ Other API functions
- Debugging
@@ -37,7 +29,7 @@
- Support for configure.in
- - Interface details of the callback parser
- C object model details
+ - Interface details of the callback parser
- C object model
@@ -110,8 +102,9 @@ the -lgedcom 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: -lgedcom_gom -lgedcom
-
- The next sections will refine this piece of code to be able to have
+
The function gedcom_init() also initializes locale handling by calling setlocale(LC_ALL, ""), in case the application would not do this (it doesn't hurt for the application to do the same).
+
+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.
@@ -154,7 +147,7 @@ way it wants. Warnings are similar, but use "Warning" instead of "Error"
Data callback mechanism
The most important use of the parser is of course to get the data
-out of the GEDCOM file. This section focuses on the callback mechanism (see the next section for the C object model). In fact, the mechanism involves two levels.
+out of the GEDCOM file. This section focuses on the callback mechanism (see here for the C object model). In fact, the mechanism involves two levels.
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
@@ -419,72 +412,6 @@ raw_value, int parsed_tag)
of the "upper" tags has been subscribed upon.
-
-C object model
-In the GEDCOM object model, all the data is immediately available after calling gom_parse_file(). For this, an entire model based on C structs is used. These structs are documented here,
-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.
-
-Main functions
-
-The following functions are available to get at these structs:
-
- - 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):
- struct header* gom_get_header();
-struct submission* gom_get_submission();
-
-
- - 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:
- struct XXX* gom_get_first_XXX();
-struct XXX* gom_get_XXX_by_xref(char* xref);
-
-
-
-The XXX stands for one of the following: family, individual, multimedia, note, repository, source, submitter, user_rec.
-
-Object model structure
-
-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 next member of the structs. This means that e.g. the following piece of code will traverse the linked list of family records:
-struct family* fam;
-
-for (fam = gom_get_first_family() ; fam ; fam = fam->next) {
- ...
-}
-
-The next member of the last element in the list is guaranteed to have the NULL value.
-
-Actually, the linked list is a doubly-linked list: each record also has a previous member. But for implementation reasons the behaviour of this previous member on the edges of the linked list will not be guaranteed, i.e. it can be circular or terminated with NULL, no assumptions can be made in the application code.
-
-This linked-list model applies also to all sub-structures of the main record structs, i.e. each struct that has a next and previous
-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 here):
-struct family* fam = ...;
-
-struct xref_list* xrl;
-for (xrl = fam->children ; xrl ; xrl = xrl->next) {
- ...
-}
-
-Note that all character strings in the object model are encoded in UTF-8 (Why UTF-8?).
-User data
-Each of the structs has an extra member called extra (of type struct user_data*).
- 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:
-
- - a level: the level number in the GEDCOM file
- - a tag: the tag given in the GEDCOM file
- - a value: the value, which can be a string value or a cross-reference value (one of the two will be non-NULL)
-
-
-This way, none of the information in the GEDCOM file is lost, even the non-standard information.
Other API functions
@@ -755,37 +682,30 @@ handle needs to be closed (when the program exits):
-Support for configure.in
- Programs using the GEDCOM parser library and using autoconf to configure
- their sources can use the following statements in configure.in (the example
- is checking for gedcom-parse, version 1.34):
-
-AC_CHECK_LIB(gedcom, gedcom_parse_file,,
- AC_MSG_ERROR(Cannot
- find libgedcom: Please install gedcom-parse))
- AC_MSG_CHECKING(for libgedcom version)
- AC_TRY_RUN([
- #include <stdio.h>
- #include <stdlib.h>
- #include <gedcom.h>
- int
- main()
- {
- if (GEDCOM_PARSE_VERSION >= 1034) exit(0);
- exit(1);
- }],
- ac_gedcom_version_ok='yes',
- ac_gedcom_version_ok='no',
- ac_gedcom_version_ok='no')
- if test "$ac_gedcom_version_ok" = 'yes' ; then
- AC_MSG_RESULT(ok)
- else
- AC_MSG_RESULT(not ok)
- AC_MSG_ERROR(You need at least version 1.34 of gedcom-parse)
- fi
-
- There are three preprocessor symbols defined for version checks in the
- header:
+Support for configure.in
There
+is a macro available for use in configure.in for applications that are using
+autoconf to configure their sources. The following macro checks whether
+the Gedcom parser library is available and whether its version is high enough:
+AM_LIB_GEDCOM_PARSER([major,[minor,[patch]]])
+
+All the arguments are optional and default to 0. E.g. to check for
+version 1.34, you would put in configure.in the following statement:
+AM_LIB_GEDCOM_PARSER(1,34)
+
+To be able to use this macro in the sources of your application, you have three options:
+
+ - Put the file
m4/gedcom.m4 in your autoconf data directory (i.e. the path given by 'aclocal --print-ac-dir', usually /usr/share/aclocal). You can do this automatically by going into the m4 subdirectory and typing 'make install-m4'.
+
+
+ - If you're using autoconf, but not automake, copy the contents of
m4/gedcom.m4 in the aclocal.m4 file in your sources.
+
+
+ - If you're using automake, copy the contents of
m4/gedcom.m4 in the acinclude.m4 file in your sources.
+
+
+
+There are three preprocessor symbols defined for version checks in the
+ header (but their direct use is deprecated: please use the macro above):
GEDCOM_PARSE_VERSION_MAJOR
The last one is equal to (GEDCOM_PARSE_VERSION_MAJOR * 1000) + GEDCOM_PARSE_VERSION_MINOR.
+
@@ -804,6 +725,9 @@ handle needs to be closed (when the program exits):
+
+
+