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