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>
32 #if defined(__GNUC__) && (__GNUC__ >= 4)
33 #define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
35 #define FC_ATTRIBUTE_SENTINEL(x)
42 typedef unsigned char FcChar8;
43 typedef unsigned short FcChar16;
44 typedef unsigned int FcChar32;
48 * Current Fontconfig version number. This same number
49 * must appear in the fontconfig configure.in file. Yes,
50 * it'a a pain to synchronize version numbers like this.
57 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
60 * Current font cache file format version
61 * This is appended to the cache files so that multiple
62 * versions of the library will peacefully coexist
64 * Change this value whenever the disk format for the cache file
65 * changes in any non-compatible way. Try to avoid such changes as
66 * it means multiple copies of the font information.
69 #define FC_CACHE_VERSION "3"
74 #define FC_FAMILY "family" /* String */
75 #define FC_STYLE "style" /* String */
76 #define FC_SLANT "slant" /* Int */
77 #define FC_WEIGHT "weight" /* Int */
78 #define FC_SIZE "size" /* Double */
79 #define FC_ASPECT "aspect" /* Double */
80 #define FC_PIXEL_SIZE "pixelsize" /* Double */
81 #define FC_SPACING "spacing" /* Int */
82 #define FC_FOUNDRY "foundry" /* String */
83 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
84 #define FC_HINTING "hinting" /* Bool (true) */
85 #define FC_HINT_STYLE "hintstyle" /* Int */
86 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
87 #define FC_AUTOHINT "autohint" /* Bool (false) */
88 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
89 #define FC_WIDTH "width" /* Int */
90 #define FC_FILE "file" /* String */
91 #define FC_INDEX "index" /* Int */
92 #define FC_FT_FACE "ftface" /* FT_Face */
93 #define FC_RASTERIZER "rasterizer" /* String */
94 #define FC_OUTLINE "outline" /* Bool */
95 #define FC_SCALABLE "scalable" /* Bool */
96 #define FC_SCALE "scale" /* double */
97 #define FC_DPI "dpi" /* double */
98 #define FC_RGBA "rgba" /* Int */
99 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
100 #define FC_SOURCE "source" /* String (deprecated) */
101 #define FC_CHARSET "charset" /* CharSet */
102 #define FC_LANG "lang" /* String RFC 3066 langs */
103 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
104 #define FC_FULLNAME "fullname" /* String */
105 #define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
106 #define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
107 #define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
108 #define FC_CAPABILITY "capability" /* String */
109 #define FC_FONTFORMAT "fontformat" /* String */
110 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
111 #define FC_EMBEDDED_BITMAP "embeddedbitmap" /* Bool - true to enable embedded bitmaps */
112 #define FC_DECORATIVE "decorative" /* Bool - true if style is a decorative variant */
113 #define FC_LCD_FILTER "lcdfilter" /* Int */
115 #define FC_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
116 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
117 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
119 /* Adjust outline rasterizer */
120 #define FC_CHAR_WIDTH "charwidth" /* Int */
121 #define FC_CHAR_HEIGHT "charheight"/* Int */
122 #define FC_MATRIX "matrix" /* FcMatrix */
124 #define FC_WEIGHT_THIN 0
125 #define FC_WEIGHT_EXTRALIGHT 40
126 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
127 #define FC_WEIGHT_LIGHT 50
128 #define FC_WEIGHT_BOOK 75
129 #define FC_WEIGHT_REGULAR 80
130 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
131 #define FC_WEIGHT_MEDIUM 100
132 #define FC_WEIGHT_DEMIBOLD 180
133 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
134 #define FC_WEIGHT_BOLD 200
135 #define FC_WEIGHT_EXTRABOLD 205
136 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
137 #define FC_WEIGHT_BLACK 210
138 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
139 #define FC_WEIGHT_EXTRABLACK 215
140 #define FC_WEIGHT_ULTRABLACK FC_WEIGHT_EXTRABLACK
142 #define FC_SLANT_ROMAN 0
143 #define FC_SLANT_ITALIC 100
144 #define FC_SLANT_OBLIQUE 110
146 #define FC_WIDTH_ULTRACONDENSED 50
147 #define FC_WIDTH_EXTRACONDENSED 63
148 #define FC_WIDTH_CONDENSED 75
149 #define FC_WIDTH_SEMICONDENSED 87
150 #define FC_WIDTH_NORMAL 100
151 #define FC_WIDTH_SEMIEXPANDED 113
152 #define FC_WIDTH_EXPANDED 125
153 #define FC_WIDTH_EXTRAEXPANDED 150
154 #define FC_WIDTH_ULTRAEXPANDED 200
156 #define FC_PROPORTIONAL 0
159 #define FC_CHARCELL 110
161 /* sub-pixel order */
162 #define FC_RGBA_UNKNOWN 0
163 #define FC_RGBA_RGB 1
164 #define FC_RGBA_BGR 2
165 #define FC_RGBA_VRGB 3
166 #define FC_RGBA_VBGR 4
167 #define FC_RGBA_NONE 5
170 #define FC_HINT_NONE 0
171 #define FC_HINT_SLIGHT 1
172 #define FC_HINT_MEDIUM 2
173 #define FC_HINT_FULL 3
176 #define FC_LCD_NONE 0
177 #define FC_LCD_DEFAULT 1
178 #define FC_LCD_LIGHT 2
179 #define FC_LCD_LEGACY 3
181 typedef enum _FcType {
193 typedef struct _FcMatrix {
194 double xx, xy, yx, yy;
197 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
198 (m)->xy = (m)->yx = 0)
201 * A data structure to represent the available glyphs in a font.
202 * This is represented as a sparse boolean btree.
205 typedef struct _FcCharSet FcCharSet;
207 typedef struct _FcObjectType {
212 typedef struct _FcConstant {
218 typedef enum _FcResult {
219 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
223 typedef struct _FcPattern FcPattern;
225 typedef struct _FcLangSet FcLangSet;
227 typedef struct _FcValue {
241 typedef struct _FcFontSet {
247 typedef struct _FcObjectSet {
250 const char **objects;
253 typedef enum _FcMatchKind {
254 FcMatchPattern, FcMatchFont, FcMatchScan
257 typedef enum _FcLangResult {
259 FcLangDifferentCountry = 1,
260 FcLangDifferentTerritory = 1,
261 FcLangDifferentLang = 2
264 typedef enum _FcSetName {
269 typedef struct _FcAtomic FcAtomic;
271 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
272 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
273 #define _FCFUNCPROTOEND }
275 #define _FCFUNCPROTOBEGIN
276 #define _FCFUNCPROTOEND
279 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
281 typedef struct _FcConfig FcConfig;
283 typedef struct _FcGlobalCache FcFileCache;
285 typedef struct _FcBlanks FcBlanks;
287 typedef struct _FcStrList FcStrList;
289 typedef struct _FcStrSet FcStrSet;
291 typedef struct _FcCache FcCache;
297 FcBlanksCreate (void);
300 FcBlanksDestroy (FcBlanks *b);
303 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
306 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
310 FcPublic const FcChar8 *
311 FcCacheDir(const FcCache *c);
314 FcCacheCopySet(const FcCache *c);
316 FcPublic const FcChar8 *
317 FcCacheSubdir (const FcCache *c, int i);
320 FcCacheNumSubdir (const FcCache *c);
323 FcCacheNumFont (const FcCache *c);
326 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
329 FcDirCacheValid (const FcChar8 *cache_file);
336 FcConfigEnableHome (FcBool enable);
339 FcConfigFilename (const FcChar8 *url);
342 FcConfigCreate (void);
345 FcConfigReference (FcConfig *config);
348 FcConfigDestroy (FcConfig *config);
351 FcConfigSetCurrent (FcConfig *config);
354 FcConfigGetCurrent (void);
357 FcConfigUptoDate (FcConfig *config);
360 FcConfigBuildFonts (FcConfig *config);
363 FcConfigGetFontDirs (FcConfig *config);
366 FcConfigGetConfigDirs (FcConfig *config);
369 FcConfigGetConfigFiles (FcConfig *config);
372 FcConfigGetCache (FcConfig *config);
375 FcConfigGetBlanks (FcConfig *config);
378 FcConfigGetCacheDirs (FcConfig *config);
381 FcConfigGetRescanInterval (FcConfig *config);
384 FcConfigSetRescanInterval (FcConfig *config, int rescanInterval);
387 FcConfigGetFonts (FcConfig *config,
391 FcConfigAppFontAddFile (FcConfig *config,
392 const FcChar8 *file);
395 FcConfigAppFontAddDir (FcConfig *config,
399 FcConfigAppFontClear (FcConfig *config);
402 FcConfigSubstituteWithPat (FcConfig *config,
408 FcConfigSubstitute (FcConfig *config,
414 FcCharSetCreate (void);
416 /* deprecated alias for FcCharSetCreate */
421 FcCharSetDestroy (FcCharSet *fcs);
424 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
427 FcCharSetCopy (FcCharSet *src);
430 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
433 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
436 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
439 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
442 FcCharSetMerge (FcCharSet *a, const FcCharSet *b, FcBool *changed);
445 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
448 FcCharSetCount (const FcCharSet *a);
451 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
454 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
457 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
459 #define FC_CHARSET_MAP_SIZE (256/32)
460 #define FC_CHARSET_DONE ((FcChar32) -1)
463 FcCharSetFirstPage (const FcCharSet *a,
464 FcChar32 map[FC_CHARSET_MAP_SIZE],
468 FcCharSetNextPage (const FcCharSet *a,
469 FcChar32 map[FC_CHARSET_MAP_SIZE],
473 * old coverage API, rather hard to use correctly
477 FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
481 FcValuePrint (const FcValue v);
484 FcPatternPrint (const FcPattern *p);
487 FcFontSetPrint (const FcFontSet *s);
491 FcDefaultSubstitute (FcPattern *pattern);
495 FcFileIsDir (const FcChar8 *file);
498 FcFileScan (FcFontSet *set,
506 FcDirScan (FcFontSet *set,
514 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
517 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
520 FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
523 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
526 FcDirCacheUnload (FcCache *cache);
530 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
535 FcFontSetCreate (void);
538 FcFontSetDestroy (FcFontSet *s);
541 FcFontSetAdd (FcFontSet *s, FcPattern *font);
545 FcInitLoadConfig (void);
548 FcInitLoadConfigAndFonts (void);
560 FcInitReinitialize (void);
563 FcInitBringUptoDate (void);
569 FcPublic const FcCharSet *
570 FcLangGetCharSet (const FcChar8 *lang);
573 FcLangSetCreate (void);
576 FcLangSetDestroy (FcLangSet *ls);
579 FcLangSetCopy (const FcLangSet *ls);
582 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
584 FcPublic FcLangResult
585 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
587 FcPublic FcLangResult
588 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
591 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
594 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
597 FcLangSetHash (const FcLangSet *ls);
600 FcLangSetGetLangs (const FcLangSet *ls);
603 FcPublic FcObjectSet *
604 FcObjectSetCreate (void);
607 FcObjectSetAdd (FcObjectSet *os, const char *object);
610 FcObjectSetDestroy (FcObjectSet *os);
612 FcPublic FcObjectSet *
613 FcObjectSetVaBuild (const char *first, va_list va);
615 FcPublic FcObjectSet *
616 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
619 FcFontSetList (FcConfig *config,
626 FcFontList (FcConfig *config,
633 FcAtomicCreate (const FcChar8 *file);
636 FcAtomicLock (FcAtomic *atomic);
639 FcAtomicNewFile (FcAtomic *atomic);
642 FcAtomicOrigFile (FcAtomic *atomic);
645 FcAtomicReplaceOrig (FcAtomic *atomic);
648 FcAtomicDeleteNew (FcAtomic *atomic);
651 FcAtomicUnlock (FcAtomic *atomic);
654 FcAtomicDestroy (FcAtomic *atomic);
658 FcFontSetMatch (FcConfig *config,
665 FcFontMatch (FcConfig *config,
670 FcFontRenderPrepare (FcConfig *config,
675 FcFontSetSort (FcConfig *config,
684 FcFontSort (FcConfig *config,
691 FcFontSetSortDestroy (FcFontSet *fs);
695 FcMatrixCopy (const FcMatrix *mat);
698 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
701 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
704 FcMatrixRotate (FcMatrix *m, double c, double s);
707 FcMatrixScale (FcMatrix *m, double sx, double sy);
710 FcMatrixShear (FcMatrix *m, double sh, double sv);
715 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
718 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
720 FcPublic const FcObjectType *
721 FcNameGetObjectType (const char *object);
724 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
727 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
729 FcPublic const FcConstant *
730 FcNameGetConstant (FcChar8 *string);
733 FcNameConstant (FcChar8 *string, int *result);
736 FcNameParse (const FcChar8 *name);
739 FcNameUnparse (FcPattern *pat);
743 FcPatternCreate (void);
746 FcPatternDuplicate (const FcPattern *p);
749 FcPatternReference (FcPattern *p);
752 FcPatternFilter (FcPattern *p, const FcObjectSet *os);
755 FcValueDestroy (FcValue v);
758 FcValueEqual (FcValue va, FcValue vb);
761 FcValueSave (FcValue v);
764 FcPatternDestroy (FcPattern *p);
767 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
770 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
773 FcPatternHash (const FcPattern *p);
776 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
779 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
782 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
785 FcPatternDel (FcPattern *p, const char *object);
788 FcPatternRemove (FcPattern *p, const char *object, int id);
791 FcPatternAddInteger (FcPattern *p, const char *object, int i);
794 FcPatternAddDouble (FcPattern *p, const char *object, double d);
797 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
800 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
803 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
806 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
809 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
812 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
815 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
818 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
821 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
824 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
827 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
830 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
833 FcPatternVaBuild (FcPattern *p, va_list va);
836 FcPatternBuild (FcPattern *p, ...) FC_ATTRIBUTE_SENTINEL(0);
839 FcPatternFormat (FcPattern *pat, const FcChar8 *format);
844 FcStrCopy (const FcChar8 *s);
847 FcStrCopyFilename (const FcChar8 *s);
850 FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
853 FcStrFree (FcChar8 *s);
855 /* These are ASCII only, suitable only for pattern element names */
856 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
857 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
858 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
861 FcStrDowncase (const FcChar8 *s);
864 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
867 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
869 FcPublic const FcChar8 *
870 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
872 FcPublic const FcChar8 *
873 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
876 FcUtf8ToUcs4 (const FcChar8 *src_orig,
881 FcUtf8Len (const FcChar8 *string,
886 #define FC_UTF8_MAX_LEN 6
889 FcUcs4ToUtf8 (FcChar32 ucs4,
890 FcChar8 dest[FC_UTF8_MAX_LEN]);
893 FcUtf16ToUcs4 (const FcChar8 *src_orig,
896 int len); /* in bytes */
899 FcUtf16Len (const FcChar8 *string,
901 int len, /* in bytes */
906 FcStrDirname (const FcChar8 *file);
909 FcStrBasename (const FcChar8 *file);
912 FcStrSetCreate (void);
915 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
918 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
921 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
924 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
927 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
930 FcStrSetDestroy (FcStrSet *set);
933 FcStrListCreate (FcStrSet *set);
936 FcStrListNext (FcStrList *list);
939 FcStrListDone (FcStrList *list);
943 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
947 #undef FC_ATTRIBUTE_SENTINEL
953 * Deprecated functions are placed here to help users fix their code without
954 * digging through documentation
957 #define FcConfigGetRescanInverval FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
958 #define FcConfigSetRescanInverval FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
962 #endif /* _FONTCONFIG_H_ */