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

/* Header for composite sequence handler.
   Copyright (C) 2001, 2002, 2003, 2004, 2005,
                 2006, 2007, 2008 Free Software Foundation, Inc.
   Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021
   Copyright (C) 2003, 2006
     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 3 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef EMACS_COMPOSITE_H
#define EMACS_COMPOSITE_H

/* Methods to display a sequence of components of a composition.  */
enum composition_method {
  /* Compose relatively without alternate characters.  */
  COMPOSITION_RELATIVE,
  /* Compose by specified composition rules.  This is not used in
     Emacs 21 but we need it to decode files saved in the older
     versions of Emacs.  */
  COMPOSITION_WITH_RULE,
  /* Compose relatively with alternate characters.  */
  COMPOSITION_WITH_ALTCHARS,
  /* Compose by specified composition rules with alternate characters.  */
  COMPOSITION_WITH_RULE_ALTCHARS,
  /* Compose by specified lispy glyph-string.  */
  COMPOSITION_WITH_GLYPH_STRING,
  /* This is not a method.  */
  COMPOSITION_NO
};

/* Maximum number of compoments a single composition can have.  */
#define MAX_COMPOSITION_COMPONENTS 16

/* These macros access information about a composition that
   has `composition' property PROP.  PROP is:
	((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
   or
	(COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
   They don't check validity of PROP.  */

/* Temporary variable used only in the following macros.  */
extern Lisp_Object composition_temp;

/* Return 1 if the composition is already registered.  */
#define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))

/* Return ID number of the already registered composition.  */
#define COMPOSITION_ID(prop) XINT (XCAR (prop))

/* Return length of the composition.  */
#define COMPOSITION_LENGTH(prop)	\
  (COMPOSITION_REGISTERD_P (prop)	\
   ? XINT (XCAR (XCDR (prop)))		\
   : XINT (XCAR (XCAR (prop))))

/* Return components of the composition.  */
#define COMPOSITION_COMPONENTS(prop)	\
  (COMPOSITION_REGISTERD_P (prop)	\
   ? XCAR (XCDR (XCDR (prop)))		\
   : XCDR (XCAR (prop)))

/* Return modification function of the composition.  */
#define COMPOSITION_MODIFICATION_FUNC(prop)	\
  (COMPOSITION_REGISTERD_P (prop)		\
   ? XCDR (XCDR (XCDR (prop)))			\
   : CONSP (prop) ? XCDR (prop) : Qnil)

/* Return the method of composition.  */
#define COMPOSITION_METHOD(prop)					\
  (COMPOSITION_REGISTERD_P (prop)					\
   ? composition_table[COMPOSITION_ID (prop)]->method			\
   : (composition_temp = XCDR (XCAR (prop)),				\
      (NILP (composition_temp)						\
       ? COMPOSITION_RELATIVE						\
       : (INTEGERP (composition_temp) || STRINGP (composition_temp))	\
       ? COMPOSITION_WITH_ALTCHARS					\
       : (VECTORP (composition_temp)					\
	  && ASIZE (composition_temp) >= 2				\
	  && VECTORP (AREF (composition_temp, 0)))			\
       ? COMPOSITION_WITH_GLYPH_STRING					\
       : COMPOSITION_WITH_RULE_ALTCHARS)))

/* Return 1 if the composition is valid.  It is valid if length of
   the composition equals to (END - START).  */
#define COMPOSITION_VALID_P(start, end, prop)			\
  (CONSP (prop)							\
   && (COMPOSITION_REGISTERD_P (prop)				\
       ? (COMPOSITION_ID (prop) >= 0				\
	  && COMPOSITION_ID (prop) <= n_compositions		\
	  && CONSP (XCDR (prop)))				\
       : (composition_temp = XCAR (prop),			\
	  (CONSP (composition_temp)				\
	   && (composition_temp = XCDR (composition_temp),	\
	       (NILP (composition_temp)				\
		|| STRINGP (composition_temp)			\
		|| VECTORP (composition_temp)			\
		|| INTEGERP (composition_temp)			\
		|| CONSP (composition_temp))))))		\
   && (end - start) == COMPOSITION_LENGTH (prop))

