src/composite.h

   1 /* Header for composite sequence handler.
   2    Copyright (C) 2001, 2002, 2003, 2004, 2005,
   3                  2006, 2007, 2008 Free Software Foundation, Inc.
   4    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
   5      National Institute of Advanced Industrial Science and Technology (AIST)
   6      Registration Number H14PRO021
   7    Copyright (C) 2003, 2006
   8      National Institute of Advanced Industrial Science and Technology (AIST)
   9      Registration Number H13PRO009
  10
  11 This file is part of GNU Emacs.
  12
  13 GNU Emacs is free software: you can redistribute it and/or modify
  14 it under the terms of the GNU General Public License as published by
  15 the Free Software Foundation, either version 3 of the License, or
  16 (at your option) any later version.
  17
  18 GNU Emacs is distributed in the hope that it will be useful,
  19 but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 GNU General Public License for more details.
  22
  23 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/>.  */
  25
  26 #ifndef EMACS_COMPOSITE_H
  27 #define EMACS_COMPOSITE_H
  28
  29 /* Methods to display a sequence of components of a composition.  */
  30 enum composition_method {
  31   /* Compose relatively without alternate characters.  */
  32   COMPOSITION_RELATIVE,
  33   /* Compose by specified composition rules.  This is not used in
  34      Emacs 21 but we need it to decode files saved in the older
  35      versions of Emacs.  */
  36   COMPOSITION_WITH_RULE,
  37   /* Compose relatively with alternate characters.  */
  38   COMPOSITION_WITH_ALTCHARS,
  39   /* Compose by specified composition rules with alternate characters.  */
  40   COMPOSITION_WITH_RULE_ALTCHARS,
  41   /* Compose by specified lispy glyph-string.  */
  42   COMPOSITION_WITH_GLYPH_STRING,
  43   /* This is not a method.  */
  44   COMPOSITION_NO
  45 };
  46
  47 /* Maximum number of compoments a single composition can have.  */
  48 #define MAX_COMPOSITION_COMPONENTS 16
  49
  50 /* These macros access information about a composition that
  51    has `composition' property PROP.  PROP is:
  52         ((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
  53    or
  54         (COMPOSITION-ID . (LENGTH COMPONENTS . MODIFICATION-FUNC))
  55    They don't check validity of PROP.  */
  56
  57 /* Temporary variable used only in the following macros.  */
  58 extern Lisp_Object composition_temp;
  59
  60 /* Return 1 if the composition is already registered.  */
  61 #define COMPOSITION_REGISTERD_P(prop) INTEGERP (XCAR (prop))
  62
  63 /* Return ID number of the already registered composition.  */
  64 #define COMPOSITION_ID(prop) XINT (XCAR (prop))
  65
  66 /* Return length of the composition.  */
  67 #define COMPOSITION_LENGTH(prop)        \
  68   (COMPOSITION_REGISTERD_P (prop)       \
  69    ? XINT (XCAR (XCDR (prop)))          \
  70    : XINT (XCAR (XCAR (prop))))
  71
  72 /* Return components of the composition.  */
  73 #define COMPOSITION_COMPONENTS(prop)    \
  74   (COMPOSITION_REGISTERD_P (prop)       \
  75    ? XCAR (XCDR (XCDR (prop)))          \
  76    : XCDR (XCAR (prop)))
  77
  78 /* Return modification function of the composition.  */
  79 #define COMPOSITION_MODIFICATION_FUNC(prop)     \
  80   (COMPOSITION_REGISTERD_P (prop)               \
  81    ? XCDR (XCDR (XCDR (prop)))                  \
  82    : CONSP (prop) ? XCDR (prop) : Qnil)
  83
  84 /* Return the method of composition.  */
  85 #define COMPOSITION_METHOD(prop)                                        \
  86   (COMPOSITION_REGISTERD_P (prop)                                       \
  87    ? composition_table[COMPOSITION_ID (prop)]->method                   \
  88    : (composition_temp = XCDR (XCAR (prop)),                            \
  89       (NILP (composition_temp)                                          \
  90        ? COMPOSITION_RELATIVE                                           \
  91        : (INTEGERP (composition_temp) || STRINGP (composition_temp))    \
  92        ? COMPOSITION_WITH_ALTCHARS                                      \
  93        : (VECTORP (composition_temp)                                    \
  94           && ASIZE (composition_temp) >= 2                              \
  95           && VECTORP (AREF (composition_temp, 0)))                      \
  96        ? COMPOSITION_WITH_GLYPH_STRING                                  \
  97        : COMPOSITION_WITH_RULE_ALTCHARS)))
  98
  99 /* Return 1 if the composition is valid.  It is valid if length of
 100    the composition equals to (END - START).  */
 101 #define COMPOSITION_VALID_P(start, end, prop)                   \
 102   (CONSP (prop)                                                 \
 103    && (COMPOSITION_REGISTERD_P (prop)                           \
 104        ? (COMPOSITION_ID (prop) >= 0                            \
 105           && COMPOSITION_ID (prop) <= n_compositions            \
 106           && CONSP (XCDR (prop)))                               \
 107        : (composition_temp = XCAR (prop),                       \
 108           (CONSP (composition_temp)                             \
 109            && (composition_temp = XCDR (composition_temp),      \
 110                (NILP (composition_temp)                         \
 111                 || STRINGP (composition_temp)                   \
 112                 || VECTORP (composition_temp)                   \
 113                 || INTEGERP (composition_temp)                  \
 114                 || CONSP (composition_temp))))))                \
 115    && (end - start) == COMPOSITION_LENGTH (prop))
 116
 117 /* Return the Nth glyph of composition specified by CMP.  CMP is a
 118    pointer to `struct composition'. */
 119 #define COMPOSITION_GLYPH(cmp, n)                                       \
 120   XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table)          \
 121                           ->key_and_value)                              \
 122                  ->contents[cmp->hash_index * 2])                       \
 123         ->contents[cmp->method == COMPOSITION_WITH_RULE_ALTCHARS        \
 124                   ? (n) * 2 : (n)])
 125
 126 /* Return the encoded composition rule to compose the Nth glyph of
 127    rule-base composition specified by CMP.  CMP is a pointer to
 128    `struct composition'. */
 129 #define COMPOSITION_RULE(cmp, n)                                \
 130   XINT (XVECTOR (XVECTOR (XHASH_TABLE (composition_hash_table)  \
 131                           ->key_and_value)                      \
 132                  ->contents[cmp->hash_index * 2])               \
 133         ->contents[(n) * 2 - 1])
 134
 135 /* Decode encoded composition rule RULE_CODE into GREF (global
 136    reference point code), NREF (new reference point code), XOFF
 137    (horizontal offset) YOFF (vertical offset).  Don't check RULE_CODE,
 138    always set GREF and NREF to valid values.  By side effect,
 139    RULE_CODE is modified.  */
 140
 141 #define COMPOSITION_DECODE_RULE(rule_code, gref, nref, xoff, yoff)      \
 142   do {                                                                  \
 143     xoff = (rule_code) >> 16;                                           \
 144     yoff = ((rule_code) >> 8) & 0xFF;                                   \
 145     rule_code &= 0xFF;                                                  \
 146     gref = (rule_code) / 12;                                            \
 147     if (gref > 12) gref = 11;                                           \
 148     nref = (rule_code) % 12;                                            \
 149   } while (0)
 150
 151 /* Return encoded composition rule for the pair of global reference
 152    point GREF and new reference point NREF.  If arguments are invalid,
 153    return -1. */
 154 #define COMPOSITION_ENCODE_RULE(gref, nref)             \
 155   ((unsigned) (gref) < 12 && (unsigned) (nref) < 12     \
 156    ? (gref) * 12 + (nref) : -1)
 157
 158 /* Data structure that records information about a composition
 159    currently used in some buffers or strings.
 160
 161    When a composition is assigned an ID number (by
 162    get_composition_id), this structure is allocated for the
 163    composition and linked in composition_table[ID].
 164
 165    Identical compositions appearing at different places have the same
 166    ID, and thus share the same instance of this structure.  */
 167
 168 struct composition {
 169   /* Number of glyphs of the composition components.  */
 170   unsigned glyph_len;
 171
 172   /* Width, ascent, and descent pixels of the composition.  */
 173   short pixel_width, ascent, descent;
 174
 175   short lbearing, rbearing;
 176
 177   /* How many columns the overall glyphs occupy on the screen.  This
 178      gives an approximate value for column calculation in
 179      Fcurrent_column, and etc.  */
 180   unsigned short width;
 181
 182   /* Method of the composition.  */
 183   enum composition_method method;
 184
 185   /* Index to the composition hash table.  */
 186   int hash_index;
 187
 188   /* For which font we have calculated the remaining members.  The
 189      actual type is device dependent.  */
 190   void *font;
 191
 192   /* Pointer to an array of x-offset and y-offset (by pixels) of
 193      glyphs.  This points to a sufficient memory space (sizeof (int) *
 194      glyph_len * 2) that is allocated when the composition is
 195      registered in composition_table.  X-offset and Y-offset of Nth
 196      glyph are (2N)th and (2N+1)th elements respectively.  */
 197   short *offsets;
 198 };
 199
 200 /* Table of pointers to the structure `composition' indexed by
 201    COMPOSITION-ID.  */
 202 extern struct composition **composition_table;
 203 /* Number of the currently registered compositions.  */
 204 extern int n_compositions;
 205
 206 /* Mask bits for CHECK_MASK arg to update_compositions.
 207    For a change in the region FROM and TO, check compositions ... */
 208 #define CHECK_HEAD      1       /* adjacent to FROM */
 209 #define CHECK_TAIL      2       /* adjacent to TO */
 210 #define CHECK_INSIDE    4       /* between FROM and TO */
 211 #define CHECK_BORDER    (CHECK_HEAD | CHECK_TAIL)
 212 #define CHECK_ALL       (CHECK_BORDER | CHECK_INSIDE)
 213
 214 extern Lisp_Object Qcomposition;
 215 extern Lisp_Object composition_hash_table;
 216 extern Lisp_Object Qauto_composed;
 217 extern Lisp_Object Vauto_composition_function;
 218 extern Lisp_Object Qauto_composition_function;
 219
 220 extern int get_composition_id P_ ((int, int, int, Lisp_Object, Lisp_Object));
 221 extern int find_composition P_ ((int, int, EMACS_INT *, EMACS_INT *, Lisp_Object *,
 222                                  Lisp_Object));
 223 extern void update_compositions P_ ((EMACS_INT, EMACS_INT, int));
 224 extern void make_composition_value_copy P_ ((Lisp_Object));
 225 extern void compose_region P_ ((int, int, Lisp_Object, Lisp_Object,
 226                                 Lisp_Object));
 227 extern void syms_of_composite P_ ((void));
 228 extern void compose_text P_ ((int, int, Lisp_Object, Lisp_Object,
 229                               Lisp_Object));
 230
 231 EXFUN (Fcompose_region_internal, 4);
 232 EXFUN (Fcompose_string_internal, 5);
 233
 234 #endif /* not EMACS_COMPOSITE_H */
 235
 236 /* arch-tag: 59524d89-c645-47bd-b5e6-65e861690118
 237    (do not change this comment) */