[bpt/emacs.git] / src / character.h

/* Header for multibyte character handler.
   Copyright (C) 1995, 1997, 1998 Electrotechnical Laboratory, JAPAN.
   Licensed to the Free Software Foundation.
   Copyright (C) 2001, 2002
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

#ifndef EMACS_CHARACTER_H
#define EMACS_CHARACTER_H

/* character code	1st byte   byte sequence
   --------------	--------   -------------
        0-7F		00..7F	   0xxxxxxx
       80-7FF		C2..DF	   110xxxxx 10xxxxxx
      800-FFFF		E0..EF	   1110xxxx 10xxxxxx 10xxxxxx
    10000-1FFFFF	F0..F7	   11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
   200000-3FFF7F	F8	   11111000 1000xxxx 10xxxxxx 10xxxxxx 10xxxxxx
      invalid		F9..FF

   raw-8-bit
   3FFF80-3FFFFF	C0..C1	   1100000x 10xxxxxx
*/

/* Maximum character code ((1 << CHARACTERBITS) - 1).  */
#define MAX_CHAR  0x3FFFFF

/* Maximum Unicode character code.  */
#define MAX_UNICODE_CHAR 0x10FFFF

/* Maximum N-byte character codes.  */
#define MAX_1_BYTE_CHAR 0x7F
#define MAX_2_BYTE_CHAR 0x7FF
#define MAX_3_BYTE_CHAR 0xFFFF
#define MAX_4_BYTE_CHAR 0x1FFFFF
#define MAX_5_BYTE_CHAR 0x3FFF7F

/* Return the character code for raw 8-bit byte BYTE.  */
#define BYTE8_TO_CHAR(byte) ((byte) + 0x3FFF00)

/* Return the raw 8-bit byte for character C.  */
#define CHAR_TO_BYTE8(c) ((c) - 0x3FFF00)

/* Nonzero iff C is a character that corresponds to a raw 8-bit
   byte.  */
#define CHAR_BYTE8_P(c) ((c) > MAX_5_BYTE_CHAR)

/* Nonzero iff BYTE is the 1st byte of a multibyte form of a character
   that corresponds to a raw 8-bit byte.  */
#define CHAR_BYTE8_HEAD_P(byte) ((byte) == 0xC0 || (byte) == 0xC1)

/* This is the maximum byte length of multibyte form.  */
#define MAX_MULTIBYTE_LENGTH 5

/* Return a Lisp character whose character code is C. */
#define make_char(c) make_number (c)

/* Nonzero iff C is an ASCII byte.  */
#define ASCII_BYTE_P(c) ((unsigned) (c) < 0x80)

/* Nonzero iff X is a character.  */
#define CHARACTERP(x) (NATNUMP (x) && XFASTINT (x) <= MAX_CHAR)

/* Nonzero iff C is valid as a character code.  GENERICP is not used
   now.  */
#define CHAR_VALID_P(c, genericp) ((unsigned) (c) <= MAX_CHAR)

/* Check if Lisp object X is a character or not.  */
#define CHECK_CHARACTER(x)						\
  do {									\
    if (! CHARACTERP(x)) x = wrong_type_argument (Qcharacterp, (x));	\
  } while (0)

/* Nonzero iff C is an ASCII character.  */
#define ASCII_CHAR_P(c) ((unsigned) (c) < 0x80)

/* Nonzero iff C is a character of code less than 0x100.  */
#define SINGLE_BYTE_CHAR_P(c) ((unsigned) (c) < 0x100)

/* Nonzero if character C has a printable glyph.  */
#define CHAR_PRINTABLE_P(c)	\
  (((c) >= 32 && ((c) < 127)	\
    || ! NILP (CHAR_TABLE_REF (Vprintable_chars, (c)))))

/* Return byte length of multibyte form for character C.  */
#define CHAR_BYTES(c)			\
  ( (c) <= MAX_1_BYTE_CHAR ? 1		\
    : (c) <= MAX_2_BYTE_CHAR ? 2	\
    : (c) <= MAX_3_BYTE_CHAR ? 3	\
    : (c) <= MAX_4_BYTE_CHAR ? 4	\
    : (c) <= MAX_5_BYTE_CHAR ? 5	\
    : 2)

/* Store multibyte form of the character C in P.  The caller should
   allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
   Returns the length of the multibyte form.  */

#define CHAR_STRING(c, p)			\
  ((unsigned) (c) <= MAX_1_BYTE_CHAR		\
   ? ((p)[0] = (c),				\
      1)					\
   : (unsigned) (c) <= MAX_2_BYTE_CHAR		\
   ? ((p)[0] = (0xC0 | ((c) >> 6)),		\
      (p)[1] = (0x80 | ((c) & 0x3F)),		\
      2)					\
   : (unsigned) (c) <= MAX_3_BYTE_CHAR		\
   ? ((p)[0] = (0xE0 | ((c) >> 12)),		\
      (p)[1] = (0x80 | (((c) >> 6) & 0x3F)),	\
      (p)[2] = (0x80 | ((c) & 0x3F)),		\
      3)					\
   : (unsigned) (c) <= MAX_5_BYTE_CHAR		\
   ? char_string_with_unification (c, p)	\
   : ((p)[0] = (0xC0 | (((c) >> 6) & 0x01)),	\
      (p)[1] = (0x80 | ((c) & 0x3F)),		\
      2))


/* Store multibyte form of the character C in P.  The caller should
   allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
   And, advance P to the end of the multibyte form.  */

