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

/* Header for composite sequence handler.
   Copyright (C) 2001-2011 Free Software Foundation, Inc.
   Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
     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,
  /* 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					\
       : 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 ref. point code).  Don't check RULE_CODE;
   always set GREF and NREF to valid values.  By side effect,
   RULE_CODE is modified.  */

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

/* Like COMPOSITION_DECODE_REFS (RULE_CODE, GREF, NREF), but also
   decode RULE_CODE into XOFF and YOFF (vertical offset).  */

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

/* Nonzero if the global reference point GREF and new reference point NREF are
   valid.  */
#define COMPOSITION_ENCODE_RULE_VALID(gref, nref)	\
  ((unsigned) (gref) < 12 && (unsigned) (nref) < 12)

/* Return encoded composition rule for the pair of global reference
   point GREF and new reference point NREF.  Arguments must be valid.  */
#define COMPOSITION_ENCODE_RULE(gref, nref)		\
  ((gref) * 12 + (nref))

/* 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.  */
  EMACS_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 int get_composition_id (EMACS_INT, EMACS_INT, EMACS_INT,
			       Lisp_Object, Lisp_Object);
extern int find_composition (EMACS_INT, EMACS_INT, EMACS_INT *, EMACS_INT *,
			     Lisp_Object *, Lisp_Object);
extern void update_compositions (EMACS_INT, EMACS_INT, int);
extern void make_composition_value_copy (Lisp_Object);
extern void compose_region (int, int, Lisp_Object, Lisp_Object,
                            Lisp_Object);
extern void syms_of_composite (void);
extern void compose_text (EMACS_INT, EMACS_INT, Lisp_Object, Lisp_Object,
                          Lisp_Object);

/* Macros for lispy glyph-string.  This is completely different from
   struct glyph_string.  */

#define LGSTRING_HEADER(lgs) AREF (lgs, 0)
#define LGSTRING_SET_HEADER(lgs, header) ASET (lgs, 0, header)

#define LGSTRING_FONT(lgs) AREF (LGSTRING_HEADER (lgs), 0)
#define LGSTRING_CHAR(lgs, i) AREF (LGSTRING_HEADER (lgs), (i) + 1)
#define LGSTRING_CHAR_LEN(lgs) (ASIZE (LGSTRING_HEADER (lgs)) - 1)

#define LGSTRING_SET_FONT(lgs, val) ASET (LGSTRING_HEADER (lgs), 0, (val))
#define LGSTRING_SET_CHAR(lgs, i, c) ASET (LGSTRING_HEADER (lgs), (i) + 1, (c))

#define LGSTRING_ID(lgs) AREF (lgs, 1)
#define LGSTRING_SET_ID(lgs, id) ASET (lgs, 1, id)

#define LGSTRING_GLYPH_LEN(lgs) (ASIZE ((lgs)) - 2)
#define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 2)
#define LGSTRING_SET_GLYPH(lgs, idx, val) ASET ((lgs), (idx) + 2, (val))

/* Vector size of Lispy glyph.  */
enum lglyph_indices
  {
    LGLYPH_IX_FROM, LGLYPH_IX_TO,  LGLYPH_IX_CHAR, LGLYPH_IX_CODE,
    LGLYPH_IX_WIDTH, LGLYPH_IX_LBEARING, LGLYPH_IX_RBEARING,
    LGLYPH_IX_ASCENT, LGLYPH_IX_DESCENT, LGLYPH_IX_ADJUSTMENT,
    /* Not an index.  */
    LGLYPH_SIZE
  };

#define LGLYPH_NEW() Fmake_vector (make_number (LGLYPH_SIZE), Qnil)
#define LGLYPH_FROM(g) XINT (AREF ((g), LGLYPH_IX_FROM))
#define LGLYPH_TO(g) XINT (AREF ((g), LGLYPH_IX_TO))
#define LGLYPH_CHAR(g) XINT (AREF ((g), LGLYPH_IX_CHAR))
#define LGLYPH_CODE(g)						\
  (NILP (AREF ((g), LGLYPH_IX_CODE))				\
   ? FONT_INVALID_CODE						\
   : cons_to_unsigned (AREF (g, LGLYPH_IX_CODE), TYPE_MAXIMUM (unsigned)))
