composite.h 13.2 KB
Newer Older
Kenichi Handa's avatar
Kenichi Handa committed
1
/* Header for composite sequence handler.
2
   Copyright (C) 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
3 4
                 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Kenichi Handa's avatar
Kenichi Handa committed
5 6
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021
7
   Copyright (C) 2003, 2006
8 9
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Kenichi Handa's avatar
Kenichi Handa committed
10 11 12

This file is part of GNU Emacs.

13
GNU Emacs is free software: you can redistribute it and/or modify
Kenichi Handa's avatar
Kenichi Handa committed
14
it under the terms of the GNU General Public License as published by
15 16
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Kenichi Handa's avatar
Kenichi Handa committed
17 18 19 20 21 22 23

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
24
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Kenichi Handa's avatar
Kenichi Handa committed
25

26 27
#ifndef EMACS_COMPOSITE_H
#define EMACS_COMPOSITE_H
Kenichi Handa's avatar
Kenichi Handa committed
28

29
/* Methods to display a sequence of components of a composition.  */
Kenichi Handa's avatar
Kenichi Handa committed
30 31 32
enum composition_method {
  /* Compose relatively without alternate characters.  */
  COMPOSITION_RELATIVE,
33 34 35
  /* 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.  */
Kenichi Handa's avatar
Kenichi Handa committed
36 37 38
  COMPOSITION_WITH_RULE,
  /* Compose relatively with alternate characters.  */
  COMPOSITION_WITH_ALTCHARS,
39 40 41 42
  /* Compose by specified composition rules with alternate characters.  */
  COMPOSITION_WITH_RULE_ALTCHARS,
  /* This is not a method.  */
  COMPOSITION_NO
Kenichi Handa's avatar
Kenichi Handa committed
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
};

/* Maximum number of compoments a single composition can have.  */
#define MAX_COMPOSITION_COMPONENTS 16

/* These macros access information about a composition that
   has `composition' property PROP.  PROP is:
	((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
   or
	(COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
   They don't check validity of PROP.  */

/* Temporary variable used only in the following macros.  */
extern Lisp_Object composition_temp;

Glenn Morris's avatar
Glenn Morris committed
58
/* Return 1 if the composition is already registered.  */
Kenichi Handa's avatar
Kenichi Handa committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
#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)))			\
80
   : CONSP (prop) ? XCDR (prop) : Qnil)
Kenichi Handa's avatar
Kenichi Handa committed
81 82 83 84 85 86 87 88

/* 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						\
Kenichi Handa's avatar
Kenichi Handa committed
89 90 91
       : (INTEGERP (composition_temp) || STRINGP (composition_temp))	\
       ? COMPOSITION_WITH_ALTCHARS					\
       : COMPOSITION_WITH_RULE_ALTCHARS)))
Kenichi Handa's avatar
Kenichi Handa committed
92

Glenn Morris's avatar
Glenn Morris committed
93
/* Return 1 if the composition is valid.  It is valid if length of
Kenichi Handa's avatar
Kenichi Handa committed
94
   the composition equals to (END - START).  */
95 96 97 98 99 100 101 102 103 104 105 106 107 108
#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))))))		\
Kenichi Handa's avatar
Kenichi Handa committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
   && (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
130 131 132 133 134 135 136 137 138 139 140 141 142
   reference point code), NREF (new reference point code), XOFF
   (horizontal offset) YOFF (vertical offset).  Don't check RULE_CODE,
   always set GREF and NREF to valid values.  By side effect,
   RULE_CODE is modified.  */

#define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff)	\
  do {									\
    xoff = (rule_code) >> 16;						\
    yoff = ((rule_code) >> 8) & 0xFF;					\
    rule_code &= 0xFF;							\
    gref = (rule_code) / 12;						\
    if (gref > 12) gref = 11;						\
    nref = (rule_code) % 12;						\
Kenichi Handa's avatar
Kenichi Handa committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156
  } while (0)

/* Return encoded composition rule for the pair of global reference
   point GREF and new reference point NREF.  If arguments are invalid,
   return -1. */
#define COMPOSITION_ENCODE_RULE(gref, nref)		\
  ((unsigned) (gref) < 12 && (unsigned) (nref) < 12	\
   ? (gref) * 12 + (nref) : -1)

/* 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
157
   composition and linked in composition_table[ID].
Kenichi Handa's avatar
Kenichi Handa committed
158 159 160 161 162 163

   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.  */
164
  unsigned glyph_len;
Kenichi Handa's avatar
Kenichi Handa committed
165

166 167 168
  /* Width, ascent, and descent pixels of the composition.  */
  short pixel_width, ascent, descent;

169 170
  short lbearing, rbearing;

