gedcom

type AddressDetail struct {
	Full       string // The full address as found in free-form fields which may be optionally broken down using following structured fields
	Line1      string
	Line2      string
	Line3      string // 5.5.1
	City       string
	State      string
	PostalCode string
	Country    string
}

type AddressRecord struct {
	Address []*AddressDetail
	Phone   []string
	Email   []string // 5.5.1
	Fax     []string // 5.5.1
	WWW     []string // 5.5.1
}

type AssociationRecord struct {
	Xref     string            // Cross-reference to the associated individual
	Relation string            // Relationship type (e.g., "godparent", "witness")
	Citation []*CitationRecord // Source citations
	Note     []*NoteRecord     // Notes about this association
}

type ChangeRecord struct {
	Date string        // Date of the change in GEDCOM date format
	Time string        // Time of the change
	Note []*NoteRecord // Notes about the change
}

type CitationRecord struct {
	Source      *SourceRecord    // The source being cited
	Page        string           // Page number or location within the source
	Data        DataRecord       // Data extracted from the source
	Quay        string           // Quality assessment (0-3, with 3 being direct evidence)
	Media       []*MediaRecord   // Media objects (e.g., photo of the source page)
	Note        []*NoteRecord    // Notes about this citation
	UserDefined []UserDefinedTag // User-defined tags
}

type DataRecord struct {
	Date        string           // Date the data was recorded
	Text        []string         // Verbatim text from the source
	UserDefined []UserDefinedTag // User-defined tags
}

type Decoder struct {
	// contains filtered or unexported fields
}

type Encoder struct {
	// contains filtered or unexported fields
}

type EventRecord struct {
	Tag                  string            // Event type tag (e.g., "BIRT", "DEAT", "MARR")
	Value                string            // Event value, often "Y" to indicate event occurred
	Type                 string            // Detailed event type for generic EVEN tags
	Date                 string            // Date in GEDCOM date format
	Place                PlaceRecord       // Location where the event occurred
	Address              AddressRecord     // Address associated with the event
	Age                  string            // Age of the individual at the time of the event
	ResponsibleAgency    string            // Agency responsible for the record
	ReligiousAffiliation string            // Religious affiliation associated with event
	Cause                string            // Cause (e.g., cause of death)
	RestrictionNotice    string            // Privacy restriction (GEDCOM 5.5.1)
	ChildInFamily        *FamilyRecord     // Link to parent family for birth events
	AdoptedByParent      string            // For adoption: "HUSB", "WIFE", or "BOTH"
	Citation             []*CitationRecord // Source citations for this event
	Media                []*MediaRecord    // Media objects (e.g., photos, certificates)
	Note                 []*NoteRecord     // Notes about this event
	UserDefined          []UserDefinedTag  // User-defined tags
}

type FamilyLinkRecord struct {
	Family *FamilyRecord // Pointer to the linked family
	Type   string        // Relationship type (e.g., "birth", "adopted", "foster")
	Note   []*NoteRecord // Notes about this family link
}

type FamilyRecord struct {
	Xref              string                 // Unique cross-reference identifier for this family (e.g., "@F1@")
	Husband           *IndividualRecord      // Pointer to the husband/father individual
	Wife              *IndividualRecord      // Pointer to the wife/mother individual
	Child             []*IndividualRecord    // Pointers to child individuals
	Event             []*EventRecord         // Family events (marriage, divorce, census, etc.)
	NumberOfChildren  string                 // Total number of children, may differ from len(Child)
	UserReference     []*UserReferenceRecord // User-provided reference numbers
	AutomatedRecordId string                 // Unique record ID assigned by the source system
	Change            ChangeRecord           // Record of when this record was last modified
	Note              []*NoteRecord          // Notes attached to this family
	Citation          []*CitationRecord      // Source citations for this family
	Media             []*MediaRecord         // Media objects (photos, documents) for this family
	UserDefined       []UserDefinedTag       // User-defined tags (prefixed with underscore)
}

type FileRecord struct {
	Name        string           // File path or URL
	Format      string           // File format (e.g., "jpeg", "gif", "pdf")
	FormatType  string           // Media type (e.g., "photo", "document")
	Title       string           // Title or caption for this file
	UserDefined []UserDefinedTag // User-defined tags
}

type Gedcom struct {
	Header      *Header
	Family      []*FamilyRecord
	Individual  []*IndividualRecord
	Media       []*MediaRecord
	Repository  []*RepositoryRecord
	Source      []*SourceRecord
	Submitter   []*SubmitterRecord
	Trailer     *Trailer
	UserDefined []UserDefinedTag
}