#define CHAR_STRING_ADVANCE(c, p)			\
  do {							\
    if ((c) <= MAX_1_BYTE_CHAR)				\
      *(p)++ = (c);					\
    else if ((c) <= MAX_2_BYTE_CHAR)			\
      *(p)++ = (0xC0 | ((c) >> 6)),			\
	*(p)++ = (0x80 | ((c) & 0x3F));			\
    else if ((c) <= MAX_3_BYTE_CHAR)			\
      *(p)++ = (0xE0 | ((c) >> 12)),			\
	*(p)++ = (0x80 | (((c) >> 6) & 0x3F)),		\
	*(p)++ = (0x80 | ((c) & 0x3F));			\
    else if ((c) <= MAX_5_BYTE_CHAR)			\
      (p) += char_string_with_unification ((c), (p));	\
    else						\
      *(p)++ = (0xC0 | (((c) >> 6) & 0x01)),		\
	*(p)++ = (0x80 | ((c) & 0x3F));			\
  } while (0)

/* Nonzero iff BYTE starts a non-ASCII character in a multibyte
   form.  */
#define LEADING_CODE_P(byte) (((byte) & 0xC0) == 0xC0)

/* Nonzero iff BYTE starts a character in a multibyte form.
   This is equivalent to:
	(ASCII_BYTE_P (byte) || LEADING_CODE_P (byte))  */
#define CHAR_HEAD_P(byte) (((byte) & 0xC0) != 0x80)

/* Just kept for backward compatibility.  This macro will be removed
   in the future.  */
#define BASE_LEADING_CODE_P LEADING_CODE_P

/* How many bytes a character that starts with BYTE occupies in a
   multibyte form.  */
#define BYTES_BY_CHAR_HEAD(byte)	\
  (!((byte) & 0x80) ? 1			\
   : !((byte) & 0x20) ? 2		\
   : !((byte) & 0x10) ? 3		\
   : !((byte) & 0x08) ? 4		\
   : 5)


/* Return the length of the multi-byte form at string STR of length
   LEN while assuming that STR points a valid multi-byte form.  As
   this macro isn't necessary anymore, all callers will be changed to
   use BYTES_BY_CHAR_HEAD directly in the future.  */

#define MULTIBYTE_FORM_LENGTH(str, len)		\
  BYTES_BY_CHAR_HEAD (*(str))

/* Parse multibyte string STR of length LENGTH and set BYTES to the
   byte length of a character at STR while assuming that STR points a
   valid multibyte form.  As this macro isn't necessary anymore, all
   callers will be changed to use BYTES_BY_CHAR_HEAD directly in the
   future.  */

#define PARSE_MULTIBYTE_SEQ(str, length, bytes)	\
  (bytes) = BYTES_BY_CHAR_HEAD (*(str))

/* The byte length of multibyte form at unibyte string P ending at
   PEND.  If STR doesn't point a valid multibyte form, return 0.  */

#define MULTIBYTE_LENGTH(p, pend)				\
  (p >= pend ? 0						\
   : !((p)[0] & 0x80) ? 1					\
   : ((p + 1 >= pend) || (((p)[1] & 0xC0) != 0x80)) ? 0		\
   : ((p)[0] & 0xE0) == 0xC0 ? 2				\
   : ((p + 2 >= pend) || (((p)[2] & 0xC0) != 0x80)) ? 0		\
   : ((p)[0] & 0xF0) == 0xE0 ? 3				\
   : ((p + 3 >= pend) || (((p)[3] & 0xC0) != 0x80)) ? 0		\
   : ((p)[0] & 0xF8) == 0xF0 ? 4				\
   : ((p + 4 >= pend) || (((p)[4] & 0xC0) != 0x80)) ? 0		\
   : (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5		\
   : 0)


/* Like MULTIBYTE_LENGTH but don't check the ending address.  */

#define MULTIBYTE_LENGTH_NO_CHECK(p)			\
  (!((p)[0] & 0x80) ? 1					\
   : ((p)[1] & 0xC0) != 0x80 ? 0			\
   : ((p)[0] & 0xE0) == 0xC0 ? 2			\
   : ((p)[2] & 0xC0) != 0x80 ? 0			\
   : ((p)[0] & 0xF0) == 0xE0 ? 3			\
   : ((p)[3] & 0xC0) != 0x80 ? 0			\
   : ((p)[0] & 0xF8) == 0xF0 ? 4			\
   : ((p)[4] & 0xC0) != 0x80 ? 0			\
   : (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5	\
   : 0)


/* Return the character code of character whose multibyte form is at
   P.  The argument LEN is ignored.  It will be removed in the
   future.  */

#define STRING_CHAR(p, len)					\
  (!((p)[0] & 0x80)						\
   ? (p)[0]							\
   : ! ((p)[0] & 0x20)						\
   ? (((((p)[0] & 0x1F) << 6)					\
       | ((p)[1] & 0x3F))					\
      + (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0))	\
   : ! ((p)[0] & 0x10)						\
   ? ((((p)[0] & 0x0F) << 12)					\
      | (((p)[1] & 0x3F) << 6)					\
      | ((p)[2] & 0x3F))					\
   : string_char_with_unification ((p), NULL, NULL))


/* Like STRING_CHAR but set ACTUAL_LEN to the length of multibyte
   form.  The argument LEN is ignored.  It will be removed in the
   future.  */

#define STRING_CHAR_AND_LENGTH(p, len, actual_len)		\
  (!((p)[0] & 0x80)						\
   ? ((actual_len) = 1, (p)[0])					\
   : ! ((p)[0] & 0x20)						\
   ? ((actual_len) = 2,						\
      (((((p)[0] & 0x1F) << 6)					\
	| ((p)[1] & 0x3F))					\
       + (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0)))	\
   : ! ((p)[0] & 0x10)						\
   ? ((actual_len) = 3,						\
      ((((p)[0] & 0x0F) << 12)					\
       | (((p)[1] & 0x3F) << 6)					\
       | ((p)[2] & 0x3F)))					\
   : string_char_with_unification ((p), NULL, &actual_len))


/* Like STRING_CHAR but advacen P to the end of multibyte form.  */

#define STRING_CHAR_ADVANCE(p)					\
  (!((p)[0] & 0x80)						\
   ? *(p)++							\
   : ! ((p)[0] & 0x20)						\
   ? ((p) += 2,							\
      ((((p)[-2] & 0x1F) << 6)					\
       | ((p)[-1] & 0x3F)					\
       | (((unsigned char) (p)[-2]) < 0xC2 ? 0x3FFF80 : 0)))	\
   : ! ((p)[0] & 0x10)						\
   ? ((p) += 3,							\
      ((((p)[-3] & 0x0F) << 12)					\
       | (((p)[-2] & 0x3F) << 6)				\
       | ((p)[-1] & 0x3F)))					\
   : string_char_with_unification ((p), &(p), NULL))


/* Fetch the "next" character from Lisp string STRING at byte position
   BYTEIDX, character position CHARIDX.  Store it into OUTPUT.

   All the args must be side-effect-free.
   BYTEIDX and CHARIDX must be lvalues;
   we increment them past the character fetched.  */

#define FETCH_STRING_CHAR_ADVANCE(OUTPUT, STRING, CHARIDX, BYTEIDX)	\
  if (1)								\
    {									\
      CHARIDX++;							\
      if (STRING_MULTIBYTE (STRING))					\
	{								\
	  unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX];	\
	  int len;							\
									\
	  OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len);		\
	  BYTEIDX += len;						\
	}								\
      else								\
	OUTPUT = XSTRING (STRING)->data[BYTEIDX++];			\
    }									\
  else