#define LGLYPH_WIDTH(g) XINT (AREF ((g), LGLYPH_IX_WIDTH))
#define LGLYPH_LBEARING(g) XINT (AREF ((g), LGLYPH_IX_LBEARING))
#define LGLYPH_RBEARING(g) XINT (AREF ((g), LGLYPH_IX_RBEARING))
#define LGLYPH_ASCENT(g) XINT (AREF ((g), LGLYPH_IX_ASCENT))
#define LGLYPH_DESCENT(g) XINT (AREF ((g), LGLYPH_IX_DESCENT))
#define LGLYPH_ADJUSTMENT(g) AREF ((g), LGLYPH_IX_ADJUSTMENT)
#define LGLYPH_SET_FROM(g, val) ASET ((g), LGLYPH_IX_FROM, make_number (val))
#define LGLYPH_SET_TO(g, val) ASET ((g), LGLYPH_IX_TO, make_number (val))
#define LGLYPH_SET_CHAR(g, val) ASET ((g), LGLYPH_IX_CHAR, make_number (val))
/* Callers must assure that VAL is not negative!  */
#define LGLYPH_SET_CODE(g, val)						\
  ASET (g, LGLYPH_IX_CODE,						\
	val == FONT_INVALID_CODE ? Qnil : INTEGER_TO_CONS (val))

#define LGLYPH_SET_WIDTH(g, val) ASET ((g), LGLYPH_IX_WIDTH, make_number (val))
#define LGLYPH_SET_LBEARING(g, val) ASET ((g), LGLYPH_IX_LBEARING, make_number (val))
#define LGLYPH_SET_RBEARING(g, val) ASET ((g), LGLYPH_IX_RBEARING, make_number (val))
#define LGLYPH_SET_ASCENT(g, val) ASET ((g), LGLYPH_IX_ASCENT, make_number (val))
#define LGLYPH_SET_DESCENT(g, val) ASET ((g), LGLYPH_IX_DESCENT, make_number (val))
#define LGLYPH_SET_ADJUSTMENT(g, val) ASET ((g), LGLYPH_IX_ADJUSTMENT, (val))

#define LGLYPH_XOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
			? XINT (AREF (LGLYPH_ADJUSTMENT (g), 0)) : 0)
#define LGLYPH_YOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
			? XINT (AREF (LGLYPH_ADJUSTMENT (g), 1)) : 0)
#define LGLYPH_WADJUST(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
			   ? XINT (AREF (LGLYPH_ADJUSTMENT (g), 2)) : 0)

struct composition_it;
struct face;
struct font_metrics;

extern Lisp_Object composition_gstring_put_cache (Lisp_Object, EMACS_INT);
extern Lisp_Object composition_gstring_from_id (int);
extern int composition_gstring_p (Lisp_Object);
extern int composition_gstring_width (Lisp_Object, EMACS_INT, EMACS_INT,
                                      struct font_metrics *);

extern void composition_compute_stop_pos (struct composition_it *,
                                          EMACS_INT, EMACS_INT, EMACS_INT,
                                          Lisp_Object);
extern int composition_reseat_it (struct composition_it *,
                                  EMACS_INT, EMACS_INT, EMACS_INT,
                                  struct window *, struct face *,
                                  Lisp_Object);
extern int composition_update_it (struct composition_it *,
                                  EMACS_INT, EMACS_INT, Lisp_Object);

extern EMACS_INT composition_adjust_point (EMACS_INT, EMACS_INT);

