X-Git-Url: https://git.dlugolecki.net.pl/?a=blobdiff_plain;f=doc%2Finterface.html;h=5cc72cb054df890818513d874443602694f391aa;hb=fd6e9eab0e4489bcc7d7c0a0897218be74852641;hp=74d5aadd0886d5fac92f5dcaa297705f68efd05a;hpb=1316fee80103b38bf682f5c626c0abaa525db41c;p=gedcom-parse.git diff --git a/doc/interface.html b/doc/interface.html index 74d5aad..5cc72cb 100644 --- a/doc/interface.html +++ b/doc/interface.html @@ -1,11 +1,7 @@ - - - - Libgedcom interface details +Libgedcom interface details + - - - +

Libgedcom interface details

@@ -19,7 +15,9 @@

struct date_value
struct date
struct date
struct age_value
+
struct xref_value

STRING

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)

STRING

DATE

,

      ELT_SUB_INDIV_BIRT,

      ELT_SUB_INDIV_GEN,

-     ELT_SUB_INDIV_ADOP

STRING

AGE

,

      ELT_SUB_INDIV_BIRT,

      ELT_SUB_INDIV_GEN,

-     ELT_SUB_INDIV_ADOP

STRING

,

      ELT_SUB_INDIV_BIRT,

      ELT_SUB_INDIV_GEN,

-     ELT_SUB_INDIV_ADOP

STRING

ELT_SUB_FAM_EVT_HUSB

ELT_SUB_FAM_EVT_WIFE

STRING

AGE

NULL

@@ -1521,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,

@@ -1644,6 +1644,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,

@@ -1824,6 +1825,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)

@@ -1847,8 +1856,8 @@ tag.

         

       The string value is the most general used value currently, for all
 those    values that don't have a more specific meaning.  In essence,
-the value    that is returned by GEDCOM_STRING is always the same as the
-raw_value passed    to the start callback, and is thus in fact redundant.

+the value    that is returned by GEDCOM_STRING(val) is always the same as the
+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.

@@ -1865,7 +1874,7 @@ raw_value passed    to the start callback, and is thus in fact redundant.

        Date_value_type  type;

        struct date      date1;

        struct date      date2;

-       char              phrase[MAX_PHRASE_LEN 
+       char             phrase[MAX_PHRASE_LEN 
   + 1];

      };

-
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

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 +

AGE_NO_MODIFIER : no modifier
AGE_LESS_THAN : the modifier '<' is added
AGE_GREATER_THAN : the modifier '>' is added

struct xref_value

Gedcom_val

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)

XREF_ANY

ELT_SUB_ASSO

TYPE

struct xref_value* gedcom_get_by_xref (char *key)
+

NULL

$Id$
$Name$