/* Like FETCH_STRING_CHAR_ADVANCE but assumes STRING is multibyte.  */

#define FETCH_STRING_CHAR_ADVANCE_NO_CHECK(OUTPUT, STRING, CHARIDX, BYTEIDX) \
  if (1)								     \
    {									     \
      unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX];		     \
      int len;								     \
									     \
      OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len);			     \
      BYTEIDX += len;							     \
      CHARIDX++;							     \
    }									     \
  else


/* Like FETCH_STRING_CHAR_ADVANCE but fetch character from the current
   buffer.  */

#define FETCH_CHAR_ADVANCE(OUTPUT, CHARIDX, BYTEIDX)		\
  if (1)							\
    {								\
      CHARIDX++;						\
      if (!NILP (current_buffer->enable_multibyte_characters))	\
	{							\
	  unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX);		\
	  int len;						\
								\
	  OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len);		\
	  BYTEIDX += len;					\
	}							\
      else							\
	{							\
	  OUTPUT = *(BYTE_POS_ADDR (BYTEIDX));			\
	  BYTEIDX++;						\
	}							\
    }								\
  else


/* Like FETCH_CHAR_ADVANCE but assumes STRING is multibyte.  */

#define FETCH_CHAR_ADVANCE_NO_CHECK(OUTPUT, CHARIDX, BYTEIDX)	\
  if (1)							\
    {								\
      unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX);		\
      int len;							\
								\
      OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len);		\
      BYTEIDX += len;						\
      CHARIDX++;						\
    }								\
  else


/* Increase the buffer byte position POS_BYTE of the current buffer to
   the next character boundary.  No range checking of POS.  */

#define INC_POS(pos_byte)				\
  do {							\
    unsigned char *p = BYTE_POS_ADDR (pos_byte);	\
    pos_byte += BYTES_BY_CHAR_HEAD (*p);		\
  } while (0)


/* Decrease the buffer byte position POS_BYTE of the current buffer to
   the previous character boundary.  No range checking of POS.  */

#define DEC_POS(pos_byte)			\
  do {						\
    unsigned char *p;				\
    						\
    pos_byte--;					\
    if (pos_byte < GPT_BYTE)			\
      p = BEG_ADDR + pos_byte - 1;		\
    else					\
      p = BEG_ADDR + GAP_SIZE + pos_byte - 1;	\
    while (!CHAR_HEAD_P (*p))			\
      {						\
	p--;					\
	pos_byte--;				\
      }						\
  } while (0)

/* Increment both CHARPOS and BYTEPOS, each in the appropriate way.  */

#define INC_BOTH(charpos, bytepos)				\
  do								\
    {								\
      (charpos)++;						\
      if (NILP (current_buffer->enable_multibyte_characters))	\
	(bytepos)++;						\
      else							\
	INC_POS ((bytepos));					\
    }								\
  while (0)


/* Decrement both CHARPOS and BYTEPOS, each in the appropriate way.  */

#define DEC_BOTH(charpos, bytepos)				\
  do								\
    {								\
      (charpos)--;						\
      if (NILP (current_buffer->enable_multibyte_characters))	\
	(bytepos)--;						\
      else							\
	DEC_POS ((bytepos));					\
    }								\
  while (0)


/* Increase the buffer byte position POS_BYTE of the current buffer to
   the next character boundary.  This macro relies on the fact that
   *GPT_ADDR and *Z_ADDR are always accessible and the values are
   '\0'.  No range checking of POS_BYTE.  */

#define BUF_INC_POS(buf, pos_byte)				\
  do {								\
    unsigned char *p = BUF_BYTE_ADDRESS (buf, pos_byte);	\
    pos_byte += BYTES_BY_CHAR_HEAD (*p);			\
  } while (0)


/* Decrease the buffer byte position POS_BYTE of the current buffer to
   the previous character boundary.  No range checking of POS_BYTE.  */