#endif /* not EMACS_COMPOSITE_H */
Commit	Line	Data
ca4c9455	1	/* Header for composite sequence handler.
73b0cd50	2	Copyright (C) 2001-2011 Free Software Foundation, Inc.
5df4f04c	3	Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
ce03bf76 KH	4	National Institute of Advanced Industrial Science and Technology (AIST)
ce03bf76 KH	5	Registration Number H14PRO021
028b54a0	6	Copyright (C) 2003, 2006
9f504898 KH	7	National Institute of Advanced Industrial Science and Technology (AIST)
9f504898 KH	8	Registration Number H13PRO009
ca4c9455 KH	9
	10	This file is part of GNU Emacs.
	11
b9b1cc14	12	GNU Emacs is free software: you can redistribute it and/or modify
ca4c9455	13	it under the terms of the GNU General Public License as published by
b9b1cc14 GM	14	the Free Software Foundation, either version 3 of the License, or
b9b1cc14 GM	15	(at your option) any later version.
ca4c9455 KH	16
	17	GNU Emacs is distributed in the hope that it will be useful,
	18	but WITHOUT ANY WARRANTY; without even the implied warranty of
	19	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	20	GNU General Public License for more details.
	21
	22	You should have received a copy of the GNU General Public License
b9b1cc14	23	along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
ca4c9455	24
15a10ef1 KH	25	#ifndef EMACS_COMPOSITE_H
15a10ef1 KH	26	#define EMACS_COMPOSITE_H
ca4c9455	27
028b54a0	28	/* Methods to display a sequence of components of a composition. */
ca4c9455	29	enum composition_method {
ca4c9455 KH	30	/* Compose relatively without alternate characters. */
ca4c9455 KH	31	COMPOSITION_RELATIVE,
9f504898 KH	32	/* Compose by specified composition rules. This is not used in
	33	Emacs 21 but we need it to decode files saved in the older
	34	versions of Emacs. */
ca4c9455 KH	35	COMPOSITION_WITH_RULE,
	36	/* Compose relatively with alternate characters. */
	37	COMPOSITION_WITH_ALTCHARS,
9f504898 KH	38	/* Compose by specified composition rules with alternate characters. */
	39	COMPOSITION_WITH_RULE_ALTCHARS,
	40	/* This is not a method. */
	41	COMPOSITION_NO
ca4c9455 KH	42	};
	43
	44	/* Maximum number of compoments a single composition can have. */
	45	#define MAX_COMPOSITION_COMPONENTS 16
	46
	47	/* These macros access information about a composition that
	48	has `composition' property PROP. PROP is:
	49	((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
	50	or
	51	(COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
	52	They don't check validity of PROP. */
	53
	54	/* Temporary variable used only in the following macros. */
	55	extern Lisp_Object composition_temp;
	56
e0f24100	57	/* Return 1 if the composition is already registered. */
ca4c9455 KH	58	#define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))
	59
	60	/* Return ID number of the already registered composition. */
	61	#define COMPOSITION_ID(prop) XINT (XCAR (prop))
	62
	63	/* Return length of the composition. */
	64	#define COMPOSITION_LENGTH(prop) \
	65	(COMPOSITION_REGISTERD_P (prop) \
	66	? XINT (XCAR (XCDR (prop))) \
	67	: XINT (XCAR (XCAR (prop))))
	68
	69	/* Return components of the composition. */
	70	#define COMPOSITION_COMPONENTS(prop) \
	71	(COMPOSITION_REGISTERD_P (prop) \
	72	? XCAR (XCDR (XCDR (prop))) \
	73	: XCDR (XCAR (prop)))
	74
	75	/* Return modification function of the composition. */
	76	#define COMPOSITION_MODIFICATION_FUNC(prop) \
	77	(COMPOSITION_REGISTERD_P (prop) \
	78	? XCDR (XCDR (XCDR (prop))) \
c1de6316	79	: CONSP (prop) ? XCDR (prop) : Qnil)
ca4c9455 KH	80
	81	/* Return the method of composition. */
	82	#define COMPOSITION_METHOD(prop) \
	83	(COMPOSITION_REGISTERD_P (prop) \
	84	? composition_table[COMPOSITION_ID (prop)]->method \
	85	: (composition_temp = XCDR (XCAR (prop)), \
	86	(NILP (composition_temp) \
	87	? COMPOSITION_RELATIVE \
48bb1088 KH	88	: (INTEGERP (composition_temp) \|\| STRINGP (composition_temp)) \
48bb1088 KH	89	? COMPOSITION_WITH_ALTCHARS \
48bb1088	90	: COMPOSITION_WITH_RULE_ALTCHARS)))
ca4c9455	91
e0f24100	92	/* Return 1 if the composition is valid. It is valid if length of
ca4c9455	93	the composition equals to (END - START). */
1f36b2fc GM	94	#define COMPOSITION_VALID_P(start, end, prop) \
	95	(CONSP (prop) \
	96	&& (COMPOSITION_REGISTERD_P (prop) \
	97	? (COMPOSITION_ID (prop) >= 0 \
	98	&& COMPOSITION_ID (prop) <= n_compositions \
	99	&& CONSP (XCDR (prop))) \
	100	: (composition_temp = XCAR (prop), \
	101	(CONSP (composition_temp) \
	102	&& (composition_temp = XCDR (composition_temp), \
	103	(NILP (composition_temp) \
	104	\|\| STRINGP (composition_temp) \
	105	\|\| VECTORP (composition_temp) \
	106	\|\| INTEGERP (composition_temp) \
	107	\|\| CONSP (composition_temp)))))) \
ca4c9455 KH	108	&& (end - start) == COMPOSITION_LENGTH (prop))
	109
	110	/* Return the Nth glyph of composition specified by CMP. CMP is a
	111	pointer to `struct composition'. */
	112	#define COMPOSITION_GLYPH(cmp, n) \
	113	XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
	114	->key_and_value) \
	115	->contents[cmp->hash_index * 2]) \
	116	->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS \
	117	? (n) * 2 : (n)])
	118
	119	/* Return the encoded composition rule to compose the Nth glyph of
	120	rule-base composition specified by CMP. CMP is a pointer to
	121	`struct composition'. */
	122	#define COMPOSITION_RULE(cmp, n) \
	123	XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table) \
	124	->key_and_value) \
	125	->contents[cmp->hash_index * 2]) \
	126	->contents[(n) * 2 - 1])
	127
	128	/* Decode encoded composition rule RULE_CODE into GREF (global
b13a45c6	129	reference point code), NREF (new ref. point code). Don't check RULE_CODE;
28d0edc7 KH	130	always set GREF and NREF to valid values. By side effect,
	131	RULE_CODE is modified. */
	132
