git.chise.org Git - chise/xemacs-chise.git-/blob - src/file-coding.h

   1 /* Header for code conversion stuff
   2    Copyright (C) 1991, 1995 Free Software Foundation, Inc.
   3    Copyright (C) 1995 Sun Microsystems, Inc.
   4    Copyright (C) 1999,2000,2002 MORIOKA Tomohiko
   5
   6 This file is part of XEmacs.
   7
   8 XEmacs is free software; you can redistribute it and/or modify it
   9 under the terms of the GNU General Public License as published by the
  10 Free Software Foundation; either version 2, or (at your option) any
  11 later version.
  12
  13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16 for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with XEmacs; see the file COPYING.  If not, write to
  20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21 Boston, MA 02111-1307, USA.  */
  22
  23 /* Synched up with: Mule 2.3.  Not in FSF. */
  24
  25 /* 91.10.09 written by K.Handa <handa@etl.go.jp> */
  26 /* Rewritten by Ben Wing <ben@xemacs.org>. */
  27
  28 #ifndef INCLUDED_file_coding_h_
  29 #define INCLUDED_file_coding_h_
  30
  31 struct decoding_stream;
  32 struct encoding_stream;
  33
  34 /* Coding system types.  These go into the TYPE field of a
  35    Lisp_Coding_System. */
  36
  37 enum coding_system_type
  38 {
  39   CODESYS_AUTODETECT,   /* Automatic conversion. */
  40 #ifdef MULE
  41   CODESYS_SHIFT_JIS,    /* Shift-JIS; Hankaku (half-width) KANA
  42                            is also supported. */
  43   CODESYS_ISO2022,      /* Any ISO2022-compliant coding system.
  44                            Includes JIS, EUC, CTEXT */
  45   CODESYS_BIG5,         /* BIG5 (used for Taiwanese). */
  46   CODESYS_UCS4,         /* ISO 10646 UCS-4 */
  47   CODESYS_UTF8,         /* ISO 10646 UTF-8 */
  48   CODESYS_CCL,          /* Converter written in CCL. */
  49 #endif
  50   CODESYS_NO_CONVERSION /* "No conversion"; used for binary files.
  51                            We use quotes because there really
  52                            is some conversion being applied,
  53                            but it appears to the user as if
  54                            the text is read in without conversion. */
  55 #ifdef DEBUG_XEMACS
  56   ,CODESYS_INTERNAL     /* Raw (internally-formatted) data. */
  57 #endif
  58 };
  59
  60 enum eol_type
  61 {
  62   EOL_AUTODETECT,
  63   EOL_LF,
  64   EOL_CRLF,
  65   EOL_CR
  66 };
  67 typedef enum eol_type eol_type_t;
  68
  69 #ifdef MULE
  70 typedef struct charset_conversion_spec charset_conversion_spec;
  71 struct charset_conversion_spec
  72 {
  73   Lisp_Object from_charset;
  74   Lisp_Object to_charset;
  75 };
  76
  77 typedef struct
  78 {
  79   Dynarr_declare (charset_conversion_spec);
  80 } charset_conversion_spec_dynarr;
  81 #endif
  82
  83 struct Lisp_Coding_System
  84 {
  85   struct lcrecord_header header;
  86
  87   /* Name and doc string of this coding system. */
  88   Lisp_Object name;
  89   Lisp_Object doc_string;
  90
  91   /* This is the major type of the coding system -- one of Big5, ISO2022,
  92      Shift-JIS, etc.  See the constants above. */
  93   enum coding_system_type type;
  94
  95   /* Mnemonic string displayed in the modeline when this coding
  96      system is active for a particular buffer. */
  97   Lisp_Object mnemonic;
  98
  99   Lisp_Object post_read_conversion;
 100   Lisp_Object pre_write_conversion;
 101
 102   eol_type_t eol_type;
 103
 104   /* Subsidiary coding systems that specify a particular type of EOL
 105      marking, rather than autodetecting it.  These will only be non-nil
 106      if (eol_type == EOL_AUTODETECT). */
 107   Lisp_Object eol_lf;
 108   Lisp_Object eol_crlf;
 109   Lisp_Object eol_cr;
 110 #ifdef MULE
 111   struct
 112   {
 113     /* What are the charsets to be initially designated to G0, G1,
 114        G2, G3?  If t, no charset is initially designated.  If nil,
 115        no charset is initially designated and no charset is allowed
 116        to be designated. */
 117     Lisp_Object initial_charset[4];
 118
 119     /* If true, a designation escape sequence needs to be sent on output
 120        for the charset in G[0-3] before that charset is used. */
 121     unsigned char force_charset_on_output[4];
 122
 123     charset_conversion_spec_dynarr *input_conv;
 124     charset_conversion_spec_dynarr *output_conv;
 125
 126     unsigned int shoort         :1; /* C makes you speak Dutch */
 127     unsigned int no_ascii_eol   :1;
 128     unsigned int no_ascii_cntl  :1;
 129     unsigned int seven          :1;
 130     unsigned int lock_shift     :1;
 131     unsigned int no_iso6429     :1;
 132     unsigned int escape_quoted  :1;
 133   } iso2022;
 134   struct
 135   {
 136     /* For a CCL coding system, these specify the CCL programs used for
 137        decoding (input) and encoding (output). */
 138     Lisp_Object decode;
 139     Lisp_Object encode;
 140   } ccl;
 141 #endif
 142 #ifdef UTF2000
 143   unsigned int disable_composition      :1;
 144   unsigned int use_entity_reference     :1;
 145   Lisp_Object ccs_priority_list;
 146 #endif
 147 };
 148 typedef struct Lisp_Coding_System Lisp_Coding_System;
 149
 150 DECLARE_LRECORD (coding_system, Lisp_Coding_System);
 151 #define XCODING_SYSTEM(x) XRECORD (x, coding_system, Lisp_Coding_System)
 152 #define XSETCODING_SYSTEM(x, p) XSETRECORD (x, p, coding_system)
 153 #define CODING_SYSTEMP(x) RECORDP (x, coding_system)
 154 #define CHECK_CODING_SYSTEM(x) CHECK_RECORD (x, coding_system)
 155 #define CONCHECK_CODING_SYSTEM(x) CONCHECK_RECORD (x, coding_system)
 156
 157 #define CODING_SYSTEM_NAME(codesys) ((codesys)->name)
 158 #define CODING_SYSTEM_DOC_STRING(codesys) ((codesys)->doc_string)
 159 #define CODING_SYSTEM_TYPE(codesys) ((codesys)->type)
 160 #define CODING_SYSTEM_MNEMONIC(codesys) ((codesys)->mnemonic)
 161 #define CODING_SYSTEM_POST_READ_CONVERSION(codesys) \
 162   ((codesys)->post_read_conversion)
 163 #define CODING_SYSTEM_PRE_WRITE_CONVERSION(codesys) \
 164   ((codesys)->pre_write_conversion)
 165 #define CODING_SYSTEM_EOL_TYPE(codesys) ((codesys)->eol_type)
 166 #define CODING_SYSTEM_EOL_LF(codesys)   ((codesys)->eol_lf)
 167 #define CODING_SYSTEM_EOL_CRLF(codesys) ((codesys)->eol_crlf)
 168 #define CODING_SYSTEM_EOL_CR(codesys)   ((codesys)->eol_cr)
 169
 170 #ifdef MULE
 171 #define CODING_SYSTEM_ISO2022_INITIAL_CHARSET(codesys, g) \
 172   ((codesys)->iso2022.initial_charset[g])
 173 #define CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT(codesys, g) \
 174   ((codesys)->iso2022.force_charset_on_output[g])
 175 #define CODING_SYSTEM_ISO2022_SHORT(codesys) ((codesys)->iso2022.shoort)
 176 #define CODING_SYSTEM_ISO2022_NO_ASCII_EOL(codesys) \
 177   ((codesys)->iso2022.no_ascii_eol)
 178 #define CODING_SYSTEM_ISO2022_NO_ASCII_CNTL(codesys) \
 179   ((codesys)->iso2022.no_ascii_cntl)
 180 #define CODING_SYSTEM_ISO2022_SEVEN(codesys) ((codesys)->iso2022.seven)
 181 #define CODING_SYSTEM_ISO2022_LOCK_SHIFT(codesys) \
 182   ((codesys)->iso2022.lock_shift)
 183 #define CODING_SYSTEM_ISO2022_NO_ISO6429(codesys) \
 184   ((codesys)->iso2022.no_iso6429)
 185 #define CODING_SYSTEM_ISO2022_ESCAPE_QUOTED(codesys) \
 186   ((codesys)->iso2022.escape_quoted)
 187 #define CODING_SYSTEM_CCL_DECODE(codesys) ((codesys)->ccl.decode)
 188 #define CODING_SYSTEM_CCL_ENCODE(codesys) ((codesys)->ccl.encode)
 189 #endif /* MULE */
 190 #ifdef UTF2000
 191 #define CODING_SYSTEM_DISABLE_COMPOSITION(codesys) \
 192   ((codesys)->disable_composition)
 193 #define CODING_SYSTEM_USE_ENTITY_REFERENCE(codesys) \
 194   ((codesys)->use_entity_reference)
 195 #define CODING_SYSTEM_CCS_PRIORITY_LIST(codesys) \
 196   ((codesys)->ccs_priority_list)
 197 #endif
 198
 199 #define XCODING_SYSTEM_NAME(codesys) \
 200   CODING_SYSTEM_NAME (XCODING_SYSTEM (codesys))
 201 #define XCODING_SYSTEM_DOC_STRING(codesys) \
 202   CODING_SYSTEM_DOC_STRING (XCODING_SYSTEM (codesys))
 203 #define XCODING_SYSTEM_TYPE(codesys) \
 204   CODING_SYSTEM_TYPE (XCODING_SYSTEM (codesys))
 205 #define XCODING_SYSTEM_MNEMONIC(codesys) \
 206   CODING_SYSTEM_MNEMONIC (XCODING_SYSTEM (codesys))
 207 #define XCODING_SYSTEM_POST_READ_CONVERSION(codesys) \
 208   CODING_SYSTEM_POST_READ_CONVERSION (XCODING_SYSTEM (codesys))
 209 #define XCODING_SYSTEM_PRE_WRITE_CONVERSION(codesys) \
 210   CODING_SYSTEM_PRE_WRITE_CONVERSION (XCODING_SYSTEM (codesys))
 211 #define XCODING_SYSTEM_EOL_TYPE(codesys) \
 212   CODING_SYSTEM_EOL_TYPE (XCODING_SYSTEM (codesys))
 213 #define XCODING_SYSTEM_EOL_LF(codesys) \
 214   CODING_SYSTEM_EOL_LF (XCODING_SYSTEM (codesys))
 215 #define XCODING_SYSTEM_EOL_CRLF(codesys) \
 216   CODING_SYSTEM_EOL_CRLF (XCODING_SYSTEM (codesys))
 217 #define XCODING_SYSTEM_EOL_CR(codesys) \
 218   CODING_SYSTEM_EOL_CR (XCODING_SYSTEM (codesys))
 219
 220 #ifdef MULE
 221 #define XCODING_SYSTEM_ISO2022_INITIAL_CHARSET(codesys, g) \
 222   CODING_SYSTEM_ISO2022_INITIAL_CHARSET (XCODING_SYSTEM (codesys), g)
 223 #define XCODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT(codesys, g) \
 224   CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (XCODING_SYSTEM (codesys), g)
 225 #define XCODING_SYSTEM_ISO2022_SHORT(codesys) \
 226   CODING_SYSTEM_ISO2022_SHORT (XCODING_SYSTEM (codesys))
 227 #define XCODING_SYSTEM_ISO2022_NO_ASCII_EOL(codesys) \
 228   CODING_SYSTEM_ISO2022_NO_ASCII_EOL (XCODING_SYSTEM (codesys))
 229 #define XCODING_SYSTEM_ISO2022_NO_ASCII_CNTL(codesys) \
 230   CODING_SYSTEM_ISO2022_NO_ASCII_CNTL (XCODING_SYSTEM (codesys))
 231 #define XCODING_SYSTEM_ISO2022_SEVEN(codesys) \
 232   CODING_SYSTEM_ISO2022_SEVEN (XCODING_SYSTEM (codesys))
 233 #define XCODING_SYSTEM_ISO2022_LOCK_SHIFT(codesys) \
 234   CODING_SYSTEM_ISO2022_LOCK_SHIFT (XCODING_SYSTEM (codesys))
 235 #define XCODING_SYSTEM_ISO2022_NO_ISO6429(codesys) \
 236   CODING_SYSTEM_ISO2022_NO_ISO6429 (XCODING_SYSTEM (codesys))
 237 #define XCODING_SYSTEM_ISO2022_ESCAPE_QUOTED(codesys) \
 238   CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (XCODING_SYSTEM (codesys))
 239 #define XCODING_SYSTEM_CCL_DECODE(codesys) \
 240   CODING_SYSTEM_CCL_DECODE (XCODING_SYSTEM (codesys))
 241 #define XCODING_SYSTEM_CCL_ENCODE(codesys) \
 242   CODING_SYSTEM_CCL_ENCODE (XCODING_SYSTEM (codesys))
 243 #endif /* MULE */
 244 #ifdef UTF2000
 245 #define XCODING_SYSTEM_DISABLE_COMPOSITION(codesys) \
 246   CODING_SYSTEM_DISABLE_COMPOSITION (XCODING_SYSTEM (codesys))
 247 #define XCODING_SYSTEM_USE_ENTITY_REFERENCE(codesys) \
 248   CODING_SYSTEM_USE_ENTITY_REFERENCE (XCODING_SYSTEM (codesys))
 249 #endif
 250
 251 EXFUN (Fcoding_category_list, 0);
 252 EXFUN (Fcoding_category_system, 1);
 253 EXFUN (Fcoding_priority_list, 0);
 254 EXFUN (Fcoding_system_charset, 2);
 255 EXFUN (Fcoding_system_doc_string, 1);
 256 EXFUN (Fcoding_system_list, 0);
 257 EXFUN (Fcoding_system_name, 1);
 258 EXFUN (Fcoding_system_p, 1);
 259 EXFUN (Fcoding_system_property, 2);
 260 EXFUN (Fcoding_system_type, 1);
 261 EXFUN (Fcopy_coding_system, 2);
 262 EXFUN (Fdecode_big5_char, 1);
 263 EXFUN (Fdecode_coding_region, 4);
 264 EXFUN (Fdecode_shift_jis_char, 1);
 265 EXFUN (Fdetect_coding_region, 3);
 266 EXFUN (Fencode_big5_char, 1);
 267 EXFUN (Fencode_coding_region, 4);
 268 EXFUN (Fencode_shift_jis_char, 1);
 269 EXFUN (Ffind_coding_system, 1);
 270 EXFUN (Fget_coding_system, 1);
 271 EXFUN (Fmake_coding_system, 4);
 272 EXFUN (Fset_coding_category_system, 2);
 273 EXFUN (Fset_coding_priority_list, 1);
 274 EXFUN (Fsubsidiary_coding_system, 2);
 275
 276 extern Lisp_Object Qucs4, Qutf8;
 277 extern Lisp_Object Qbig5, Qccl, Qcharset_g0;
 278 extern Lisp_Object Qcharset_g1, Qcharset_g2, Qcharset_g3, Qcoding_system_error;
 279 extern Lisp_Object Qcoding_systemp, Qcr, Qcrlf, Qdecode, Qencode;
 280 extern Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf, Qeol_type, Qescape_quoted;
 281 extern Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
 282 extern Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output;
 283 extern Lisp_Object Qinput_charset_conversion, Qiso2022, Qlf, Qlock_shift;
 284 extern Lisp_Object Qmnemonic, Qno_ascii_cntl, Qno_ascii_eol, Qno_conversion;
 285 extern Lisp_Object Qraw_text;
 286 extern Lisp_Object Qno_iso6429, Qoutput_charset_conversion;
 287 extern Lisp_Object Qpost_read_conversion, Qpre_write_conversion, Qseven;
 288 extern Lisp_Object Qshift_jis, Qshort, Vcoding_system_for_read;
 289 extern Lisp_Object Vcoding_system_for_write, Vcoding_system_hash_table;
 290 extern Lisp_Object Vfile_name_coding_system, Vkeyboard_coding_system;
 291 extern Lisp_Object Vterminal_coding_system;
 292
 293 /* Flags indicating current state while converting code. */
 294
 295 /* Used by everyone. */
 296
 297 #define CODING_STATE_END        (1 << 0) /* If set, this is the last chunk of
 298                                             data being processed.  When this
 299                                             is finished, output any necessary
 300                                             terminating control characters,
 301                                             escape sequences, etc. */
 302 #define CODING_STATE_CR         (1 << 1) /* If set, we just saw a CR. */
 303
 304
 305 /* Used by Big 5 on output. */
 306 #ifdef MULE
 307 #define CODING_STATE_BIG5_1     (1 << 2) /* If set, we just encountered
 308                                             LEADING_BYTE_BIG5_1. */
 309 #define CODING_STATE_BIG5_2     (1 << 3) /* If set, we just encountered
 310                                             LEADING_BYTE_BIG5_2. */
 311
 312
 313 /* Used by ISO2022 on input and output. */
 314
 315 #define CODING_STATE_R2L        (1 << 4)  /* If set, the current
 316                                              directionality is right-to-left.
 317                                              Otherwise, it's left-to-right. */
 318
 319
 320 /* Used by ISO2022 on input. */
 321
 322 #define CODING_STATE_ESCAPE     (1 << 5)  /* If set, we're currently parsing
 323                                              an escape sequence and the upper
 324                                              16 bits should be looked at to
 325                                              indicate what partial escape
 326                                              sequence we've seen so far.
 327                                              Otherwise, we're running
 328                                              through actual text. */
 329 #define CODING_STATE_SS2        (1 << 6)  /* If set, G2 is invoked into GL, but
 330                                              only for the next character. */
 331 #define CODING_STATE_SS3        (1 << 7)  /* If set, G3 is invoked into GL,
 332                                              but only for the next character.
 333                                              If both CODING_STATE_SS2 and
 334                                              CODING_STATE_SS3 are set,
 335                                              CODING_STATE_SS2 overrides; but
 336                                              this probably indicates an error
 337                                              in the text encoding. */
 338 #ifdef ENABLE_COMPOSITE_CHARS
 339 #define CODING_STATE_COMPOSITE  (1 << 8)  /* If set, we're currently processing
 340                                              a composite character (i.e. a
 341                                              character constructed by
 342                                              overstriking two or more
 343                                              characters). */
 344 #endif /* ENABLE_COMPOSITE_CHARS */
 345
 346
 347 /* CODING_STATE_ISO2022_LOCK is the mask of flags that remain on until
 348    explicitly turned off when in the ISO2022 encoder/decoder.  Other flags are
 349    turned off at the end of processing each character or escape sequence. */
 350 #ifdef ENABLE_COMPOSITE_CHARS
 351 # define CODING_STATE_ISO2022_LOCK \
 352   (CODING_STATE_END | CODING_STATE_COMPOSITE | CODING_STATE_R2L)
 353 #else
 354 # define CODING_STATE_ISO2022_LOCK (CODING_STATE_END | CODING_STATE_R2L)
 355 #endif
 356
 357 #define CODING_STATE_BIG5_LOCK CODING_STATE_END
 358
 359 /* Flags indicating what we've seen so far when parsing an
 360    ISO2022 escape sequence. */
 361 enum iso_esc_flag
 362 {
 363   /* Partial sequences */
 364   ISO_ESC_NOTHING,      /* Nothing has been seen. */
 365   ISO_ESC,              /* We've seen ESC. */
 366   ISO_ESC_2_4,          /* We've seen ESC $.  This indicates
 367                            that we're designating a multi-byte, rather
 368                            than a single-byte, character set. */
 369   ISO_ESC_2_8,          /* We've seen ESC 0x28, i.e. ESC (.
 370                            This means designate a 94-character
 371                            character set into G0. */
 372   ISO_ESC_2_9,          /* We've seen ESC 0x29 -- designate a
 373                            94-character character set into G1. */
 374   ISO_ESC_2_10,         /* We've seen ESC 0x2A. */
 375   ISO_ESC_2_11,         /* We've seen ESC 0x2B. */
 376   ISO_ESC_2_12,         /* We've seen ESC 0x2C -- designate a
 377                            96-character character set into G0.
 378                            (This is not ISO2022-standard.
 379                            The following 96-character
 380                            control sequences are standard,
 381                            though.) */
 382   ISO_ESC_2_13,         /* We've seen ESC 0x2D -- designate a
 383                            96-character character set into G1.
 384                            */
 385   ISO_ESC_2_14,         /* We've seen ESC 0x2E. */
 386   ISO_ESC_2_15,         /* We've seen ESC 0x2F. */
 387   ISO_ESC_2_4_8,        /* We've seen ESC $ 0x28 -- designate
 388                            a 94^N character set into G0. */
 389   ISO_ESC_2_4_9,        /* We've seen ESC $ 0x29. */
 390   ISO_ESC_2_4_10,       /* We've seen ESC $ 0x2A. */
 391   ISO_ESC_2_4_11,       /* We've seen ESC $ 0x2B. */
 392   ISO_ESC_2_4_12,       /* We've seen ESC $ 0x2C. */
 393   ISO_ESC_2_4_13,       /* We've seen ESC $ 0x2D. */
 394   ISO_ESC_2_4_14,       /* We've seen ESC $ 0x2E. */
 395   ISO_ESC_2_4_15,       /* We've seen ESC $ 0x2F. */
 396   ISO_ESC_5_11,         /* We've seen ESC [ or 0x9B.  This
 397                            starts a directionality-control
 398                            sequence.  The next character
 399                            must be 0, 1, 2, or ]. */
 400   ISO_ESC_5_11_0,       /* We've seen 0x9B 0.  The next character must be ]. */
 401   ISO_ESC_5_11_1,       /* We've seen 0x9B 1.  The next character must be ]. */
 402   ISO_ESC_5_11_2,       /* We've seen 0x9B 2.  The next character must be ]. */
 403
 404   /* Full sequences. */
 405 #ifdef ENABLE_COMPOSITE_CHARS
 406   ISO_ESC_START_COMPOSITE, /* Private usage for START COMPOSING */
 407   ISO_ESC_END_COMPOSITE,   /* Private usage for END COMPOSING */
 408 #endif /* ENABLE_COMPOSITE_CHARS */
 409   ISO_ESC_SINGLE_SHIFT, /* We've seen a complete single-shift sequence. */
 410   ISO_ESC_LOCKING_SHIFT,/* We've seen a complete locking-shift sequence. */
 411   ISO_ESC_DESIGNATE,    /* We've seen a complete designation sequence. */
 412   ISO_ESC_DIRECTIONALITY,/* We've seen a complete ISO6429 directionality
 413                            sequence. */
 414   ISO_ESC_LITERAL       /* We've seen a literal character ala
 415                            escape-quoting. */
 416 };
 417
 418 /* Macros to define code of control characters for ISO2022's functions.  */
 419                         /* code */      /* function */
 420 #define ISO_CODE_LF     0x0A            /* line-feed */
 421 #define ISO_CODE_CR     0x0D            /* carriage-return */
 422 #define ISO_CODE_SO     0x0E            /* shift-out */
 423 #define ISO_CODE_SI     0x0F            /* shift-in */
 424 #define ISO_CODE_ESC    0x1B            /* escape */
 425 #define ISO_CODE_DEL    0x7F            /* delete */
 426 #define ISO_CODE_SS2    0x8E            /* single-shift-2 */
 427 #define ISO_CODE_SS3    0x8F            /* single-shift-3 */
 428 #define ISO_CODE_CSI    0x9B            /* control-sequence-introduce */
 429 #endif /* MULE */
 430
 431 /* Distinguishable categories of encodings.
 432
 433    This list determines the initial priority of the categories.
 434
 435    For better or worse, currently Mule files are encoded in 7-bit ISO 2022.
 436    For this reason, under Mule ISO_7 gets highest priority.
 437
 438    Putting NO_CONVERSION second prevents "binary corruption" in the
 439    default case in all but the (presumably) extremely rare case of a
 440    binary file which contains redundant escape sequences but no 8-bit
 441    characters.
 442
 443    The remaining priorities are based on perceived "internationalization
 444    political correctness."  An exception is UCS-4 at the bottom, since
 445    basically everything is compatible with UCS-4, but it is likely to
 446    be very rare as an external encoding. */
 447
 448 enum coding_category_type
 449 {
 450   /* must be a contiguous range of values 0 -- CODING_CATEGORY_LAST - 1 */
 451 #ifdef MULE
 452   CODING_CATEGORY_ISO_7, /* ISO2022 system using only seven-bit bytes,
 453                             no locking shift */
 454   CODING_CATEGORY_NO_CONVERSION,
 455   CODING_CATEGORY_UTF8,
 456   CODING_CATEGORY_ISO_8_1, /* ISO2022 system using eight-bit bytes,
 457                               no locking shift, no designation sequences,
 458                               one-dimension characters in the upper half. */
 459   CODING_CATEGORY_ISO_8_2, /* ISO2022 system using eight-bit bytes,
 460                               no locking shift, no designation sequences,
 461                               two-dimension characters in the upper half. */
 462   CODING_CATEGORY_ISO_8_DESIGNATE, /* ISO2022 system using eight-bit bytes,
 463                                       no locking shift, no single shift,
 464                                       using designation to switch charsets */
 465   CODING_CATEGORY_ISO_LOCK_SHIFT, /* ISO2022 system using locking shift */
 466   CODING_CATEGORY_SHIFT_JIS,
 467   CODING_CATEGORY_BIG5,
 468   CODING_CATEGORY_UCS4,
 469 #else /* not MULE */
 470   CODING_CATEGORY_NO_CONVERSION,
 471 #endif /* MULE */
 472   CODING_CATEGORY_LAST          /* not a real coding category */
 473 };
 474
 475 #ifdef MULE
 476 #define CODING_CATEGORY_SHIFT_JIS_MASK  \
 477   (1 << CODING_CATEGORY_SHIFT_JIS)
 478 #define CODING_CATEGORY_ISO_7_MASK \
 479   (1 << CODING_CATEGORY_ISO_7)
 480 #define CODING_CATEGORY_ISO_8_DESIGNATE_MASK \
 481   (1 << CODING_CATEGORY_ISO_8_DESIGNATE)
 482 #define CODING_CATEGORY_ISO_8_1_MASK \
 483   (1 << CODING_CATEGORY_ISO_8_1)
 484 #define CODING_CATEGORY_ISO_8_2_MASK \
 485   (1 << CODING_CATEGORY_ISO_8_2)
 486 #define CODING_CATEGORY_ISO_LOCK_SHIFT_MASK \
 487   (1 << CODING_CATEGORY_ISO_LOCK_SHIFT)
 488 #define CODING_CATEGORY_BIG5_MASK \
 489   (1 << CODING_CATEGORY_BIG5)
 490 #define CODING_CATEGORY_UCS4_MASK \
 491   (1 << CODING_CATEGORY_UCS4)
 492 #define CODING_CATEGORY_UTF8_MASK \
 493   (1 << CODING_CATEGORY_UTF8)
 494 #endif
 495 #define CODING_CATEGORY_NO_CONVERSION_MASK \
 496   (1 << CODING_CATEGORY_NO_CONVERSION)
 497 #define CODING_CATEGORY_NOT_FINISHED_MASK \
 498   (1 << 30)
 499
 500 #ifdef MULE
 501 /* Convert shift-JIS code (sj1, sj2) into internal string
 502    representation (c1, c2). (The leading byte is assumed.) */
 503
 504 #define DECODE_SJIS(sj1, sj2, c1, c2)                   \
 505 do {                                                    \
 506   int I1 = sj1, I2 = sj2;                               \
 507   if (I2 >= 0x9f)                                       \
 508     c1 = (I1 << 1) - ((I1 >= 0xe0) ? 0xe0 : 0x60),      \
 509     c2 = I2 + 2;                                        \
 510   else                                                  \
 511     c1 = (I1 << 1) - ((I1 >= 0xe0) ? 0xe1 : 0x61),      \
 512     c2 = I2 + ((I2 >= 0x7f) ? 0x60 : 0x61);             \
 513 } while (0)
 514
 515 /* Convert the internal string representation of a Shift-JIS character
 516    (c1, c2) into Shift-JIS code (sj1, sj2).  The leading byte is
 517    assumed. */
 518
 519 #define ENCODE_SJIS(c1, c2, sj1, sj2)                   \
 520 do {                                                    \
 521   int I1 = c1, I2 = c2;                                 \
 522   if (I1 & 1)                                           \
 523     sj1 = (I1 >> 1) + ((I1 < 0xdf) ? 0x31 : 0x71),      \
 524     sj2 = I2 - ((I2 >= 0xe0) ? 0x60 : 0x61);            \
 525   else                                                  \
 526     sj1 = (I1 >> 1) + ((I1 < 0xdf) ? 0x30 : 0x70),      \
 527     sj2 = I2 - 2;                                       \
 528 } while (0)
 529 #endif /* MULE */
 530
 531 Lisp_Object make_decoding_input_stream (Lstream *stream,
 532                                         Lisp_Object codesys);
 533 Lisp_Object make_encoding_input_stream (Lstream *stream,
 534                                         Lisp_Object codesys);
 535 Lisp_Object make_decoding_output_stream (Lstream *stream,
 536                                          Lisp_Object codesys);
 537 Lisp_Object make_encoding_output_stream (Lstream *stream,
 538                                          Lisp_Object codesys);
 539 Lisp_Object decoding_stream_coding_system (Lstream *stream);
 540 Lisp_Object encoding_stream_coding_system (Lstream *stream);
 541 void set_decoding_stream_coding_system (Lstream *stream,
 542                                         Lisp_Object codesys);
 543 void set_encoding_stream_coding_system (Lstream *stream,
 544                                         Lisp_Object codesys);
 545 void determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out,
 546                                    eol_type_t *eol_type_in_out);
 547
 548
 549 #ifndef MULE
 550 #define MIN_LEADING_BYTE                0x80
 551 /* These need special treatment in a string and/or character */
 552 #ifdef ENABLE_COMPOSITE_CHARS
 553 #define LEADING_BYTE_COMPOSITE          0x80 /* for a composite character */
 554 #endif
 555 #define LEADING_BYTE_CONTROL_1          0x8F /* represent normal 80-9F */
 556 #define LEADING_BYTE_LATIN_ISO8859_1    0x81 /* Right half of ISO 8859-1 */
 557 #define BYTE_C1_P(c) ((unsigned int) ((unsigned int) (c) - 0x80) < 0x20)
 558 #define BUFBYTE_FIRST_BYTE_P(c) ((c) < 0xA0)
 559 #define BUFBYTE_LEADING_BYTE_P(c) BYTE_C1_P (c)
 560 #endif /* not MULE */
 561
 562 #endif /* INCLUDED_file_coding_h_ */
 563