#define BUF_DEC_POS(buf, pos_byte)					\
  do {									\
    unsigned char *p;							\
    pos_byte--;								\
    if (pos_byte < BUF_GPT_BYTE (buf))					\
      p = BUF_BEG_ADDR (buf) + pos_byte - 1;				\
    else								\
      p = BUF_BEG_ADDR (buf) + BUF_GAP_SIZE (buf) + pos_byte - 1;	\
    while (!CHAR_HEAD_P (*p))						\
      {									\
	p--;								\
	pos_byte--;							\
      }									\
  } while (0)


#define MAYBE_UNIFY_CHAR(c)					\
  if (CHAR_TABLE_P (Vchar_unify_table))				\
    {								\
      Lisp_Object val;						\
      int unified;						\
								\
      val = CHAR_TABLE_REF (Vchar_unify_table, c);		\
      if (! NILP (val))						\
	{							\
	  if (SYMBOLP (val))					\
	    {							\
	      Funify_charset (val, Qnil);			\
	      val = CHAR_TABLE_REF (Vchar_unify_table, c);	\
	    }							\
	  if ((unified = XINT (val)) >= 0)			\
	    c = unified;					\
	}							\
    }								\
  else


/* Return the width of ASCII character C.  The width is measured by
   how many columns occupied on the screen when displayed in the
   current buffer.  */

#define ASCII_CHAR_WIDTH(c)						\
  (c < 0x20								\
   ? (c == '\t'								\
      ? XFASTINT (current_buffer->tab_width)				\
      : (c == '\n' ? 0 : (NILP (current_buffer->ctl_arrow) ? 4 : 2)))	\
   : (c < 0x7f								\
      ? 1								\
      : ((NILP (current_buffer->ctl_arrow) ? 4 : 2))))

/* Return the width of character C.  The width is measured by how many
   columns occupied on the screen when displayed in the current
   buffer.  */

#define CHAR_WIDTH(c)		\
  (ASCII_CHAR_P (c)		\
   ? ASCII_CHAR_WIDTH (c)	\
   : XINT (CHAR_TABLE_REF (Vchar_width_table, c)))

extern int char_string_with_unification P_ ((int, unsigned char *));
extern int string_char_with_unification P_ ((unsigned char *,
					     unsigned char **, int *));

extern int translate_char P_ ((Lisp_Object, int c));
extern int char_printable_p P_ ((int c));
extern void parse_str_as_multibyte P_ ((unsigned char *, int, int *, int *));
extern int parse_str_to_multibyte P_ ((unsigned char *, int));
extern int str_as_multibyte P_ ((unsigned char *, int, int, int *));
extern int str_to_multibyte P_ ((unsigned char *, int, int));
extern int str_as_unibyte P_ ((unsigned char *, int));
extern int strwidth P_ ((unsigned char *, int));
extern int c_string_width P_ ((unsigned char *, int, int, int *, int *));
extern int lisp_string_width P_ ((Lisp_Object, int, int *, int *));

extern Lisp_Object Vprintable_chars;

extern Lisp_Object Qcharacterp, Qauto_fill_chars;
extern Lisp_Object Vtranslation_table_vector;
extern Lisp_Object Vchar_width_table;
extern Lisp_Object Vchar_direction_table;
extern Lisp_Object Vchar_unify_table;

extern Lisp_Object string_escape_byte8 P_ ((Lisp_Object));

/* Return a translation table of id number ID.  */
#define GET_TRANSLATION_TABLE(id) \
  (XCDR(XVECTOR(Vtranslation_table_vector)->contents[(id)]))

/* A char-table for characters which may invoke auto-filling.  */
extern Lisp_Object Vauto_fill_chars;

/* Copy LEN bytes from FROM to TO.  This macro should be used only
   when a caller knows that LEN is short and the obvious copy loop is
   faster than calling bcopy which has some overhead.  Copying a
   multibyte sequence of a character is the typical case.  */

#define BCOPY_SHORT(from, to, len)		\
  do {						\
    int i = len;				\
    unsigned char *from_p = from, *to_p = to;	\
    while (i--) *to_p++ = *from_p++;		\
  } while (0)

#define DEFSYM(sym, name)	\
  do { (sym) = intern ((name)); staticpro (&(sym)); } while (0)

#endif /* EMACS_CHARACTER_H */
Commit	Line	Data
0168c3d8 KH	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
885317d8 KH	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
0168c3d8 KH	36
0168c3d8 KH	37	raw-8-bit
885317d8	38	3FFF80-3FFFFF C0..C1 1100000x 10xxxxxx
0168c3d8 KH	39	*/
0168c3d8 KH	40
885317d8	41	/* Maximum character code ((1 << CHARACTERBITS) - 1). */
0168c3d8 KH	42	#define MAX_CHAR 0x3FFFFF
0168c3d8 KH	43
885317d8	44	/* Maximum Unicode character code. */
0168c3d8 KH	45	#define MAX_UNICODE_CHAR 0x10FFFF
0168c3d8 KH	46
885317d8	47	/* Maximum N-byte character codes. */
0168c3d8 KH	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
885317d8	54	/* Return the character code for raw 8-bit byte BYTE. */
0168c3d8	55	#define BYTE8_TO_CHAR(byte) ((byte) + 0x3FFF00)
885317d8 KH	56
885317d8 KH	57	/* Return the raw 8-bit byte for character C. */
0168c3d8	58	#define CHAR_TO_BYTE8(c) ((c) - 0x3FFF00)
885317d8 KH	59
	60	/* Nonzero iff C is a character that corresponds to a raw 8-bit
	61	byte. */
