XEmacs 21.4.22.
[chise/xemacs-chise.git.1] / src / file-coding.h
index 023bf57..322dbec 100644 (file)
@@ -24,14 +24,14 @@ Boston, MA 02111-1307, USA.  */
 /* 91.10.09 written by K.Handa <handa@etl.go.jp> */
 /* Rewritten by Ben Wing <ben@xemacs.org>. */
 
-#ifndef _XEMACS_MULE_CODING_H_
-#define _XEMACS_MULE_CODING_H_
+#ifndef INCLUDED_file_coding_h_
+#define INCLUDED_file_coding_h_
 
 struct decoding_stream;
 struct encoding_stream;
 
 /* Coding system types.  These go into the TYPE field of a
-   struct Lisp_Coding_System. */
+   Lisp_Coding_System. */
 
 enum coding_system_type
 {
@@ -84,7 +84,8 @@ struct Lisp_Coding_System
   struct lcrecord_header header;
 
   /* Name and doc string of this coding system. */
-  Lisp_Object name, doc_string;
+  Lisp_Object name;
+  Lisp_Object doc_string;
 
   /* This is the major type of the coding system -- one of Big5, ISO2022,
      Shift-JIS, etc.  See the constants above. */
@@ -94,14 +95,17 @@ struct Lisp_Coding_System
      system is active for a particular buffer. */
   Lisp_Object mnemonic;
 
-  Lisp_Object post_read_conversion, pre_write_conversion;
+  Lisp_Object post_read_conversion;
+  Lisp_Object pre_write_conversion;
 
-  enum eol_type eol_type;
+  eol_type_t eol_type;
 
   /* Subsidiary coding systems that specify a particular type of EOL
      marking, rather than autodetecting it.  These will only be non-nil
      if (eol_type == EOL_AUTODETECT). */
-  Lisp_Object eol_lf, eol_crlf, eol_cr;
+  Lisp_Object eol_lf;
+  Lisp_Object eol_crlf;
+  Lisp_Object eol_cr;
 #ifdef MULE
   struct
   {
@@ -130,14 +134,15 @@ struct Lisp_Coding_System
   {
     /* For a CCL coding system, these specify the CCL programs used for
        decoding (input) and encoding (output). */
-    Lisp_Object decode, encode;
+    Lisp_Object decode;
+    Lisp_Object encode;
   } ccl;
 #endif
 };
 typedef struct Lisp_Coding_System Lisp_Coding_System;
 
-DECLARE_LRECORD (coding_system, struct Lisp_Coding_System);
-#define XCODING_SYSTEM(x) XRECORD (x, coding_system, struct Lisp_Coding_System)
+DECLARE_LRECORD (coding_system, Lisp_Coding_System);
+#define XCODING_SYSTEM(x) XRECORD (x, coding_system, Lisp_Coding_System)
 #define XSETCODING_SYSTEM(x, p) XSETRECORD (x, p, coding_system)
 #define CODING_SYSTEMP(x) RECORDP (x, coding_system)
 #define CHECK_CODING_SYSTEM(x) CHECK_RECORD (x, coding_system)
@@ -251,7 +256,7 @@ EXFUN (Fsubsidiary_coding_system, 2);
 extern Lisp_Object Qucs4, Qutf8;
 extern Lisp_Object Qbig5, Qccl, Qcharset_g0;
 extern Lisp_Object Qcharset_g1, Qcharset_g2, Qcharset_g3, Qcoding_system_error;
-extern Lisp_Object Qcoding_systemp, Qcr, Qcrlf, Qctext, Qdecode, Qencode;
+extern Lisp_Object Qcoding_systemp, Qcr, Qcrlf, Qdecode, Qencode;
 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type, Qescape_quoted;
 extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output;
@@ -403,32 +408,50 @@ enum iso_esc_flag
 #define ISO_CODE_CSI   0x9B            /* control-sequence-introduce */
 #endif /* MULE */
 
-/* For detecting the encoding of text */
+/* Distinguishable categories of encodings.
+
+   This list determines the initial priority of the categories.
+
+   For better or worse, currently Mule files are encoded in 7-bit ISO 2022.
+   For this reason, under Mule ISO_7 gets highest priority.
+
+   Putting NO_CONVERSION second prevents "binary corruption" in the
+   default case in all but the (presumably) extremely rare case of a
+   binary file which contains redundant escape sequences but no 8-bit
+   characters.
+
+   The remaining priorities are based on perceived "internationalization
+   political correctness."  An exception is UCS-4 at the bottom, since
+   basically everything is compatible with UCS-4, but it is likely to
+   be very rare as an external encoding. */
+
 enum coding_category_type
 {
+  /* must be a contiguous range of values 0 -- CODING_CATEGORY_LAST - 1 */
 #ifdef MULE
-  CODING_CATEGORY_SHIFT_JIS,
   CODING_CATEGORY_ISO_7, /* ISO2022 system using only seven-bit bytes,
                            no locking shift */
-  CODING_CATEGORY_ISO_8_DESIGNATE, /* ISO2022 system using eight-bit bytes,
-                                     no locking shift, no single shift,
-                                     using designation to switch charsets */
+  CODING_CATEGORY_NO_CONVERSION,
+  CODING_CATEGORY_UTF8,
   CODING_CATEGORY_ISO_8_1, /* ISO2022 system using eight-bit bytes,
                              no locking shift, no designation sequences,
                              one-dimension characters in the upper half. */
   CODING_CATEGORY_ISO_8_2, /* ISO2022 system using eight-bit bytes,
                              no locking shift, no designation sequences,
                              two-dimension characters in the upper half. */
+  CODING_CATEGORY_ISO_8_DESIGNATE, /* ISO2022 system using eight-bit bytes,
+                                     no locking shift, no single shift,
+                                     using designation to switch charsets */
   CODING_CATEGORY_ISO_LOCK_SHIFT, /* ISO2022 system using locking shift */
+  CODING_CATEGORY_SHIFT_JIS,
   CODING_CATEGORY_BIG5,
   CODING_CATEGORY_UCS4,
-  CODING_CATEGORY_UTF8,
+#else /* not MULE */
+  CODING_CATEGORY_NO_CONVERSION,
 #endif /* MULE */
-  CODING_CATEGORY_NO_CONVERSION
+  CODING_CATEGORY_LAST         /* not a real coding category */
 };
 
-#define CODING_CATEGORY_LAST CODING_CATEGORY_NO_CONVERSION
-
 #ifdef MULE
 #define CODING_CATEGORY_SHIFT_JIS_MASK \
   (1 << CODING_CATEGORY_SHIFT_JIS)
@@ -500,7 +523,7 @@ void set_decoding_stream_coding_system (Lstream *stream,
 void set_encoding_stream_coding_system (Lstream *stream,
                                        Lisp_Object codesys);
 void determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out,
-                                  enum eol_type *eol_type_in_out);
+                                  eol_type_t *eol_type_in_out);
 
 
 #ifndef MULE
@@ -515,5 +538,6 @@ void determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out,
 #define BUFBYTE_FIRST_BYTE_P(c) ((c) < 0xA0)
 #define BUFBYTE_LEADING_BYTE_P(c) BYTE_C1_P (c)
 #endif /* not MULE */
-#endif /* _XEMACS_MULE_CODING_H_ */
+
+#endif /* INCLUDED_file_coding_h_ */