b13a45c6	133	#define COMPOSITION_DECODE_REFS(rule_code, gref, nref) \
28d0edc7	134	do { \
28d0edc7 KH	135	rule_code &= 0xFF; \
	136	gref = (rule_code) / 12; \
	137	if (gref > 12) gref = 11; \
	138	nref = (rule_code) % 12; \
ca4c9455 KH	139	} while (0)
ca4c9455 KH	140
b13a45c6 PE	141	/* Like COMPOSITION_DECODE_REFS (RULE_CODE, GREF, NREF), but also
	142	decode RULE_CODE into XOFF and YOFF (vertical offset). */
	143
	144	#define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff) \
	145	do { \
	146	xoff = (rule_code) >> 16; \
	147	yoff = ((rule_code) >> 8) & 0xFF; \
	148	COMPOSITION_DECODE_REFS (rule_code, gref, nref); \
	149	} while (0)
	150
d5efd1d1 PE	151	/* Nonzero if the global reference point GREF and new reference point NREF are
	152	valid. */
	153	#define COMPOSITION_ENCODE_RULE_VALID(gref, nref) \
	154	((unsigned) (gref) < 12 && (unsigned) (nref) < 12)
	155
ca4c9455	156	/* Return encoded composition rule for the pair of global reference
d5efd1d1	157	point GREF and new reference point NREF. Arguments must be valid. */
ca4c9455	158	#define COMPOSITION_ENCODE_RULE(gref, nref) \
d5efd1d1	159	((gref) * 12 + (nref))
ca4c9455 KH	160
	161	/* Data structure that records information about a composition
	162	currently used in some buffers or strings.
	163
	164	When a composition is assigned an ID number (by
	165	get_composition_id), this structure is allocated for the
177c0ea7	166	composition and linked in composition_table[ID].
ca4c9455 KH	167
	168	Identical compositions appearing at different places have the same
	169	ID, and thus share the same instance of this structure. */
	170
	171	struct composition {
ca4c9455	172	/* Number of glyphs of the composition components. */
28cd4910	173	unsigned glyph_len;
ca4c9455	174
51e31f7a KH	175	/* Width, ascent, and descent pixels of the composition. */
	176	short pixel_width, ascent, descent;
	177
28d0edc7 KH	178	short lbearing, rbearing;
28d0edc7 KH	179
28cd4910 KH	180	/* How many columns the overall glyphs occupy on the screen. This
	181	gives an approximate value for column calculation in
	182	Fcurrent_column, and etc. */
	183	unsigned short width;
	184
ca4c9455 KH	185	/* Method of the composition. */
	186	enum composition_method method;
	187
	188	/* Index to the composition hash table. */
0de4bb68	189	EMACS_INT hash_index;
ca4c9455 KH	190
	191	/* For which font we have calculated the remaining members. The
	192	actual type is device dependent. */
	193	void *font;
	194
	195	/* Pointer to an array of x-offset and y-offset (by pixels) of
	196	glyphs. This points to a sufficient memory space (sizeof (int) *
	197	glyph_len * 2) that is allocated when the composition is
	198	registered in composition_table. X-offset and Y-offset of Nth
	199	glyph are (2N)th and (2N+1)th elements respectively. */
	200	short *offsets;
ca4c9455 KH	201	};
	202
	203	/* Table of pointers to the structure `composition' indexed by
	204	COMPOSITION-ID. */
	205	extern struct composition **composition_table;
	206	/* Number of the currently registered compositions. */
	207	extern int n_compositions;
	208
	209	/* Mask bits for CHECK_MASK arg to update_compositions.
	210	For a change in the region FROM and TO, check compositions ... */
	211	#define CHECK_HEAD 1 /* adjacent to FROM */
	212	#define CHECK_TAIL 2 /* adjacent to TO */
	213	#define CHECK_INSIDE 4 /* between FROM and TO */
	214	#define CHECK_BORDER (CHECK_HEAD \| CHECK_TAIL)
	215	#define CHECK_ALL (CHECK_BORDER \| CHECK_INSIDE)
	216
	217	extern Lisp_Object Qcomposition;
	218	extern Lisp_Object composition_hash_table;
