[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

#include "font.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)

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