my_message_handler is the callback
- that will be called for errors (type=ERROR), warnings (
- type=WARNING) and messages (type=MESSAGE). The
+ 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 (see "Why UTF-8?" LINK TBD). Also, +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>
gedcom-tags.h yourself).struct that will contain the information for the
+ e.g. pass a 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.struct that
+ that the context of the parent line (here e.g. the struct that
describes the header) is passed to this start callback. The callback
-itself returns here the same context, but this can be its own context object
+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 will be the same in the example.
+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
@@ -293,9 +291,8 @@ level number (the initial number of the line in the GEDCOM file), the tag
Gedcom_val argument of the end callback
is currently not used. It is there for future enhancements.Gedcom_val argument in
-the start callback for records. This argument is currently a string
-value giving the pointer in string form.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.parent could be of different
types, depending on the context).NULLlocale 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 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 thechar *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
+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_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
+
GEDCOM_PARSE_VERSION_MAJORGEDCOM_PARSE_VERSION_MINORGEDCOM_PARSE_VERSION(GEDCOM_PARSE_VERSION_MAJOR * 1000) + GEDCOM_PARSE_VERSION_MINOR.$Id$+
$Name$
$Id$
$Name$
- - + \ No newline at end of file