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 93
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 "1"
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_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
74 #define FC_AUTOHINT "autohint" /* Bool (false) */
75 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
76 #define FC_WIDTH "width" /* Int */
77 #define FC_FILE "file" /* String */
78 #define FC_INDEX "index" /* Int */
79 #define FC_FT_FACE "ftface" /* FT_Face */
80 #define FC_RASTERIZER "rasterizer" /* String */
81 #define FC_OUTLINE "outline" /* Bool */
82 #define FC_SCALABLE "scalable" /* Bool */
83 #define FC_SCALE "scale" /* double */
84 #define FC_DPI "dpi" /* double */
85 #define FC_RGBA "rgba" /* Int */
86 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
87 #define FC_SOURCE "source" /* String (X11, freetype) */
88 #define FC_CHARSET "charset" /* CharSet */
89 #define FC_LANG "lang" /* String RFC 3066 langs */
90 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
92 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
93 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
95 /* Adjust outline rasterizer */
96 #define FC_CHAR_WIDTH "charwidth" /* Int */
97 #define FC_CHAR_HEIGHT "charheight"/* Int */
98 #define FC_MATRIX "matrix" /* FcMatrix */
100 #define FC_WEIGHT_THIN 0
101 #define FC_WEIGHT_EXTRALIGHT 40
102 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
103 #define FC_WEIGHT_LIGHT 50
104 #define FC_WEIGHT_REGULAR 80
105 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
106 #define FC_WEIGHT_MEDIUM 100
107 #define FC_WEIGHT_DEMIBOLD 180
108 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
109 #define FC_WEIGHT_BOLD 200
110 #define FC_WEIGHT_EXTRABOLD 205
111 #define FC_WEIGHT_BLACK 210
113 #define FC_SLANT_ROMAN 0
114 #define FC_SLANT_ITALIC 100
115 #define FC_SLANT_OBLIQUE 110
117 #define FC_WIDTH_ULTRACONDENSED 50
118 #define FC_WIDTH_EXTRACONDENSED 63
119 #define FC_WIDTH_CONDENSED 75
120 #define FC_WIDTH_SEMICONDENSED 87
121 #define FC_WIDTH_NORMAL 100
122 #define FC_WIDTH_SEMIEXPANDED 113
123 #define FC_WIDTH_EXPANDED 125
124 #define FC_WIDTH_EXTRAEXPANDED 150
125 #define FC_WIDTH_ULTRAEXPANDED 200
127 #define FC_PROPORTIONAL 0
129 #define FC_CHARCELL 110
131 /* sub-pixel order */
132 #define FC_RGBA_UNKNOWN 0
133 #define FC_RGBA_RGB 1
134 #define FC_RGBA_BGR 2
135 #define FC_RGBA_VRGB 3
136 #define FC_RGBA_VBGR 4
137 #define FC_RGBA_NONE 5
139 typedef enum _FcType {
151 typedef struct _FcMatrix {
152 double xx, xy, yx, yy;
155 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
156 (m)->xy = (m)->yx = 0)
159 * A data structure to represent the available glyphs in a font.
160 * This is represented as a sparse boolean btree.
163 typedef struct _FcCharSet FcCharSet;
165 typedef struct _FcObjectType {
170 typedef struct _FcConstant {
176 typedef enum _FcResult {
177 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId
180 typedef struct _FcPattern FcPattern;
182 typedef struct _FcLangSet FcLangSet;
184 typedef struct _FcValue {
199 typedef struct _FcFontSet {
205 typedef struct _FcObjectSet {
208 const char **objects;
211 typedef enum _FcMatchKind {
212 FcMatchPattern, FcMatchFont
215 typedef enum _FcLangResult {
216 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
219 typedef enum _FcSetName {
224 typedef struct _FcAtomic FcAtomic;
226 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
227 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
228 #define _FCFUNCPROTOEND }
230 #define _FCFUNCPROTOBEGIN
231 #define _FCFUNCPROTOEND
234 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
236 typedef struct _FcConfig FcConfig;
238 typedef struct _FcGlobalCache FcFileCache;
240 typedef struct _FcBlanks FcBlanks;
242 typedef struct _FcStrList FcStrList;
244 typedef struct _FcStrSet FcStrSet;
249 FcDirCacheValid (const FcChar8 *cache_file);
253 FcBlanksCreate (void);
256 FcBlanksDestroy (FcBlanks *b);
259 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
262 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
269 FcConfigEnableHome (FcBool enable);
272 FcConfigFilename (const FcChar8 *url);
275 FcConfigCreate (void);
278 FcConfigDestroy (FcConfig *config);
281 FcConfigSetCurrent (FcConfig *config);
284 FcConfigGetCurrent (void);
287 FcConfigUptoDate (FcConfig *config);
290 FcConfigBuildFonts (FcConfig *config);
293 FcConfigGetFontDirs (FcConfig *config);
296 FcConfigGetConfigDirs (FcConfig *config);
299 FcConfigGetConfigFiles (FcConfig *config);
302 FcConfigGetCache (FcConfig *config);
305 FcConfigGetBlanks (FcConfig *config);
308 FcConfigGetRescanInverval (FcConfig *config);
311 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
314 FcConfigGetFonts (FcConfig *config,
318 FcConfigAppFontAddFile (FcConfig *config,
319 const FcChar8 *file);
322 FcConfigAppFontAddDir (FcConfig *config,
326 FcConfigAppFontClear (FcConfig *config);
329 FcConfigSubstituteWithPat (FcConfig *config,
335 FcConfigSubstitute (FcConfig *config,
341 FcCharSetCreate (void);
344 FcCharSetDestroy (FcCharSet *fcs);
347 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
350 FcCharSetCopy (FcCharSet *src);
353 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
356 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
359 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
362 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
365 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
368 FcCharSetCount (const FcCharSet *a);
371 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
374 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
377 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
379 #define FC_CHARSET_MAP_SIZE (256/32)
380 #define FC_CHARSET_DONE ((FcChar32) -1)
383 FcCharSetFirstPage (const FcCharSet *a,
384 FcChar32 map[FC_CHARSET_MAP_SIZE],
388 FcCharSetNextPage (const FcCharSet *a,
389 FcChar32 map[FC_CHARSET_MAP_SIZE],
395 FcValuePrint (const FcValue v);
398 FcPatternPrint (const FcPattern *p);
401 FcFontSetPrint (const FcFontSet *s);
405 FcDefaultSubstitute (FcPattern *pattern);
409 FcFileScan (FcFontSet *set,
417 FcDirScan (FcFontSet *set,
425 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
429 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
434 FcFontSetCreate (void);
437 FcFontSetDestroy (FcFontSet *s);
440 FcFontSetAdd (FcFontSet *s, FcPattern *font);
444 FcInitLoadConfig (void);
447 FcInitLoadConfigAndFonts (void);
456 FcInitReinitialize (void);
459 FcInitBringUptoDate (void);
463 FcLangSetCreate (void);
466 FcLangSetDestroy (FcLangSet *ls);
469 FcLangSetCopy (const FcLangSet *ls);
472 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
475 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
478 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
481 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
484 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
487 FcLangSetHash (const FcLangSet *ls);
491 FcObjectSetCreate (void);
494 FcObjectSetAdd (FcObjectSet *os, const char *object);
497 FcObjectSetDestroy (FcObjectSet *os);
500 FcObjectSetVaBuild (const char *first, va_list va);
503 FcObjectSetBuild (const char *first, ...);
506 FcFontSetList (FcConfig *config,
513 FcFontList (FcConfig *config,
520 FcAtomicCreate (const FcChar8 *file);
523 FcAtomicLock (FcAtomic *atomic);
526 FcAtomicNewFile (FcAtomic *atomic);
529 FcAtomicOrigFile (FcAtomic *atomic);
532 FcAtomicReplaceOrig (FcAtomic *atomic);
535 FcAtomicDeleteNew (FcAtomic *atomic);
538 FcAtomicUnlock (FcAtomic *atomic);
541 FcAtomicDestroy (FcAtomic *atomic);
545 FcFontSetMatch (FcConfig *config,
552 FcFontMatch (FcConfig *config,
557 FcFontRenderPrepare (FcConfig *config,
562 FcFontSetSort (FcConfig *config,
571 FcFontSort (FcConfig *config,
578 FcFontSetSortDestroy (FcFontSet *fs);
582 FcMatrixCopy (const FcMatrix *mat);
585 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
588 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
591 FcMatrixRotate (FcMatrix *m, double c, double s);
594 FcMatrixScale (FcMatrix *m, double sx, double sy);
597 FcMatrixShear (FcMatrix *m, double sh, double sv);
602 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
605 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
608 FcNameGetObjectType (const char *object);
611 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
614 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
617 FcNameGetConstant (FcChar8 *string);
620 FcNameConstant (FcChar8 *string, int *result);
623 FcNameParse (const FcChar8 *name);
626 FcNameUnparse (FcPattern *pat);
630 FcPatternCreate (void);
633 FcPatternDuplicate (const FcPattern *p);
636 FcPatternReference (FcPattern *p);
639 FcValueDestroy (FcValue v);
642 FcValueEqual (FcValue va, FcValue vb);
645 FcValueSave (FcValue v);
648 FcPatternDestroy (FcPattern *p);
651 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
654 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
657 FcPatternHash (const FcPattern *p);
660 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
663 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
666 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
669 FcPatternDel (FcPattern *p, const char *object);
672 FcPatternAddInteger (FcPattern *p, const char *object, int i);
675 FcPatternAddDouble (FcPattern *p, const char *object, double d);
678 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
681 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
684 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
687 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
690 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
693 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
696 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
699 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
702 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
705 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
708 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
711 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
714 FcPatternVaBuild (FcPattern *orig, va_list va);
717 FcPatternBuild (FcPattern *orig, ...);
722 FcStrCopy (const FcChar8 *s);
725 FcStrCopyFilename (const FcChar8 *s);
727 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
728 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
729 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
732 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
735 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
738 FcUtf8ToUcs4 (const FcChar8 *src_orig,
743 FcUtf8Len (const FcChar8 *string,
748 #define FC_UTF8_MAX_LEN 6
751 FcUcs4ToUtf8 (FcChar32 ucs4,
752 FcChar8 dest[FC_UTF8_MAX_LEN]);
755 FcUtf16ToUcs4 (const FcChar8 *src_orig,
758 int len); /* in bytes */
761 FcUtf16Len (const FcChar8 *string,
763 int len, /* in bytes */
768 FcStrDirname (const FcChar8 *file);
771 FcStrBasename (const FcChar8 *file);
774 FcStrSetCreate (void);
777 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
780 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
783 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
786 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
789 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
792 FcStrSetDestroy (FcStrSet *set);
795 FcStrListCreate (FcStrSet *set);
798 FcStrListNext (FcStrList *list);
801 FcStrListDone (FcStrList *list);
805 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
809 #endif /* _FONTCONFIG_H_ */