/* Return the Nth glyph of composition specified by CMP.  CMP is a
   pointer to `struct composition'. */
#define COMPOSITION_GLYPH(cmp, n)					\
  XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table)		\
			  ->key_and_value)				\
		 ->contents[cmp->hash_index * 2])			\
	->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS	\
		  ? (n) * 2 : (n)])

/* Return the encoded composition rule to compose the Nth glyph of
   rule-base composition specified by CMP.  CMP is a pointer to
   `struct composition'. */
#define COMPOSITION_RULE(cmp, n)				\
  XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table)	\
			  ->key_and_value)			\
		 ->contents[cmp->hash_index * 2])		\
	->contents[(n) * 2 - 1])

/* Decode encoded composition rule RULE_CODE into GREF (global
   reference point code), NREF (new reference point code), XOFF
   (horizontal offset) YOFF (vertical offset).  Don't check RULE_CODE,
   always set GREF and NREF to valid values.  By side effect,
   RULE_CODE is modified.  */

#define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff)	\
  do {									\
    xoff = (rule_code) >> 16;						\
    yoff = ((rule_code) >> 8) & 0xFF;					\
    rule_code &= 0xFF;							\
    gref = (rule_code) / 12;						\
    if (gref > 12) gref = 11;						\
    nref = (rule_code) % 12;						\
  } while (0)

/* Return encoded composition rule for the pair of global reference
   point GREF and new reference point NREF.  If arguments are invalid,
   return -1. */
#define COMPOSITION_ENCODE_RULE(gref, nref)		\
  ((unsigned) (gref) < 12 && (unsigned) (nref) < 12	\
   ? (gref) * 12 + (nref) : -1)

/* Data structure that records information about a composition
   currently used in some buffers or strings.

   When a composition is assigned an ID number (by
   get_composition_id), this structure is allocated for the
   composition and linked in composition_table[ID].

   Identical compositions appearing at different places have the same
   ID, and thus share the same instance of this structure.  */

struct composition {
  /* Number of glyphs of the composition components.  */
  unsigned glyph_len;

  /* Width, ascent, and descent pixels of the composition.  */
  short pixel_width, ascent, descent;

  short lbearing, rbearing;

  /* How many columns the overall glyphs occupy on the screen.  This
     gives an approximate value for column calculation in
     Fcurrent_column, and etc.  */
  unsigned short width;

  /* Method of the composition.  */
  enum composition_method method;

  /* Index to the composition hash table.  */
  int hash_index;

  /* For which font we have calculated the remaining members.  The
     actual type is device dependent.  */
  void *font;

  /* Pointer to an array of x-offset and y-offset (by pixels) of
     glyphs.  This points to a sufficient memory space (sizeof (int) *
     glyph_len * 2) that is allocated when the composition is
     registered in composition_table.  X-offset and Y-offset of Nth
     glyph are (2N)th and (2N+1)th elements respectively.  */
  short *offsets;
};

/* Table of pointers to the structure `composition' indexed by
   COMPOSITION-ID.  */
extern struct composition **composition_table;
/* Number of the currently registered compositions.  */
extern int n_compositions;

/* Mask bits for CHECK_MASK arg to update_compositions.
   For a change in the region FROM and TO, check compositions ... */
#define CHECK_HEAD	1	/* adjacent to FROM */
#define CHECK_TAIL	2	/* adjacent to TO */
#define CHECK_INSIDE	4	/* between FROM and TO */
#define CHECK_BORDER	(CHECK_HEAD | CHECK_TAIL)
#define CHECK_ALL	(CHECK_BORDER | CHECK_INSIDE)

extern Lisp_Object Qcomposition;
extern Lisp_Object composition_hash_table;
extern Lisp_Object Qauto_composed;
extern Lisp_Object Vauto_composition_function;
extern Lisp_Object Qauto_composition_function;

extern int get_composition_id P_ ((int, int, int, Lisp_Object, Lisp_Object));
extern int find_composition P_ ((int, int, EMACS_INT *, EMACS_INT *, Lisp_Object *,
				 Lisp_Object));
extern void update_compositions P_ ((EMACS_INT, EMACS_INT, int));
extern void make_composition_value_copy P_ ((Lisp_Object));
extern void compose_region P_ ((int, int, Lisp_Object, Lisp_Object,
				Lisp_Object));