0168c3d8	62	#define CHAR_BYTE8_P(c) ((c) > MAX_5_BYTE_CHAR)
885317d8 KH	63
	64	/* Nonzero iff BYTE is the 1st byte of a multibyte form of a character
	65	that corresponds to a raw 8-bit byte. */
0168c3d8 KH	66	#define CHAR_BYTE8_HEAD_P(byte) ((byte) == 0xC0 \|\| (byte) == 0xC1)
0168c3d8 KH	67
885317d8	68	/* This is the maximum byte length of multibyte form. */
0168c3d8 KH	69	#define MAX_MULTIBYTE_LENGTH 5
0168c3d8 KH	70
885317d8	71	/* Return a Lisp character whose character code is C. */
0168c3d8 KH	72	#define make_char(c) make_number (c)
	73
	74	/* Nonzero iff C is an ASCII byte. */
	75	#define ASCII_BYTE_P(c) ((unsigned) (c) < 0x80)
	76
	77	/* Nonzero iff X is a character. */
	78	#define CHARACTERP(x) (NATNUMP (x) && XFASTINT (x) <= MAX_CHAR)
	79
f65c6d94	80	/* Nonzero iff C is valid as a character code. GENERICP is not used
885317d8 KH	81	now. */
885317d8 KH	82	#define CHAR_VALID_P(c, genericp) ((unsigned) (c) <= MAX_CHAR)
0168c3d8 KH	83
	84	/* Check if Lisp object X is a character or not. */
	85	#define CHECK_CHARACTER(x) \
	86	do { \
	87	if (! CHARACTERP(x)) x = wrong_type_argument (Qcharacterp, (x)); \
	88	} while (0)
	89
	90	/* Nonzero iff C is an ASCII character. */
	91	#define ASCII_CHAR_P(c) ((unsigned) (c) < 0x80)
	92
	93	/* Nonzero iff C is a character of code less than 0x100. */
	94	#define SINGLE_BYTE_CHAR_P(c) ((unsigned) (c) < 0x100)
	95
	96	/* Nonzero if character C has a printable glyph. */
	97	#define CHAR_PRINTABLE_P(c) \
	98	(((c) >= 32 && ((c) < 127) \
	99	\|\| ! NILP (CHAR_TABLE_REF (Vprintable_chars, (c)))))
	100
885317d8	101	/* Return byte length of multibyte form for character C. */
0168c3d8 KH	102	#define CHAR_BYTES(c) \
	103	( (c) <= MAX_1_BYTE_CHAR ? 1 \
	104	: (c) <= MAX_2_BYTE_CHAR ? 2 \
	105	: (c) <= MAX_3_BYTE_CHAR ? 3 \
	106	: (c) <= MAX_4_BYTE_CHAR ? 4 \
	107	: (c) <= MAX_5_BYTE_CHAR ? 5 \
	108	: 2)
	109
885317d8 KH	110	/* Store multibyte form of the character C in P. The caller should
	111	allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
	112	Returns the length of the multibyte form. */
0168c3d8 KH	113
	114	#define CHAR_STRING(c, p) \
	115	((unsigned) (c) <= MAX_1_BYTE_CHAR \
	116	? ((p)[0] = (c), \
	117	1) \
	118	: (unsigned) (c) <= MAX_2_BYTE_CHAR \
	119	? ((p)[0] = (0xC0 \| ((c) >> 6)), \
	120	(p)[1] = (0x80 \| ((c) & 0x3F)), \
	121	2) \
	122	: (unsigned) (c) <= MAX_3_BYTE_CHAR \
	123	? ((p)[0] = (0xE0 \| ((c) >> 12)), \
	124	(p)[1] = (0x80 \| (((c) >> 6) & 0x3F)), \
	125	(p)[2] = (0x80 \| ((c) & 0x3F)), \
	126	3) \
	127	: (unsigned) (c) <= MAX_5_BYTE_CHAR \
885317d8	128	? char_string_with_unification (c, p) \
0168c3d8 KH	129	: ((p)[0] = (0xC0 \| (((c) >> 6) & 0x01)), \
	130	(p)[1] = (0x80 \| ((c) & 0x3F)), \
	131	2))
	132
	133
885317d8 KH	134	/* Store multibyte form of the character C in P. The caller should
	135	allocate at least MAX_MULTIBYTE_LENGTH bytes area at P in advance.
	136	And, advance P to the end of the multibyte form. */
0168c3d8	137
885317d8 KH	138	#define CHAR_STRING_ADVANCE(c, p) \
	139	do { \
	140	if ((c) <= MAX_1_BYTE_CHAR) \
	141	*(p)++ = (c); \
	142	else if ((c) <= MAX_2_BYTE_CHAR) \
	143	*(p)++ = (0xC0 \| ((c) >> 6)), \
	144	*(p)++ = (0x80 \| ((c) & 0x3F)); \
	145	else if ((c) <= MAX_3_BYTE_CHAR) \
	146	*(p)++ = (0xE0 \| ((c) >> 12)), \
	147	*(p)++ = (0x80 \| (((c) >> 6) & 0x3F)), \
	148	*(p)++ = (0x80 \| ((c) & 0x3F)); \
	149	else if ((c) <= MAX_5_BYTE_CHAR) \
	150	(p) += char_string_with_unification ((c), (p)); \
	151	else \
	152	*(p)++ = (0xC0 \| (((c) >> 6) & 0x01)), \
	153	*(p)++ = (0x80 \| ((c) & 0x3F)); \
	154	} while (0)
0168c3d8 KH	155
	156	/* Nonzero iff BYTE starts a non-ASCII character in a multibyte
	157	form. */
	158	#define LEADING_CODE_P(byte) (((byte) & 0xC0) == 0xC0)
	159
