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

/* Header for composite sequence handler.
   Copyright (C) 2001-2013 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

INLINE_HEADER_BEGIN
#ifndef COMPOSITE_INLINE
# define COMPOSITE_INLINE INLINE
#endif

/* 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 components 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_CMP (gref, <, 12) && UNSIGNED_CMP (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.  */
  int 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.  */
  ptrdiff_t 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 (short) *
     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 ptrdiff_t 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 ptrdiff_t get_composition_id (ptrdiff_t, ptrdiff_t, ptrdiff_t,
				     Lisp_Object, Lisp_Object);
extern bool find_composition (ptrdiff_t, ptrdiff_t, ptrdiff_t *, ptrdiff_t *,
			      Lisp_Object *, Lisp_Object);
extern void update_compositions (ptrdiff_t, ptrdiff_t, 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 (ptrdiff_t, ptrdiff_t, 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))
COMPOSITE_INLINE Lisp_Object *
lgstring_glyph_addr (Lisp_Object lgs, ptrdiff_t idx)
{
  return aref_addr (lgs, idx + 2);
}

/* 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, ptrdiff_t);
extern Lisp_Object composition_gstring_from_id (ptrdiff_t);
extern bool composition_gstring_p (Lisp_Object);
extern int composition_gstring_width (Lisp_Object, ptrdiff_t, ptrdiff_t,
                                      struct font_metrics *);

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

extern ptrdiff_t composition_adjust_point (ptrdiff_t, ptrdiff_t);

INLINE_HEADER_END

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