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

/* Header for composite sequence handler.
   Copyright (C) 1999 Electrotechnical Laboratory, JAPAN.
     Licensed to the Free Software Foundation.
   Copyright (C) 2001 Free Software Foundation, Inc.
   Copyright (C) 2003
     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_COMPOSITE_H
#define EMACS_COMPOSITE_H

/* Methods to display a sequence of components 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,
  /* 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 iff 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					\
	  : COMPOSITION_WITH_RULE_ALTCHARS))))

/* Return 1 iff 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));
extern void compose_chars_in_text P_ ((int, int, Lisp_Object));

#endif /* not EMACS_COMPOSITE_H */

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