type Header struct {
	SourceSystem        SystemRecord
	Destination         string
	Date                string
	Time                string
	Submitter           *SubmitterRecord
	Submission          *SubmissionRecord
	Filename            string
	Copyright           string
	Version             string
	Form                string
	CharacterSet        string
	CharacterSetVersion string
	Language            string
	Place               PlaceRecord
	Note                string
	UserDefined         []UserDefinedTag
}

type IndividualRecord struct {
	Xref                      string                 // Unique cross-reference identifier (e.g., "@I1@")
	Name                      []*NameRecord          // Names (may have multiple for maiden names, aliases)
	Sex                       string                 // Sex: "M" for male, "F" for female, "U" for unknown
	Event                     []*EventRecord         // Life events (birth, death, burial, etc.)
	Attribute                 []*EventRecord         // Attributes (occupation, residence, education, etc.)
	Parents                   []*FamilyLinkRecord    // Links to families where this person is a child
	Family                    []*FamilyLinkRecord    // Links to families where this person is a spouse
	Submitter                 []*SubmitterRecord     // Submitters of this record
	Association               []*AssociationRecord   // Associations with other individuals
	PermanentRecordFileNumber string                 // Permanent record file number
	AncestralFileNumber       string                 // Ancestral file number
	UserReference             []*UserReferenceRecord // User-provided reference numbers
	AutomatedRecordId         string                 // Unique record ID assigned by the source system
	Change                    ChangeRecord           // Record of when this record was last modified
	Note                      []*NoteRecord          // Notes attached to this individual
	Citation                  []*CitationRecord      // Source citations for this individual
	Media                     []*MediaRecord         // Media objects (photos, documents)
	UserDefined               []UserDefinedTag       // User-defined tags (prefixed with underscore)
}

type Line struct {
	Level      int    // Hierarchy level (0 for top-level records)
	Tag        string // GEDCOM tag (e.g., "INDI", "NAME", "BIRT")
	Value      string // Optional value following the tag
	Xref       string // Optional cross-reference identifier (e.g., "I1" from "@I1@")
	LineNumber int    // Line number in the input file (1-indexed)
	Offset     int    // Character offset in the input file
}

type MediaRecord struct {
	Xref              string                 // Unique cross-reference identifier (e.g., "@M1@")
	File              []*FileRecord          // File references for this media object
	Title             string                 // Title or description of the media
	UserReference     []*UserReferenceRecord // User-provided reference numbers
	AutomatedRecordId string                 // Unique record ID assigned by the source system
	Change            ChangeRecord           // Record of when this record was last modified
	Note              []*NoteRecord          // Notes attached to this media
	Citation          []*CitationRecord      // Source citations
	UserDefined       []UserDefinedTag       // User-defined tags
}

type NameRecord struct {
	Name                   string               // Full name in GEDCOM format (e.g., "John /Smith/ Jr.")
	Type                   string               // Name type (e.g., "birth", "married", "aka")
	NamePiecePrefix        string               // Name prefix (e.g., "Dr.", "Rev.")
	NamePieceGiven         string               // Given name(s)
	NamePieceNick          string               // Nickname
	NamePieceSurnamePrefix string               // Surname prefix (e.g., "van", "de")
	NamePieceSurname       string               // Surname
	NamePieceSuffix        string               // Name suffix (e.g., "Jr.", "III")
	Phonetic               []*VariantNameRecord // Phonetic variants of the name
	Romanized              []*VariantNameRecord // Romanized variants of the name
	Citation               []*CitationRecord    // Source citations for this name
	Note                   []*NoteRecord        // Notes about this name
	UserDefined            []UserDefinedTag     // User-defined tags
}

type NoteRecord struct {
	Note     string            // The note text
	Citation []*CitationRecord // Source citations for the note
}

type ParsedName struct {
	Full     string // Reconstructed full name without GEDCOM delimiters
	Given    string // Given name(s) / first name(s)
	Surname  string // Surname / family name / last name
	Suffix   string // Name suffix (e.g., "Jr.", "III", "PhD")
	Nickname string // Nickname, if present in quotes
}

