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.
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_BOOK 75
105 #define FC_WEIGHT_REGULAR 80
106 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
107 #define FC_WEIGHT_MEDIUM 100
108 #define FC_WEIGHT_DEMIBOLD 180
109 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
110 #define FC_WEIGHT_BOLD 200
111 #define FC_WEIGHT_EXTRABOLD 205
112 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
113 #define FC_WEIGHT_BLACK 210
114 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
116 #define FC_SLANT_ROMAN 0
117 #define FC_SLANT_ITALIC 100
118 #define FC_SLANT_OBLIQUE 110
120 #define FC_WIDTH_ULTRACONDENSED 50
121 #define FC_WIDTH_EXTRACONDENSED 63
122 #define FC_WIDTH_CONDENSED 75
123 #define FC_WIDTH_SEMICONDENSED 87
124 #define FC_WIDTH_NORMAL 100
125 #define FC_WIDTH_SEMIEXPANDED 113
126 #define FC_WIDTH_EXPANDED 125
127 #define FC_WIDTH_EXTRAEXPANDED 150
128 #define FC_WIDTH_ULTRAEXPANDED 200
130 #define FC_PROPORTIONAL 0
132 #define FC_CHARCELL 110
134 /* sub-pixel order */
135 #define FC_RGBA_UNKNOWN 0
136 #define FC_RGBA_RGB 1
137 #define FC_RGBA_BGR 2
138 #define FC_RGBA_VRGB 3
139 #define FC_RGBA_VBGR 4
140 #define FC_RGBA_NONE 5
142 typedef enum _FcType {
154 typedef struct _FcMatrix {
155 double xx, xy, yx, yy;
158 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
159 (m)->xy = (m)->yx = 0)
162 * A data structure to represent the available glyphs in a font.
163 * This is represented as a sparse boolean btree.
166 typedef struct _FcCharSet FcCharSet;
168 typedef struct _FcObjectType {
173 typedef struct _FcConstant {
179 typedef enum _FcResult {
180 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId
183 typedef struct _FcPattern FcPattern;
185 typedef struct _FcLangSet FcLangSet;
187 typedef struct _FcValue {
202 typedef struct _FcFontSet {
208 typedef struct _FcObjectSet {
211 const char **objects;
214 typedef enum _FcMatchKind {
215 FcMatchPattern, FcMatchFont
218 typedef enum _FcLangResult {
219 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
222 typedef enum _FcSetName {
227 typedef struct _FcAtomic FcAtomic;
229 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
230 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
231 #define _FCFUNCPROTOEND }
233 #define _FCFUNCPROTOBEGIN
234 #define _FCFUNCPROTOEND
237 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
239 typedef struct _FcConfig FcConfig;
241 typedef struct _FcGlobalCache FcFileCache;
243 typedef struct _FcBlanks FcBlanks;
245 typedef struct _FcStrList FcStrList;
247 typedef struct _FcStrSet FcStrSet;
252 FcDirCacheValid (const FcChar8 *cache_file);
256 FcBlanksCreate (void);
259 FcBlanksDestroy (FcBlanks *b);
262 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
265 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
272 FcConfigEnableHome (FcBool enable);
275 FcConfigFilename (const FcChar8 *url);
278 FcConfigCreate (void);
281 FcConfigDestroy (FcConfig *config);
284 FcConfigSetCurrent (FcConfig *config);
287 FcConfigGetCurrent (void);
290 FcConfigUptoDate (FcConfig *config);
293 FcConfigBuildFonts (FcConfig *config);
296 FcConfigGetFontDirs (FcConfig *config);
299 FcConfigGetConfigDirs (FcConfig *config);
302 FcConfigGetConfigFiles (FcConfig *config);
305 FcConfigGetCache (FcConfig *config);
308 FcConfigGetBlanks (FcConfig *config);
311 FcConfigGetRescanInverval (FcConfig *config);
314 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
317 FcConfigGetFonts (FcConfig *config,
321 FcConfigAppFontAddFile (FcConfig *config,
322 const FcChar8 *file);
325 FcConfigAppFontAddDir (FcConfig *config,
329 FcConfigAppFontClear (FcConfig *config);
332 FcConfigSubstituteWithPat (FcConfig *config,
338 FcConfigSubstitute (FcConfig *config,
344 FcCharSetCreate (void);
347 FcCharSetDestroy (FcCharSet *fcs);
350 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
353 FcCharSetCopy (FcCharSet *src);
356 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
359 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
362 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
365 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
368 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
371 FcCharSetCount (const FcCharSet *a);
374 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
377 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
380 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
382 #define FC_CHARSET_MAP_SIZE (256/32)
383 #define FC_CHARSET_DONE ((FcChar32) -1)
386 FcCharSetFirstPage (const FcCharSet *a,
387 FcChar32 map[FC_CHARSET_MAP_SIZE],
391 FcCharSetNextPage (const FcCharSet *a,
392 FcChar32 map[FC_CHARSET_MAP_SIZE],
398 FcValuePrint (const FcValue v);
401 FcPatternPrint (const FcPattern *p);
404 FcFontSetPrint (const FcFontSet *s);
408 FcDefaultSubstitute (FcPattern *pattern);
412 FcFileScan (FcFontSet *set,
420 FcDirScan (FcFontSet *set,
428 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
432 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
437 FcFontSetCreate (void);
440 FcFontSetDestroy (FcFontSet *s);
443 FcFontSetAdd (FcFontSet *s, FcPattern *font);
447 FcInitLoadConfig (void);
450 FcInitLoadConfigAndFonts (void);
459 FcInitReinitialize (void);
462 FcInitBringUptoDate (void);
466 FcLangSetCreate (void);
469 FcLangSetDestroy (FcLangSet *ls);
472 FcLangSetCopy (const FcLangSet *ls);
475 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
478 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
481 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
484 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
487 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
490 FcLangSetHash (const FcLangSet *ls);
494 FcObjectSetCreate (void);
497 FcObjectSetAdd (FcObjectSet *os, const char *object);
500 FcObjectSetDestroy (FcObjectSet *os);
503 FcObjectSetVaBuild (const char *first, va_list va);
506 FcObjectSetBuild (const char *first, ...);
509 FcFontSetList (FcConfig *config,
516 FcFontList (FcConfig *config,
523 FcAtomicCreate (const FcChar8 *file);
526 FcAtomicLock (FcAtomic *atomic);
529 FcAtomicNewFile (FcAtomic *atomic);
532 FcAtomicOrigFile (FcAtomic *atomic);
535 FcAtomicReplaceOrig (FcAtomic *atomic);
538 FcAtomicDeleteNew (FcAtomic *atomic);
541 FcAtomicUnlock (FcAtomic *atomic);
544 FcAtomicDestroy (FcAtomic *atomic);
548 FcFontSetMatch (FcConfig *config,
555 FcFontMatch (FcConfig *config,
560 FcFontRenderPrepare (FcConfig *config,
565 FcFontSetSort (FcConfig *config,
574 FcFontSort (FcConfig *config,
581 FcFontSetSortDestroy (FcFontSet *fs);
585 FcMatrixCopy (const FcMatrix *mat);
588 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
591 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
594 FcMatrixRotate (FcMatrix *m, double c, double s);
597 FcMatrixScale (FcMatrix *m, double sx, double sy);
600 FcMatrixShear (FcMatrix *m, double sh, double sv);
605 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
608 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
611 FcNameGetObjectType (const char *object);
614 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
617 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
620 FcNameGetConstant (FcChar8 *string);
623 FcNameConstant (FcChar8 *string, int *result);
626 FcNameParse (const FcChar8 *name);
629 FcNameUnparse (FcPattern *pat);
633 FcPatternCreate (void);
636 FcPatternDuplicate (const FcPattern *p);
639 FcPatternReference (FcPattern *p);
642 FcValueDestroy (FcValue v);
645 FcValueEqual (FcValue va, FcValue vb);
648 FcValueSave (FcValue v);
651 FcPatternDestroy (FcPattern *p);
654 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
657 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
660 FcPatternHash (const FcPattern *p);
663 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
666 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
669 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
672 FcPatternDel (FcPattern *p, const char *object);
675 FcPatternAddInteger (FcPattern *p, const char *object, int i);
678 FcPatternAddDouble (FcPattern *p, const char *object, double d);
681 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
684 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
687 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
690 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
693 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
696 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
699 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
702 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
705 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
708 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
711 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
714 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
717 FcPatternVaBuild (FcPattern *orig, va_list va);
720 FcPatternBuild (FcPattern *orig, ...);
725 FcStrCopy (const FcChar8 *s);
728 FcStrCopyFilename (const FcChar8 *s);
730 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
731 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
732 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
735 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
738 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
741 FcUtf8ToUcs4 (const FcChar8 *src_orig,
746 FcUtf8Len (const FcChar8 *string,
751 #define FC_UTF8_MAX_LEN 6
754 FcUcs4ToUtf8 (FcChar32 ucs4,
755 FcChar8 dest[FC_UTF8_MAX_LEN]);
758 FcUtf16ToUcs4 (const FcChar8 *src_orig,
761 int len); /* in bytes */
764 FcUtf16Len (const FcChar8 *string,
766 int len, /* in bytes */
771 FcStrDirname (const FcChar8 *file);
774 FcStrBasename (const FcChar8 *file);
777 FcStrSetCreate (void);
780 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
783 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
786 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
789 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
792 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
795 FcStrSetDestroy (FcStrSet *set);
798 FcStrListCreate (FcStrSet *set);
801 FcStrListNext (FcStrList *list);
804 FcStrListDone (FcStrList *list);
808 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
812 #endif /* _FONTCONFIG_H_ */