579c18d0 EZ	219	extern int get_composition_id (EMACS_INT, EMACS_INT, EMACS_INT,
	220	Lisp_Object, Lisp_Object);
	221	extern int find_composition (EMACS_INT, EMACS_INT, EMACS_INT , EMACS_INT ,
	222	Lisp_Object *, Lisp_Object);
383e0970 J	223	extern void update_compositions (EMACS_INT, EMACS_INT, int);
	224	extern void make_composition_value_copy (Lisp_Object);
	225	extern void compose_region (int, int, Lisp_Object, Lisp_Object,
	226	Lisp_Object);
	227	extern void syms_of_composite (void);
579c18d0	228	extern void compose_text (EMACS_INT, EMACS_INT, Lisp_Object, Lisp_Object,
383e0970	229	Lisp_Object);
ca4c9455	230
6e8b8329 KH	231	/* Macros for lispy glyph-string. This is completely different from
	232	struct glyph_string. */
	233
	234	#define LGSTRING_HEADER(lgs) AREF (lgs, 0)
	235	#define LGSTRING_SET_HEADER(lgs, header) ASET (lgs, 0, header)
	236
	237	#define LGSTRING_FONT(lgs) AREF (LGSTRING_HEADER (lgs), 0)
	238	#define LGSTRING_CHAR(lgs, i) AREF (LGSTRING_HEADER (lgs), (i) + 1)
	239	#define LGSTRING_CHAR_LEN(lgs) (ASIZE (LGSTRING_HEADER (lgs)) - 1)
	240
	241	#define LGSTRING_SET_FONT(lgs, val) ASET (LGSTRING_HEADER (lgs), 0, (val))
	242	#define LGSTRING_SET_CHAR(lgs, i, c) ASET (LGSTRING_HEADER (lgs), (i) + 1, (c))
	243
	244	#define LGSTRING_ID(lgs) AREF (lgs, 1)
	245	#define LGSTRING_SET_ID(lgs, id) ASET (lgs, 1, id)
	246
	247	#define LGSTRING_GLYPH_LEN(lgs) (ASIZE ((lgs)) - 2)
	248	#define LGSTRING_GLYPH(lgs, idx) AREF ((lgs), (idx) + 2)
	249	#define LGSTRING_SET_GLYPH(lgs, idx, val) ASET ((lgs), (idx) + 2, (val))
	250
	251	/* Vector size of Lispy glyph. */
	252	enum lglyph_indices
	253	{
	254	LGLYPH_IX_FROM, LGLYPH_IX_TO, LGLYPH_IX_CHAR, LGLYPH_IX_CODE,
	255	LGLYPH_IX_WIDTH, LGLYPH_IX_LBEARING, LGLYPH_IX_RBEARING,
	256	LGLYPH_IX_ASCENT, LGLYPH_IX_DESCENT, LGLYPH_IX_ADJUSTMENT,
	257	/* Not an index. */
	258	LGLYPH_SIZE
	259	};
	260
	261	#define LGLYPH_NEW() Fmake_vector (make_number (LGLYPH_SIZE), Qnil)
	262	#define LGLYPH_FROM(g) XINT (AREF ((g), LGLYPH_IX_FROM))
	263	#define LGLYPH_TO(g) XINT (AREF ((g), LGLYPH_IX_TO))
	264	#define LGLYPH_CHAR(g) XINT (AREF ((g), LGLYPH_IX_CHAR))
	265	#define LGLYPH_CODE(g) \
	266	(NILP (AREF ((g), LGLYPH_IX_CODE)) \
	267	? FONT_INVALID_CODE \
be44ca6c	268	: cons_to_unsigned (AREF (g, LGLYPH_IX_CODE), TYPE_MAXIMUM (unsigned)))
6e8b8329 KH	269	#define LGLYPH_WIDTH(g) XINT (AREF ((g), LGLYPH_IX_WIDTH))
	270	#define LGLYPH_LBEARING(g) XINT (AREF ((g), LGLYPH_IX_LBEARING))
	271	#define LGLYPH_RBEARING(g) XINT (AREF ((g), LGLYPH_IX_RBEARING))
	272	#define LGLYPH_ASCENT(g) XINT (AREF ((g), LGLYPH_IX_ASCENT))
	273	#define LGLYPH_DESCENT(g) XINT (AREF ((g), LGLYPH_IX_DESCENT))
	274	#define LGLYPH_ADJUSTMENT(g) AREF ((g), LGLYPH_IX_ADJUSTMENT)
	275	#define LGLYPH_SET_FROM(g, val) ASET ((g), LGLYPH_IX_FROM, make_number (val))
	276	#define LGLYPH_SET_TO(g, val) ASET ((g), LGLYPH_IX_TO, make_number (val))
	277	#define LGLYPH_SET_CHAR(g, val) ASET ((g), LGLYPH_IX_CHAR, make_number (val))
