src/character.h

   1 /* Header for multibyte character handler.
   2    Copyright (C) 1995, 1997, 1998 Electrotechnical Laboratory, JAPAN.
   3    Licensed to the Free Software Foundation.
   4    Copyright (C) 2001, 2002
   5      National Institute of Advanced Industrial Science and Technology (AIST)
   6      Registration Number H13PRO009
   7
   8 This file is part of GNU Emacs.
   9
  10 GNU Emacs is free software; you can redistribute it and/or modify
  11 it under the terms of the GNU General Public License as published by
  12 the Free Software Foundation; either version 2, or (at your option)
  13 any later version.
  14
  15 GNU Emacs is distributed in the hope that it will be useful,
  16 but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 GNU General Public License for more details.
  19
  20 You should have received a copy of the GNU General Public License
  21 along with GNU Emacs; see the file COPYING.  If not, write to
  22 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 Boston, MA 02111-1307, USA.  */
  24
  25 #ifndef EMACS_CHARACTER_H
  26 #define EMACS_CHARACTER_H
  27
  28 /* character code       1st byte   byte sequence
  29    --------------       --------   -------------
  30         0-7F            00..7F     0xxxxxxx
  31        80-7FF           C2..DF     110xxxxx 10xxxxxx
  32       800-FFFF          E0..EF     1110xxxx 10xxxxxx 10xxxxxx
  33     10000-1FFFFF        F0..F7     11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
  34    200000-3FFF7F        F8         11111000 1000xxxx 10xxxxxx 10xxxxxx 10xxxxxx
  35       invalid           F9..FF
  36
  37    raw-8-bit
  38    3FFF80-3FFFFF        C0..C1     1100000x 10xxxxxx
  39 */
  40
  41 /* Maximum character code ((1 << CHARACTERBITS) - 1).  */
  42 #define MAX_CHAR  0x3FFFFF
  43
  44 /* Maximum Unicode character code.  */
  45 #define MAX_UNICODE_CHAR 0x10FFFF
  46
  47 /* Maximum N-byte character codes.  */
  48 #define MAX_1_BYTE_CHAR 0x7F
  49 #define MAX_2_BYTE_CHAR 0x7FF
  50 #define MAX_3_BYTE_CHAR 0xFFFF
  51 #define MAX_4_BYTE_CHAR 0x1FFFFF
  52 #define MAX_5_BYTE_CHAR 0x3FFF7F
  53
  54 /* Leading code range of Latin-1 chars.  */
  55 #define LEADING_CODE_LATIN_1_MIN 0xC2
  56 #define LEADING_CODE_LATIN_1_MAX 0xC3
  57
  58 /* Nonzero iff C is a character that corresponds to a raw 8-bit
  59    byte.  */
  60 #define CHAR_BYTE8_P(c) ((c) > MAX_5_BYTE_CHAR)
  61
  62 /* Return the character code for raw 8-bit byte BYTE.  */
  63 #define BYTE8_TO_CHAR(byte) ((byte) + 0x3FFF00)
  64
  65 /* Return the raw 8-bit byte for character C.  */
  66 #define CHAR_TO_BYTE8(c)        \
  67   (CHAR_BYTE8_P (c)             \
  68    ? (c) - 0x3FFF00             \
  69    : multibyte_char_to_unibyte (c, Qnil))
  70
  71 /* Nonzero iff BYTE is the 1st byte of a multibyte form of a character
  72    that corresponds to a raw 8-bit byte.  */
  73 #define CHAR_BYTE8_HEAD_P(byte) ((byte) == 0xC0 || (byte) == 0xC1)
  74
  75 /* Mapping table from unibyte chars to multibyte chars.  */
  76 extern int unibyte_to_multibyte_table[256];
  77
  78 /* Convert the unibyte character C to the corresponding multibyte
  79    character.  If C can't be converted, return C.  */
  80 #define unibyte_char_to_multibyte(c)    \
  81   ((c) < 256 ? unibyte_to_multibyte_table[(c)] : (c))
  82
  83 /* If C is not ASCII, make it unibyte. */
  84 #define MAKE_CHAR_UNIBYTE(c)    \
  85   do {                          \
  86     if (! ASCII_CHAR_P (c))     \
  87       c = CHAR_TO_BYTE8 (c);    \
  88   } while (0)
  89
  90
  91 /* If C is not ASCII, make it multibyte.  It assumes C < 256.  */
  92 #define MAKE_CHAR_MULTIBYTE(c) ((c) = unibyte_to_multibyte_table[(c)])
  93
  94 /* This is the maximum byte length of multibyte form.  */
  95 #define MAX_MULTIBYTE_LENGTH 5
  96
  97 /* Return a Lisp character whose character code is C. */
  98 #define make_char(c) make_number (c)
  99
 100 /* Nonzero iff C is an ASCII byte.  */
 101 #define ASCII_BYTE_P(c) ((unsigned) (c) < 0x80)
 102
 103 /* Nonzero iff X is a character.  */
 104 #define CHARACTERP(x) (NATNUMP (x) && XFASTINT (x) <= MAX_CHAR)
 105
 106 /* Nonzero iff C is valid as a character code.  GENERICP is not used
 107    now.  */
 108 #define CHAR_VALID_P(c, genericp) ((unsigned) (c) <= MAX_CHAR)
 109
 110 /* Check if Lisp object X is a character or not.  */
 111 #define CHECK_CHARACTER(x)                                              \
 112   do {                                                                  \
 113     if (! CHARACTERP(x)) x = wrong_type_argument (Qcharacterp, (x));    \
 114   } while (0)
 115
 116 /* Nonzero iff C is an ASCII character.  */
 117 #define ASCII_CHAR_P(c) ((unsigned) (c) < 0x80)
 118
 119 /* Nonzero iff C is a character of code less than 0x100.  */
 120 #define SINGLE_BYTE_CHAR_P(c) ((unsigned) (c) < 0x100)
 121
 122 /* Nonzero if character C has a printable glyph.  */
 123 #define CHAR_PRINTABLE_P(c)     \
 124   (((c) >= 32 && ((c) < 127)    \
 125     || ! NILP (CHAR_TABLE_REF (Vprintable_chars, (c)))))
 126
 127 /* Return byte length of multibyte form for character C.  */
 128 #define CHAR_BYTES(c)                   \
 129   ( (c) <= MAX_1_BYTE_CHAR ? 1          \
 130     : (c) <= MAX_2_BYTE_CHAR ? 2        \
 131     : (c) <= MAX_3_BYTE_CHAR ? 3        \
 132     : (c) <= MAX_4_BYTE_CHAR ? 4        \
 133     : (c) <= MAX_5_BYTE_CHAR ? 5        \
 134     : 2)
 135
 136
 137 /* Return the leading code of multibyte form of C.  */
 138 #define CHAR_LEADING_CODE(c)                            \
 139   ((c) <= MAX_1_BYTE_CHAR ? c                           \
 140    : (c) <= MAX_2_BYTE_CHAR ? (0xC0 | ((c) >> 6))       \
 141    : (c) <= MAX_3_BYTE_CHAR ? (0xE0 | ((c) >> 12))      \
 142    : (c) <= MAX_4_BYTE_CHAR ? (0xF0 | ((c) >> 18))      \
 143    : (c) <= MAX_5_BYTE_CHAR ? 0xF8                      \
 144    : (0xC0 | (((c) >> 6) & 0x01)))
 145
 146
 147 /* Store multibyte form of the character C in P.  The caller should
 148    allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
 149    Returns the length of the multibyte form.  */
 150
 151 #define CHAR_STRING(c, p)                       \
 152   ((unsigned) (c) <= MAX_1_BYTE_CHAR            \
 153    ? ((p)[0] = (c),                             \
 154       1)                                        \
 155    : (unsigned) (c) <= MAX_2_BYTE_CHAR          \
 156    ? ((p)[0] = (0xC0 | ((c) >> 6)),             \
 157       (p)[1] = (0x80 | ((c) & 0x3F)),           \
 158       2)                                        \
 159    : (unsigned) (c) <= MAX_3_BYTE_CHAR          \
 160    ? ((p)[0] = (0xE0 | ((c) >> 12)),            \
 161       (p)[1] = (0x80 | (((c) >> 6) & 0x3F)),    \
 162       (p)[2] = (0x80 | ((c) & 0x3F)),           \
 163       3)                                        \
 164    : (unsigned) (c) <= MAX_5_BYTE_CHAR          \
 165    ? char_string_with_unification (c, p)        \
 166    : ((p)[0] = (0xC0 | (((c) >> 6) & 0x01)),    \
 167       (p)[1] = (0x80 | ((c) & 0x3F)),           \
 168       2))
 169
 170 /* Store multibyte form of eight-bit char B in P.  The caller should
 171    allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
 172    Returns the length of the multibyte form.  */
 173
 174 #define BYTE8_STRING(b, p)                      \
 175   ((p)[0] = (0xC0 | (((b) >> 6) & 0x01)),       \
 176    (p)[1] = (0x80 | ((c) & 0x3F)),              \
 177    2)
 178
 179
 180 /* Store multibyte form of the character C in P.  The caller should
 181    allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
 182    And, advance P to the end of the multibyte form.  */
 183
 184 #define CHAR_STRING_ADVANCE(c, p)                       \
 185   do {                                                  \
 186     if ((c) <= MAX_1_BYTE_CHAR)                         \
 187       *(p)++ = (c);                                     \
 188     else if ((c) <= MAX_2_BYTE_CHAR)                    \
 189       *(p)++ = (0xC0 | ((c) >> 6)),                     \
 190         *(p)++ = (0x80 | ((c) & 0x3F));                 \
 191     else if ((c) <= MAX_3_BYTE_CHAR)                    \
 192       *(p)++ = (0xE0 | ((c) >> 12)),                    \
 193         *(p)++ = (0x80 | (((c) >> 6) & 0x3F)),          \
 194         *(p)++ = (0x80 | ((c) & 0x3F));                 \
 195     else if ((c) <= MAX_5_BYTE_CHAR)                    \
 196       (p) += char_string_with_unification ((c), (p));   \
 197     else                                                \
 198       *(p)++ = (0xC0 | (((c) >> 6) & 0x01)),            \
 199         *(p)++ = (0x80 | ((c) & 0x3F));                 \
 200   } while (0)
 201
 202 /* Nonzero iff BYTE starts a non-ASCII character in a multibyte
 203    form.  */
 204 #define LEADING_CODE_P(byte) (((byte) & 0xC0) == 0xC0)
 205
 206 /* Nonzero iff BYTE is a trailing code of a non-ASCII character in a
 207    multibyte form.  */
 208 #define TRAILING_CODE_P(byte) (((byte) & 0xC0) == 0x80)
 209
 210 /* Nonzero iff BYTE starts a character in a multibyte form.
 211    This is equivalent to:
 212         (ASCII_BYTE_P (byte) || LEADING_CODE_P (byte))  */
 213 #define CHAR_HEAD_P(byte) (((byte) & 0xC0) != 0x80)
 214
 215 /* Just kept for backward compatibility.  This macro will be removed
 216    in the future.  */
 217 #define BASE_LEADING_CODE_P LEADING_CODE_P
 218
 219 /* How many bytes a character that starts with BYTE occupies in a
 220    multibyte form.  */
 221 #define BYTES_BY_CHAR_HEAD(byte)        \
 222   (!((byte) & 0x80) ? 1                 \
 223    : !((byte) & 0x20) ? 2               \
 224    : !((byte) & 0x10) ? 3               \
 225    : !((byte) & 0x08) ? 4               \
 226    : 5)
 227
 228
 229 /* Return the length of the multi-byte form at string STR of length
 230    LEN while assuming that STR points a valid multi-byte form.  As
 231    this macro isn't necessary anymore, all callers will be changed to
 232    use BYTES_BY_CHAR_HEAD directly in the future.  */
 233
 234 #define MULTIBYTE_FORM_LENGTH(str, len)         \
 235   BYTES_BY_CHAR_HEAD (*(str))
 236
 237 /* Parse multibyte string STR of length LENGTH and set BYTES to the
 238    byte length of a character at STR while assuming that STR points a
 239    valid multibyte form.  As this macro isn't necessary anymore, all
 240    callers will be changed to use BYTES_BY_CHAR_HEAD directly in the
 241    future.  */
 242
 243 #define PARSE_MULTIBYTE_SEQ(str, length, bytes) \
 244   (bytes) = BYTES_BY_CHAR_HEAD (*(str))
 245
 246 /* The byte length of multibyte form at unibyte string P ending at
 247    PEND.  If STR doesn't point a valid multibyte form, return 0.  */
 248
 249 #define MULTIBYTE_LENGTH(p, pend)                               \
 250   (p >= pend ? 0                                                \
 251    : !((p)[0] & 0x80) ? 1                                       \
 252    : ((p + 1 >= pend) || (((p)[1] & 0xC0) != 0x80)) ? 0         \
 253    : ((p)[0] & 0xE0) == 0xC0 ? 2                                \
 254    : ((p + 2 >= pend) || (((p)[2] & 0xC0) != 0x80)) ? 0         \
 255    : ((p)[0] & 0xF0) == 0xE0 ? 3                                \
 256    : ((p + 3 >= pend) || (((p)[3] & 0xC0) != 0x80)) ? 0         \
 257    : ((p)[0] & 0xF8) == 0xF0 ? 4                                \
 258    : ((p + 4 >= pend) || (((p)[4] & 0xC0) != 0x80)) ? 0         \
 259    : (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5              \
 260    : 0)
 261
 262
 263 /* Like MULTIBYTE_LENGTH but don't check the ending address.  */
 264
 265 #define MULTIBYTE_LENGTH_NO_CHECK(p)                    \
 266   (!((p)[0] & 0x80) ? 1                                 \
 267    : ((p)[1] & 0xC0) != 0x80 ? 0                        \
 268    : ((p)[0] & 0xE0) == 0xC0 ? 2                        \
 269    : ((p)[2] & 0xC0) != 0x80 ? 0                        \
 270    : ((p)[0] & 0xF0) == 0xE0 ? 3                        \
 271    : ((p)[3] & 0xC0) != 0x80 ? 0                        \
 272    : ((p)[0] & 0xF8) == 0xF0 ? 4                        \
 273    : ((p)[4] & 0xC0) != 0x80 ? 0                        \
 274    : (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5      \
 275    : 0)
 276
 277
 278 /* Return the character code of character whose multibyte form is at
 279    P.  The argument LEN is ignored.  It will be removed in the
 280    future.  */
 281
 282 #define STRING_CHAR(p, len)                                     \
 283   (!((p)[0] & 0x80)                                             \
 284    ? (p)[0]                                                     \
 285    : ! ((p)[0] & 0x20)                                          \
 286    ? (((((p)[0] & 0x1F) << 6)                                   \
 287        | ((p)[1] & 0x3F))                                       \
 288       + (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0))       \
 289    : ! ((p)[0] & 0x10)                                          \
 290    ? ((((p)[0] & 0x0F) << 12)                                   \
 291       | (((p)[1] & 0x3F) << 6)                                  \
 292       | ((p)[2] & 0x3F))                                        \
 293    : string_char_with_unification ((p), NULL, NULL))
 294
 295
 296 /* Like STRING_CHAR but set ACTUAL_LEN to the length of multibyte
 297    form.  The argument LEN is ignored.  It will be removed in the
 298    future.  */
 299
 300 #define STRING_CHAR_AND_LENGTH(p, len, actual_len)              \
 301   (!((p)[0] & 0x80)                                             \
 302    ? ((actual_len) = 1, (p)[0])                                 \
 303    : ! ((p)[0] & 0x20)                                          \
 304    ? ((actual_len) = 2,                                         \
 305       (((((p)[0] & 0x1F) << 6)                                  \
 306         | ((p)[1] & 0x3F))                                      \
 307        + (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0)))     \
 308    : ! ((p)[0] & 0x10)                                          \
 309    ? ((actual_len) = 3,                                         \
 310       ((((p)[0] & 0x0F) << 12)                                  \
 311        | (((p)[1] & 0x3F) << 6)                                 \
 312        | ((p)[2] & 0x3F)))                                      \
 313    : string_char_with_unification ((p), NULL, &actual_len))
 314
 315
 316 /* Like STRING_CHAR but advacen P to the end of multibyte form.  */
 317
 318 #define STRING_CHAR_ADVANCE(p)                                  \
 319   (!((p)[0] & 0x80)                                             \
 320    ? *(p)++                                                     \
 321    : ! ((p)[0] & 0x20)                                          \
 322    ? ((p) += 2,                                                 \
 323       ((((p)[-2] & 0x1F) << 6)                                  \
 324        | ((p)[-1] & 0x3F)                                       \
 325        | (((unsigned char) (p)[-2]) < 0xC2 ? 0x3FFF80 : 0)))    \
 326    : ! ((p)[0] & 0x10)                                          \
 327    ? ((p) += 3,                                                 \
 328       ((((p)[-3] & 0x0F) << 12)                                 \
 329        | (((p)[-2] & 0x3F) << 6)                                \
 330        | ((p)[-1] & 0x3F)))                                     \
 331    : string_char_with_unification ((p), &(p), NULL))
 332
 333
 334 /* Fetch the "next" character from Lisp string STRING at byte position
 335    BYTEIDX, character position CHARIDX.  Store it into OUTPUT.
 336
 337    All the args must be side-effect-free.
 338    BYTEIDX and CHARIDX must be lvalues;
 339    we increment them past the character fetched.  */
 340
 341 #define FETCH_STRING_CHAR_ADVANCE(OUTPUT, STRING, CHARIDX, BYTEIDX)     \
 342   if (1)                                                                \
 343     {                                                                   \
 344       CHARIDX++;                                                        \
 345       if (STRING_MULTIBYTE (STRING))                                    \
 346         {                                                               \
 347           unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX];        \
 348           int len;                                                      \
 349                                                                         \
 350           OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len);                \
 351           BYTEIDX += len;                                               \
 352         }                                                               \
 353       else                                                              \
 354         OUTPUT = XSTRING (STRING)->data[BYTEIDX++];                     \
 355     }                                                                   \
 356   else
 357
 358 /* Like FETCH_STRING_CHAR_ADVANCE */
 359
 360 #define FETCH_STRING_CHAR_AS_MULTIBYTE_ADVANCE(OUTPUT, STRING, CHARIDX, BYTEIDX) \
 361   if (1)                                                                      \
 362     {                                                                         \
 363       CHARIDX++;                                                              \
 364       if (STRING_MULTIBYTE (STRING))                                          \
 365         {                                                                     \
 366           unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX];              \
 367           int len;                                                            \
 368                                                                               \
 369           OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len);                      \
 370           BYTEIDX += len;                                                     \
 371         }                                                                     \
 372       else                                                                    \
 373         {                                                                     \
 374           OUTPUT = XSTRING (STRING)->data[BYTEIDX++];                         \
 375           MAKE_CHAR_MULTIBYTE (OUTPUT);                                       \
 376         }                                                                     \
 377     }                                                                         \
 378   else
 379
 380
 381 /* Like FETCH_STRING_CHAR_ADVANCE but assumes STRING is multibyte.  */
 382
 383 #define FETCH_STRING_CHAR_ADVANCE_NO_CHECK(OUTPUT, STRING, CHARIDX, BYTEIDX) \
 384   if (1)                                                                     \
 385     {                                                                        \
 386       unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX];                 \
 387       int len;                                                               \
 388                                                                              \
 389       OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len);                         \
 390       BYTEIDX += len;                                                        \
 391       CHARIDX++;                                                             \
 392     }                                                                        \
 393   else
 394
 395
 396 /* Like FETCH_STRING_CHAR_ADVANCE but fetch character from the current
 397    buffer.  */
 398
 399 #define FETCH_CHAR_ADVANCE(OUTPUT, CHARIDX, BYTEIDX)            \
 400   if (1)                                                        \
 401     {                                                           \
 402       CHARIDX++;                                                \
 403       if (!NILP (current_buffer->enable_multibyte_characters))  \
 404         {                                                       \
 405           unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX);         \
 406           int len;                                              \
 407                                                                 \
 408           OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len);         \
 409           BYTEIDX += len;                                       \
 410         }                                                       \
 411       else                                                      \
 412         {                                                       \
 413           OUTPUT = *(BYTE_POS_ADDR (BYTEIDX));                  \
 414           BYTEIDX++;                                            \
 415         }                                                       \
 416     }                                                           \
 417   else
 418
 419
 420 /* Like FETCH_CHAR_ADVANCE but assumes STRING is multibyte.  */
 421
 422 #define FETCH_CHAR_ADVANCE_NO_CHECK(OUTPUT, CHARIDX, BYTEIDX)   \
 423   if (1)                                                        \
 424     {                                                           \
 425       unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX);             \
 426       int len;                                                  \
 427                                                                 \
 428       OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len);             \
 429       BYTEIDX += len;                                           \
 430       CHARIDX++;                                                \
 431     }                                                           \
 432   else
 433
 434
 435 /* Increase the buffer byte position POS_BYTE of the current buffer to
 436    the next character boundary.  No range checking of POS.  */
 437
 438 #define INC_POS(pos_byte)                               \
 439   do {                                                  \
 440     unsigned char *p = BYTE_POS_ADDR (pos_byte);        \
 441     pos_byte += BYTES_BY_CHAR_HEAD (*p);                \
 442   } while (0)
 443
 444
 445 /* Decrease the buffer byte position POS_BYTE of the current buffer to
 446    the previous character boundary.  No range checking of POS.  */
 447
 448 #define DEC_POS(pos_byte)                       \
 449   do {                                          \
 450     unsigned char *p;                           \
 451                                                 \
 452     pos_byte--;                                 \
 453     if (pos_byte < GPT_BYTE)                    \
 454       p = BEG_ADDR + pos_byte - 1;              \
 455     else                                        \
 456       p = BEG_ADDR + GAP_SIZE + pos_byte - 1;   \
 457     while (!CHAR_HEAD_P (*p))                   \
 458       {                                         \
 459         p--;                                    \
 460         pos_byte--;                             \
 461       }                                         \
 462   } while (0)
 463
 464 /* Increment both CHARPOS and BYTEPOS, each in the appropriate way.  */
 465
 466 #define INC_BOTH(charpos, bytepos)                              \
 467   do                                                            \
 468     {                                                           \
 469       (charpos)++;                                              \
 470       if (NILP (current_buffer->enable_multibyte_characters))   \
 471         (bytepos)++;                                            \
 472       else                                                      \
 473         INC_POS ((bytepos));                                    \
 474     }                                                           \
 475   while (0)
 476
 477
 478 /* Decrement both CHARPOS and BYTEPOS, each in the appropriate way.  */
 479
 480 #define DEC_BOTH(charpos, bytepos)                              \
 481   do                                                            \
 482     {                                                           \
 483       (charpos)--;                                              \
 484       if (NILP (current_buffer->enable_multibyte_characters))   \
 485         (bytepos)--;                                            \
 486       else                                                      \
 487         DEC_POS ((bytepos));                                    \
 488     }                                                           \
 489   while (0)
 490
 491
 492 /* Increase the buffer byte position POS_BYTE of the current buffer to
 493    the next character boundary.  This macro relies on the fact that
 494    *GPT_ADDR and *Z_ADDR are always accessible and the values are
 495    '\0'.  No range checking of POS_BYTE.  */
 496
 497 #define BUF_INC_POS(buf, pos_byte)                              \
 498   do {                                                          \
 499     unsigned char *p = BUF_BYTE_ADDRESS (buf, pos_byte);        \
 500     pos_byte += BYTES_BY_CHAR_HEAD (*p);                        \
 501   } while (0)
 502
 503
 504 /* Decrease the buffer byte position POS_BYTE of the current buffer to
 505    the previous character boundary.  No range checking of POS_BYTE.  */
 506
 507 #define BUF_DEC_POS(buf, pos_byte)                                      \
 508   do {                                                                  \
 509     unsigned char *p;                                                   \
 510     pos_byte--;                                                         \
 511     if (pos_byte < BUF_GPT_BYTE (buf))                                  \
 512       p = BUF_BEG_ADDR (buf) + pos_byte - 1;                            \
 513     else                                                                \
 514       p = BUF_BEG_ADDR (buf) + BUF_GAP_SIZE (buf) + pos_byte - 1;       \
 515     while (!CHAR_HEAD_P (*p))                                           \
 516       {                                                                 \
 517         p--;                                                            \
 518         pos_byte--;                                                     \
 519       }                                                                 \
 520   } while (0)
 521
 522
 523 #define MAYBE_UNIFY_CHAR(c)                                     \
 524   if (CHAR_TABLE_P (Vchar_unify_table))                         \
 525     {                                                           \
 526       Lisp_Object val;                                          \
 527       int unified;                                              \
 528                                                                 \
 529       val = CHAR_TABLE_REF (Vchar_unify_table, c);              \
 530       if (! NILP (val))                                         \
 531         {                                                       \
 532           if (SYMBOLP (val))                                    \
 533             {                                                   \
 534               Funify_charset (val, Qnil, Qnil);                 \
 535               val = CHAR_TABLE_REF (Vchar_unify_table, c);      \
 536             }                                                   \
 537           if ((unified = XINT (val)) >= 0)                      \
 538             c = unified;                                        \
 539         }                                                       \
 540     }                                                           \
 541   else
 542
 543
 544 /* Return the width of ASCII character C.  The width is measured by
 545    how many columns occupied on the screen when displayed in the
 546    current buffer.  */
 547
 548 #define ASCII_CHAR_WIDTH(c)                                             \
 549   (c < 0x20                                                             \
 550    ? (c == '\t'                                                         \
 551       ? XFASTINT (current_buffer->tab_width)                            \
 552       : (c == '\n' ? 0 : (NILP (current_buffer->ctl_arrow) ? 4 : 2)))   \
 553    : (c < 0x7f                                                          \
 554       ? 1                                                               \
 555       : ((NILP (current_buffer->ctl_arrow) ? 4 : 2))))
 556
 557 /* Return the width of character C.  The width is measured by how many
 558    columns occupied on the screen when displayed in the current
 559    buffer.  */
 560
 561 #define CHAR_WIDTH(c)           \
 562   (ASCII_CHAR_P (c)             \
 563    ? ASCII_CHAR_WIDTH (c)       \
 564    : XINT (CHAR_TABLE_REF (Vchar_width_table, c)))
 565
 566 extern int char_string_with_unification P_ ((int, unsigned char *));
 567 extern int string_char_with_unification P_ ((const unsigned char *,
 568                                              const unsigned char **, int *));
 569
 570 extern int translate_char P_ ((Lisp_Object, int c));
 571 extern int char_printable_p P_ ((int c));
 572 extern void parse_str_as_multibyte P_ ((unsigned char *, int, int *, int *));
 573 extern int parse_str_to_multibyte P_ ((unsigned char *, int));
 574 extern int str_as_multibyte P_ ((unsigned char *, int, int, int *));
 575 extern int str_to_multibyte P_ ((unsigned char *, int, int));
 576 extern int str_as_unibyte P_ ((unsigned char *, int));
 577 extern int strwidth P_ ((unsigned char *, int));
 578 extern int c_string_width P_ ((unsigned char *, int, int, int *, int *));
 579 extern int lisp_string_width P_ ((Lisp_Object, int, int *, int *));
 580
 581 extern Lisp_Object Vprintable_chars;
 582
 583 extern Lisp_Object Qcharacterp, Qauto_fill_chars;
 584 extern Lisp_Object Vtranslation_table_vector;
 585 extern Lisp_Object Vchar_width_table;
 586 extern Lisp_Object Vchar_direction_table;
 587 extern Lisp_Object Vchar_unify_table;
 588
 589 extern Lisp_Object string_escape_byte8 P_ ((Lisp_Object));
 590
 591 /* Return a translation table of id number ID.  */
 592 #define GET_TRANSLATION_TABLE(id) \
 593   (XCDR(XVECTOR(Vtranslation_table_vector)->contents[(id)]))
 594
 595 /* A char-table for characters which may invoke auto-filling.  */
 596 extern Lisp_Object Vauto_fill_chars;
 597
 598 extern Lisp_Object Vchar_script_table;
 599
 600 /* Copy LEN bytes from FROM to TO.  This macro should be used only
 601    when a caller knows that LEN is short and the obvious copy loop is
 602    faster than calling bcopy which has some overhead.  Copying a
 603    multibyte sequence of a character is the typical case.  */
 604
 605 #define BCOPY_SHORT(from, to, len)              \
 606   do {                                          \
 607     int i = len;                                \
 608     unsigned char *from_p = from, *to_p = to;   \
 609     while (i--) *to_p++ = *from_p++;            \
 610   } while (0)
 611
 612 #define DEFSYM(sym, name)       \
 613   do { (sym) = intern ((name)); staticpro (&(sym)); } while (0)
 614
 615 #endif /* EMACS_CHARACTER_H */