extern void syms_of_composite P_ ((void));
extern void compose_text P_ ((int, int, Lisp_Object, Lisp_Object,
			      Lisp_Object));

EXFUN (Fcompose_region_internal, 4);
EXFUN (Fcompose_string_internal, 5);

#endif /* not EMACS_COMPOSITE_H */

/* arch-tag: 59524d89-c645-47bd-b5e6-65e861690118
   (do not change this comment) */
Commit	Line	Data
ca4c9455	1	/* Header for composite sequence handler.
aaef169d	2	Copyright (C) 2001, 2002, 2003, 2004, 2005,
8cabe764 GM	3	2006, 2007, 2008 Free Software Foundation, Inc.
8cabe764 GM	4	Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
ce03bf76 KH	5	National Institute of Advanced Industrial Science and Technology (AIST)
ce03bf76 KH	6	Registration Number H14PRO021
028b54a0	7	Copyright (C) 2003, 2006
9f504898 KH	8	National Institute of Advanced Industrial Science and Technology (AIST)
9f504898 KH	9	Registration Number H13PRO009
ca4c9455 KH	10
	11	This file is part of GNU Emacs.
	12
b9b1cc14	13	GNU Emacs is free software: you can redistribute it and/or modify
ca4c9455	14	it under the terms of the GNU General Public License as published by
b9b1cc14 GM	15	the Free Software Foundation, either version 3 of the License, or
b9b1cc14 GM	16	(at your option) any later version.
ca4c9455 KH	17
	18	GNU Emacs is distributed in the hope that it will be useful,
	19	but WITHOUT ANY WARRANTY; without even the implied warranty of
	20	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	21	GNU General Public License for more details.
	22
	23	You should have received a copy of the GNU General Public License
b9b1cc14	24	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
ca4c9455	25
15a10ef1 KH	26	#ifndef EMACS_COMPOSITE_H
15a10ef1 KH	27	#define EMACS_COMPOSITE_H
ca4c9455	28
028b54a0	29	/* Methods to display a sequence of components of a composition. */
ca4c9455	30	enum composition_method {
ca4c9455 KH	31	/* Compose relatively without alternate characters. */
ca4c9455 KH	32	COMPOSITION_RELATIVE,
9f504898 KH	33	/* Compose by specified composition rules. This is not used in
	34	Emacs 21 but we need it to decode files saved in the older
	35	versions of Emacs. */
ca4c9455 KH	36	COMPOSITION_WITH_RULE,
	37	/* Compose relatively with alternate characters. */
	38	COMPOSITION_WITH_ALTCHARS,
9f504898 KH	39	/* Compose by specified composition rules with alternate characters. */
9f504898 KH	40	COMPOSITION_WITH_RULE_ALTCHARS,
028b54a0 KH	41	/* Compose by specified lispy glyph-string. */
028b54a0 KH	42	COMPOSITION_WITH_GLYPH_STRING,
9f504898 KH	43	/* This is not a method. */
9f504898 KH	44	COMPOSITION_NO
ca4c9455 KH	45	};
	46
	47	/* Maximum number of compoments a single composition can have. */
	48	#define MAX_COMPOSITION_COMPONENTS 16
	49
	50	/* These macros access information about a composition that
	51	has `composition' property PROP. PROP is:
	52	((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
	53	or
	54	(COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
	55	They don't check validity of PROP. */
	56
	57	/* Temporary variable used only in the following macros. */
	58	extern Lisp_Object composition_temp;
	59