fdcb19ca	278	/* Callers must assure that VAL is not negative! */
6e8b8329	279	#define LGLYPH_SET_CODE(g, val) \
be44ca6c PE	280	ASET (g, LGLYPH_IX_CODE, \
be44ca6c PE	281	val == FONT_INVALID_CODE ? Qnil : INTEGER_TO_CONS (val))
b13a45c6	282
6e8b8329 KH	283	#define LGLYPH_SET_WIDTH(g, val) ASET ((g), LGLYPH_IX_WIDTH, make_number (val))
	284	#define LGLYPH_SET_LBEARING(g, val) ASET ((g), LGLYPH_IX_LBEARING, make_number (val))
	285	#define LGLYPH_SET_RBEARING(g, val) ASET ((g), LGLYPH_IX_RBEARING, make_number (val))
	286	#define LGLYPH_SET_ASCENT(g, val) ASET ((g), LGLYPH_IX_ASCENT, make_number (val))
	287	#define LGLYPH_SET_DESCENT(g, val) ASET ((g), LGLYPH_IX_DESCENT, make_number (val))
	288	#define LGLYPH_SET_ADJUSTMENT(g, val) ASET ((g), LGLYPH_IX_ADJUSTMENT, (val))
	289
	290	#define LGLYPH_XOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
	291	? XINT (AREF (LGLYPH_ADJUSTMENT (g), 0)) : 0)
	292	#define LGLYPH_YOFF(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
	293	? XINT (AREF (LGLYPH_ADJUSTMENT (g), 1)) : 0)
	294	#define LGLYPH_WADJUST(g) (VECTORP (LGLYPH_ADJUSTMENT (g)) \
	295	? XINT (AREF (LGLYPH_ADJUSTMENT (g), 2)) : 0)
	296
	297	struct composition_it;
	298	struct face;
	299	struct font_metrics;
	300
dcd5c89a	301	extern Lisp_Object composition_gstring_put_cache (Lisp_Object, EMACS_INT);
383e0970 J	302	extern Lisp_Object composition_gstring_from_id (int);
383e0970 J	303	extern int composition_gstring_p (Lisp_Object);
579c18d0	304	extern int composition_gstring_width (Lisp_Object, EMACS_INT, EMACS_INT,
383e0970 J	305	struct font_metrics *);
	306
	307	extern void composition_compute_stop_pos (struct composition_it *,
	308	EMACS_INT, EMACS_INT, EMACS_INT,
	309	Lisp_Object);
	310	extern int composition_reseat_it (struct composition_it *,
	311	EMACS_INT, EMACS_INT, EMACS_INT,
	312	struct window , struct face ,
	313	Lisp_Object);
	314	extern int composition_update_it (struct composition_it *,
	315	EMACS_INT, EMACS_INT, Lisp_Object);
	316
41118bd3	317	extern EMACS_INT composition_adjust_point (EMACS_INT, EMACS_INT);
6e8b8329	318
15a10ef1	319	#endif /* not EMACS_COMPOSITE_H */