src/composite.h

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