Set compatibility variables to sane value at restart.
[gedcom-parse.git] / gedcom / compat.c
1 /* Compatibility handling for the GEDCOM parser.
2    Copyright (C) 2001, 2002 The Genes Development Team
3    This file is part of the Gedcom parser library.
4    Contributed by Peter Verthez <Peter.Verthez@advalvas.be>, 2001.
5
6    The Gedcom parser library is free software; you can redistribute it
7    and/or modify it under the terms of the GNU Lesser General Public
8    License as published by the Free Software Foundation; either
9    version 2.1 of the License, or (at your option) any later version.
10
11    The Gedcom parser library is distributed in the hope that it will be
12    useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14    Lesser General Public License for more details.
15
16    You should have received a copy of the GNU Lesser General Public
17    License along with the Gedcom parser library; if not, write to the
18    Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
19    02111-1307 USA.  */
20
21 /* $Id$ */
22 /* $Name$ */
23
24 #include "compat.h"
25 #include "interface.h"
26 #include "encoding.h"
27 #include "xref.h"
28 #include "gedcom_internal.h"
29 #include "gedcom.h"
30
31 int compat_enabled = 1;
32 int compatibility  = 0; 
33 int compat_at = 0;
34 char* default_charset = "";
35
36 #define SUBMITTER_LINK         "@__COMPAT__SUBM__@"
37 #define DEFAULT_SUBMITTER_NAME "Submitter"
38 #define DEFAULT_GEDCOM_VERS    "5.5"
39 #define DEFAULT_GEDCOM_FORM    "LINEAGE-LINKED"
40
41 /* Incompatibility list (with GEDCOM 5.5):
42
43     - ftree:
44         - no submitter record, no submitter link in the header
45         - INDI.ADDR instead of INDI.RESI.ADDR
46         - NOTE doesn't have a value
47
48     - Lifelines (3.0.2):
49         - no submitter record, no submitter link in the header
50         - no GEDC field in the header
51         - no CHAR field in the header
52         - HEAD.TIME instead of HEAD.DATE.TIME (will be ignored here)
53         - '@' not written as '@@' in values
54         - lots of missing required values
55  */
56
57 /* Compatibility handling */
58
59 void gedcom_set_compat_handling(int enable_compat)
60 {
61   compat_enabled = enable_compat;
62 }
63
64 void set_compatibility(char* program)
65 {
66   /* Reinitialize compatibility */
67   compat_at = 0;
68   default_charset = "";
69   compatibility = 0;
70   
71   if (compat_enabled) {
72     if (! strncmp(program, "ftree", 6)) {
73       gedcom_warning(_("Enabling compatibility with 'ftree'"));
74       compatibility = C_FTREE;
75     }
76     else if (! strncmp(program, "LIFELINES", 9)) {
77       /* Matches "LIFELINES 3.0.2" */
78       gedcom_warning(_("Enabling compatibility with 'Lifelines'"));
79       compatibility = C_LIFELINES;
80       default_charset = "ANSI";
81       compat_at = 1;
82     }
83   }
84 }
85
86 int compat_mode(int compat_flags)
87 {
88   return (compat_flags & compatibility);
89 }
90
91 void compat_generate_submitter_link(Gedcom_ctxt parent)
92 {
93   struct xref_value *xr = gedcom_parse_xref(SUBMITTER_LINK, XREF_USED,
94                                             XREF_SUBM);
95   struct tag_struct ts;
96   Gedcom_ctxt self;
97   
98   ts.string = "SUBM";
99   ts.value  = TAG_SUBM;
100   self = start_element(ELT_HEAD_SUBM,
101                        parent, 1, ts, SUBMITTER_LINK,
102                        GEDCOM_MAKE_XREF_PTR(val1, xr));
103   end_element(ELT_HEAD_SUBM, parent, self, NULL);
104 }
105
106 void compat_generate_submitter()
107 {
108   struct xref_value *xr = gedcom_parse_xref(SUBMITTER_LINK, XREF_DEFINED,
109                                             XREF_SUBM);
110   struct tag_struct ts;
111   Gedcom_ctxt self1, self2;
112
113   /* first generate "0 SUBM" */
114   ts.string = "SUBM";
115   ts.value  = TAG_SUBM;
116   self1 = start_record(REC_SUBM, 0, GEDCOM_MAKE_XREF_PTR(val1, xr), ts,
117                        NULL, GEDCOM_MAKE_NULL(val2));
118
119   /* then generate "1 NAME ..." */
120   ts.string = "NAME";
121   ts.value  = TAG_NAME;
122   self2 = start_element(ELT_SUBM_NAME, self1, 1, ts, DEFAULT_SUBMITTER_NAME,
123                         GEDCOM_MAKE_STRING(val1, DEFAULT_SUBMITTER_NAME));
124
125   /* close "1 NAME ..." */
126   end_element(ELT_SUBM_NAME, self1, self2, NULL);
127
128   /* close "0 SUBM" */
129   end_record(REC_SUBM, self1);
130 }
131
132 void compat_generate_gedcom(Gedcom_ctxt parent)
133 {
134   struct tag_struct ts;
135   Gedcom_ctxt self1, self2;
136   
137   /* first generate "1 GEDC" */
138   ts.string = "GEDC";
139   ts.value  = TAG_GEDC;
140   self1 = start_element(ELT_HEAD_GEDC, parent, 1, ts, NULL,
141                         GEDCOM_MAKE_NULL(val1));
142   
143   /* then generate "2 VERS <DEFAULT_GEDC_VERS>" */
144   ts.string = "VERS";
145   ts.value  = TAG_VERS;
146   self2 = start_element(ELT_HEAD_GEDC_VERS, self1, 2, ts,
147                         DEFAULT_GEDCOM_VERS,
148                         GEDCOM_MAKE_STRING(val1, DEFAULT_GEDCOM_VERS));
149   
150   /* close "2 VERS" */
151   end_element(ELT_HEAD_GEDC_VERS, self1, self2, NULL);
152   
153   /* then generate "2 FORM <DEFAULT_GEDCOM_FORM> */
154   ts.string = "FORM";
155   ts.value  = TAG_FORM;
156   self2 = start_element(ELT_HEAD_GEDC_FORM, self1, 2, ts,
157                         DEFAULT_GEDCOM_FORM,
158                         GEDCOM_MAKE_STRING(val1, DEFAULT_GEDCOM_FORM));
159   
160   /* close "2 FORM" */
161   end_element(ELT_HEAD_GEDC_FORM, self1, self2, NULL);
162   
163   /* close "1 GEDC" */
164   end_element(ELT_HEAD_GEDC, parent, self1, NULL);
165 }
166
167 int compat_generate_char(Gedcom_ctxt parent)
168 {
169   struct tag_struct ts;
170   Gedcom_ctxt self1;
171   
172   /* first generate "1 CHAR <DEFAULT_CHAR>" */
173   ts.string = "CHAR";
174   ts.value  = TAG_CHAR;
175   self1 = start_element(ELT_HEAD_CHAR, parent, 1, ts, default_charset,
176                         GEDCOM_MAKE_STRING(val1, default_charset));
177   
178   /* close "1 CHAR" */
179   end_element(ELT_HEAD_CHAR, parent, self1, NULL);
180   if (open_conv_to_internal(default_charset) == 0)
181     return 1;
182   else
183     return 0;
184 }
185
186 Gedcom_ctxt compat_generate_resi_start(Gedcom_ctxt parent)
187 {
188   Gedcom_ctxt self;
189   struct tag_struct ts;
190
191   ts.string = "RESI";
192   ts.value  = TAG_RESI;
193   self = start_element(ELT_SUB_INDIV_RESI, parent, 1, ts, NULL,
194                        GEDCOM_MAKE_NULL(val1));
195   return self;
196 }
197
198 void compat_generate_resi_end(Gedcom_ctxt parent, Gedcom_ctxt self)
199 {
200   end_element(ELT_SUB_INDIV_RESI, parent, self, NULL);
201 }