[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.  */

/* 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 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 syms_of_composite (void);
extern void compose_text (ptrdiff_t, ptrdiff_t, Lisp_Object, Lisp_Object,
                          Lisp_Object);

/* Return the method of composition.  */
COMPOSITE_INLINE enum composition_method
composition_method (Lisp_Object prop)
{
  Lisp_Object temp;

  return (COMPOSITION_REGISTERD_P (prop)
	  ? composition_table[COMPOSITION_ID (prop)]->method
	  : (temp = XCDR (XCAR (prop)),
	     (NILP (temp)
	      ? COMPOSITION_RELATIVE
	      : (INTEGERP (temp) || STRINGP (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).  */
COMPOSITE_INLINE bool
composition_valid_p (ptrdiff_t start, ptrdiff_t end, Lisp_Object prop)
{
  Lisp_Object temp;

  return (CONSP (prop)
	  && (COMPOSITION_REGISTERD_P (prop)
	      ? (COMPOSITION_ID (prop) >= 0
		 && COMPOSITION_ID (prop) <= n_compositions
		 && CONSP (XCDR (prop)))
	      : (temp = XCAR (prop),
		 (CONSP (temp)
		  && (temp = XCDR (temp),
		      (NILP (temp)
		       || STRINGP (temp)
		       || VECTORP (temp)
		       || INTEGERP (temp)
		       || CONSP (temp))))))
	  && (end - start) == COMPOSITION_LENGTH (prop));
}

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