$PREFIX/share/gedcom-parse
+There is a separate script to help with library and compilation flags, see the development support.$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.-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).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
@@ -411,6 +421,148 @@ raw_value, int parsed_tag)Gedcom_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);
+
+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.
+
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 contains an example implementation (utf8-locale.c
- and utf8-locale.h in the "t" subdirectory of 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). -- Both functions return a pointer to a static buffer that is overwritten - on each call. To function properly, the application must first set -the locale using the-char *convert_utf8_to_locale (char *input, int *conv_failures);
char *convert_locale_to_utf8 (char *input);
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.---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 -
- -iconvconsecutively 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 seterrno- toEILSEQ; 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);
+gedcom-parse comes a library implementing help functions for UTF-8 encoding (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_PATH_GEDCOM_PARSER([min_version,[action_if_found,[action_if_not_found,[modules]]]])
-AM_LIB_GEDCOM_PARSER(1,34)
+version 1.34.2, you would put in configure.in the following statement:
+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)
+
+
+The macro also sets the variablesGEDCOM_CFLAGSandGEDCOM_LIBSfor 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)
@@ -713,7 +751,21 @@ There are three preprocessor symbols defined for version checks in the
- The last one is equal to(GEDCOM_PARSE_VERSION_MAJOR * 1000) + GEDCOM_PARSE_VERSION_MINOR.
+ The last one is equal to(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.
+
+Compilation and linking flags
+Similar to other libraries, the GEDCOM parse library installs a scriptgedcom-configto help with compilation and linking flags for programs that don't use autoconf/automake.
+
+To get compilation flags for your program, use (depending on whether you +only use the callback parser, or also the GEDCOM object model): ++Similarly, to get linking flags, use one of the following: +gedcom-config --cflags
+gedcom-config --cflags gom
++gedcom-config --libs
+gedcom-config --libs gom
+
@@ -724,6 +776,14 @@ There are three preprocessor symbols defined for version checks in the+
+
+
+
+
+
+
+