X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=doc%2Finterface.html;h=16e66e929881da59aad88312be315266c8e1df4a;hb=90d522d64b1bc52135d15e26f88f55cf0d700ec6;hp=c27e3d07664a6cc826670865b420eddb2b47700b;hpb=6d7fe09b0eab9dd8ea3c209d59589bea6514a48c;p=gedcom-parse.git diff --git a/doc/interface.html b/doc/interface.html index c27e3d0..16e66e9 100644 --- a/doc/interface.html +++ b/doc/interface.html @@ -1,9 +1,7 @@ Libgedcom interface details - - - +

Libgedcom interface details


@@ -16,9 +14,11 @@
  • Gedcom_val types
    • @@ -825,9 +825,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -915,9 +914,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -929,7 +927,14 @@ element start callback.
    REC_INDI
    - XREF_PTR(INDI)
    + XREF_PTR(FAM),
    +XREF_PTR(INDI),
    +XREF_PTR(NOTE),
    +XREF_PTR(OBJE),
    +XREF_PTR(REPO),
    +XREF_PTR(SOUR),
    +XREF_PTR(SUBM),
    +XREF_PTR(SUBN)
    @@ -1047,8 +1052,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -1064,10 +1069,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    DATE
    @@ -1083,11 +1086,10 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    - STRING
    + AGE
    @@ -1101,9 +1103,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -1119,9 +1120,8 @@ element start callback.
    ELT_SUB_INDIV_RESI,
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    - ELT_SUB_INDIV_ADOP
    -
    -
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -1170,7 +1170,7 @@ element start callback.
    ELT_SUB_FAM_EVT_HUSB,
    ELT_SUB_FAM_EVT_WIFE
    - STRING
    + AGE
    @@ -1466,6 +1466,7 @@ element start callback.
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN,
    ELT_SUB_SOUR
    NULL
    @@ -1519,6 +1520,7 @@ element start callback.
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN,
    ELT_SUB_LIO_BAPL,
    ELT_SUB_LIO_SLGC,
    ELT_SUB_LSS_SLGS,
    @@ -1613,7 +1615,12 @@ element start callback.
    ELT_SUB_FAM_EVT,
    ELT_SUB_FAM_EVT_EVEN,
    ELT_SUB_INDIV_ATTR,
    - ELT_SUB_INDIV_RESI
    + ELT_SUB_INDIV_RESI    , +
    +ELT_SUB_INDIV_BIRT,
    + ELT_SUB_INDIV_GEN,
    + ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN
    STRING
    @@ -1642,6 +1649,7 @@ element start callback.
    ELT_SUB_INDIV_BIRT,
    ELT_SUB_INDIV_GEN,
    ELT_SUB_INDIV_ADOP,
    +ELT_SUB_INDIV_EVEN,
    ELT_SUB_LIO_BAPL,
    ELT_SUB_LIO_SLGC,
    ELT_SUB_LSS_SLGS,
    @@ -1822,6 +1830,14 @@ element start callback.
    struct date_value dv = GEDCOM_DATE(val); + age
    + + GEDCOM_IS_AGE(val)
    + + struct age_value age = GEDCOM_AGE(val);
    + + + xref pointer
    GEDCOM_IS_XREF_PTR(val)
    @@ -1849,13 +1865,13 @@ the value that is returned by GEDCOM_STRING(val) is always the s raw_value passed to the start callback, and is thus in fact redundant.

    The date value is used for all elements that return a date.  See -here for the definition.
    +here for the definition.

    The xref value is for cross-references between records in the file.  See -here for the definition.
    +here for the definition.

    -

    struct date_value

    +

    struct date_value

    This struct describes a date as given in the GEDCOM file, and has the following definition:
    @@ -1983,7 +1999,7 @@ the value that is returned by GEDCOM_STRING(val) is always the s
    -

    struct date
    +

    struct date

    The date1 and date2 also have a strict syntax:
    @@ -2076,17 +2092,100 @@ day number.  Two cases can be distinguished:
    -
    These are represented by 2 serial day numbers (sdn1 and sdn2) and a Date_type equal + +
    These are represented by 2 serial day numbers (sdn1 and sdn2) and a Date_type equal to DATE_BOUNDED.
    -
    +
    + For example, the Gregorian date "MAR 1990" is represented by the serial day numbers for "1 MAR 1990" and "31 MAR 1990", and the Gregorian date "1990" is represented by the serial day numbers for "1 JAN 1990" and "31 DEC 1990".  Similarly for the other calendar types.
    +
    + +
    +
    +

    struct age_value

    + + This struct describes an age as given in the GEDCOM file, and has the + following definition:
    + + +
    struct age_value {
    +   Age_type      type;
    +   Age_modifier  mod;
    +   int           years;
    +  int           months;
    +  int           days;
    +   char          phrase[MAX_PHRASE_LEN + + 1];
    + };
    +
    +
    -
    + -

    struct xref_value

    + + It depends on the first member, the type, which members are actually + relevant:
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Age_type
    +     		Meaning
    +     		Relevant members
    +
    AGE_UNRECOGNIZED
    +     		format not recognized, full raw value in phrase
    +     		phrase
    +
    AGE_CHILD
    +     		the indication 'CHILD'
    +     		mod
    +
    AGE_INFANT
    +     		the indication 'INFANT'
    +     		mod
    +
    AGE_STILLBORN
    +     		the indication 'STILLBORN'
    +     		mod
    +
    AGE_NUMERIC
    +     		an indication in years, months and/or days (each can be -1 if not given)
    +     		mod, years, months, days
    +
    +
    +The modifier can be one of the following:
    + +
    +

    struct xref_value

    + This struct represents a cross-reference in the GEDCOM file (but note that the Gedcom_val contains a pointer to such a struct, not the struct itself).  It is defined as:
    @@ -2109,7 +2208,9 @@ be one of:
  • XREF_REPO
  • XREF_SOUR
  • XREF_SUBM
    • -
  • XREF_SUBN
    • +
  • XREF_SUBN
  • XREF_ANY (if the type is not known, see below)
    +
    • +
  • XREF_USER (for application-specific cross-references)
    • @@ -2120,6 +2221,10 @@ can be filled by the application with an object (of any type) that corresponds with the cross-reference, and then later extracted when the cross-reference is used or defined again in the file.  This relieves the application from the burden of maintaining the mapping between cross-references and objects.
    +
    +The value XREF_ANY is used when the type of the object is not +immediately known: it has to come from further information.  This is +the case in an association (ELT_SUB_ASSO): the type is then given by the TYPE subtag.

    The parser checks whether all cross-references that are used are defined (if not, an error is produced) and whether all cross-references that are @@ -2128,10 +2233,19 @@ the type of the cross-reference is the same on definition and use (if not, an error is produced).  The first two checks are done at the end of the parsing, because cross-references can be defined after their usage in GEDCOM.
    -
    +
    +An xref_value can also be retrieved by its key via the following function:
    + +
    struct xref_value* gedcom_get_by_xref (char *key)
    +
    +The function returns NULL if the given key isn't used.
    $Id$
    $Name$

    - \ No newline at end of file +
    +
    +
    +
    +