2 * $RCSId: xc/lib/fontconfig/fontconfig/fontconfig.h,v 1.30 2002/09/26 00:17:27 keithp Exp $
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 * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18 * EVENT SHALL KEITH PACKARD 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 "2"
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 */
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
175 typedef enum _FcType {
187 typedef struct _FcMatrix {
188 double xx, xy, yx, yy;
191 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
192 (m)->xy = (m)->yx = 0)
195 * A data structure to represent the available glyphs in a font.
196 * This is represented as a sparse boolean btree.
199 typedef struct _FcCharSet FcCharSet;
201 typedef struct _FcObjectType {
206 typedef struct _FcConstant {
212 typedef enum _FcResult {
213 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
217 typedef struct _FcPattern FcPattern;
219 typedef struct _FcLangSet FcLangSet;
221 typedef struct _FcValue {
236 typedef struct _FcFontSet {
242 typedef struct _FcObjectSet {
245 const char **objects;
248 typedef enum _FcMatchKind {
249 FcMatchPattern, FcMatchFont, FcMatchScan
252 typedef enum _FcLangResult {
253 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
256 typedef enum _FcSetName {
261 typedef struct _FcAtomic FcAtomic;
263 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
264 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
265 #define _FCFUNCPROTOEND }
267 #define _FCFUNCPROTOBEGIN
268 #define _FCFUNCPROTOEND
271 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
273 typedef struct _FcConfig FcConfig;
275 typedef struct _FcGlobalCache FcFileCache;
277 typedef struct _FcBlanks FcBlanks;
279 typedef struct _FcStrList FcStrList;
281 typedef struct _FcStrSet FcStrSet;
283 typedef struct _FcCache FcCache;
289 FcBlanksCreate (void);
292 FcBlanksDestroy (FcBlanks *b);
295 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
298 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
302 FcPublic const FcChar8 *
303 FcCacheDir(const FcCache *c);
306 FcCacheCopySet(const FcCache *c);
308 FcPublic const FcChar8 *
309 FcCacheSubdir (const FcCache *c, int i);
312 FcCacheNumSubdir (const FcCache *c);
315 FcCacheNumFont (const FcCache *c);
318 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
321 FcDirCacheValid (const FcChar8 *cache_file);
328 FcConfigEnableHome (FcBool enable);
331 FcConfigFilename (const FcChar8 *url);
334 FcConfigCreate (void);
337 FcConfigDestroy (FcConfig *config);
340 FcConfigSetCurrent (FcConfig *config);
343 FcConfigGetCurrent (void);
346 FcConfigUptoDate (FcConfig *config);
349 FcConfigBuildFonts (FcConfig *config);
352 FcConfigGetFontDirs (FcConfig *config);
355 FcConfigGetConfigDirs (FcConfig *config);
358 FcConfigGetConfigFiles (FcConfig *config);
361 FcConfigGetCache (FcConfig *config);
364 FcConfigGetBlanks (FcConfig *config);
367 FcConfigGetCacheDirs (FcConfig *config);
370 FcConfigGetRescanInverval (FcConfig *config);
373 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
376 FcConfigGetFonts (FcConfig *config,
380 FcConfigAppFontAddFile (FcConfig *config,
381 const FcChar8 *file);
384 FcConfigAppFontAddDir (FcConfig *config,
388 FcConfigAppFontClear (FcConfig *config);
391 FcConfigSubstituteWithPat (FcConfig *config,
397 FcConfigSubstitute (FcConfig *config,
403 FcCharSetCreate (void);
405 /* deprecated alias for FcCharSetCreate */
410 FcCharSetDestroy (FcCharSet *fcs);
413 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
416 FcCharSetCopy (FcCharSet *src);
419 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
422 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
425 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
428 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
431 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
434 FcCharSetCount (const FcCharSet *a);
437 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
440 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
443 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
445 #define FC_CHARSET_MAP_SIZE (256/32)
446 #define FC_CHARSET_DONE ((FcChar32) -1)
449 FcCharSetFirstPage (const FcCharSet *a,
450 FcChar32 map[FC_CHARSET_MAP_SIZE],
454 FcCharSetNextPage (const FcCharSet *a,
455 FcChar32 map[FC_CHARSET_MAP_SIZE],
459 * old coverage API, rather hard to use correctly
463 FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
467 FcValuePrint (const FcValue v);
470 FcPatternPrint (const FcPattern *p);
473 FcFontSetPrint (const FcFontSet *s);
477 FcDefaultSubstitute (FcPattern *pattern);
481 FcFileIsDir (const FcChar8 *file);
484 FcFileScan (FcFontSet *set,
492 FcDirScan (FcFontSet *set,
500 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
503 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
506 FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
509 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
512 FcDirCacheUnload (FcCache *cache);
516 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
521 FcFontSetCreate (void);
524 FcFontSetDestroy (FcFontSet *s);
527 FcFontSetAdd (FcFontSet *s, FcPattern *font);
531 FcInitLoadConfig (void);
534 FcInitLoadConfigAndFonts (void);
546 FcInitReinitialize (void);
549 FcInitBringUptoDate (void);
553 FcLangSetCreate (void);
556 FcLangSetDestroy (FcLangSet *ls);
559 FcLangSetCopy (const FcLangSet *ls);
562 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
564 FcPublic FcLangResult
565 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
567 FcPublic FcLangResult
568 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
571 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
574 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
577 FcLangSetHash (const FcLangSet *ls);
580 FcPublic FcObjectSet *
581 FcObjectSetCreate (void);
584 FcObjectSetAdd (FcObjectSet *os, const char *object);
587 FcObjectSetDestroy (FcObjectSet *os);
589 FcPublic FcObjectSet *
590 FcObjectSetVaBuild (const char *first, va_list va);
592 FcPublic FcObjectSet *
593 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
596 FcFontSetList (FcConfig *config,
603 FcFontList (FcConfig *config,
610 FcAtomicCreate (const FcChar8 *file);
613 FcAtomicLock (FcAtomic *atomic);
616 FcAtomicNewFile (FcAtomic *atomic);
619 FcAtomicOrigFile (FcAtomic *atomic);
622 FcAtomicReplaceOrig (FcAtomic *atomic);
625 FcAtomicDeleteNew (FcAtomic *atomic);
628 FcAtomicUnlock (FcAtomic *atomic);
631 FcAtomicDestroy (FcAtomic *atomic);
635 FcFontSetMatch (FcConfig *config,
642 FcFontMatch (FcConfig *config,
647 FcFontRenderPrepare (FcConfig *config,
652 FcFontSetSort (FcConfig *config,
661 FcFontSort (FcConfig *config,
668 FcFontSetSortDestroy (FcFontSet *fs);
672 FcMatrixCopy (const FcMatrix *mat);
675 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
678 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
681 FcMatrixRotate (FcMatrix *m, double c, double s);
684 FcMatrixScale (FcMatrix *m, double sx, double sy);
687 FcMatrixShear (FcMatrix *m, double sh, double sv);
692 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
695 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
697 FcPublic const FcObjectType *
698 FcNameGetObjectType (const char *object);
701 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
704 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
706 FcPublic const FcConstant *
707 FcNameGetConstant (FcChar8 *string);
710 FcNameConstant (FcChar8 *string, int *result);
713 FcNameParse (const FcChar8 *name);
716 FcNameUnparse (FcPattern *pat);
720 FcPatternCreate (void);
723 FcPatternDuplicate (const FcPattern *p);
726 FcPatternReference (FcPattern *p);
729 FcValueDestroy (FcValue v);
732 FcValueEqual (FcValue va, FcValue vb);
735 FcValueSave (FcValue v);
738 FcPatternDestroy (FcPattern *p);
741 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
744 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
747 FcPatternHash (const FcPattern *p);
750 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
753 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
756 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
759 FcPatternDel (FcPattern *p, const char *object);
762 FcPatternRemove (FcPattern *p, const char *object, int id);
765 FcPatternAddInteger (FcPattern *p, const char *object, int i);
768 FcPatternAddDouble (FcPattern *p, const char *object, double d);
771 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
774 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
777 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
780 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
783 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
786 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
789 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
792 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
795 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
798 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
801 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
804 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
807 FcPatternVaBuild (FcPattern *orig, va_list va);
810 FcPatternBuild (FcPattern *orig, ...) FC_ATTRIBUTE_SENTINEL(0);
815 FcStrCopy (const FcChar8 *s);
818 FcStrCopyFilename (const FcChar8 *s);
821 FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
824 FcStrFree (FcChar8 *s);
826 /* These are ASCII only, suitable only for pattern element names */
827 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
828 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
829 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
832 FcStrDowncase (const FcChar8 *s);
835 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
838 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
840 FcPublic const FcChar8 *
841 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
843 FcPublic const FcChar8 *
844 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
847 FcUtf8ToUcs4 (const FcChar8 *src_orig,
852 FcUtf8Len (const FcChar8 *string,
857 #define FC_UTF8_MAX_LEN 6
860 FcUcs4ToUtf8 (FcChar32 ucs4,
861 FcChar8 dest[FC_UTF8_MAX_LEN]);
864 FcUtf16ToUcs4 (const FcChar8 *src_orig,
867 int len); /* in bytes */
870 FcUtf16Len (const FcChar8 *string,
872 int len, /* in bytes */
877 FcStrDirname (const FcChar8 *file);
880 FcStrBasename (const FcChar8 *file);
883 FcStrSetCreate (void);
886 FcStrSetMember (FcPublic FcStrSet *set, const FcChar8 *s);
889 FcStrSetEqual (FcPublic FcStrSet *sa, FcPublic FcStrSet *sb);
892 FcStrSetAdd (FcPublic FcStrSet *set, const FcChar8 *s);
895 FcStrSetAddFilename (FcPublic FcStrSet *set, const FcChar8 *s);
898 FcStrSetDel (FcPublic FcStrSet *set, const FcChar8 *s);
901 FcStrSetDestroy (FcPublic FcStrSet *set);
904 FcStrListCreate (FcPublic FcStrSet *set);
907 FcStrListNext (FcStrList *list);
910 FcStrListDone (FcStrList *list);
914 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
918 #undef FC_ATTRIBUTE_SENTINEL
920 #endif /* _FONTCONFIG_H_ */