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 the author(s) not be used in
11 * advertising or publicity pertaining to distribution of the software without
12 * specific, written prior permission. The authors make 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 /* FC_GLOBAL_ADVANCE is deprecated. this is simply ignored on freetype 2.4.5 or later */
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 */
115 #define FC_NAMELANG "namelang" /* String RFC 3866 langs */
117 #define FC_CACHE_SUFFIX ".cache-" FC_CACHE_VERSION
118 #define FC_DIR_CACHE_FILE "fonts.cache-" FC_CACHE_VERSION
119 #define FC_USER_CACHE_FILE ".fonts.cache-" FC_CACHE_VERSION
121 /* Adjust outline rasterizer */
122 #define FC_CHAR_WIDTH "charwidth" /* Int */
123 #define FC_CHAR_HEIGHT "charheight"/* Int */
124 #define FC_MATRIX "matrix" /* FcMatrix */
126 #define FC_WEIGHT_THIN 0
127 #define FC_WEIGHT_EXTRALIGHT 40
128 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
129 #define FC_WEIGHT_LIGHT 50
130 #define FC_WEIGHT_BOOK 75
131 #define FC_WEIGHT_REGULAR 80
132 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
133 #define FC_WEIGHT_MEDIUM 100
134 #define FC_WEIGHT_DEMIBOLD 180
135 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
136 #define FC_WEIGHT_BOLD 200
137 #define FC_WEIGHT_EXTRABOLD 205
138 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
139 #define FC_WEIGHT_BLACK 210
140 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
141 #define FC_WEIGHT_EXTRABLACK 215
142 #define FC_WEIGHT_ULTRABLACK FC_WEIGHT_EXTRABLACK
144 #define FC_SLANT_ROMAN 0
145 #define FC_SLANT_ITALIC 100
146 #define FC_SLANT_OBLIQUE 110
148 #define FC_WIDTH_ULTRACONDENSED 50
149 #define FC_WIDTH_EXTRACONDENSED 63
150 #define FC_WIDTH_CONDENSED 75
151 #define FC_WIDTH_SEMICONDENSED 87
152 #define FC_WIDTH_NORMAL 100
153 #define FC_WIDTH_SEMIEXPANDED 113
154 #define FC_WIDTH_EXPANDED 125
155 #define FC_WIDTH_EXTRAEXPANDED 150
156 #define FC_WIDTH_ULTRAEXPANDED 200
158 #define FC_PROPORTIONAL 0
161 #define FC_CHARCELL 110
163 /* sub-pixel order */
164 #define FC_RGBA_UNKNOWN 0
165 #define FC_RGBA_RGB 1
166 #define FC_RGBA_BGR 2
167 #define FC_RGBA_VRGB 3
168 #define FC_RGBA_VBGR 4
169 #define FC_RGBA_NONE 5
172 #define FC_HINT_NONE 0
173 #define FC_HINT_SLIGHT 1
174 #define FC_HINT_MEDIUM 2
175 #define FC_HINT_FULL 3
178 #define FC_LCD_NONE 0
179 #define FC_LCD_DEFAULT 1
180 #define FC_LCD_LIGHT 2
181 #define FC_LCD_LEGACY 3
183 typedef enum _FcType {
195 typedef struct _FcMatrix {
196 double xx, xy, yx, yy;
199 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
200 (m)->xy = (m)->yx = 0)
203 * A data structure to represent the available glyphs in a font.
204 * This is represented as a sparse boolean btree.
207 typedef struct _FcCharSet FcCharSet;
209 typedef struct _FcObjectType {
214 typedef struct _FcConstant {
220 typedef enum _FcResult {
221 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
225 typedef struct _FcPattern FcPattern;
227 typedef struct _FcLangSet FcLangSet;
229 typedef struct _FcValue {
243 typedef struct _FcFontSet {
249 typedef struct _FcObjectSet {
252 const char **objects;
255 typedef enum _FcMatchKind {
256 FcMatchPattern, FcMatchFont, FcMatchScan
259 typedef enum _FcLangResult {
261 FcLangDifferentCountry = 1,
262 FcLangDifferentTerritory = 1,
263 FcLangDifferentLang = 2
266 typedef enum _FcSetName {
271 typedef struct _FcAtomic FcAtomic;
273 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
274 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
275 #define _FCFUNCPROTOEND }
277 #define _FCFUNCPROTOBEGIN
278 #define _FCFUNCPROTOEND
281 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
283 typedef struct _FcConfig FcConfig;
285 typedef struct _FcGlobalCache FcFileCache;
287 typedef struct _FcBlanks FcBlanks;
289 typedef struct _FcStrList FcStrList;
291 typedef struct _FcStrSet FcStrSet;
293 typedef struct _FcCache FcCache;
299 FcBlanksCreate (void);
302 FcBlanksDestroy (FcBlanks *b);
305 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
308 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
312 FcPublic const FcChar8 *
313 FcCacheDir(const FcCache *c);
316 FcCacheCopySet(const FcCache *c);
318 FcPublic const FcChar8 *
319 FcCacheSubdir (const FcCache *c, int i);
322 FcCacheNumSubdir (const FcCache *c);
325 FcCacheNumFont (const FcCache *c);
328 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
331 FcDirCacheValid (const FcChar8 *cache_file);
334 FcDirCacheClean (const FcChar8 *cache_dir, FcBool verbose);
337 FcCacheCreateTagFile (const FcConfig *config);
344 FcConfigEnableHome (FcBool enable);
347 FcConfigFilename (const FcChar8 *url);
350 FcConfigCreate (void);
353 FcConfigReference (FcConfig *config);
356 FcConfigDestroy (FcConfig *config);
359 FcConfigSetCurrent (FcConfig *config);
362 FcConfigGetCurrent (void);
365 FcConfigUptoDate (FcConfig *config);
368 FcConfigBuildFonts (FcConfig *config);
371 FcConfigGetFontDirs (FcConfig *config);
374 FcConfigGetConfigDirs (FcConfig *config);
377 FcConfigGetConfigFiles (FcConfig *config);
380 FcConfigGetCache (FcConfig *config);
383 FcConfigGetBlanks (FcConfig *config);
386 FcConfigGetCacheDirs (const FcConfig *config);
389 FcConfigGetRescanInterval (FcConfig *config);
392 FcConfigSetRescanInterval (FcConfig *config, int rescanInterval);
395 FcConfigGetFonts (FcConfig *config,
399 FcConfigAppFontAddFile (FcConfig *config,
400 const FcChar8 *file);
403 FcConfigAppFontAddDir (FcConfig *config,
407 FcConfigAppFontClear (FcConfig *config);
410 FcConfigSubstituteWithPat (FcConfig *config,
416 FcConfigSubstitute (FcConfig *config,
422 FcCharSetCreate (void);
424 /* deprecated alias for FcCharSetCreate */
429 FcCharSetDestroy (FcCharSet *fcs);
432 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
435 FcCharSetDelChar (FcCharSet *fcs, FcChar32 ucs4);
438 FcCharSetCopy (FcCharSet *src);
441 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
444 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
447 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
450 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
453 FcCharSetMerge (FcCharSet *a, const FcCharSet *b, FcBool *changed);
456 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
459 FcCharSetCount (const FcCharSet *a);
462 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
465 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
468 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
470 #define FC_CHARSET_MAP_SIZE (256/32)
471 #define FC_CHARSET_DONE ((FcChar32) -1)
474 FcCharSetFirstPage (const FcCharSet *a,
475 FcChar32 map[FC_CHARSET_MAP_SIZE],
479 FcCharSetNextPage (const FcCharSet *a,
480 FcChar32 map[FC_CHARSET_MAP_SIZE],
484 * old coverage API, rather hard to use correctly
488 FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
492 FcValuePrint (const FcValue v);
495 FcPatternPrint (const FcPattern *p);
498 FcFontSetPrint (const FcFontSet *s);
502 FcGetDefaultLangs (void);
505 FcDefaultSubstitute (FcPattern *pattern);
509 FcFileIsDir (const FcChar8 *file);
512 FcFileScan (FcFontSet *set,
520 FcDirScan (FcFontSet *set,
528 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
531 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
534 FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
537 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
540 FcDirCacheUnload (FcCache *cache);
544 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
549 FcFontSetCreate (void);
552 FcFontSetDestroy (FcFontSet *s);
555 FcFontSetAdd (FcFontSet *s, FcPattern *font);
559 FcInitLoadConfig (void);
562 FcInitLoadConfigAndFonts (void);
574 FcInitReinitialize (void);
577 FcInitBringUptoDate (void);
583 FcPublic const FcCharSet *
584 FcLangGetCharSet (const FcChar8 *lang);
587 FcLangSetCreate (void);
590 FcLangSetDestroy (FcLangSet *ls);
593 FcLangSetCopy (const FcLangSet *ls);
596 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
599 FcLangSetDel (FcLangSet *ls, const FcChar8 *lang);
601 FcPublic FcLangResult
602 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
604 FcPublic FcLangResult
605 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
608 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
611 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
614 FcLangSetHash (const FcLangSet *ls);
617 FcLangSetGetLangs (const FcLangSet *ls);
620 FcLangSetUnion (const FcLangSet *a, const FcLangSet *b);
623 FcLangSetSubtract (const FcLangSet *a, const FcLangSet *b);
626 FcPublic FcObjectSet *
627 FcObjectSetCreate (void);
630 FcObjectSetAdd (FcObjectSet *os, const char *object);
633 FcObjectSetDestroy (FcObjectSet *os);
635 FcPublic FcObjectSet *
636 FcObjectSetVaBuild (const char *first, va_list va);
638 FcPublic FcObjectSet *
639 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
642 FcFontSetList (FcConfig *config,
649 FcFontList (FcConfig *config,
656 FcAtomicCreate (const FcChar8 *file);
659 FcAtomicLock (FcAtomic *atomic);
662 FcAtomicNewFile (FcAtomic *atomic);
665 FcAtomicOrigFile (FcAtomic *atomic);
668 FcAtomicReplaceOrig (FcAtomic *atomic);
671 FcAtomicDeleteNew (FcAtomic *atomic);
674 FcAtomicUnlock (FcAtomic *atomic);
677 FcAtomicDestroy (FcAtomic *atomic);
681 FcFontSetMatch (FcConfig *config,
688 FcFontMatch (FcConfig *config,
693 FcFontRenderPrepare (FcConfig *config,
698 FcFontSetSort (FcConfig *config,
707 FcFontSort (FcConfig *config,
714 FcFontSetSortDestroy (FcFontSet *fs);
718 FcMatrixCopy (const FcMatrix *mat);
721 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
724 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
727 FcMatrixRotate (FcMatrix *m, double c, double s);
730 FcMatrixScale (FcMatrix *m, double sx, double sy);
733 FcMatrixShear (FcMatrix *m, double sh, double sv);
738 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
741 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
743 FcPublic const FcObjectType *
744 FcNameGetObjectType (const char *object);
747 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
750 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
752 FcPublic const FcConstant *
753 FcNameGetConstant (const FcChar8 *string);
756 FcNameConstant (const FcChar8 *string, int *result);
759 FcNameParse (const FcChar8 *name);
762 FcNameUnparse (FcPattern *pat);
766 FcPatternCreate (void);
769 FcPatternDuplicate (const FcPattern *p);
772 FcPatternReference (FcPattern *p);
775 FcPatternFilter (FcPattern *p, const FcObjectSet *os);
778 FcValueDestroy (FcValue v);
781 FcValueEqual (FcValue va, FcValue vb);
784 FcValueSave (FcValue v);
787 FcPatternDestroy (FcPattern *p);
790 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
793 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
796 FcPatternHash (const FcPattern *p);
799 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
802 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
805 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
808 FcPatternDel (FcPattern *p, const char *object);
811 FcPatternRemove (FcPattern *p, const char *object, int id);
814 FcPatternAddInteger (FcPattern *p, const char *object, int i);
817 FcPatternAddDouble (FcPattern *p, const char *object, double d);
820 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
823 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
826 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
829 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
832 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
835 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
838 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
841 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
844 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
847 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
850 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
853 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
856 FcPatternVaBuild (FcPattern *p, va_list va);
859 FcPatternBuild (FcPattern *p, ...) FC_ATTRIBUTE_SENTINEL(0);
862 FcPatternFormat (FcPattern *pat, const FcChar8 *format);
867 FcStrCopy (const FcChar8 *s);
870 FcStrCopyFilename (const FcChar8 *s);
873 FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
876 FcStrFree (FcChar8 *s);
878 /* These are ASCII only, suitable only for pattern element names */
879 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
880 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
881 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
884 FcStrDowncase (const FcChar8 *s);
887 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
890 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
892 FcPublic const FcChar8 *
893 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
895 FcPublic const FcChar8 *
896 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
899 FcUtf8ToUcs4 (const FcChar8 *src_orig,
904 FcUtf8Len (const FcChar8 *string,
909 #define FC_UTF8_MAX_LEN 6
912 FcUcs4ToUtf8 (FcChar32 ucs4,
913 FcChar8 dest[FC_UTF8_MAX_LEN]);
916 FcUtf16ToUcs4 (const FcChar8 *src_orig,
919 int len); /* in bytes */
922 FcUtf16Len (const FcChar8 *string,
924 int len, /* in bytes */
929 FcStrDirname (const FcChar8 *file);
932 FcStrBasename (const FcChar8 *file);
935 FcStrSetCreate (void);
938 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
941 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
944 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
947 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
950 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
953 FcStrSetDestroy (FcStrSet *set);
956 FcStrListCreate (FcStrSet *set);
959 FcStrListNext (FcStrList *list);
962 FcStrListDone (FcStrList *list);
966 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
970 #undef FC_ATTRIBUTE_SENTINEL
976 * Deprecated functions are placed here to help users fix their code without
977 * digging through documentation
980 #define FcConfigGetRescanInverval FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
981 #define FcConfigSetRescanInverval FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
985 #endif /* _FONTCONFIG_H_ */