885317d8 KH	160	/* Nonzero iff BYTE starts a character in a multibyte form.
	161	This is equivalent to:
	162	(ASCII_BYTE_P (byte) \|\| LEADING_CODE_P (byte)) */
	163	#define CHAR_HEAD_P(byte) (((byte) & 0xC0) != 0x80)
	164
0168c3d8 KH	165	/* Just kept for backward compatibility. This macro will be removed
	166	in the future. */
	167	#define BASE_LEADING_CODE_P LEADING_CODE_P
	168
	169	/* How many bytes a character that starts with BYTE occupies in a
	170	multibyte form. */
	171	#define BYTES_BY_CHAR_HEAD(byte) \
	172	(!((byte) & 0x80) ? 1 \
	173	: !((byte) & 0x20) ? 2 \
	174	: !((byte) & 0x10) ? 3 \
	175	: !((byte) & 0x08) ? 4 \
	176	: 5)
	177
	178
	179	/* Return the length of the multi-byte form at string STR of length
	180	LEN while assuming that STR points a valid multi-byte form. As
	181	this macro isn't necessary anymore, all callers will be changed to
	182	use BYTES_BY_CHAR_HEAD directly in the future. */
	183
	184	#define MULTIBYTE_FORM_LENGTH(str, len) \
	185	BYTES_BY_CHAR_HEAD (*(str))
	186
	187	/* Parse multibyte string STR of length LENGTH and set BYTES to the
	188	byte length of a character at STR while assuming that STR points a
	189	valid multibyte form. As this macro isn't necessary anymore, all
	190	callers will be changed to use BYTES_BY_CHAR_HEAD directly in the
	191	future. */
	192
	193	#define PARSE_MULTIBYTE_SEQ(str, length, bytes) \
	194	(bytes) = BYTES_BY_CHAR_HEAD (*(str))
	195
	196	/* The byte length of multibyte form at unibyte string P ending at
	197	PEND. If STR doesn't point a valid multibyte form, return 0. */
	198
	199	#define MULTIBYTE_LENGTH(p, pend) \
	200	(p >= pend ? 0 \
	201	: !((p)[0] & 0x80) ? 1 \
	202	: ((p + 1 >= pend) \|\| (((p)[1] & 0xC0) != 0x80)) ? 0 \
	203	: ((p)[0] & 0xE0) == 0xC0 ? 2 \
	204	: ((p + 2 >= pend) \|\| (((p)[2] & 0xC0) != 0x80)) ? 0 \
	205	: ((p)[0] & 0xF0) == 0xE0 ? 3 \
	206	: ((p + 3 >= pend) \|\| (((p)[3] & 0xC0) != 0x80)) ? 0 \
	207	: ((p)[0] & 0xF8) == 0xF0 ? 4 \
	208	: ((p + 4 >= pend) \|\| (((p)[4] & 0xC0) != 0x80)) ? 0 \
	209	: (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5 \
	210	: 0)
	211
	212
	213	/* Like MULTIBYTE_LENGTH but don't check the ending address. */
	214
	215	#define MULTIBYTE_LENGTH_NO_CHECK(p) \
	216	(!((p)[0] & 0x80) ? 1 \
	217	: ((p)[1] & 0xC0) != 0x80 ? 0 \
	218	: ((p)[0] & 0xE0) == 0xC0 ? 2 \
	219	: ((p)[2] & 0xC0) != 0x80 ? 0 \
	220	: ((p)[0] & 0xF0) == 0xE0 ? 3 \
	221	: ((p)[3] & 0xC0) != 0x80 ? 0 \
	222	: ((p)[0] & 0xF8) == 0xF0 ? 4 \
	223	: ((p)[4] & 0xC0) != 0x80 ? 0 \
	224	: (p)[0] == 0xF8 && ((p)[1] & 0xF0) == 0x80 ? 5 \
	225	: 0)
	226
	227
	228	/* Return the character code of character whose multibyte form is at
229	P. The argument LEN is ignored. It will be removed in the
230	future. */
231
232	#define STRING_CHAR(p, len) \
233	(!((p)[0] & 0x80) \
234	? (p)[0] \
235	: ! ((p)[0] & 0x20) \
236	? (((((p)[0] & 0x1F) << 6) \
237	\| ((p)[1] & 0x3F)) \
238	+ (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0)) \
239	: ! ((p)[0] & 0x10) \
240	? ((((p)[0] & 0x0F) << 12) \
241	\| (((p)[1] & 0x3F) << 6) \
242	\| ((p)[2] & 0x3F)) \
885317d8	243	: string_char_with_unification ((p), NULL, NULL))
0168c3d8 KH	244
	245
	246	/* Like STRING_CHAR but set ACTUAL_LEN to the length of multibyte
	247	form. The argument LEN is ignored. It will be removed in the
	248	future. */
	249
	250	#define STRING_CHAR_AND_LENGTH(p, len, actual_len) \
	251	(!((p)[0] & 0x80) \
	252	? ((actual_len) = 1, (p)[0]) \
	253	: ! ((p)[0] & 0x20) \
	254	? ((actual_len) = 2, \
	255	(((((p)[0] & 0x1F) << 6) \
	256	\| ((p)[1] & 0x3F)) \
	257	+ (((unsigned char) (p)[0]) < 0xC2 ? 0x3FFF80 : 0))) \
	258	: ! ((p)[0] & 0x10) \
	259	? ((actual_len) = 3, \
	260	((((p)[0] & 0x0F) << 12) \
	261	\| (((p)[1] & 0x3F) << 6) \
	262	\| ((p)[2] & 0x3F))) \
885317d8	263	: string_char_with_unification ((p), NULL, &actual_len))
0168c3d8 KH	264
	265
	266	/* Like STRING_CHAR but advacen P to the end of multibyte form. */
	267
	268	#define STRING_CHAR_ADVANCE(p) \
	269	(!((p)[0] & 0x80) \
	270	? *(p)++ \
	271	: ! ((p)[0] & 0x20) \
	272	? ((p) += 2, \
	273	((((p)[-2] & 0x1F) << 6) \
	274	\| ((p)[-1] & 0x3F) \
	275	\| (((unsigned char) (p)[-2]) < 0xC2 ? 0x3FFF80 : 0))) \
	276	: ! ((p)[0] & 0x10) \
	277	? ((p) += 3, \
	278	((((p)[-3] & 0x0F) << 12) \
	279	\| (((p)[-2] & 0x3F) << 6) \
	280	\| ((p)[-1] & 0x3F))) \
885317d8	281	: string_char_with_unification ((p), &(p), NULL))
0168c3d8 KH	282
	283
	284	/* Fetch the "next" character from Lisp string STRING at byte position
	285	BYTEIDX, character position CHARIDX. Store it into OUTPUT.
	286
	287	All the args must be side-effect-free.
	288	BYTEIDX and CHARIDX must be lvalues;
	289	we increment them past the character fetched. */
	290
	291	#define FETCH_STRING_CHAR_ADVANCE(OUTPUT, STRING, CHARIDX, BYTEIDX) \
	292	if (1) \
	293	{ \
	294	CHARIDX++; \
	295	if (STRING_MULTIBYTE (STRING)) \
	296	{ \
	297	unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX]; \
	298	int len; \
	299	\
	300	OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len); \
	301	BYTEIDX += len; \
	302	} \
	303	else \
	304	OUTPUT = XSTRING (STRING)->data[BYTEIDX++]; \
	305	} \
	306	else
	307
	308
	309	/* Like FETCH_STRING_CHAR_ADVANCE but assumes STRING is multibyte. */
	310
	311	#define FETCH_STRING_CHAR_ADVANCE_NO_CHECK(OUTPUT, STRING, CHARIDX, BYTEIDX) \
	312	if (1) \
	313	{ \
	314	unsigned char *ptr = &XSTRING (STRING)->data[BYTEIDX]; \
	315	int len; \
	316	\
	317	OUTPUT = STRING_CHAR_AND_LENGTH (ptr, 0, len); \
	318	BYTEIDX += len; \
	319	CHARIDX++; \
	320	} \
	321	else
	322
	323
	324	/* Like FETCH_STRING_CHAR_ADVANCE but fetch character from the current
	325	buffer. */
	326
	327	#define FETCH_CHAR_ADVANCE(OUTPUT, CHARIDX, BYTEIDX) \
	328	if (1) \
	329	{ \
	330	CHARIDX++; \
	331	if (!NILP (current_buffer->enable_multibyte_characters)) \
	332	{ \
	333	unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX); \
	334	int len; \
	335	\
	336	OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len); \
	337	BYTEIDX += len; \
	338	} \
	339	else \
	340	{ \
	341	OUTPUT = *(BYTE_POS_ADDR (BYTEIDX)); \
	342	BYTEIDX++; \
	343	} \
	344	} \
	345	else
