Copied from old documentation. Removed all Gedcom_val details.
[gedcom-parse.git] / gedcom / write.c
index 5bc9efa10fd33e841b25b6cae66e0b25a2440569..6e186b7b8c612d444d9895cfa7622df67288a36a 100644 (file)
@@ -24,6 +24,7 @@
 #include "gedcom_internal.h"
 #include "gedcom.h"
 #include "encoding.h"
+#include "encoding_state.h"
 #include "tag_data.h"
 #include "buffer.h"
 #include "utf8tools.h"
 
 #define MAXWRITELEN MAXGEDCLINELEN
 
-const char* encoding = "ASCII";
-int write_encoding_details = ONE_BYTE;
-/* SYS_NEWLINE is defined in config.h */
-const char* write_terminator = SYS_NEWLINE;
-
 struct Gedcom_write_struct {
   int       filedesc;
   convert_t conv;
@@ -48,19 +44,6 @@ struct Gedcom_write_struct {
   int       ctxt_level;
 };
 
-const char* default_encoding[] = {
-  /* ONE_BYTE */      "ASCII",
-  /* TWO_BYTE_HILO */ "UCS-2BE",
-  /* TWO_BYTE_LOHI */ "UCS-2LE"
-};
-
-const char* terminator[] = {
-  /* END_CR */     "\x0D",
-  /* END_LF */     "\x0A",
-  /* END_CR_LF */  "\x0D\x0A",
-  /* END_LF_CR */  "\x0A\x0D"
-};
-
 void cleanup_write_buffer();
 struct safe_buffer write_buffer = { NULL, 0, NULL, 0, cleanup_write_buffer };
 
@@ -79,7 +62,8 @@ void cleanup_convert_at_buffer()
 }
 
 int write_simple(Gedcom_write_hndl hndl,
-                int level, char* xref, char* tag, char* value)
+                int level, const char* xref, const char* tag,
+                const char* value)
 {
   int res;
   
@@ -119,13 +103,23 @@ int write_simple(Gedcom_write_hndl hndl,
   return 0;
 }
 
+int write_encoding_value(Gedcom_write_hndl hndl,
+                        int level, const char* xref, const char* tag,
+                        const char* value)
+{
+  if (strcmp(value, write_encoding.charset))
+    gedcom_warning(_("Forcing HEAD.CHAR value to '%s'"),
+                  write_encoding.charset);
+  return write_simple(hndl, level, xref, tag, write_encoding.charset);
+}
+
 int supports_continuation(int elt_or_rec, int which_continuation)
 {
   return tag_data[elt_or_rec].options & which_continuation;
 }
 
 int write_long(Gedcom_write_hndl hndl, int elt_or_rec,
-              int level, char* xref, char* tag, char* value)
+              int level, const char* xref, const char* tag, const char* value)
 {
   int prefix_len, value_len = 0, term_len;
   char* nl_pos = NULL;
@@ -140,11 +134,11 @@ int write_long(Gedcom_write_hndl hndl, int elt_or_rec,
   if (!nl_pos && prefix_len + value_len + term_len <= MAXWRITELEN)
     write_simple(hndl, level, xref, tag, value);
   else {
-    char* value_ptr = value;
+    const char* value_ptr = value;
     int cont_supported = supports_continuation(elt_or_rec, OPT_CONT);
     int cont_as_conc   = supports_continuation(elt_or_rec, OPT_CONT_AS_CONC);
     if (nl_pos && !cont_supported) {
-      gedcom_error (_("The tag %s doesn't support newlines\n"), tag);
+      gedcom_error (_("The tag %s doesn't support newlines"), tag);
       return 1;
     }
     else {
@@ -160,8 +154,13 @@ int write_long(Gedcom_write_hndl hndl, int elt_or_rec,
 
        if (prefix_len + line_len + term_len > MAXWRITELEN) {
          line_len = MAXWRITELEN - prefix_len - term_len;
-         if (!cont_as_conc)
+         if (!cont_as_conc) {
            cont_tag = "CONC";
+           while (value_ptr[line_len] == ' '
+                  || value_ptr[line_len-1] == ' ') {
+             line_len--;
+           }
+         }
        }
        
        memset(value_part, 0, sizeof(value_part));
@@ -171,7 +170,7 @@ int write_long(Gedcom_write_hndl hndl, int elt_or_rec,
        if (line_len < value_len) {
          value_ptr   = value_ptr + line_len;
          value_len   = value_len - line_len;
-         while (*value_ptr == '\n') {
+         if (*value_ptr == '\n') {
            value_ptr++;
            value_len--;
          }
@@ -190,43 +189,6 @@ int write_long(Gedcom_write_hndl hndl, int elt_or_rec,
   return 0;
 }
 
-int gedcom_write_set_encoding(const char* charset,
-                             Encoding width, Enc_bom bom)
-{
-  char* new_encoding = NULL;
-  if (!strcmp(charset, "UNICODE")) {
-    if (width == ONE_BYTE) {
-      gedcom_error(_("Unicode cannot be encoded into one byte"));
-      return 1;
-    }
-    else {
-      new_encoding = get_encoding(charset, width);
-      if (new_encoding) {
-       encoding = new_encoding;
-       write_encoding_details = width | bom;
-      }
-      else
-       return 1;
-    }
-  }
-  else {
-    new_encoding = get_encoding(charset, ONE_BYTE);
-    if (new_encoding) {
-      encoding = new_encoding;
-      write_encoding_details = ONE_BYTE;
-    }
-    else
-      return 1;
-  }
-  return 0;
-}
-
-int gedcom_write_set_line_terminator(Enc_line_end end)
-{
-  write_terminator = terminator[end];
-  return 0;
-}
-
 Gedcom_write_hndl gedcom_write_open(const char *filename)
 {
   Gedcom_write_hndl hndl;
@@ -236,11 +198,13 @@ Gedcom_write_hndl gedcom_write_open(const char *filename)
   if (!hndl)
     MEMORY_ERROR;
   else {
+    init_write_encoding();
+    init_write_terminator();
     hndl->total_conv_fails = 0;
-    hndl->conv = initialize_utf8_conversion(encoding, 0);
+    hndl->conv = initialize_utf8_conversion(write_encoding.encoding, 0);
     if (!hndl->conv) {
       gedcom_error(_("Could not open encoding '%s' for writing: %s"),
-                  encoding, strerror(errno));
+                  write_encoding.encoding, strerror(errno));
       free(hndl);
       hndl = NULL;
     }
@@ -254,15 +218,17 @@ Gedcom_write_hndl gedcom_write_open(const char *filename)
        hndl = NULL;
       }
       else {
-       hndl->term = write_terminator;
+       hndl->term = write_encoding.terminator;
        hndl->ctxt_level = -1;
-       if (write_encoding_details & WITH_BOM) {
-         if (write_encoding_details & TWO_BYTE_HILO)
+       if (write_encoding.bom == WITH_BOM) {
+         if (write_encoding.width == TWO_BYTE_HILO)
            write(hndl->filedesc, "\xFE\xFF", 2);
-         else if (write_encoding_details & TWO_BYTE_LOHI)
+         else if (write_encoding.width == TWO_BYTE_LOHI)
            write(hndl->filedesc, "\xFF\xFE", 2);
+         else if (!strcmp(write_encoding.encoding, "UTF-8"))
+           write(hndl->filedesc, "\xEF\xBB\xBF", 3);
          else
-           gedcom_warning(_("Byte order mark configured, but no Unicode"));
+           gedcom_warning(_("Byte order mark configured, but not relevant"));
        }
       }
     }
@@ -298,7 +264,7 @@ char* get_tag_string(int elt_or_rec, int tag)
     }
   }
   else {
-    gedcom_error(_("The element or record type '%s' requires a specific tag"
+    gedcom_error(_("The element or record type '%s' requires a specific tag "
                   "for writing"),
                 tag_data[elt_or_rec].elt_name);
     return NULL;
@@ -361,7 +327,7 @@ char* convert_at(const char* input)
 
 int _gedcom_write_val(Gedcom_write_hndl hndl,
                      int rec_or_elt, int tag, int parent_rec_or_elt,
-                     char* xrefstr, char* val)
+                     const char* xrefstr, const char* val)
 {
   int result = 1;
   int level = 0;
@@ -370,7 +336,9 @@ int _gedcom_write_val(Gedcom_write_hndl hndl,
   tag_str = get_tag_string(rec_or_elt, tag);
   level   = get_level(hndl, rec_or_elt, parent_rec_or_elt);
   if (tag_str && (level != -1)) {
-    if (supports_continuation(rec_or_elt, OPT_CONT|OPT_CONC|OPT_CONT_AS_CONC))
+    if (rec_or_elt == ELT_HEAD_CHAR)
+      result = write_encoding_value(hndl, level, xrefstr, tag_str, val);
+    else if (supports_continuation(rec_or_elt, OPT_CONT|OPT_CONC))
       result = write_long(hndl, rec_or_elt, level, xrefstr, tag_str, val);
     else
       result = write_simple(hndl, level, xrefstr, tag_str, val);
@@ -380,7 +348,8 @@ int _gedcom_write_val(Gedcom_write_hndl hndl,
 }
 
 int gedcom_write_record_str(Gedcom_write_hndl hndl,
-                           Gedcom_rec rec, char* xrefstr, char* val)
+                           Gedcom_rec rec, const char* xrefstr,
+                           const char* val)
 {
   int result = 1;
   if (check_type(rec, (val ? GV_CHAR_PTR : GV_NULL)))
@@ -390,7 +359,7 @@ int gedcom_write_record_str(Gedcom_write_hndl hndl,
 
 int gedcom_write_element_str(Gedcom_write_hndl hndl,
                             Gedcom_elt elt, int tag, int parent_rec_or_elt,
-                            char* val)
+                            const char* val)
 {
   int result = 1;
   if (check_type(elt, (val ? GV_CHAR_PTR : GV_NULL)))
@@ -401,7 +370,7 @@ int gedcom_write_element_str(Gedcom_write_hndl hndl,
 
 int gedcom_write_element_xref(Gedcom_write_hndl hndl,
                              Gedcom_elt elt, int tag, int parent_rec_or_elt,
-                             struct xref_value* val)
+                             const struct xref_value* val)
 {
   int result = 1;
   if (check_type(elt, (val ? GV_XREF_PTR : GV_NULL)))
@@ -412,7 +381,7 @@ int gedcom_write_element_xref(Gedcom_write_hndl hndl,
 
 int gedcom_write_element_date(Gedcom_write_hndl hndl,
                              Gedcom_elt elt, int tag, int parent_rec_or_elt,
-                             struct date_value* val)
+                             const struct date_value* val)
 {
   int result = 1;
   if (check_type(elt, (val ? GV_DATE_VALUE : GV_NULL)))
@@ -423,7 +392,7 @@ int gedcom_write_element_date(Gedcom_write_hndl hndl,
 
 int gedcom_write_element_age(Gedcom_write_hndl hndl,
                             Gedcom_elt elt, int tag, int parent_rec_or_elt,
-                            struct age_value* val)
+                            const struct age_value* val)
 {
   int result = 1;
   if (check_type(elt, (val ? GV_AGE_VALUE : GV_NULL)))
@@ -432,8 +401,8 @@ int gedcom_write_element_age(Gedcom_write_hndl hndl,
   return result;
 }
 
-int gedcom_write_user_str(Gedcom_write_hndl hndl, int level, char* tag,
-                         char* xrefstr, char* value)
+int gedcom_write_user_str(Gedcom_write_hndl hndl, int level, const char* tag,
+                         const char* xrefstr, const char* value)
 {
   int result = 1;
   if (tag && tag[0] == '_')
@@ -441,8 +410,8 @@ int gedcom_write_user_str(Gedcom_write_hndl hndl, int level, char* tag,
   return result;
 }
 
-int gedcom_write_user_xref(Gedcom_write_hndl hndl, int level, char* tag,
-                          char* xrefstr, struct xref_value* val)
+int gedcom_write_user_xref(Gedcom_write_hndl hndl, int level, const char* tag,
+                          const char* xrefstr, const struct xref_value* val)
 {
   int result = 1;
   if (tag && tag[0] == '_')