e0f24100	60	/* Return 1 if the composition is already registered. */
ca4c9455 KH	61	#define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))
	62
	63	/* Return ID number of the already registered composition. */
	64	#define COMPOSITION_ID(prop) XINT (XCAR (prop))
	65
	66	/* Return length of the composition. */
	67	#define COMPOSITION_LENGTH(prop) \
	68	(COMPOSITION_REGISTERD_P (prop) \
	69	? XINT (XCAR (XCDR (prop))) \
	70	: XINT (XCAR (XCAR (prop))))
	71
	72	/* Return components of the composition. */
	73	#define COMPOSITION_COMPONENTS(prop) \
	74	(COMPOSITION_REGISTERD_P (prop) \
	75	? XCAR (XCDR (XCDR (prop))) \
	76	: XCDR (XCAR (prop)))
	77
	78	/* Return modification function of the composition. */
	79	#define COMPOSITION_MODIFICATION_FUNC(prop) \
	80	(COMPOSITION_REGISTERD_P (prop) \
	81	? XCDR (XCDR (XCDR (prop))) \
c1de6316	82	: CONSP (prop) ? XCDR (prop) : Qnil)
ca4c9455 KH	83
	84	/* Return the method of composition. */
	85	#define COMPOSITION_METHOD(prop) \
	86	(COMPOSITION_REGISTERD_P (prop) \
	87	? composition_table[COMPOSITION_ID (prop)]->method \
	88	: (composition_temp = XCDR (XCAR (prop)), \
	89	(NILP (composition_temp) \
	90	? COMPOSITION_RELATIVE \
48bb1088 KH	91	: (INTEGERP (composition_temp) \|\| STRINGP (composition_temp)) \
	92	? COMPOSITION_WITH_ALTCHARS \
	93	: (VECTORP (composition_temp) \
	94	&& ASIZE (composition_temp) >= 2 \
	95	&& VECTORP (AREF (composition_temp, 0))) \
	96	? COMPOSITION_WITH_GLYPH_STRING \
	97	: COMPOSITION_WITH_RULE_ALTCHARS)))
ca4c9455	98
e0f24100	99	/* Return 1 if the composition is valid. It is valid if length of
ca4c9455	100	the composition equals to (END - START). */
1f36b2fc GM	101	#define COMPOSITION_VALID_P(start, end, prop) \
	102	(CONSP (prop) \
	103	&& (COMPOSITION_REGISTERD_P (prop) \
	104	? (COMPOSITION_ID (prop) >= 0 \
	105	&& COMPOSITION_ID (prop) <= n_compositions \
	106	&& CONSP (XCDR (prop))) \
	107	: (composition_temp = XCAR (prop), \
	108	(CONSP (composition_temp) \
	109	&& (composition_temp = XCDR (composition_temp), \
	110	(NILP (composition_temp) \
	111	\|\| STRINGP (composition_temp) \
	112	\|\| VECTORP (composition_temp) \
	113	\|\| INTEGERP (composition_temp) \
	114	\|\| CONSP (composition_temp)))))) \
ca4c9455 KH	115	&& (end - start) == COMPOSITION_LENGTH (prop))
	116
	117	/* Return the Nth glyph of composition specified by CMP. CMP is a
	118	pointer to `struct composition'. */
	119	#define COMPOSITION_GLYPH(cmp, n) \
	120	XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
	121	->key_and_value) \
	122	->contents[cmp->hash_index * 2]) \
	123	->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS \
	124	? (n) * 2 : (n)])
	125
	126	/* Return the encoded composition rule to compose the Nth glyph of
	127	rule-base composition specified by CMP. CMP is a pointer to
	128	`struct composition'. */
	129	#define COMPOSITION_RULE(cmp, n) \
	130	XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
	131	->key_and_value) \
	132	->contents[cmp->hash_index * 2]) \
	133	->contents[(n) * 2 - 1])
	134
	135	/* Decode encoded composition rule RULE_CODE into GREF (global
28d0edc7 KH	136	reference point code), NREF (new reference point code), XOFF
	137	(horizontal offset) YOFF (vertical offset). Don't check RULE_CODE,
	138	always set GREF and NREF to valid values. By side effect,
	139	RULE_CODE is modified. */
	140
	141	#define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff) \
	142	do { \
	143	xoff = (rule_code) >> 16; \
	144	yoff = ((rule_code) >> 8) & 0xFF; \
	145	rule_code &= 0xFF; \
	146	gref = (rule_code) / 12; \
	147	if (gref > 12) gref = 11; \
	148	nref = (rule_code) % 12; \
ca4c9455 KH	149	} while (0)
	150
	151	/* Return encoded composition rule for the pair of global reference
	152	point GREF and new reference point NREF. If arguments are invalid,
	153	return -1. */
	154	#define COMPOSITION_ENCODE_RULE(gref, nref) \
	155	((unsigned) (gref) < 12 && (unsigned) (nref) < 12 \
	156	? (gref) * 12 + (nref) : -1)
	157
	158	/* Data structure that records information about a composition
	159	currently used in some buffers or strings.
	160
	161	When a composition is assigned an ID number (by
	162	get_composition_id), this structure is allocated for the
177c0ea7	163	composition and linked in composition_table[ID].
ca4c9455 KH	164
	165	Identical compositions appearing at different places have the same
	166	ID, and thus share the same instance of this structure. */
	167
	168	struct composition {
ca4c9455	169	/* Number of glyphs of the composition components. */
28cd4910	170	unsigned glyph_len;
ca4c9455	171
51e31f7a KH	172	/* Width, ascent, and descent pixels of the composition. */
	173	short pixel_width, ascent, descent;
	174
28d0edc7 KH	175	short lbearing, rbearing;
28d0edc7 KH	176
28cd4910 KH	177	/* How many columns the overall glyphs occupy on the screen. This
	178	gives an approximate value for column calculation in
	179	Fcurrent_column, and etc. */
	180	unsigned short width;
	181
ca4c9455 KH	182	/* Method of the composition. */
	183	enum composition_method method;
	184
	185	/* Index to the composition hash table. */
	186	int hash_index;
	187
	188	/* For which font we have calculated the remaining members. The
	189	actual type is device dependent. */
	190	void *font;
	191
	192	/* Pointer to an array of x-offset and y-offset (by pixels) of
	193	glyphs. This points to a sufficient memory space (sizeof (int) *
	194	glyph_len * 2) that is allocated when the composition is
	195	registered in composition_table. X-offset and Y-offset of Nth
	196	glyph are (2N)th and (2N+1)th elements respectively. */
	197	short *offsets;
ca4c9455 KH	198	};
	199
	200	/* Table of pointers to the structure `composition' indexed by
	201	COMPOSITION-ID. */
	202	extern struct composition **composition_table;
	203	/* Number of the currently registered compositions. */
	204	extern int n_compositions;
	205
	206	/* Mask bits for CHECK_MASK arg to update_compositions.
	207	For a change in the region FROM and TO, check compositions ... */
	208	#define CHECK_HEAD 1 /* adjacent to FROM */
	209	#define CHECK_TAIL 2 /* adjacent to TO */
	210	#define CHECK_INSIDE 4 /* between FROM and TO */
	211	#define CHECK_BORDER (CHECK_HEAD \| CHECK_TAIL)
	212	#define CHECK_ALL (CHECK_BORDER \| CHECK_INSIDE)
	213
	214	extern Lisp_Object Qcomposition;
	215	extern Lisp_Object composition_hash_table;
