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