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_
30 #if defined(__GNUC__) && (__GNUC__ >= 4)
31 #define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
33 #define FC_ATTRIBUTE_SENTINEL(x)
36 typedef unsigned char FcChar8;
37 typedef unsigned short FcChar16;
38 typedef unsigned int FcChar32;
42 * Current Fontconfig version number. This same number
43 * must appear in the fontconfig configure.in file. Yes,
44 * it'a a pain to synchronize version numbers like this.
49 #define FC_REVISION 96
51 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
54 * Current font cache file format version
55 * This is appended to the cache files so that multiple
56 * versions of the library will peacefully coexist
58 * Change this value whenever the disk format for the cache file
59 * changes in any non-compatible way. Try to avoid such changes as
60 * it means multiple copies of the font information.
63 #define FC_CACHE_VERSION "2"
68 #define FC_FAMILY "family" /* String */
69 #define FC_STYLE "style" /* String */
70 #define FC_SLANT "slant" /* Int */
71 #define FC_WEIGHT "weight" /* Int */
72 #define FC_SIZE "size" /* Double */
73 #define FC_ASPECT "aspect" /* Double */
74 #define FC_PIXEL_SIZE "pixelsize" /* Double */
75 #define FC_SPACING "spacing" /* Int */
76 #define FC_FOUNDRY "foundry" /* String */
77 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
78 #define FC_HINTING "hinting" /* Bool (true) */
79 #define FC_HINT_STYLE "hintstyle" /* Int */
80 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
81 #define FC_AUTOHINT "autohint" /* Bool (false) */
82 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
83 #define FC_WIDTH "width" /* Int */
84 #define FC_FILE "file" /* String */
85 #define FC_INDEX "index" /* Int */
86 #define FC_FT_FACE "ftface" /* FT_Face */
87 #define FC_RASTERIZER "rasterizer" /* String */
88 #define FC_OUTLINE "outline" /* Bool */
89 #define FC_SCALABLE "scalable" /* Bool */
90 #define FC_SCALE "scale" /* double */
91 #define FC_DPI "dpi" /* double */
92 #define FC_RGBA "rgba" /* Int */
93 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
94 #define FC_SOURCE "source" /* String (deprecated) */
95 #define FC_CHARSET "charset" /* CharSet */
96 #define FC_LANG "lang" /* String RFC 3066 langs */
97 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
98 #define FC_FULLNAME "fullname" /* String */
99 #define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
100 #define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
101 #define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
102 #define FC_CAPABILITY "capability" /* String */
103 #define FC_FONTFORMAT "fontformat" /* String */
104 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
105 #define FC_EMBEDDED_BITMAP "embeddedbitmap" /* Bool - true to enable embedded bitmaps */
106 #define FC_DECORATIVE "decorative" /* Bool - true if style is a decorative variant */
108 #define FC_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
109 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
110 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
112 /* Adjust outline rasterizer */
113 #define FC_CHAR_WIDTH "charwidth" /* Int */
114 #define FC_CHAR_HEIGHT "charheight"/* Int */
115 #define FC_MATRIX "matrix" /* FcMatrix */
117 #define FC_WEIGHT_THIN 0
118 #define FC_WEIGHT_EXTRALIGHT 40
119 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
120 #define FC_WEIGHT_LIGHT 50
121 #define FC_WEIGHT_BOOK 75
122 #define FC_WEIGHT_REGULAR 80
123 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
124 #define FC_WEIGHT_MEDIUM 100
125 #define FC_WEIGHT_DEMIBOLD 180
126 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
127 #define FC_WEIGHT_BOLD 200
128 #define FC_WEIGHT_EXTRABOLD 205
129 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
130 #define FC_WEIGHT_BLACK 210
131 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
133 #define FC_SLANT_ROMAN 0
134 #define FC_SLANT_ITALIC 100
135 #define FC_SLANT_OBLIQUE 110
137 #define FC_WIDTH_ULTRACONDENSED 50
138 #define FC_WIDTH_EXTRACONDENSED 63
139 #define FC_WIDTH_CONDENSED 75
140 #define FC_WIDTH_SEMICONDENSED 87
141 #define FC_WIDTH_NORMAL 100
142 #define FC_WIDTH_SEMIEXPANDED 113
143 #define FC_WIDTH_EXPANDED 125
144 #define FC_WIDTH_EXTRAEXPANDED 150
145 #define FC_WIDTH_ULTRAEXPANDED 200
147 #define FC_PROPORTIONAL 0
150 #define FC_CHARCELL 110
152 /* sub-pixel order */
153 #define FC_RGBA_UNKNOWN 0
154 #define FC_RGBA_RGB 1
155 #define FC_RGBA_BGR 2
156 #define FC_RGBA_VRGB 3
157 #define FC_RGBA_VBGR 4
158 #define FC_RGBA_NONE 5
161 #define FC_HINT_NONE 0
162 #define FC_HINT_SLIGHT 1
163 #define FC_HINT_MEDIUM 2
164 #define FC_HINT_FULL 3
166 typedef enum _FcType {
178 typedef struct _FcMatrix {
179 double xx, xy, yx, yy;
182 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
183 (m)->xy = (m)->yx = 0)
186 * A data structure to represent the available glyphs in a font.
187 * This is represented as a sparse boolean btree.
190 typedef struct _FcCharSet FcCharSet;
192 typedef struct _FcObjectType {
197 typedef struct _FcConstant {
203 typedef enum _FcResult {
204 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
208 typedef struct _FcPattern FcPattern;
210 typedef struct _FcLangSet FcLangSet;
212 typedef struct _FcValue {
227 typedef struct _FcFontSet {
233 typedef struct _FcObjectSet {
236 const char **objects;
239 typedef enum _FcMatchKind {
240 FcMatchPattern, FcMatchFont, FcMatchScan
243 typedef enum _FcLangResult {
244 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
247 typedef enum _FcSetName {
252 typedef struct _FcAtomic FcAtomic;
254 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
255 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
256 #define _FCFUNCPROTOEND }
258 #define _FCFUNCPROTOBEGIN
259 #define _FCFUNCPROTOEND
262 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
264 typedef struct _FcConfig FcConfig;
266 typedef struct _FcGlobalCache FcFileCache;
268 typedef struct _FcBlanks FcBlanks;
270 typedef struct _FcStrList FcStrList;
272 typedef struct _FcStrSet FcStrSet;
277 FcDirCacheValid (const FcChar8 *cache_file);
281 FcBlanksCreate (void);
284 FcBlanksDestroy (FcBlanks *b);
287 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
290 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
297 FcConfigEnableHome (FcBool enable);
300 FcConfigFilename (const FcChar8 *url);
303 FcConfigCreate (void);
306 FcConfigDestroy (FcConfig *config);
309 FcConfigSetCurrent (FcConfig *config);
312 FcConfigGetCurrent (void);
315 FcConfigUptoDate (FcConfig *config);
318 FcConfigBuildFonts (FcConfig *config);
321 FcConfigGetFontDirs (FcConfig *config);
324 FcConfigGetConfigDirs (FcConfig *config);
327 FcConfigGetConfigFiles (FcConfig *config);
330 FcConfigGetCache (FcConfig *config);
333 FcConfigGetBlanks (FcConfig *config);
336 FcConfigGetRescanInverval (FcConfig *config);
339 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
342 FcConfigGetFonts (FcConfig *config,
346 FcConfigAppFontAddFile (FcConfig *config,
347 const FcChar8 *file);
350 FcConfigAppFontAddDir (FcConfig *config,
354 FcConfigAppFontClear (FcConfig *config);
357 FcConfigSubstituteWithPat (FcConfig *config,
363 FcConfigSubstitute (FcConfig *config,
369 FcCharSetCreate (void);
372 FcCharSetDestroy (FcCharSet *fcs);
375 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
378 FcCharSetCopy (FcCharSet *src);
381 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
384 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
387 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
390 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
393 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
396 FcCharSetCount (const FcCharSet *a);
399 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
402 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
405 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
407 #define FC_CHARSET_MAP_SIZE (256/32)
408 #define FC_CHARSET_DONE ((FcChar32) -1)
411 FcCharSetFirstPage (const FcCharSet *a,
412 FcChar32 map[FC_CHARSET_MAP_SIZE],
416 FcCharSetNextPage (const FcCharSet *a,
417 FcChar32 map[FC_CHARSET_MAP_SIZE],
423 FcValuePrint (const FcValue v);
426 FcPatternPrint (const FcPattern *p);
429 FcFontSetPrint (const FcFontSet *s);
433 FcDefaultSubstitute (FcPattern *pattern);
437 FcFileScan (FcFontSet *set,
445 FcDirScan (FcFontSet *set,
453 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
457 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
462 FcFontSetCreate (void);
465 FcFontSetDestroy (FcFontSet *s);
468 FcFontSetAdd (FcFontSet *s, FcPattern *font);
472 FcInitLoadConfig (void);
475 FcInitLoadConfigAndFonts (void);
487 FcInitReinitialize (void);
490 FcInitBringUptoDate (void);
494 FcLangSetCreate (void);
497 FcLangSetDestroy (FcLangSet *ls);
500 FcLangSetCopy (const FcLangSet *ls);
503 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
506 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
509 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
512 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
515 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
518 FcLangSetHash (const FcLangSet *ls);
522 FcObjectSetCreate (void);
525 FcObjectSetAdd (FcObjectSet *os, const char *object);
528 FcObjectSetDestroy (FcObjectSet *os);
531 FcObjectSetVaBuild (const char *first, va_list va);
534 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
537 FcFontSetList (FcConfig *config,
544 FcFontList (FcConfig *config,
551 FcAtomicCreate (const FcChar8 *file);
554 FcAtomicLock (FcAtomic *atomic);
557 FcAtomicNewFile (FcAtomic *atomic);
560 FcAtomicOrigFile (FcAtomic *atomic);
563 FcAtomicReplaceOrig (FcAtomic *atomic);
566 FcAtomicDeleteNew (FcAtomic *atomic);
569 FcAtomicUnlock (FcAtomic *atomic);
572 FcAtomicDestroy (FcAtomic *atomic);
576 FcFontSetMatch (FcConfig *config,
583 FcFontMatch (FcConfig *config,
588 FcFontRenderPrepare (FcConfig *config,
593 FcFontSetSort (FcConfig *config,
602 FcFontSort (FcConfig *config,
609 FcFontSetSortDestroy (FcFontSet *fs);
613 FcMatrixCopy (const FcMatrix *mat);
616 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
619 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
622 FcMatrixRotate (FcMatrix *m, double c, double s);
625 FcMatrixScale (FcMatrix *m, double sx, double sy);
628 FcMatrixShear (FcMatrix *m, double sh, double sv);
633 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
636 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
639 FcNameGetObjectType (const char *object);
642 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
645 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
648 FcNameGetConstant (FcChar8 *string);
651 FcNameConstant (FcChar8 *string, int *result);
654 FcNameParse (const FcChar8 *name);
657 FcNameUnparse (FcPattern *pat);
661 FcPatternCreate (void);
664 FcPatternDuplicate (const FcPattern *p);
667 FcPatternReference (FcPattern *p);
670 FcValueDestroy (FcValue v);
673 FcValueEqual (FcValue va, FcValue vb);
676 FcValueSave (FcValue v);
679 FcPatternDestroy (FcPattern *p);
682 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
685 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
688 FcPatternHash (const FcPattern *p);
691 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
694 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
697 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
700 FcPatternDel (FcPattern *p, const char *object);
703 FcPatternRemove (FcPattern *p, const char *object, int id);
706 FcPatternAddInteger (FcPattern *p, const char *object, int i);
709 FcPatternAddDouble (FcPattern *p, const char *object, double d);
712 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
715 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
718 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
721 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
724 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
727 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
730 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
733 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
736 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
739 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
742 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
745 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
748 FcPatternVaBuild (FcPattern *orig, va_list va);
751 FcPatternBuild (FcPattern *orig, ...) FC_ATTRIBUTE_SENTINEL(0);
756 FcStrCopy (const FcChar8 *s);
759 FcStrCopyFilename (const FcChar8 *s);
761 /* These are ASCII only, suitable only for pattern element names */
762 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
763 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
764 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
767 FcStrDowncase (const FcChar8 *s);
770 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
773 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
776 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
779 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
782 FcUtf8ToUcs4 (const FcChar8 *src_orig,
787 FcUtf8Len (const FcChar8 *string,
792 #define FC_UTF8_MAX_LEN 6
795 FcUcs4ToUtf8 (FcChar32 ucs4,
796 FcChar8 dest[FC_UTF8_MAX_LEN]);
799 FcUtf16ToUcs4 (const FcChar8 *src_orig,
802 int len); /* in bytes */
805 FcUtf16Len (const FcChar8 *string,
807 int len, /* in bytes */
812 FcStrDirname (const FcChar8 *file);
815 FcStrBasename (const FcChar8 *file);
818 FcStrSetCreate (void);
821 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
824 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
827 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
830 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
833 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
836 FcStrSetDestroy (FcStrSet *set);
839 FcStrListCreate (FcStrSet *set);
842 FcStrListNext (FcStrList *list);
845 FcStrListDone (FcStrList *list);
849 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
853 #undef FC_ATTRIBUTE_SENTINEL
855 #endif /* _FONTCONFIG_H_ */