[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 operations 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 true if PROP is already registered.  */
COMPOSITE_INLINE bool
composition_registered_p (Lisp_Object prop)
{
  return 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_registered_p (prop)	\
   ? XINT (XCAR (XCDR (prop)))		\
   : XINT (XCAR (XCAR (prop))))

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

/* Return modification function of the composition.  */
#define COMPOSITION_MODIFICATION_FUNC(prop)	\
  (composition_registered_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 a composition with property PROP.  */

COMPOSITE_INLINE enum composition_method
composition_method (Lisp_Object prop)
{
  if (composition_registered_p (prop))
    return composition_table[COMPOSITION_ID (prop)]->method;
  else
    {
      Lisp_Object temp = XCDR (XCAR (prop));
      return (NILP (temp)
	      ? COMPOSITION_RELATIVE
	      : INTEGERP (temp) || STRINGP (temp)
	      ? COMPOSITION_WITH_ALTCHARS
	      : COMPOSITION_WITH_RULE_ALTCHARS);
    }
}

/* Given offsets START and END, return true if PROP is a valid composition
   property with length END - START.  */

COMPOSITE_INLINE bool
composition_valid_p (ptrdiff_t start, ptrdiff_t end, Lisp_Object prop)
{
  return (CONSP (prop)
	  && (composition_registered_p (prop)
	      ? (COMPOSITION_ID (prop) >= 0
		 && COMPOSITION_ID (prop) <= n_compositions
		 && CONSP (XCDR (prop)))
	      : (CONSP (XCAR (prop))
		  && (NILP (XCDR (XCAR (prop)))
		      || STRINGP (XCDR (XCAR (prop)))
		      || VECTORP (XCDR (XCAR (prop)))
		      || INTEGERP (XCDR (XCAR (prop)))
		      || CONSP (XCDR (XCAR (prop))))))
	  && COMPOSITION_LENGTH (prop) == end - start);
}

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