346
347
348	/* Like FETCH_CHAR_ADVANCE but assumes STRING is multibyte. */
349
350	#define FETCH_CHAR_ADVANCE_NO_CHECK(OUTPUT, CHARIDX, BYTEIDX) \
351	if (1) \
352	{ \
353	unsigned char *ptr = BYTE_POS_ADDR (BYTEIDX); \
354	int len; \
355	\
356	OUTPUT= STRING_CHAR_AND_LENGTH (ptr, 0, len); \
357	BYTEIDX += len; \
358	CHARIDX++; \
359	} \
360	else
361
362
363	/* Increase the buffer byte position POS_BYTE of the current buffer to
364	the next character boundary. No range checking of POS. */
365
366	#define INC_POS(pos_byte) \
367	do { \
368	unsigned char *p = BYTE_POS_ADDR (pos_byte); \
369	pos_byte += BYTES_BY_CHAR_HEAD (*p); \
370	} while (0)
371
372
373	/* Decrease the buffer byte position POS_BYTE of the current buffer to
374	the previous character boundary. No range checking of POS. */
375
376	#define DEC_POS(pos_byte) \
377	do { \
378	unsigned char *p; \
379	\
380	pos_byte--; \
381	if (pos_byte < GPT_BYTE) \
382	p = BEG_ADDR + pos_byte - 1; \
383	else \
384	p = BEG_ADDR + GAP_SIZE + pos_byte - 1; \
385	while (!CHAR_HEAD_P (*p)) \
386	{ \
387	p--; \
388	pos_byte--; \
389	} \
390	} while (0)
391
392	/* Increment both CHARPOS and BYTEPOS, each in the appropriate way. */
393
394	#define INC_BOTH(charpos, bytepos) \
395	do \
396	{ \
397	(charpos)++; \
398	if (NILP (current_buffer->enable_multibyte_characters)) \
399	(bytepos)++; \
400	else \
401	INC_POS ((bytepos)); \
402	} \
403	while (0)
404
405
406	/* Decrement both CHARPOS and BYTEPOS, each in the appropriate way. */
407
408	#define DEC_BOTH(charpos, bytepos) \
409	do \
410	{ \
411	(charpos)--; \
412	if (NILP (current_buffer->enable_multibyte_characters)) \
413	(bytepos)--; \
414	else \
415	DEC_POS ((bytepos)); \
416	} \
417	while (0)
418
419
420	/* Increase the buffer byte position POS_BYTE of the current buffer to
421	the next character boundary. This macro relies on the fact that
422	GPT_ADDR and Z_ADDR are always accessible and the values are
423	'\0'. No range checking of POS_BYTE. */
424
425	#define BUF_INC_POS(buf, pos_byte) \
426	do { \
427	unsigned char *p = BUF_BYTE_ADDRESS (buf, pos_byte); \
428	pos_byte += BYTES_BY_CHAR_HEAD (*p); \
429	} while (0)
430
431
432	/* Decrease the buffer byte position POS_BYTE of the current buffer to
433	the previous character boundary. No range checking of POS_BYTE. */
434
435	#define BUF_DEC_POS(buf, pos_byte) \
436	do { \
437	unsigned char *p; \
438	pos_byte--; \
439	if (pos_byte < BUF_GPT_BYTE (buf)) \
440	p = BUF_BEG_ADDR (buf) + pos_byte - 1; \
441	else \
442	p = BUF_BEG_ADDR (buf) + BUF_GAP_SIZE (buf) + pos_byte - 1; \
443	while (!CHAR_HEAD_P (*p)) \
444	{ \
445	p--; \
446	pos_byte--; \
447	} \
448	} while (0)
449
450
fc9d9d2a KH	451	#define MAYBE_UNIFY_CHAR(c) \
	452	if (CHAR_TABLE_P (Vchar_unify_table)) \
	453	{ \
	454	Lisp_Object val; \
	455	int unified; \
	456	\
	457	val = CHAR_TABLE_REF (Vchar_unify_table, c); \
	458	if (! NILP (val)) \
	459	{ \
	460	if (SYMBOLP (val)) \
	461	{ \
	462	Funify_charset (val, Qnil); \
	463	val = CHAR_TABLE_REF (Vchar_unify_table, c); \
	464	} \
	465	if ((unified = XINT (val)) >= 0) \
	466	c = unified; \
	467	} \
	468	} \
