libgedcom.so), to be linked in the application
- programgedcom.h), to be used in the sources
- of the application programgedcom-tags.h) that is also installed,
- but that is automatically included via gedcom.h$PREFIX/share/gedcom-parse
- that contains some additional stuff, but which is not immediately
-important at first. I'll leave the description of the data directory
-for later.libgedcom.so), to be linked in the
+application program, which implements the callback parsergedcom.h), to be used in the sources
+ of the application programgedcom-tags.h) that is also installed,
+ but that is automatically included via gedcom.hlibgedcom.so is also needed in this case, because the object model uses the callback parser internally):libgedcom_gom.so), to be linked in the application program, which implements the C object modelgom.h), to be used in the sources of the application program$PREFIX/share/gedcom-parse
+ that contains some additional stuff, but which is not immediately
+ important at first. I'll leave the description of the data directory
+ for later.gedcom.h header is assumed, as everywhere
+in this manual):int result;
- ...
- result = gedcom_parse_file("myfamily.ged");
- - In the above piece of code,void my_message_handler (Gedcom_msg_type type, - char *msg)
- {
- ...
- }
- ...
- gedcom_set_message_handler(my_message_handler);
- ...
- result = gedcom_parse_file("myfamily.ged");
-
my_message_handler is the callback
- that will be called for errors (type=ERROR), warnings (type=WARNING) and messages (type=MESSAGE). The
- callback must have the signature as in the example. For errors, the
- msg passed to the callback will have the format:- Note that the entire string will be properly internationalized, and -encoded in UTF-8 (Why UTF-8?). Also, -no newline is appended, so that the application program can use it in any -way it wants. Warnings are similar, but use "Warning" instead of -"Error". Messages are plain text, without any prefix.Error on line<lineno>: <actual_message>
-
-printf is used in the message handler.gedcom.h and gom.h is required):int result;
+ ...
+ gedcom_init();
+ ...
+ result = gom_parse_file("myfamily.ged");
+ gom_parse_file will build the C object model, which is then a complete representation of the GEDCOM file.gedcom_init() should be one of the first calls
+in your program. The requirement is that it should come before the first
+call to iconv_open (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 iconv_open
+ in its initialization.-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 -lgedcomgedcom_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).gom_parse_file would be called in case the C object model is used):+ In the above piece of code,void my_message_handler (Gedcom_msg_type type, + char *msg)
+ {
+ ...
+ }
+ ...
+ gedcom_set_message_handler(my_message_handler);
+ ...
+ result = gedcom_parse_file("myfamily.ged");
+
my_message_handler is the
+ callback that will be called for errors (type=ERROR), warnings
+ (type=WARNING) and messages (type=MESSAGE). The
+ callback must have the signature as in the example. For errors,
+the msg passed to the callback will have the format:+ Note that the entire string will be properly internationalized, and + encoded in UTF-8 (Why UTF-8?). Also, +no newline is appended, so that the application program can use it in any +way it wants. Warnings are similar, but use "Warning" instead of "Error". + Messages are plain text, without any prefix.Error on line<lineno>: <actual_message>
+
+ printf is used in the message handler.- Using theGedcom_ctxt my_header_start_cb (int level, -
- - Gedcom_val xref,
- - char *tag,
- - char *raw_value,
- - int parsed_tag,
- - Gedcom_val parsed_value)
- {
- printf("The header starts\n");
- return (Gedcom_ctxt)1;
- }
-
- void my_header_end_cb (Gedcom_ctxt self)
- {
- printf("The header ends, context is %d\n", (int)self); /* context - will print as "1" */
- }
-
- ...
- gedcom_subscribe_to_record(REC_HEAD, my_header_start_cb, - my_header_end_cb);
- ...
- result = gedcom_parse_file("myfamily.ged");
-
gedcom_subscribe_to_record function, the application
- requests to use the specified callbacks as start and end callback. The end
- callback is optional: you can pass NULL if you are not interested
- in the end callback. The identifiers to use as first argument to
-the function (here REC_HEAD) are described in the
- interface details.Gedcom_ctxt type that is used as a result of the start
- callback and as an argument to the end callback is vital for passing context
- necessary for the application. This type is meant to be opaque; in
- fact, it's a void pointer, so you can pass anything via it. The important
- thing to know is that the context that the application returns in the start
- callback will be passed in the end callback as an argument, and as we will
- see shortly, also to all the directly subordinate elements of the record.tag is the GEDCOM tag in string format, the parsed_tag
- is an integer, for which symbolic values are defined as TAG_HEAD,
- TAG_SOUR, TAG_DATA, ... and USERTAG gedcom-tags.h that is installed, and included via
- gedcom.h (so no need to include gedcom-tags.h yourself).struct (or an object in a C++ application) that will contain the information for the
- header. In the end callback, the application could then e.g. do some
- finalizing operations on the struct to put it in its database.Gedcom_val type for the xref
- and parsed_value arguments was not discussed, see further
-for this)- The subscription mechanism for elements is similar, only the signatures - of the callbacks differ. The signature for the start callback shows - that the context of the parent line (here e.g. theGedcom_ctxt my_header_source_start_cb(Gedcom_ctxt - parent,
- - int - level,
- - char* - tag,
- - char* - raw_value,
- - int - parsed_tag,
- - Gedcom_val - parsed_value)
- {
- char *source = GEDCOM_STRING(parsed_value);
- printf("This file was written by %s\n", source);
- return parent;
- }
-
- void my_header_source_end_cb(Gedcom_ctxt parent,
- - Gedcom_ctxt self,
- - Gedcom_val parsed_value)
- {
- printf("End of the source description\n");
- }
-
- ...
- gedcom_subscribe_to_element(ELT_HEAD_SOUR,
- - my_header_source_start_cb,
- - my_header_source_end_cb);
- ...
- result = gedcom_parse_file("myfamily.ged");
-
struct that
-describes the header) is passed to this start callback. The callback
-itself returns here in this example the same context, but this 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
- interface details .Gedcom_val 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
- interface details. Gedcom_val argument of the end callback
- is currently not used. It is there for future enhancements.Gedcom_val arguments in
-the start callback for records. The first one (xref) contains the xref_value corresponding to the cross-reference (or NULL if there isn't one), the second one (parsed_value) contains the value that is parsed from the raw_value. See the interface details.- This callback has a similar signature as the previous ones, - but it doesn't contain a parsed value. However, it does contain the - parent context, that was returned by the application for the most specific - containing tag that the application supported.void my_default_cb (Gedcom_ctxt parent, - int level, char* tag, char* raw_value, int parsed_tag)
- {
- ...
- }
+ After this introduction, let's see what the API looks like...
+
+ +Start and end callbacks
+ +Callbacks for records
+ 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:
+
+ +Gedcom_ctxt my_header_start_cb (Gedcom_rec rec,
+ int level,
+ + Gedcom_val xref,
+ + char *tag,
+ + char *raw_value,
+ + int parsed_tag,
+ + Gedcom_val parsed_value)
+ {
+ printf("The header starts\n");
+ return (Gedcom_ctxt)1;
+ }
- ...
- gedcom_set_default_callback(my_default_cb);
- ...
- result = gedcom_parse_file("myfamily.ged");
+ void my_header_end_cb (Gedcom_rec rec, Gedcom_ctxt self)
+ {
+ printf("The header ends, context is %d\n", (int)self); + /* context will print as "1" */
+ }
+
+ ...
+ gedcom_subscribe_to_record(REC_HEAD, my_header_start_cb, + my_header_end_cb);
+ ...
+ result = gedcom_parse_file("myfamily.ged");
gedcom_subscribe_to_record function, the
+ application requests to use the specified callbacks as start and end
+callback. The end callback is optional: you can pass NULL
+ if you are not interested in the end callback. The identifiers
+to use as first argument to the function (here REC_HEAD)
+are described in the interface
+details . These are also passed as first argument in the callbacks (the Gedcom_rec argument).- Note that the default callback will be called for any tag that isn't -specifically subscribed upon by the application, and can thus be called -in various contexts. For simplicity, the example above doesn't take -this into account (thestruct header {
- char* source;
- ...
- char* extra_text;
- };
-
- Gedcom_ctxt my_header_start_cb(int level, Gedcom_val xref, char* tag, -char *raw_value,
- - int parsed_tag, Gedcom_val parsed_value)
- {
- struct header head = my_make_header_struct();
- return (Gedcom_ctxt)head;
- }
+ From the name of the function it becomes clear that this function +is specific to complete records. For the separate elements in records + there is another function, which we'll see shortly. Again, the callbacks + need to have the signatures as shown in the example.
+
+ TheGedcom_ctxttype that is used as a result of the +start callback and as an argument to the end callback is vital for passing +context necessary for the application. This type is meant to be opaque; +in fact, it's a void pointer, so you can pass anything via it. The +important thing to know is that the context that the application returns +in the start callback will be passed in the end callback as an argument, +and as we will see shortly, also to all the directly subordinate elements +of the record.
+
+ Thetagis the GEDCOM tag in string format, theparsed_tag+ is an integer, for which symbolic values are defined asTAG_HEAD,+TAG_SOUR,TAG_DATA,... andUSERTAG +for the application-specific tags. These values +are defined in the headergedcom-tags.hthat is installed, +and included viagedcom.h(so no need to includegedcom-tags.h+ yourself).
+
+ The example passes a simple integer as context, but an application + could e.g. pass astruct(or an object in a C++ application) + that will contain the information for the header. In the end callback, + the application could then e.g. do some finalizing operations on the +structto put it in its database.
+
+ (Note that theGedcom_valtype for thexref+ andparsed_valuearguments was not discussed, see further + for this)
+
+ +Callbacks for elements
+ We will now retrieve the SOUR field (the name of the program that +wrote the file) from the header:
+ +Gedcom_ctxt my_header_source_start_cb(Gedcom_elt elt,
+ + Gedcom_ctxt + parent,
+ + int + level,
+ + char* + tag,
+ + char* + raw_value,
+ + int + parsed_tag,
+ + Gedcom_val + parsed_value)
+ {
+ char *source = GEDCOM_STRING(parsed_value);
+ printf("This file was written by %s\n", source);
+ return parent;
+ }
- void my_default_cb(Gedcom_ctxt parent, int level, char* tag, char* raw_value, - int parsed_tag)
- {
- struct header head = (struct header)parent;
- my_header_add_to_extra_text(head, level, tag, raw_value);
- }
+ void my_header_source_end_cb(Gedcom_elt elt,
+ Gedcom_ctxt parent,
+ + Gedcom_ctxt self,
+ + Gedcom_val parsed_value)
+ {
+ printf("End of the source description\n");
+ }
- gedcom_set_default_callback(my_default_cb);
- gedcom_subscribe_to_record(REC_HEAD, my_header_start, NULL);
- ...
- result = gedcom_parse_file(filename);
+ ...
+ gedcom_subscribe_to_element(ELT_HEAD_SOUR,
+ + my_header_source_start_cb,
+ + my_header_source_end_cb);
+ ...
+ result = gedcom_parse_file("myfamily.ged");
parent could be of different
-types, depending on the context).NULLstruct
+ that describes the header) is passed to this start callback. The
+ callback itself returns here in this example the same context, but this
+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 interface details . Again, these are passed as first argument in the callback (the Gedcom_elt argument).Gedcom_val 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 interface details.
+ Gedcom_val argument of the end callback
+ is used to pass 'complete' values, e.g. the full text of a note. See
+ the interface details
+ for the exact type of this argument.Gedcom_val arguments
+ in the start callback for records. The first one (xref
+ ) contains the xref_value corresponding to the cross-reference
+ (or NULL if there isn't one), the second one (parsed_value
+ ) contains the value that is parsed from the raw_value. See
+ the interface details
+ .+ This callback has a similar signature as the previous ones, + but it doesn't contain a parsed value. However, it does contain the + parent context, that was returned by the application for the most specific + containing tag that the application supported.void my_default_cb (Gedcom_elt elt, Gedcom_ctxt parent, int level, + char* tag, char* raw_value, int parsed_tag)
+ {
+ ...
+ }
+
+ ...
+ gedcom_set_default_callback(my_default_cb);
+ ...
+ result = gedcom_parse_file("myfamily.ged");
+
+ Note that the default callback will be called for any tag that isn't + specifically subscribed upon by the application, and can thus be called + in various contexts. For simplicity, the example above doesn't take + this into account (thestruct header {
+ char* source;
+ ...
+ char* extra_text;
+ };
+
+ Gedcom_ctxt my_header_start_cb(Gedcom_rec rec, int level, Gedcom_val xref, char* tag, + char *raw_value,
+ + int parsed_tag, Gedcom_val parsed_value)
+ {
+ struct header head = my_make_header_struct();
+ return (Gedcom_ctxt)head;
+ }
+
+ void my_default_cb(Gedcom_elt elt, Gedcom_ctxt parent, int level, char* tag, char* +raw_value, int parsed_tag)
+ {
+ struct header head = (struct header)parent;
+ my_header_add_to_extra_text(head, level, tag, raw_value);
+ }
+
+ gedcom_set_default_callback(my_default_cb);
+ gedcom_subscribe_to_record(REC_HEAD, my_header_start, NULL);
+ ...
+ result = gedcom_parse_file(filename);
+
parent could be of different
+ types, depending on the context).NULLGedcom_write_hndl gedcom_write_open (const char* filename);
+int gedcom_write_close (Gedcom_write_hndl hndl, int* total_conv_fails);
gedcom_write_open takes a parameter the name of
+the file to write, and returns a write handle, which needs to be used in
+subsequent functions. It returns NULL in case of errors.gedcom_write_close takes, next to the write handle,
+an integer pointer as parameter. If you pass an actual pointer for
+this, the function will write in it the total number of conversion failures;
+you can pass NULL if you're not interested. The function returns 0 in case of success, non-zero in case of failure.gedcom_write_open, i.e. it affects all files that are opened after it is being called:
+int gedcom_write_set_encoding (Enc_from from, const char* charset, Encoding width, Enc_bom bom);
from parameter indicates how you want the encoding to be set:ENC_FROM_FILE: The same as the read file was in (this is the default).ENC_FROM_SYS: Not a valid value here, see below for gedcom_write_set_terminatorENC_MANUAL: From the values given in the following parameters.ENC_FROM_FILE is selected, the other parameters in the function are ignored (they can be passed as 0). When ENC_MANUAL is chosen, the meaning of the other parameters is as follows:charset values are given in the first column in the file gedcom.enc in the data directory of gedcom-parse ($PREFIX/share/gedcom-parse).
+ The character sets UNICODE, ASCII and ANSEL are always supported (these
+are standard for GEDCOM), as well as ANSI (not standard), but there may be
+others.width parameter takes one of the following values:ONE_BYTE: This should be used for all character sets except UNICODE.TWO_BYTE_HILO: High-low encoding for UNICODE (i.e. big-endian)TWO_BYTE_LOHI: Low-high encoding for UNICODE (i.e. little-endian)bom parameter determines whether a byte-order-mark should
+be written in the file in case of UNICODE encoding (usually preferred because
+it then clearly indicates the byte ordering). It takes one of the following
+values:WITHOUT_BOMWITH_BOMgedcom_write_open):int gedcom_write_set_line_terminator (Enc_from from, Enc_line_end end);
from parameter are given above. The value ENC_FROM_SYS
+is valid here, and means that the normal terminator for the current system
+is used (the second parameter of the function is then ignored). This
+is the default for this setting.end parameter takes one of the following values:END_CR: only carriage return ("/r") (system value for Macintosh)END_LF: only line feed ("/n") (system value for Unix, Mac OS X)END_CR_LF: first carriage return, then line feed ("/r/n") (system value for DOS, Windows)END_LF_CR: first line feed, then carriage return ("/n/r")write_header in gom/header.c).int gedcom_write_record_str (Gedcom_write_hndl hndl, Gedcom_rec rec, const char* xrefstr, const char* value);
hndl parameter is the write handle that was returned by gedcom_write_open. The rec parameter is one of the identifiers given in the first column in this table (except REC_USER: see below). The xrefstr and val parameters are respectively the cross-reference key of the record (something like '@FAM01@'), and the value of the record line, which should be NULL for some record types, according to the same table.+int gedcom_write_element_str (Gedcom_write_hndl hndl, Gedcom_elt elt, int parsed_tag,
+ + int parent_rec_or_elt, const char* value);
+int gedcom_write_element_xref (Gedcom_write_hndl hndl, Gedcom_elt elt, int parsed_tag,
+ + int parent_rec_or_elt, const struct xref_value* +value);
+int gedcom_write_element_date (Gedcom_write_hndl hndl, Gedcom_elt elt, int parsed_tag,
+ + int parent_rec_or_elt, const struct date_value* +value);
+int gedcom_write_element_age (Gedcom_write_hndl hndl, Gedcom_elt elt, int parsed_tag,
+ + int parent_rec_or_elt, const struct age_value* +value);
+
hndl parameter is again the write handle returned by gedcom_write_open. The elt parameter is one of the identifiers given in the first column in this table (except ELT_USER: see below). The parent_rec_or_elt is the corresponding rec or elt
+identifier of the logically enclosing statement: this will determine the
+level number written on the line, as the level number of the parent + 1.parsed_tag has to be passed for some of them. This parsed tag is the same as was returned by the callback functions defined above, and is an identifier of the form TAG_name. This parameter is needed whenever the second column in this table shows several possible tags (this is e.g. the case for ELT_SUB_FAM_EVT).gedcom_normalize_date (see here).+In the case of user-defined tags, the level and tag string are passed verbatim +(not controlled by the library). This allows to write any extra data +that doesn't use a standard tag, but is only allowed for tags starting with +an underscore.int gedcom_write_user_str (Gedcom_write_hndl hndl, int level, const char* tag, const char* xrefstr,
+ const char* value);
+int gedcom_write_user_xref (Gedcom_write_hndl hndl,int level, const char* tag, const char* xrefstr,
++ + const struct xref_value* value);
+
- Thevoid gedcom_set_debug_level (int level, - FILE* trace_output)
-
level can be one of the following values:trace_output is NULL, debugging information
- will be written to stderr, otherwise the given file handle
-is used (which must be open).- Thevoid gedcom_set_error_handling (Gedcom_err_mech - mechanism)
-
mechanism can be one of:IMMED_FAIL: immediately fail the
-parsing on an error (this is the default)DEFER_FAIL: continue parsing after
- an error, but return a failure code eventuallyIGNORE_ERRORS: continue parsing
-after an error, return success always+ Thevoid gedcom_set_debug_level (int level, FILE* +trace_output)
+
level can be one of the following values:trace_output is NULL, debugging information
+ will be written to stderr, otherwise the given file handle
+ is used (which must be open).- The argument can be:void gedcom_set_compat_handling - (int enable_compat)
-
+ Thevoid gedcom_set_error_handling (Gedcom_err_mech + mechanism)
+
mechanism can be one of:locale mechanism (i.e. via the LANG, LC_ALL or LC_CTYPE environment variables), which also controls the gettext
- mechanism in the application. IMMED_FAIL: immediately fail
+the parsing on an error (this is the default)DEFER_FAIL: continue parsing
+after an error, but return a failure code eventuallyIGNORE_ERRORS: continue parsing
+ after an error, return success alwaysgedcom-parse contains an example implementation (utf8-locale.c and utf8-locale.h
- in the top directory). Feel free to use it in
-your source code (it is not part of the library, and it isn't installed anywhere,
-so you need to take over the source and header file in your application).
- + +char *convert_utf8_to_locale (char *input, int *conv_failures);
char *convert_locale_to_utf8 (char *input);
+ The argument can be:void gedcom_set_compat_handling (int enable_compat)
+
+The parameter can be an OR'ed combination of the following options:void gedcom_set_compat_options (Gedcom_compat options)
+
COMPAT_ALLOW_OUT_OF_CONTEXT++In some compatibility cases, tags are coming out-of-order, +i.e. their start element callback would have to come after the end element +callback of the parent tag. E.g. instead of the standard GEDCOM+
++the genealogy program has generated something like:1 DATE ...
+2 TIME ...
+
++This can give a problem if your end element callbacks free some resources.1 DATE ...
+1 TIME ...
+
+
+If your program can handle elements out of context, you can enable this option. + By default it is disabled, and so the values of these out-of-context +tags are lost (the parser generates a warning if this is the case). The Gedcom object model in C has this option enabled.
+
setlocale function (the second step detailed below).
- All other steps given below, including setting up and closing down the conversion
-handles, are transparantly handled by the two functions. NULL if you are not interested (note that usually, the interesting information is just whether there were
- conversion failures or not, which is then given by the integer being bigger
-than zero or not). The second function doesn't need this, because any
-locale can be converted to UTF-8.locale mechanism (i.e. via the LANG,
+ LC_ALL or LC_CTYPE environment variables), which also
+controls the gettext mechanism in the application.
+gedcom-parse comes a library implementing help functions for UTF-8 encoding (+All the arguments are optional and default to 0. E.g. to check for +version 1.34.2, you would put in configure.in the following statement:AM_PATH_GEDCOM_PARSER([min_version,[action_if_found,[action_if_not_found,[modules]]]])
+
Note that version numbers now contains three parts (since version +0.20.0: this is also the first version in which this macro is available).AM_PATH_GEDCOM_PARSER(1.34.2)
+
GEDCOM_CFLAGS and GEDCOM_LIBS for use in Makefiles. Typically, this would be done as follows in a Makefile.am:+If your program uses some extra modules, they can be passed as fourth argument +in the macro, so that the CFLAGS and LIBS are correctly filled in. Currently, +the only available module isbin_programs = myprg
+myprg_SOURCES = myprg.c foo.c bar.c
+INCLUDES = @GEDCOM_CFLAGS@
+LDADD = @GEDCOM_LIBS@
gom (the Gedcom object model). For example:+To be able to use this macro in the sources of your application, you have three options:AM_PATH_GEDCOM_PARSER(0.21.2, , ,gom)
+
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'.m4/gedcom.m4 in the aclocal.m4 file in your sources.m4/gedcom.m4 in the acinclude.m4 file in your sources.GEDCOM_PARSE_VERSION_MAJORGEDCOM_PARSE_VERSION_MINORGEDCOM_PARSE_VERSION(GEDCOM_PARSE_VERSION_MAJOR * 1000) + GEDCOM_PARSE_VERSION_MINOR. As you see, this only checked the major and minor version, not the patch number, so this is obsolete.gedcom-config to help with compilation and linking flags for programs that don't use autoconf/automake.+Similarly, to get linking flags, use one of the following: +gedcom-config --cflags
+gedcom-config --cflags gom
+
-You can change the "?" that is output for characters that can't be converted -to any string you want, using the following function before the conversion -calls:gedcom-config --libs
+gedcom-config --libs gom
+
-void convert_set_unknown (const char *unknown);
-----#include <locale.h> /* for setlocale */
#include <langinfo.h> /* for nl_langinfo */
#include <iconv.h> /* for iconv_* functions */
-----setlocale(LC_ALL, "");
-----iconv_t iconv_handle;
...
iconv_handle = iconv_open(nl_langinfo(CODESET), "UTF-8");
if (iconv_handle == (iconv_t) -1)
/* signal an error */
-----/* char* in_buf is the input buffer, size_t in_len is its length */
/* char* out_buf is the output buffer, size_t out_len is its length */
size_t nconv;
char *in_ptr = in_buf;
char *out_ptr = out_buf;
nconv = iconv(iconv_handle, &in_ptr, &in_len, &out_ptr, &out_len);
If the output buffer is not big enough,-iconvwill return -1 and seterrnotoE2BIG. Also, thein_ptrandout_ptrwill point just after the last successfully converted character in the respective buffers, and thein_lenandout_lenwill be updated to show the remaining lengths. There can be two strategies here:
--
-Another error case is when the conversion was unsuccessful (if one of the -characters can't be represented in the target character set). The- Make sure from the beginning -that the output buffer is big enough. However, it's difficult to find -an absolute maximum length in advance, even given the length of the input -string.
-
-
-- Do the conversion in several steps, growing the output buffer each time to make more space, and calling
-iconv- consecutively until the conversion is complete. This is the preferred -way (a function could be written to encapsulate all this).iconvfunction will then also return -1 and seterrnotoEILSEQ; thein_ptrwill point to the character that couldn't be converted. In that case, again two strategies are possible:
--
-- Just fail the conversion, and show an error. This is not very user friendly, of course.
-
-
-- Skip over the character that can't be converted and append a "?" to the output buffer, then call
-iconvagain. Skipping over a UTF-8 character is fairly simple, as follows from the encoding rules:-
--
-- if the first byte is in binary 0xxxxxxx, then the character is only one byte long, just skip over that byte
-
-
-- if the first byte is in binary 11xxxxxx, then skip over that byte and all bytes 10xxxxxx that follow.
-
-
-- The example implementation -mentioned above grows the output buffer dynamically and outputs "?" for characters -that can't be converted.---iconv_close(iconv_handle);
-There are three preprocessor symbols defined for version checks in the header:AC_CHECK_LIB(gedcom, gedcom_parse_file,,
- AC_MSG_ERROR(Cannot find libgedcom: Please install gedcom-parse))
-AC_CACHE_CHECK(for libgedcom version, ac_cv_gedcom_version_ok,
-[AC_TRY_RUN([
-#include <stdio.h>
-#include <stdlib.h>
-#include <gedcom.h>
-int
-main()
-{
-if (GEDCOM_PARSE_VERSION >= 1034) exit(0);
-exit(1);
-}],
-ac_cv_gedcom_version_ok='yes',
-ac_cv_gedcom_version_ok='no')])
-if test "$ac_cv_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
-
GEDCOM_PARSE_VERSION_MAJORGEDCOM_PARSE_VERSION_MINORGEDCOM_PARSE_VERSION(GEDCOM_PARSE_VERSION_MAJOR * 1000) + GEDCOM_PARSE_VERSION_MINOR.$Id$- -
$Name$
+ +
$Id$- - \ No newline at end of file + +
$Name$
+ + +