X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=include%2Fgedcom.h.in;h=424c516a876c4a8de1b96fd1140b6a28a39fa156;hb=505301d49e81bcd0e1827026cd4672b8722ac349;hp=20a300aa55d84cce773b794c8d060a6560c03d2f;hpb=1aa245b49a351f8a05049ebf6f189936723b0b69;p=gedcom-parse.git diff --git a/include/gedcom.h.in b/include/gedcom.h.in index 20a300a..424c516 100644 --- a/include/gedcom.h.in +++ b/include/gedcom.h.in @@ -25,8 +25,11 @@ #define __GEDCOM_H #include +#include -__BEGIN_DECLS +#ifdef __cplusplus +extern "C" { +#endif #ifndef GEDCOM_INTERNAL #include @@ -34,9 +37,12 @@ __BEGIN_DECLS #define GEDCOM_PARSE_VERSION_MAJOR @VERSION_MAJOR@ #define GEDCOM_PARSE_VERSION_MINOR @VERSION_MINOR@ +#define GEDCOM_PARSE_VERSION_PATCH 0 #define GEDCOM_PARSE_VERSION \ (GEDCOM_PARSE_VERSION_MAJOR * 1000 + GEDCOM_PARSE_VERSION_MINOR) +int gedcom_check_version(int major, int minor, int patch); + /**************************************************************************/ /*** First the records and elements to subscribe upon ***/ /**************************************************************************/ @@ -56,7 +62,7 @@ typedef enum _REC { } Gedcom_rec; typedef enum _ELT { - ELT_HEAD_SOUR, + ELT_HEAD_SOUR = NR_OF_RECS, ELT_HEAD_SOUR_VERS, ELT_HEAD_SOUR_NAME, ELT_HEAD_SOUR_CORP, @@ -328,7 +334,8 @@ typedef enum _XREF_TYPE { XREF_SOUR, XREF_SUBM, XREF_SUBN, - XREF_USER + XREF_USER, + XREF_ANY } Xref_type; struct xref_value { @@ -337,6 +344,47 @@ struct xref_value { Gedcom_ctxt object; }; +typedef enum _AGE_TYPE { + AGE_UNRECOGNIZED, + AGE_CHILD, + AGE_INFANT, + AGE_STILLBORN, + AGE_NUMERIC +} Age_type; + +typedef enum _AGE_MODIFIER { + AGE_NO_MODIFIER, + AGE_LESS_THAN, + AGE_GREATER_THAN +} Age_modifier; + +struct age_value { + Age_type type; + Age_modifier mod; + int years; + int months; + int days; + char phrase[MAX_PHRASE_LEN + 1]; +}; + +typedef enum _ENC { + ONE_BYTE = 0x00, + TWO_BYTE_HILO = 0x01, + TWO_BYTE_LOHI = 0x02 +} Encoding; + +typedef enum _ENC_BOM { + WITHOUT_BOM = 0x00, + WITH_BOM = 0x10 +} Enc_bom; + +typedef enum _ENC_LINE_END { + END_CR = 0, + END_LF = 1, + END_CR_LF = 2, + END_LF_CR = 3 +} Enc_line_end; + /**************************************************************************/ /*** Things meant to be internal, susceptible to changes ***/ /*** Use the GEDCOM_STRING/GEDCOM_DATE interface instead of relying ***/ @@ -344,15 +392,17 @@ struct xref_value { /**************************************************************************/ typedef enum _GEDCOM_VAL_TYPE { - GV_NULL, - GV_CHAR_PTR, - GV_DATE_VALUE, - GV_XREF_PTR + GV_NULL = 0x01, + GV_CHAR_PTR = 0x02, + GV_DATE_VALUE = 0x04, + GV_AGE_VALUE = 0x08, + GV_XREF_PTR = 0x10 } Gedcom_val_type; union _Gedcom_val_union { char* string_val; struct date_value date_val; + struct age_value age_val; struct xref_value *xref_val; }; @@ -361,11 +411,12 @@ typedef struct _Gedcom_val_struct { union _Gedcom_val_union value; } Gedcom_val_struct; -void gedcom_cast_error(char* file, int line, +void gedcom_cast_error(const char* file, int line, Gedcom_val_type tried_type, Gedcom_val_type real_type); extern struct date_value def_date_val; +extern struct age_value def_age_val; extern struct xref_value def_xref_val; #define GV_CHECK_CAST(VAL, TYPE, MEMBER, DEFVAL) \ @@ -383,6 +434,10 @@ extern struct xref_value def_xref_val; /* Type for parsed values, meant to be opaque */ typedef Gedcom_val_struct* Gedcom_val; +/* Type for write handle, meant to be opaque */ +struct Gedcom_write_struct; +typedef struct Gedcom_write_struct* Gedcom_write_hndl; + /* Check to determine whether there is a parsed value or not */ #define GEDCOM_IS_NULL(VAL) \ GV_IS_TYPE(VAL, GV_NULL) @@ -401,6 +456,13 @@ typedef Gedcom_val_struct* Gedcom_val; #define GEDCOM_IS_DATE(VAL) \ GV_IS_TYPE(VAL, GV_DATE_VALUE) +/* This returns the struct age_value from a Gedcom_val, if appropriate */ +/* It gives a gedcom_warning if the cast is not correct */ +#define GEDCOM_AGE(VAL) \ + GV_CHECK_CAST(VAL, GV_AGE_VALUE, age_val, def_age_val) +#define GEDCOM_IS_AGE(VAL) \ + GV_IS_TYPE(VAL, GV_AGE_VALUE) + /* This returns the (struct xref_value *) from a Gedcom_val, if appropriate */ /* It gives a gedcom_warning if the cast is not correct */ #define GEDCOM_XREF_PTR(VAL) \ @@ -414,28 +476,30 @@ typedef void typedef Gedcom_ctxt (*Gedcom_rec_start_cb) - (int level, Gedcom_val xref, char *tag, char *raw_value, - int tag_value, Gedcom_val parsed_value); + (Gedcom_rec rec, int level, Gedcom_val xref, char *tag, + char *raw_value, int tag_value, Gedcom_val parsed_value); typedef void (*Gedcom_rec_end_cb) - (Gedcom_ctxt self); + (Gedcom_rec rec, Gedcom_ctxt self, Gedcom_val parsed_value); typedef Gedcom_ctxt (*Gedcom_elt_start_cb) - (Gedcom_ctxt parent, + (Gedcom_elt elt, Gedcom_ctxt parent, int level, char *tag, char *raw_value, int tag_value, Gedcom_val parsed_value); typedef void (*Gedcom_elt_end_cb) - (Gedcom_ctxt parent, Gedcom_ctxt self, Gedcom_val parsed_value); + (Gedcom_elt elt, Gedcom_ctxt parent, Gedcom_ctxt self, + Gedcom_val parsed_value); typedef void (*Gedcom_def_cb) - (Gedcom_ctxt parent, int level, char *tag, char *raw_value, - int tag_value); + (Gedcom_elt elt, Gedcom_ctxt parent, int level, char *tag, + char *raw_value, int tag_value); -void gedcom_init(); -int gedcom_parse_file(char* file_name); +int gedcom_init(); +int gedcom_parse_file(const char* file_name); +int gedcom_new_model(); void gedcom_set_debug_level(int level, FILE* trace_output); void gedcom_set_error_handling(Gedcom_err_mech mechanism); void gedcom_set_compat_handling(int enable_compat); @@ -450,8 +514,38 @@ void gedcom_subscribe_to_element(Gedcom_elt elt, Gedcom_elt_end_cb cb_end); /* Separate value parsing functions */ -struct date_value gedcom_parse_date(char* line_value); - -__END_DECLS +struct date_value gedcom_parse_date(const char* line_value); +struct age_value gedcom_parse_age(const char* line_value); + +/* Handling cross-references */ +struct xref_value *gedcom_get_by_xref(const char *key); +struct xref_value *gedcom_add_xref(Xref_type type, const char* xrefstr, + Gedcom_ctxt object); +struct xref_value *gedcom_link_xref(Xref_type type, const char* xrefstr); +struct xref_value *gedcom_unlink_xref(Xref_type type, const char* xrefstr); +int gedcom_delete_xref(const char* xrefstr); + +/* Writing support */ +Gedcom_write_hndl gedcom_write_open(const char* filename); +int gedcom_write_close(Gedcom_write_hndl hndl, int *total_conv_fails); +int gedcom_write_set_encoding(const char* charset, Encoding width, + Enc_bom bom); +int gedcom_write_set_line_terminator(Enc_line_end end); +int gedcom_write_record_str(Gedcom_write_hndl hndl, + Gedcom_rec rec, char* tag, + struct xref_value* xref, char* val); +int gedcom_write_element_str(Gedcom_write_hndl hndl, + Gedcom_elt elt, char* tag, int parent_rec_or_elt, + char* val); + +/* For use in gom */ +int gedcom_error(const char* s, ...); +int gedcom_warning(const char* s, ...); +int gedcom_message(const char* s, ...); +int gedcom_debug_print(const char* s, ...); + +#ifdef __cplusplus +} +#endif #endif /* __GEDCOM_H */