382a2913 KH	216	extern Lisp_Object Qauto_composed;
	217	extern Lisp_Object Vauto_composition_function;
	218	extern Lisp_Object Qauto_composition_function;
ca4c9455 KH	219
ca4c9455 KH	220	extern int get_composition_id P_ ((int, int, int, Lisp_Object, Lisp_Object));
72ac5ed6	221	extern int find_composition P_ ((int, int, EMACS_INT , EMACS_INT , Lisp_Object *,
ca4c9455	222	Lisp_Object));
72ac5ed6	223	extern void update_compositions P_ ((EMACS_INT, EMACS_INT, int));
4a8c194f	224	extern void make_composition_value_copy P_ ((Lisp_Object));
ca4c9455 KH	225	extern void compose_region P_ ((int, int, Lisp_Object, Lisp_Object,
ca4c9455 KH	226	Lisp_Object));
b5b80599	227	extern void syms_of_composite P_ ((void));
f9beddb2 DL	228	extern void compose_text P_ ((int, int, Lisp_Object, Lisp_Object,
f9beddb2 DL	229	Lisp_Object));
ca4c9455	230
15139d67 SM	231	EXFUN (Fcompose_region_internal, 4);
	232	EXFUN (Fcompose_string_internal, 5);
	233
15a10ef1	234	#endif /* not EMACS_COMPOSITE_H */
6b61353c KH	235
	236	/* arch-tag: 59524d89-c645-47bd-b5e6-65e861690118
	237	(do not change this comment) */