2
* fontconfig/fontconfig/fontconfig.h
4
* Copyright Ā© 2001 Keith Packard
6
* Permission to use, copy, modify, distribute, and sell this software and its
7
* documentation for any purpose is hereby granted without fee, provided that
8
* the above copyright notice appear in all copies and that both that
9
* copyright notice and this permission notice appear in supporting
10
* documentation, and that the name of Keith Packard not be used in
11
* advertising or publicity pertaining to distribution of the software without
12
* specific, written prior permission. Keith Packard makes no
13
* representations about the suitability of this software for any purpose. It
14
* is provided "as is" without express or implied warranty.
16
* THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18
* EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
19
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
20
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
21
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
22
* PERFORMANCE OF THIS SOFTWARE.
25
#ifndef _FONTCONFIG_H_
26
#define _FONTCONFIG_H_
28
#include <sys/types.h>
33
#if defined(__GNUC__) && (__GNUC__ >= 4)
34
#define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
36
#define FC_ATTRIBUTE_SENTINEL(x)
43
typedef unsigned char FcChar8;
44
typedef unsigned short FcChar16;
45
typedef unsigned int FcChar32;
49
* Current Fontconfig version number. This same number
50
* must appear in the fontconfig configure.in file. Yes,
51
* it'a a pain to synchronize version numbers like this.
58
#define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
61
* Current font cache file format version
62
* This is appended to the cache files so that multiple
63
* versions of the library will peacefully coexist
65
* Change this value whenever the disk format for the cache file
66
* changes in any non-compatible way. Try to avoid such changes as
67
* it means multiple copies of the font information.
70
#define FC_CACHE_VERSION "3"
75
#define FC_FAMILY "family" /* String */
76
#define FC_STYLE "style" /* String */
77
#define FC_SLANT "slant" /* Int */
78
#define FC_WEIGHT "weight" /* Int */
79
#define FC_SIZE "size" /* Double */
80
#define FC_ASPECT "aspect" /* Double */
81
#define FC_PIXEL_SIZE "pixelsize" /* Double */
82
#define FC_SPACING "spacing" /* Int */
83
#define FC_FOUNDRY "foundry" /* String */
84
#define FC_ANTIALIAS "antialias" /* Bool (depends) */
85
#define FC_HINTING "hinting" /* Bool (true) */
86
#define FC_HINT_STYLE "hintstyle" /* Int */
87
#define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
88
#define FC_AUTOHINT "autohint" /* Bool (false) */
89
#define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
90
#define FC_WIDTH "width" /* Int */
91
#define FC_FILE "file" /* String */
92
#define FC_INDEX "index" /* Int */
93
#define FC_FT_FACE "ftface" /* FT_Face */
94
#define FC_RASTERIZER "rasterizer" /* String */
95
#define FC_OUTLINE "outline" /* Bool */
96
#define FC_SCALABLE "scalable" /* Bool */
97
#define FC_SCALE "scale" /* double */
98
#define FC_DPI "dpi" /* double */
99
#define FC_RGBA "rgba" /* Int */
100
#define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
101
#define FC_SOURCE "source" /* String (deprecated) */
102
#define FC_CHARSET "charset" /* CharSet */
103
#define FC_LANG "lang" /* String RFC 3066 langs */
104
#define FC_FONTVERSION "fontversion" /* Int from 'head' table */
105
#define FC_FULLNAME "fullname" /* String */
106
#define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
107
#define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
108
#define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
109
#define FC_CAPABILITY "capability" /* String */
110
#define FC_FONTFORMAT "fontformat" /* String */
111
#define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
112
#define FC_EMBEDDED_BITMAP "embeddedbitmap" /* Bool - true to enable embedded bitmaps */
113
#define FC_DECORATIVE "decorative" /* Bool - true if style is a decorative variant */
114
#define FC_LCD_FILTER "lcdfilter" /* Int */
116
#define FC_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
117
#define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
118
#define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
120
/* Adjust outline rasterizer */
121
#define FC_CHAR_WIDTH "charwidth" /* Int */
122
#define FC_CHAR_HEIGHT "charheight"/* Int */
123
#define FC_MATRIX "matrix" /* FcMatrix */
125
#define FC_WEIGHT_THIN 0
126
#define FC_WEIGHT_EXTRALIGHT 40
127
#define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
128
#define FC_WEIGHT_LIGHT 50
129
#define FC_WEIGHT_BOOK 75
130
#define FC_WEIGHT_REGULAR 80
131
#define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
132
#define FC_WEIGHT_MEDIUM 100
133
#define FC_WEIGHT_DEMIBOLD 180
134
#define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
135
#define FC_WEIGHT_BOLD 200
136
#define FC_WEIGHT_EXTRABOLD 205
137
#define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
138
#define FC_WEIGHT_BLACK 210
139
#define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
140
#define FC_WEIGHT_EXTRABLACK 215
141
#define FC_WEIGHT_ULTRABLACK FC_WEIGHT_EXTRABLACK
143
#define FC_SLANT_ROMAN 0
144
#define FC_SLANT_ITALIC 100
145
#define FC_SLANT_OBLIQUE 110
147
#define FC_WIDTH_ULTRACONDENSED 50
148
#define FC_WIDTH_EXTRACONDENSED 63
149
#define FC_WIDTH_CONDENSED 75
150
#define FC_WIDTH_SEMICONDENSED 87
151
#define FC_WIDTH_NORMAL 100
152
#define FC_WIDTH_SEMIEXPANDED 113
153
#define FC_WIDTH_EXPANDED 125
154
#define FC_WIDTH_EXTRAEXPANDED 150
155
#define FC_WIDTH_ULTRAEXPANDED 200
157
#define FC_PROPORTIONAL 0
160
#define FC_CHARCELL 110
162
/* sub-pixel order */
163
#define FC_RGBA_UNKNOWN 0
164
#define FC_RGBA_RGB 1
165
#define FC_RGBA_BGR 2
166
#define FC_RGBA_VRGB 3
167
#define FC_RGBA_VBGR 4
168
#define FC_RGBA_NONE 5
171
#define FC_HINT_NONE 0
172
#define FC_HINT_SLIGHT 1
173
#define FC_HINT_MEDIUM 2
174
#define FC_HINT_FULL 3
177
#define FC_LCD_NONE 0
178
#define FC_LCD_DEFAULT 1
179
#define FC_LCD_LIGHT 2
180
#define FC_LCD_LEGACY 3
182
typedef enum _FcType {
194
typedef struct _FcMatrix {
195
double xx, xy, yx, yy;
198
#define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
199
(m)->xy = (m)->yx = 0)
202
* A data structure to represent the available glyphs in a font.
203
* This is represented as a sparse boolean btree.
206
typedef struct _FcCharSet FcCharSet;
208
typedef struct _FcObjectType {
213
typedef struct _FcConstant {
219
typedef enum _FcResult {
220
FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
224
typedef struct _FcPattern FcPattern;
226
typedef struct _FcLangSet FcLangSet;
228
typedef struct _FcValue {
242
typedef struct _FcFontSet {
248
typedef struct _FcObjectSet {
251
const char **objects;
254
typedef enum _FcMatchKind {
255
FcMatchPattern, FcMatchFont, FcMatchScan
258
typedef enum _FcLangResult {
260
FcLangDifferentCountry = 1,
261
FcLangDifferentTerritory = 1,
262
FcLangDifferentLang = 2
265
typedef enum _FcSetName {
270
typedef struct _FcAtomic FcAtomic;
272
#if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
273
#define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
274
#define _FCFUNCPROTOEND }
276
#define _FCFUNCPROTOBEGIN
277
#define _FCFUNCPROTOEND
280
typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
282
typedef struct _FcConfig FcConfig;
284
typedef struct _FcGlobalCache FcFileCache;
286
typedef struct _FcBlanks FcBlanks;
288
typedef struct _FcStrList FcStrList;
290
typedef struct _FcStrSet FcStrSet;
292
typedef struct _FcCache FcCache;
298
FcBlanksCreate (void);
301
FcBlanksDestroy (FcBlanks *b);
304
FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
307
FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
311
FcPublic const FcChar8 *
312
FcCacheDir(const FcCache *c);
315
FcCacheCopySet(const FcCache *c);
317
FcPublic const FcChar8 *
318
FcCacheSubdir (const FcCache *c, int i);
321
FcCacheNumSubdir (const FcCache *c);
324
FcCacheNumFont (const FcCache *c);
327
FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
330
FcDirCacheValid (const FcChar8 *cache_file);
337
FcConfigEnableHome (FcBool enable);
340
FcConfigFilename (const FcChar8 *url);
343
FcConfigCreate (void);
346
FcConfigReference (FcConfig *config);
349
FcConfigDestroy (FcConfig *config);
352
FcConfigSetCurrent (FcConfig *config);
355
FcConfigGetCurrent (void);
358
FcConfigUptoDate (FcConfig *config);
361
FcConfigBuildFonts (FcConfig *config);
364
FcConfigGetFontDirs (FcConfig *config);
367
FcConfigGetConfigDirs (FcConfig *config);
370
FcConfigGetConfigFiles (FcConfig *config);
373
FcConfigGetCache (FcConfig *config);
376
FcConfigGetBlanks (FcConfig *config);
379
FcConfigGetCacheDirs (FcConfig *config);
382
FcConfigGetRescanInterval (FcConfig *config);
385
FcConfigSetRescanInterval (FcConfig *config, int rescanInterval);
388
FcConfigGetFonts (FcConfig *config,
392
FcConfigAppFontAddFile (FcConfig *config,
393
const FcChar8 *file);
396
FcConfigAppFontAddDir (FcConfig *config,
400
FcConfigAppFontClear (FcConfig *config);
403
FcConfigSubstituteWithPat (FcConfig *config,
409
FcConfigSubstitute (FcConfig *config,
415
FcCharSetCreate (void);
417
/* deprecated alias for FcCharSetCreate */
422
FcCharSetDestroy (FcCharSet *fcs);
425
FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
428
FcCharSetCopy (FcCharSet *src);
431
FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
434
FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
437
FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
440
FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
443
FcCharSetMerge (FcCharSet *a, const FcCharSet *b, FcBool *changed);
446
FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
449
FcCharSetCount (const FcCharSet *a);
452
FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
455
FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
458
FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
460
#define FC_CHARSET_MAP_SIZE (256/32)
461
#define FC_CHARSET_DONE ((FcChar32) -1)
464
FcCharSetFirstPage (const FcCharSet *a,
465
FcChar32 map[FC_CHARSET_MAP_SIZE],
469
FcCharSetNextPage (const FcCharSet *a,
470
FcChar32 map[FC_CHARSET_MAP_SIZE],
474
* old coverage API, rather hard to use correctly
478
FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
482
FcValuePrint (const FcValue v);
485
FcPatternPrint (const FcPattern *p);
488
FcFontSetPrint (const FcFontSet *s);
492
FcDefaultSubstitute (FcPattern *pattern);
496
FcFileIsDir (const FcChar8 *file);
499
FcFileScan (FcFontSet *set,
507
FcDirScan (FcFontSet *set,
515
FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
518
FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
521
FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
524
FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
527
FcDirCacheUnload (FcCache *cache);
531
FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
536
FcFontSetCreate (void);
539
FcFontSetDestroy (FcFontSet *s);
542
FcFontSetAdd (FcFontSet *s, FcPattern *font);
546
FcInitLoadConfig (void);
549
FcInitLoadConfigAndFonts (void);
561
FcInitReinitialize (void);
564
FcInitBringUptoDate (void);
570
FcPublic const FcCharSet *
571
FcLangGetCharSet (const FcChar8 *lang);
574
FcLangSetCreate (void);
577
FcLangSetDestroy (FcLangSet *ls);
580
FcLangSetCopy (const FcLangSet *ls);
583
FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
585
FcPublic FcLangResult
586
FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
588
FcPublic FcLangResult
589
FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
592
FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
595
FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
598
FcLangSetHash (const FcLangSet *ls);
601
FcLangSetGetLangs (const FcLangSet *ls);
604
FcPublic FcObjectSet *
605
FcObjectSetCreate (void);
608
FcObjectSetAdd (FcObjectSet *os, const char *object);
611
FcObjectSetDestroy (FcObjectSet *os);
613
FcPublic FcObjectSet *
614
FcObjectSetVaBuild (const char *first, va_list va);
616
FcPublic FcObjectSet *
617
FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
620
FcFontSetList (FcConfig *config,
627
FcFontList (FcConfig *config,
634
FcAtomicCreate (const FcChar8 *file);
637
FcAtomicLock (FcAtomic *atomic);
640
FcAtomicNewFile (FcAtomic *atomic);
643
FcAtomicOrigFile (FcAtomic *atomic);
646
FcAtomicReplaceOrig (FcAtomic *atomic);
649
FcAtomicDeleteNew (FcAtomic *atomic);
652
FcAtomicUnlock (FcAtomic *atomic);
655
FcAtomicDestroy (FcAtomic *atomic);
659
FcFontSetMatch (FcConfig *config,
666
FcFontMatch (FcConfig *config,
671
FcFontRenderPrepare (FcConfig *config,
676
FcFontSetSort (FcConfig *config,
685
FcFontSort (FcConfig *config,
692
FcFontSetSortDestroy (FcFontSet *fs);
696
FcMatrixCopy (const FcMatrix *mat);
699
FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
702
FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
705
FcMatrixRotate (FcMatrix *m, double c, double s);
708
FcMatrixScale (FcMatrix *m, double sx, double sy);
711
FcMatrixShear (FcMatrix *m, double sh, double sv);
716
FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
719
FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
721
FcPublic const FcObjectType *
722
FcNameGetObjectType (const char *object);
725
FcNameRegisterConstants (const FcConstant *consts, int nconsts);
728
FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
730
FcPublic const FcConstant *
731
FcNameGetConstant (FcChar8 *string);
734
FcNameConstant (FcChar8 *string, int *result);
737
FcNameParse (const FcChar8 *name);
740
FcNameUnparse (FcPattern *pat);
744
FcPatternCreate (void);
747
FcPatternDuplicate (const FcPattern *p);
750
FcPatternReference (FcPattern *p);
753
FcPatternFilter (FcPattern *p, const FcObjectSet *os);
756
FcValueDestroy (FcValue v);
759
FcValueEqual (FcValue va, FcValue vb);
762
FcValueSave (FcValue v);
765
FcPatternDestroy (FcPattern *p);
768
FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
771
FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
774
FcPatternHash (const FcPattern *p);
777
FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
780
FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
783
FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
786
FcPatternDel (FcPattern *p, const char *object);
789
FcPatternRemove (FcPattern *p, const char *object, int id);
792
FcPatternAddInteger (FcPattern *p, const char *object, int i);
795
FcPatternAddDouble (FcPattern *p, const char *object, double d);
798
FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
801
FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
804
FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
807
FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
810
FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
813
FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
816
FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
819
FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
822
FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
825
FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
828
FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
831
FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
834
FcPatternVaBuild (FcPattern *p, va_list va);
837
FcPatternBuild (FcPattern *p, ...) FC_ATTRIBUTE_SENTINEL(0);
840
FcPatternFormat (FcPattern *pat, const FcChar8 *format);
845
FcStrCopy (const FcChar8 *s);
848
FcStrCopyFilename (const FcChar8 *s);
851
FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
854
FcStrFree (FcChar8 *s);
856
/* These are ASCII only, suitable only for pattern element names */
857
#define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
858
#define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
859
#define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
862
FcStrDowncase (const FcChar8 *s);
865
FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
868
FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
870
FcPublic const FcChar8 *
871
FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
873
FcPublic const FcChar8 *
874
FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
877
FcUtf8ToUcs4 (const FcChar8 *src_orig,
882
FcUtf8Len (const FcChar8 *string,
887
#define FC_UTF8_MAX_LEN 6
890
FcUcs4ToUtf8 (FcChar32 ucs4,
891
FcChar8 dest[FC_UTF8_MAX_LEN]);
894
FcUtf16ToUcs4 (const FcChar8 *src_orig,
897
int len); /* in bytes */
900
FcUtf16Len (const FcChar8 *string,
902
int len, /* in bytes */
907
FcStrDirname (const FcChar8 *file);
910
FcStrBasename (const FcChar8 *file);
913
FcStrSetCreate (void);
916
FcStrSetMember (FcStrSet *set, const FcChar8 *s);
919
FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
922
FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
925
FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
928
FcStrSetDel (FcStrSet *set, const FcChar8 *s);
931
FcStrSetDestroy (FcStrSet *set);
934
FcStrListCreate (FcStrSet *set);
937
FcStrListNext (FcStrList *list);
940
FcStrListDone (FcStrList *list);
944
FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
948
#undef FC_ATTRIBUTE_SENTINEL
954
* Deprecated functions are placed here to help users fix their code without
955
* digging through documentation
958
#define FcConfigGetRescanInverval FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
959
#define FcConfigSetRescanInverval FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
963
#endif /* _FONTCONFIG_H_ */