0168c3d8 KH	469	else
0168c3d8 KH	470
fc9d9d2a	471
0168c3d8 KH	472	/* Return the width of ASCII character C. The width is measured by
	473	how many columns occupied on the screen when displayed in the
	474	current buffer. */
	475
	476	#define ASCII_CHAR_WIDTH(c) \
	477	(c < 0x20 \
	478	? (c == '\t' \
	479	? XFASTINT (current_buffer->tab_width) \
	480	: (c == '\n' ? 0 : (NILP (current_buffer->ctl_arrow) ? 4 : 2))) \
	481	: (c < 0x7f \
	482	? 1 \
	483	: ((NILP (current_buffer->ctl_arrow) ? 4 : 2))))
	484
	485	/* Return the width of character C. The width is measured by how many
	486	columns occupied on the screen when displayed in the current
	487	buffer. */
	488
	489	#define CHAR_WIDTH(c) \
	490	(ASCII_CHAR_P (c) \
	491	? ASCII_CHAR_WIDTH (c) \
	492	: XINT (CHAR_TABLE_REF (Vchar_width_table, c)))
	493
885317d8	494	extern int char_string_with_unification P_ ((int, unsigned char *));
0168c3d8 KH	495	extern int string_char_with_unification P_ ((unsigned char *,
	496	unsigned char *, int ));
	497
	498	extern int translate_char P_ ((Lisp_Object, int c));
	499	extern int char_printable_p P_ ((int c));
	500	extern void parse_str_as_multibyte P_ ((unsigned char , int, int , int *));
	501	extern int parse_str_to_multibyte P_ ((unsigned char *, int));
	502	extern int str_as_multibyte P_ ((unsigned char , int, int, int ));
	503	extern int str_to_multibyte P_ ((unsigned char *, int, int));
	504	extern int str_as_unibyte P_ ((unsigned char *, int));
	505	extern int strwidth P_ ((unsigned char *, int));
	506	extern int c_string_width P_ ((unsigned char , int, int, int , int *));
	507	extern int lisp_string_width P_ ((Lisp_Object, int, int , int ));
	508
	509	extern Lisp_Object Vprintable_chars;
	510
	511	extern Lisp_Object Qcharacterp, Qauto_fill_chars;
	512	extern Lisp_Object Vtranslation_table_vector;
	513	extern Lisp_Object Vchar_width_table;
	514	extern Lisp_Object Vchar_direction_table;
	515	extern Lisp_Object Vchar_unify_table;
	516
fac2bdc4 DL	517	extern Lisp_Object string_escape_byte8 P_ ((Lisp_Object));
fac2bdc4 DL	518
0168c3d8 KH	519	/* Return a translation table of id number ID. */
	520	#define GET_TRANSLATION_TABLE(id) \
	521	(XCDR(XVECTOR(Vtranslation_table_vector)->contents[(id)]))
	522
	523	/* A char-table for characters which may invoke auto-filling. */
	524	extern Lisp_Object Vauto_fill_chars;
	525
	526	/* Copy LEN bytes from FROM to TO. This macro should be used only
	527	when a caller knows that LEN is short and the obvious copy loop is
	528	faster than calling bcopy which has some overhead. Copying a
	529	multibyte sequence of a character is the typical case. */
	530
	531	#define BCOPY_SHORT(from, to, len) \
	532	do { \
	533	int i = len; \
	534	unsigned char from_p = from, to_p = to; \
	535	while (i--) to_p++ = from_p++; \
	536	} while (0)
	537
	538	#define DEFSYM(sym, name) \
	539	do { (sym) = intern ((name)); staticpro (&(sym)); } while (0)
	540
	541	#endif /* EMACS_CHARACTER_H */