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., 59 Temple Place, Suite 330, Boston, MA
  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   enum MFontType type : 2;
 108   enum MFontSource source : 2;
 109   enum MFontSpacing spacing : 2;
 110   unsigned for_full_width : 1;
 111   /* Pixel size of the font in 1/10 pixels.  The negative value means
 112      a point size in 1/10 pt.  */
 113   int size : 25;
 114   MSymbol file;
 115   MSymbol capability;
 116   MFontEncoding *encoding;
 117 };
 118
 119 typedef struct
 120 {
 121   int size, inc, used;
 122   MSymbol property;
 123   MSymbol *names;
 124 } MFontPropertyTable;
 125
 126 extern MFontPropertyTable mfont__property_table[MFONT_REGISTRY + 1];
 127
 128 /** Return the symbol of the Nth font property of FONT.  */
 129 #define FONT_PROPERTY(font, n)  \
 130   (mfont__property_table[(n)].names[(font)->property[(n)]])
 131
 132 struct MRealizedFont
 133 {
 134   /* Font spec used to find the font.
 135      MRealizedFont::spec.property[MFONT_TYPE] is MFONT_TYPE_REALIZED
 136      so that this object can be distingushed from MFont.  */
 137   MFont spec;
 138
 139   /* Frame on which the font is realized.  */
 140   MFrame *frame;
 141
 142   /* The found font.  */
 143   MFont *font;
 144
 145   MFontDriver *driver;
 146
 147   /* Font Layout Table for the font.  This is just a container to
 148      carry the infomation.  */
 149   MSymbol layouter;
 150
 151   /* Extra information set by MRealizedFont::driver->open.  If
 152      non-NULL, it must be a pointer to a managed object.  */
 153   void *info;
 154
 155   int ascent, descent, max_advance, average_width, baseline_offset;
 156
 157   /* Pointer to the font structure.  */
 158   void *fontp;
 159
 160   MRealizedFont *next;
 161 };
 162
 163 typedef struct {
 164   MFont *font;
 165   int score;
 166 } MFontScore;
 167
 168 /** Structure to hold a list of fonts.  */
 169
 170 typedef struct
 171 {
 172   MFont object;
 173   MFontScore *fonts;
 174   int nfonts;
 175 } MFontList;
 176
 177 struct MFontDriver
 178 {
 179   /** Return a font best matching with FONT.  */
 180   MFont *(*select) (MFrame *frame, MFont *font, int limited_size);
 181
 182   /** Open a font specified by RFONT.  */
 183   MRealizedFont *(*open) (MFrame *frame, MFont *font, MFont *spec,
 184                           MRealizedFont *rfont);
 185
 186   /** Set metrics of glyphs in GSTRING from FROM to TO.  */
 187   void (*find_metric) (MRealizedFont *rfont, MGlyphString *gstring,
 188                        int from, int to);
 189
 190   /** Check if the font has a glyph for CODE.  CODE is a code point of
 191       a character in font->encoder->encoding_charset.  Return nonzero
 192       iff the font has the glyph.  */
 193   int (*has_char) (MFrame *frame, MFont *font, MFont *spec,
 194                    int c, unsigned code);
 195
 196   /** Encode CODE into a glyph code the font.  CODE is a code point of
 197       a character in rfont->encoder->encoding_charset.  If the font
 198       has no glyph for CODE, return MCHAR_INVALID_CODE.  */
 199   unsigned (*encode_char) (MFrame *frame, MFont *font, MFont *spec,
 200                            unsigned code);
 201
 202   /** Draw glyphs from FROM to TO (exclusive) on window WIN of FRAME
 203       at coordinate (X, Y) relative to WIN.  */
 204   void (*render) (MDrawWindow win, int x, int y,
 205                   MGlyphString *gstring, MGlyph *from, MGlyph *to,
 206                   int reverse, MDrawRegion region);
 207
 208   /** Push to PLIST fonts matching with FONT.  MAXNUM if greater than
 209       0 limits the number of listed fonts.  Return the number of fonts
 210       listed.  */
 211   int (*list) (MFrame *frame, MPlist *plist, MFont *font, int maxnum);
 212
 213   /** Check if RFONT support CAPABILITY.  */
 214   int (*check_capability) (MRealizedFont *rfont, MSymbol capability);
 215 };
 216
 217 /** Initialize the members of FONT.  */
 218
 219 #define MFONT_INIT(font) memset ((font), 0, sizeof (MFont))
 220
 221 extern MSymbol Mlayouter;
 222 extern MSymbol Miso8859_1, Miso10646_1, Municode_bmp, Municode_full;
 223 extern MSymbol Mapple_roman;
 224
 225 extern int mfont__flt_init ();
 226
 227 extern void mfont__flt_fini ();
 228
 229 #ifdef HAVE_FREETYPE
 230 #include <ft2build.h>
 231 #include FT_FREETYPE_H
 232
 233 #ifdef HAVE_FONTCONFIG
 234 #include <fontconfig/fontconfig.h>
 235 #endif
 236
 237 #ifdef HAVE_OTF
 238 #include <otf.h>
 239 #else  /* not HAVE_OTF */
 240 typedef unsigned OTF_Tag;
 241 #endif /* not HAVE_OTF */
 242
 243 enum MFontOpenTypeTable
 244   {
 245     MFONT_OTT_GSUB,
 246     MFONT_OTT_GPOS,
 247     MFONT_OTT_MAX
 248   };
 249
 250 typedef struct
 251 {
 252   M17NObject control;
 253   MSymbol *lang;
 254   MSymbol script;
 255   OTF_Tag script_tag;
 256   OTF_Tag langsys_tag;
 257   struct {
 258     char *str;
 259     int nfeatures;
 260     OTF_Tag *tags;
 261   } features[MFONT_OTT_MAX];
 262 } MFontCapability;
 263
 264 extern MFontDriver mfont__ft_driver;
 265
 266 extern int mfont__ft_init ();
 267
 268 extern void mfont__ft_fini ();
 269
 270 extern int mfont__ft_parse_name (const char *name, MFont *font);
 271
 272 extern char *mfont__ft_unparse_name (MFont *font);
 273
 274 #ifdef HAVE_OTF
 275
 276 extern int mfont__ft_drive_otf (MGlyphString *gstring, int from, int to,
 277                                 MFontCapability *capability);
 278
 279 extern int mfont__ft_decode_otf (MGlyph *g);
 280
 281 #endif  /* HAVE_OTF */
 282
 283 #endif /* HAVE_FREETYPE */
 284
 285 extern void mfont__free_realized (MRealizedFont *rfont);
 286
 287 extern int mfont__match_p (MFont *font, MFont *spec, int prop);
 288
 289 extern int mfont__merge (MFont *dst, MFont *src, int error_on_conflict);
 290
 291 extern void mfont__set_spec_from_face (MFont *spec, MFace *face);
 292
 293 extern MSymbol mfont__set_spec_from_plist (MFont *spec, MPlist *plist);
 294
 295 extern void mfont__resize (MFont *spec, MFont *request);
 296
 297 extern int mfont__has_char (MFrame *frame, MFont *font, MFont *spec, int c);
 298
 299 extern unsigned mfont__encode_char (MFrame *frame, MFont *font, MFont *spec,
 300                                     int c);
 301
 302 extern MFont *mfont__select (MFrame *frame, MFont *font, int max_size);
 303
 304 extern MFontList *mfont__list (MFrame *frame, MFont *spec, MFont *request,
 305                                int limited_size);
 306
 307 extern MRealizedFont *mfont__open (MFrame *frame, MFont *font, MFont *spec);
 308
 309 extern void mfont__get_metric (MGlyphString *gstring, int from, int to);
 310
 311 extern void mfont__set_property (MFont *font, enum MFontProperty key,
 312                                  MSymbol val);
 313
 314 extern int mfont__split_name (char *name, int *property_idx,
 315                               unsigned short *point, unsigned short *resy);
 316
 317 extern int mfont__parse_name_into_font (const char *name, MSymbol format,
 318                                         MFont *font);
 319
 320 extern MPlist *mfont__encoding_list (void);
 321
 322 extern MFontCapability *mfont__get_capability (MSymbol sym);
 323
 324 extern int mfont__check_capability (MRealizedFont *rfont, MSymbol capability);
 325
 326 extern unsigned mfont__flt_encode_char (MSymbol layouter_name, int c);
 327
 328 extern int mfont__flt_run (MGlyphString *gstring, int from, int to,
 329                            MRealizedFace *rface);
 330
 331 #endif /* _M17N_FONT_H_ */