171 172 173 174 175
  /* 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;

Kenichi Handa's avatar
Kenichi Handa committed
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
  /* Method of the composition.  */
  enum composition_method method;

  /* Index to the composition hash table.  */
  int hash_index;

  /* For which font we have calculated the remaining members.  The
     actual type is device dependent.  */
  void *font;

  /* Pointer to an array of x-offset and y-offset (by pixels) of
     glyphs.  This points to a sufficient memory space (sizeof (int) *
     glyph_len * 2) that is allocated when the composition is
     registered in composition_table.  X-offset and Y-offset of Nth
     glyph are (2N)th and (2N+1)th elements respectively.  */
  short *offsets;
};

/* Table of pointers to the structure `composition' indexed by
   COMPOSITION-ID.  */
extern struct composition **composition_table;
/* Number of the currently registered compositions.  */
extern int n_compositions;

/* Mask bits for CHECK_MASK arg to update_compositions.
   For a change in the region FROM and TO, check compositions ... */
#define CHECK_HEAD	1	/* adjacent to FROM */
#define CHECK_TAIL	2	/* adjacent to TO */
#define CHECK_INSIDE	4	/* between FROM and TO */
#define CHECK_BORDER	(CHECK_HEAD | CHECK_TAIL)
#define CHECK_ALL	(CHECK_BORDER | CHECK_INSIDE)

extern Lisp_Object Qcomposition;
extern Lisp_Object composition_hash_table;
210 211 212
extern Lisp_Object Qauto_composed;
extern Lisp_Object Vauto_composition_function;
extern Lisp_Object Qauto_composition_function;
213
extern Lisp_Object Vcomposition_function_table;
Kenichi Handa's avatar
Kenichi Handa committed
214

Jan D's avatar
Jan D committed
215 216 217 218 219 220 221 222 223 224
extern int get_composition_id (int, int, int, Lisp_Object, Lisp_Object);
extern int find_composition (int, int, EMACS_INT *, EMACS_INT *, Lisp_Object *,
                             Lisp_Object);
extern void update_compositions (EMACS_INT, EMACS_INT, int);
extern void make_composition_value_copy (Lisp_Object);
extern void compose_region (int, int, Lisp_Object, Lisp_Object,
                            Lisp_Object);
extern void syms_of_composite (void);
extern void compose_text (int, int, Lisp_Object, Lisp_Object,
                          Lisp_Object);
Kenichi Handa's avatar
Kenichi Handa committed
225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/* Macros for lispy glyph-string.  This is completely different from
   struct glyph_string.  */

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

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

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

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

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

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

#define LGLYPH_NEW() Fmake_vector (make_number (LGLYPH_SIZE), Qnil)
#define LGLYPH_FROM(g) XINT (AREF ((g), LGLYPH_IX_FROM))
#define LGLYPH_TO(g) XINT (AREF ((g), LGLYPH_IX_TO))
#define LGLYPH_CHAR(g) XINT (AREF ((g), LGLYPH_IX_CHAR))
#define LGLYPH_CODE(g)						\
  (NILP (AREF ((g), LGLYPH_IX_CODE))				\
   ? FONT_INVALID_CODE						\
   : CONSP (AREF ((g), LGLYPH_IX_CODE))				\
   ? ((XFASTINT (XCAR (AREF ((g), LGLYPH_IX_CODE))) << 16)	\
      | (XFASTINT (XCDR (AREF ((g), LGLYPH_IX_CODE)))))		\
   : XFASTINT (AREF ((g), LGLYPH_IX_CODE)))
#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))
276
/* Callers must assure that VAL is not negative!  */
277 278 279 280
#define LGLYPH_SET_CODE(g, val)						\
  do {									\
    if (val == FONT_INVALID_CODE)					\
      ASET ((g), LGLYPH_IX_CODE, Qnil);					\
281
    else if ((EMACS_INT)val > MOST_POSITIVE_FIXNUM)			\
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
      ASET ((g), LGLYPH_IX_CODE, Fcons (make_number ((val) >> 16),	\
					make_number ((val) & 0xFFFF)));	\
    else								\
      ASET ((g), LGLYPH_IX_CODE, make_number (val));			\
  } while (0)
      
#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;

Jan D's avatar
Jan D committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
extern Lisp_Object composition_gstring_put_cache (Lisp_Object, int);
extern Lisp_Object composition_gstring_from_id (int);
extern int composition_gstring_p (Lisp_Object);
extern int composition_gstring_width (Lisp_Object, int, int,
                                      struct font_metrics *);

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

extern int composition_adjust_point (EMACS_INT, EMACS_INT);
323

324 325
EXFUN (Fcompose_region_internal, 4);
EXFUN (Fcompose_string_internal, 5);
326
EXFUN (Fcomposition_get_gstring, 4);
327

328
#endif /* not EMACS_COMPOSITE_H */
Kenichi Handa's avatar
Kenichi Handa committed
329 330 331

/* arch-tag: 59524d89-c645-47bd-b5e6-65e861690118
   (do not change this comment) */