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.
56 #define FC_REVISION 92
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 {
235 typedef struct _FcFontSet {
241 typedef struct _FcObjectSet {
244 const char **objects;
247 typedef enum _FcMatchKind {
248 FcMatchPattern, FcMatchFont, FcMatchScan
251 typedef enum _FcLangResult {
253 FcLangDifferentCountry = 1,
254 FcLangDifferentTerritory = 1,
255 FcLangDifferentLang = 2
258 typedef enum _FcSetName {
263 typedef struct _FcAtomic FcAtomic;
265 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
266 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
267 #define _FCFUNCPROTOEND }
269 #define _FCFUNCPROTOBEGIN
270 #define _FCFUNCPROTOEND
273 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
275 typedef struct _FcConfig FcConfig;
277 typedef struct _FcGlobalCache FcFileCache;
279 typedef struct _FcBlanks FcBlanks;
281 typedef struct _FcStrList FcStrList;
283 typedef struct _FcStrSet FcStrSet;
285 typedef struct _FcCache FcCache;
291 FcBlanksCreate (void);
294 FcBlanksDestroy (FcBlanks *b);
297 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
300 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
304 FcPublic const FcChar8 *
305 FcCacheDir(const FcCache *c);
308 FcCacheCopySet(const FcCache *c);
310 FcPublic const FcChar8 *
311 FcCacheSubdir (const FcCache *c, int i);
314 FcCacheNumSubdir (const FcCache *c);
317 FcCacheNumFont (const FcCache *c);
320 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
323 FcDirCacheValid (const FcChar8 *cache_file);
330 FcConfigEnableHome (FcBool enable);
333 FcConfigFilename (const FcChar8 *url);
336 FcConfigCreate (void);
339 FcConfigDestroy (FcConfig *config);
342 FcConfigSetCurrent (FcConfig *config);
345 FcConfigGetCurrent (void);
348 FcConfigUptoDate (FcConfig *config);
351 FcConfigBuildFonts (FcConfig *config);
354 FcConfigGetFontDirs (FcConfig *config);
357 FcConfigGetConfigDirs (FcConfig *config);
360 FcConfigGetConfigFiles (FcConfig *config);
363 FcConfigGetCache (FcConfig *config);
366 FcConfigGetBlanks (FcConfig *config);
369 FcConfigGetCacheDirs (FcConfig *config);
372 FcConfigGetRescanInterval (FcConfig *config);
375 FcConfigSetRescanInterval (FcConfig *config, int rescanInterval);
378 FcConfigGetFonts (FcConfig *config,
382 FcConfigAppFontAddFile (FcConfig *config,
383 const FcChar8 *file);
386 FcConfigAppFontAddDir (FcConfig *config,
390 FcConfigAppFontClear (FcConfig *config);
393 FcConfigSubstituteWithPat (FcConfig *config,
399 FcConfigSubstitute (FcConfig *config,
405 FcCharSetCreate (void);
407 /* deprecated alias for FcCharSetCreate */
412 FcCharSetDestroy (FcCharSet *fcs);
415 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
418 FcCharSetCopy (FcCharSet *src);
421 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
424 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
427 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
430 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
433 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
436 FcCharSetCount (const FcCharSet *a);
439 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
442 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
445 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
447 #define FC_CHARSET_MAP_SIZE (256/32)
448 #define FC_CHARSET_DONE ((FcChar32) -1)
451 FcCharSetFirstPage (const FcCharSet *a,
452 FcChar32 map[FC_CHARSET_MAP_SIZE],
456 FcCharSetNextPage (const FcCharSet *a,
457 FcChar32 map[FC_CHARSET_MAP_SIZE],
461 * old coverage API, rather hard to use correctly
465 FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
469 FcValuePrint (const FcValue v);
472 FcPatternPrint (const FcPattern *p);
475 FcFontSetPrint (const FcFontSet *s);
479 FcDefaultSubstitute (FcPattern *pattern);
483 FcFileIsDir (const FcChar8 *file);
486 FcFileScan (FcFontSet *set,
494 FcDirScan (FcFontSet *set,
502 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
505 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
508 FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
511 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
514 FcDirCacheUnload (FcCache *cache);
518 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
523 FcFontSetCreate (void);
526 FcFontSetDestroy (FcFontSet *s);
529 FcFontSetAdd (FcFontSet *s, FcPattern *font);
533 FcInitLoadConfig (void);
536 FcInitLoadConfigAndFonts (void);
548 FcInitReinitialize (void);
551 FcInitBringUptoDate (void);
557 FcPublic const FcCharSet *
558 FcLangGetCharSet (const FcChar8 *lang);
561 FcLangSetCreate (void);
564 FcLangSetDestroy (FcLangSet *ls);
567 FcLangSetCopy (const FcLangSet *ls);
570 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
572 FcPublic FcLangResult
573 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
575 FcPublic FcLangResult
576 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
579 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
582 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
585 FcLangSetHash (const FcLangSet *ls);
588 FcPublic FcObjectSet *
589 FcObjectSetCreate (void);
592 FcObjectSetAdd (FcObjectSet *os, const char *object);
595 FcObjectSetDestroy (FcObjectSet *os);
597 FcPublic FcObjectSet *
598 FcObjectSetVaBuild (const char *first, va_list va);
600 FcPublic FcObjectSet *
601 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
604 FcFontSetList (FcConfig *config,
611 FcFontList (FcConfig *config,
618 FcAtomicCreate (const FcChar8 *file);
621 FcAtomicLock (FcAtomic *atomic);
624 FcAtomicNewFile (FcAtomic *atomic);
627 FcAtomicOrigFile (FcAtomic *atomic);
630 FcAtomicReplaceOrig (FcAtomic *atomic);
633 FcAtomicDeleteNew (FcAtomic *atomic);
636 FcAtomicUnlock (FcAtomic *atomic);
639 FcAtomicDestroy (FcAtomic *atomic);
643 FcFontSetMatch (FcConfig *config,
650 FcFontMatch (FcConfig *config,
655 FcFontRenderPrepare (FcConfig *config,
660 FcFontSetSort (FcConfig *config,
669 FcFontSort (FcConfig *config,
676 FcFontSetSortDestroy (FcFontSet *fs);
680 FcMatrixCopy (const FcMatrix *mat);
683 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
686 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
689 FcMatrixRotate (FcMatrix *m, double c, double s);
692 FcMatrixScale (FcMatrix *m, double sx, double sy);
695 FcMatrixShear (FcMatrix *m, double sh, double sv);
700 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
703 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
705 FcPublic const FcObjectType *
706 FcNameGetObjectType (const char *object);
709 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
712 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
714 FcPublic const FcConstant *
715 FcNameGetConstant (FcChar8 *string);
718 FcNameConstant (FcChar8 *string, int *result);
721 FcNameParse (const FcChar8 *name);
724 FcNameUnparse (FcPattern *pat);
728 FcPatternCreate (void);
731 FcPatternDuplicate (const FcPattern *p);
734 FcPatternReference (FcPattern *p);
737 FcValueDestroy (FcValue v);
740 FcValueEqual (FcValue va, FcValue vb);
743 FcValueSave (FcValue v);
746 FcPatternDestroy (FcPattern *p);
749 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
752 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
755 FcPatternHash (const FcPattern *p);
758 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
761 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
764 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
767 FcPatternDel (FcPattern *p, const char *object);
770 FcPatternRemove (FcPattern *p, const char *object, int id);
773 FcPatternAddInteger (FcPattern *p, const char *object, int i);
776 FcPatternAddDouble (FcPattern *p, const char *object, double d);
779 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
782 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
785 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
788 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
791 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
794 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
797 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
800 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
803 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
806 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
809 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
812 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
815 FcPatternVaBuild (FcPattern *orig, va_list va);
818 FcPatternBuild (FcPattern *orig, ...) FC_ATTRIBUTE_SENTINEL(0);
823 FcStrCopy (const FcChar8 *s);
826 FcStrCopyFilename (const FcChar8 *s);
829 FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
832 FcStrFree (FcChar8 *s);
834 /* These are ASCII only, suitable only for pattern element names */
835 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
836 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
837 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
840 FcStrDowncase (const FcChar8 *s);
843 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
846 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
848 FcPublic const FcChar8 *
849 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
851 FcPublic const FcChar8 *
852 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
855 FcUtf8ToUcs4 (const FcChar8 *src_orig,
860 FcUtf8Len (const FcChar8 *string,
865 #define FC_UTF8_MAX_LEN 6
868 FcUcs4ToUtf8 (FcChar32 ucs4,
869 FcChar8 dest[FC_UTF8_MAX_LEN]);
872 FcUtf16ToUcs4 (const FcChar8 *src_orig,
875 int len); /* in bytes */
878 FcUtf16Len (const FcChar8 *string,
880 int len, /* in bytes */
885 FcStrDirname (const FcChar8 *file);
888 FcStrBasename (const FcChar8 *file);
891 FcStrSetCreate (void);
894 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
897 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
900 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
903 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
906 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
909 FcStrSetDestroy (FcStrSet *set);
912 FcStrListCreate (FcStrSet *set);
915 FcStrListNext (FcStrList *list);
918 FcStrListDone (FcStrList *list);
922 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
926 #undef FC_ATTRIBUTE_SENTINEL
932 * Deprecated functions are placed here to help users fix their code without
933 * digging through documentation
936 #define FcConfigGetRescanInverval FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
937 #define FcConfigSetRescanInverval FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
941 #endif /* _FONTCONFIG_H_ */