type PlaceRecord struct {
	Name      string                    // Place name (jurisdiction hierarchy)
	Phonetic  []*VariantPlaceNameRecord // Phonetic variants of the place name
	Romanized []*VariantPlaceNameRecord // Romanized variants of the place name
	Latitude  string                    // Latitude in GEDCOM format (e.g., "N50.9333")
	Longitude string                    // Longitude in GEDCOM format (e.g., "W1.8")
	Citation  []*CitationRecord         // Source citations
	Note      []*NoteRecord             // Notes about the place
}

type RepositoryRecord struct {
	Xref              string                 // Unique cross-reference identifier (e.g., "@R1@")
	Name              string                 // Name of the repository
	Address           AddressRecord          // Address of the repository
	Note              []*NoteRecord          // Notes about the repository
	UserReference     []*UserReferenceRecord // User-provided reference numbers
	AutomatedRecordId string                 // Unique record ID assigned by the source system
	Change            ChangeRecord           // Record of when this record was last modified
	UserDefined       []UserDefinedTag       // User-defined tags
}

type ScanErr struct {
	Err        error // The underlying error
	LineNumber int   // Line number where the error occurred (1-indexed)
	Offset     int   // Character offset within the line
}

type Scanner struct {
	// contains filtered or unexported fields
}

type SourceCallNumberRecord struct {
	CallNumber string // The call number or shelf location
	MediaType  string // Type of media (e.g., "book", "microfilm")
}

type SourceDataRecord struct {
	Event []*SourceEventRecord // Events covered by the source
}

type SourceEventRecord struct {
	Kind  string // Type of event (e.g., "BIRT", "MARR", "DEAT")
	Date  string // Date range covered by the source
	Place string // Place jurisdiction covered by the source
}

type SourceRecord struct {
	Xref              string                  // Unique cross-reference identifier (e.g., "@S1@")
	Title             string                  // Title of the source
	Data              *SourceDataRecord       // Data recorded from the source
	Originator        string                  // Author or creator of the source
	FiledBy           string                  // Person who filed the source
	PublicationFacts  string                  // Publication information
	Text              string                  // Verbatim text from the source
	Repository        *SourceRepositoryRecord // Repository where the source is held
	UserReference     []*UserReferenceRecord  // User-provided reference numbers
	AutomatedRecordId string                  // Unique record ID assigned by the source system
	Change            ChangeRecord            // Record of when this record was last modified
	Note              []*NoteRecord           // Notes about the source
	Media             []*MediaRecord          // Media objects (photos of documents, etc.)
	UserDefined       []UserDefinedTag        // User-defined tags
}

type SourceRepositoryRecord struct {
	Repository *RepositoryRecord         // The repository holding the source
	Note       []*NoteRecord             // Notes about the source at this repository
	CallNumber []*SourceCallNumberRecord // Call numbers for locating the source
}

type SubmissionRecord struct {
	Xref string
}

type SubmitterRecord struct {
	Xref                  string         // Unique cross-reference identifier (e.g., "@SUBM1@")
	Name                  string         // Name of the submitter
	Address               *AddressRecord // Address of the submitter
	Media                 []*MediaRecord // Media objects (e.g., photo of submitter)
	Language              []string       // Languages used by the submitter
	SubmitterRecordFileID string         // Submitter record file identifier
	AutomatedRecordId     string         // Unique record ID assigned by the source system
	Note                  []*NoteRecord  // Notes from the submitter
	Change                *ChangeRecord  // Record of when this record was last modified
}

type SystemRecord struct {
	Xref            string
	Version         string
	ProductName     string
	BusinessName    string
	Address         AddressRecord
	SourceName      string
	SourceDate      string
	SourceCopyright string
	UserDefined     []UserDefinedTag
}

type Trailer struct{}

type UserDefinedTag struct {
	Tag         string
	Value       string
	Xref        string
	Level       int
	UserDefined []UserDefinedTag
}

type UserReferenceRecord struct {
	Number string // The reference number
	Type   string // The type of reference
}

type VariantNameRecord struct {
	Name                   string            // Full variant name
	Type                   string            // Variant type (e.g., "kana", "hangul" for phonetic)
	NamePiecePrefix        string            // Name prefix
	NamePieceGiven         string            // Given name(s)
	NamePieceNick          string            // Nickname
	NamePieceSurnamePrefix string            // Surname prefix
	NamePieceSurname       string            // Surname
	NamePieceSuffix        string            // Name suffix
	Citation               []*CitationRecord // Source citations
	Note                   []*NoteRecord     // Notes
}

type VariantPlaceNameRecord struct {
	Name string // The variant place name
	Type string // Variant type (e.g., "kana", "hangul" for phonetic)
}