src/font.h

   1 /* font.h -- header file for the font module.
   2    Copyright (C) 2003, 2004
   3      National Institute of Advanced Industrial Science and Technology (AIST)
   4      Registration Number H15PRO112
   5
   6    This file is part of the m17n library.
   7
   8    The m17n library is free software; you can redistribute it and/or
   9    modify it under the terms of the GNU Lesser General Public License
  10    as published by the Free Software Foundation; either version 2.1 of
  11    the License, or (at your option) any later version.
  12
  13    The m17n library is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16    Lesser General Public License for more details.
  17
  18    You should have received a copy of the GNU Lesser General Public
  19    License along with the m17n library; if not, write to the Free
  20    Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21    02111-1307, USA.  */
  22
  23 #ifndef _M17N_FONT_H_
  24 #define _M17N_FONT_H_
  25
  26 enum MFontProperty
  27   {
  28     /* The order of MFONT_FOUNDRY to MFONT_ADSTYLE must be the same as
  29        enum MFaceProperty.  */
  30     MFONT_FOUNDRY,
  31     MFONT_FAMILY,
  32     MFONT_WEIGHT,
  33     MFONT_STYLE,
  34     MFONT_STRETCH,
  35     MFONT_ADSTYLE,
  36     MFONT_REGISTRY,
  37     MFONT_RESY,
  38     /* The follwoings should not be used as an index to
  39        MFont->propperty.  */
  40     MFONT_SIZE,
  41     MFONT_SPACING,
  42     /* anchor */
  43     MFONT_PROPERTY_MAX = MFONT_SIZE
  44   };
  45
  46 enum MFontType
  47   {
  48     MFONT_TYPE_SPEC,
  49     MFONT_TYPE_OBJECT,
  50     MFONT_TYPE_REALIZED,
  51     MFONT_TYPE_FAILURE
  52   };
  53
  54 enum MFontSource
  55   {
  56     MFONT_SOURCE_UNDECIDED = 0,
  57     MFONT_SOURCE_X = 1,
  58     MFONT_SOURCE_FT = 2
  59   };
  60
  61 enum MFontSpacing
  62   {
  63     MFONT_SPACING_UNDECIDED,
  64     MFONT_SPACING_PROPORTIONAL,
  65     MFONT_SPACING_MONO,
  66     MFONT_SPACING_CHARCELL
  67   };
  68
  69 typedef struct MFontEncoding MFontEncoding;
  70 typedef struct MFontDriver MFontDriver;
  71
  72 /** Information about a font.  This structure is used in three ways:
  73     FONT-OBJ, FONT-OPENED, and FONT-SPEC.
  74
  75     FONT-OBJ: To store information of an existing font.  Instances
  76     appear only in <font_list> of MDisplay.
  77
  78     FONT-OPENED: To store information of an opened font.  Instances
  79     appear only in <opend_list> of MDisplay.
  80
  81     FONT-SPEC: To store specifications of a font.  Instances appear
  82     only in <spec_list> of MFontset.  */
  83
  84 struct MFont
  85 {
  86   /** Numeric value of each font property.  Also used as an index to
  87       the table @c mfont__property_table to get the actual name of the
  88       property.
  89
  90       For FONT-OBJ, FONT-OPENED: The value is greater than zero.
  91
  92       For FONT-SPEC: The value is equal to or greater than zero.  Zero
  93       means that the correponding property is not specified (i.e. wild
  94       card).
  95
  96       For FONT-OBJ: If the value is 0, the font is scalable or
  97       auto-scaled.
  98
  99       For FONT-OPENED: The actual size of opened font.
 100
 101       <property>[MFONT_RESY] is the designed resolution of the font in
 102       DPI, or zero.  Zero means that the font is scalable.
 103
 104       For the time being, we mention only Y-resolution (resy) and
 105       assume that resx is always equal to resy.  */
 106   unsigned short property[MFONT_PROPERTY_MAX];
 107   unsigned type : 2;
 108   unsigned source : 2;
 109   unsigned spacing : 2;
 110   unsigned for_full_width : 1;
 111   /* For FONT-OBJ, 1 means `size' is a logical or of bit masks for
 112      available pixel sizes (Nth bit corresponds to (6 + N) pixels), 0
 113      means `size' is an actual pixel size * 10.  For FONT-SPEC and
 114      FONT-OPENED, this is always 0, and `size' is an actual pixel
 115      size * 10.  */
 116   unsigned multiple_sizes : 1;
 117   unsigned size : 24;
 118   MSymbol file;
 119   MSymbol capability;
 120   MFontEncoding *encoding;
 121 };
 122
 123 typedef struct
 124 {
 125   int size, inc, used;
 126   MSymbol property;
 127   MSymbol *names;
 128 } MFontPropertyTable;
 129
 130 extern MFontPropertyTable mfont__property_table[MFONT_REGISTRY + 1];
 131
 132 /** Return the symbol of the Nth font property of FONT.  */
 133 #define FONT_PROPERTY(font, n)  \
 134   (mfont__property_table[(n)].names[(font)->property[(n)]])
 135
 136 struct MRealizedFont
 137 {
 138   /* Font spec used to find the font.
 139      MRealizedFont::spec.property[MFONT_TYPE] is MFONT_TYPE_REALIZED
 140      so that this object can be distingushed from MFont.  */
 141   MFont spec;
 142
 143   /* Frame on which the font is realized.  */
 144   MFrame *frame;
 145
 146   /* The found font.  */
 147   MFont *font;
 148
 149   MFontDriver *driver;
 150
 151   /* Font Layout Table for the font.  This is just a container to
 152      carry the infomation.  */
 153   MSymbol layouter;
 154
 155   /* 1 iff the font is opend by encapsulating client-side font data.  */
 156   int encapsulating;
 157
 158   /* Extra information set by MRealizedFont::driver->open.  If
 159      non-NULL, it must be a pointer to a managed object.  */
 160   void *info;
 161
 162   int ascent, descent, max_advance, average_width, baseline_offset;
 163
 164   /* Pointer to the font structure.  */
 165   void *fontp;
 166
 167   MRealizedFont *next;
 168 };
 169
 170 typedef struct {
 171   MFont *font;
 172   int score;
 173 } MFontScore;
 174
 175 /** Structure to hold a list of fonts.  */
 176
 177 typedef struct
 178 {
 179   MFont object;
 180   MFontScore *fonts;
 181   int nfonts;
 182 } MFontList;
 183
 184 struct MFontDriver
 185 {
 186   /** Return a font best matching with FONT.  */
 187   MFont *(*select) (MFrame *frame, MFont *font, int limited_size);
 188
 189   /** Open a font specified by RFONT.  */
 190   MRealizedFont *(*open) (MFrame *frame, MFont *font, MFont *spec,
 191                           MRealizedFont *rfont);
 192
 193   /** Set metrics of glyphs in GSTRING from FROM to TO.  */
 194   void (*find_metric) (MRealizedFont *rfont, MGlyphString *gstring,
 195                        int from, int to);
 196
 197   /** Check if the font has a glyph for CODE.  CODE is a code point of
 198       a character in font->encoder->encoding_charset.  Return nonzero
 199       iff the font has the glyph.  */
 200   int (*has_char) (MFrame *frame, MFont *font, MFont *spec,
 201                    int c, unsigned code);
 202
 203   /** Encode CODE into a glyph code the font.  CODE is a code point of
 204       a character in rfont->encoder->encoding_charset.  If the font
 205       has no glyph for CODE, return MCHAR_INVALID_CODE.  */
 206   unsigned (*encode_char) (MFrame *frame, MFont *font, MFont *spec,
 207                            unsigned code);
 208
 209   /** Draw glyphs from FROM to TO (exclusive) on window WIN of FRAME
 210       at coordinate (X, Y) relative to WIN.  */
 211   void (*render) (MDrawWindow win, int x, int y,
 212                   MGlyphString *gstring, MGlyph *from, MGlyph *to,
 213                   int reverse, MDrawRegion region);
 214
 215   /** Push to PLIST fonts matching with FONT.  MAXNUM if greater than
 216       0 limits the number of listed fonts.  Return the number of fonts
 217       listed.  */
 218   int (*list) (MFrame *frame, MPlist *plist, MFont *font, int maxnum);
 219
 220   /** Push to PLIST font family names (symbol) available on FRAME.  */
 221   void (*list_family_names) (MFrame *frame, MPlist *plist);
 222
 223   /** Check if RFONT support CAPABILITY.  */
 224   int (*check_capability) (MRealizedFont *rfont, MSymbol capability);
 225
 226   /** Open a font by encapsulating DATA.  */
 227   MRealizedFont *(*encapsulate) (MFrame *frame, MSymbol source, void *data);
 228
 229   void (*close) (MRealizedFont *rfont);
 230 };
 231
 232 /** Initialize the members of FONT.  */
 233
 234 #define MFONT_INIT(font) memset ((font), 0, sizeof (MFont))
 235
 236 extern MSymbol Mlayouter;
 237 extern MSymbol Miso8859_1, Miso10646_1, Municode_bmp, Municode_full;
 238 extern MSymbol Mapple_roman;
 239
 240 extern int mfont__flt_init ();
 241
 242 extern void mfont__flt_fini ();
 243
 244 #ifdef HAVE_FREETYPE
 245 #include <ft2build.h>
 246 #include FT_FREETYPE_H
 247
 248 #ifdef HAVE_FONTCONFIG
 249 #include <fontconfig/fontconfig.h>
 250 #endif
 251
 252 #ifdef HAVE_OTF
 253 #include <otf.h>
 254 #else  /* not HAVE_OTF */
 255 typedef unsigned OTF_Tag;
 256 #endif /* not HAVE_OTF */
 257
 258 enum MFontOpenTypeTable
 259   {
 260     MFONT_OTT_GSUB,
 261     MFONT_OTT_GPOS,
 262     MFONT_OTT_MAX
 263   };
 264
 265 typedef struct
 266 {
 267   M17NObject control;
 268   MSymbol language;
 269   MSymbol script;
 270   MSymbol otf;
 271   OTF_Tag script_tag;
 272   OTF_Tag langsys_tag;
 273   struct {
 274     char *str;
 275     int nfeatures;
 276     OTF_Tag *tags;
 277   } features[MFONT_OTT_MAX];
 278 } MFontCapability;
 279
 280 extern MFontDriver mfont__ft_driver;
 281
 282 extern int mfont__ft_init ();
 283
 284 extern void mfont__ft_fini ();
 285
 286 extern int mfont__ft_parse_name (const char *name, MFont *font);
 287
 288 extern char *mfont__ft_unparse_name (MFont *font);
 289
 290 #ifdef HAVE_OTF
 291
 292 extern int mfont__ft_drive_otf (MGlyphString *gstring, int from, int to,
 293                                 MFontCapability *capability);
 294
 295 extern int mfont__ft_decode_otf (MGlyph *g);
 296
 297 #endif  /* HAVE_OTF */
 298
 299 #endif /* HAVE_FREETYPE */
 300
 301 extern void mfont__free_realized (MRealizedFont *rfont);
 302
 303 extern int mfont__match_p (MFont *font, MFont *spec, int prop);
 304
 305 extern int mfont__merge (MFont *dst, MFont *src, int error_on_conflict);
 306
 307 extern void mfont__set_spec_from_face (MFont *spec, MFace *face);
 308
 309 extern MSymbol mfont__set_spec_from_plist (MFont *spec, MPlist *plist);
 310
 311 extern int mfont__has_char (MFrame *frame, MFont *font, MFont *spec, int c);
 312
 313 extern unsigned mfont__encode_char (MFrame *frame, MFont *font, MFont *spec,
 314                                     int c);
 315
 316 extern MFont *mfont__select (MFrame *frame, MFont *font, int max_size);
 317
 318 extern MFontList *mfont__list (MFrame *frame, MFont *spec, MFont *request,
 319                                int limited_size);
 320
 321 extern MRealizedFont *mfont__open (MFrame *frame, MFont *font, MFont *spec);
 322
 323 extern void mfont__get_metric (MGlyphString *gstring, int from, int to);
 324
 325 extern void mfont__set_property (MFont *font, enum MFontProperty key,
 326                                  MSymbol val);
 327
 328 extern int mfont__split_name (char *name, int *property_idx,
 329                               unsigned short *point, unsigned short *resy);
 330
 331 extern int mfont__parse_name_into_font (const char *name, MSymbol format,
 332                                         MFont *font);
 333
 334 extern MPlist *mfont__encoding_list (void);
 335
 336 extern MFontCapability *mfont__get_capability (MSymbol sym);
 337
 338 extern int mfont__check_capability (MRealizedFont *rfont, MSymbol capability);
 339
 340 extern unsigned mfont__flt_encode_char (MSymbol layouter_name, int c);
 341
 342 extern int mfont__flt_run (MGlyphString *gstring, int from, int to,
 343                            MRealizedFace *rface);
 344
 345 #endif /* _M17N_FONT_H_ */