2 * $XFree86: xc/lib/fontconfig/fontconfig/fontconfig.h,v 1.15 2002/06/02 20:52:06 keithp Exp $
4 * Copyright © 2001 Keith Packard, member of The XFree86 Project, Inc.
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
42 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
47 #define FC_FAMILY "family" /* String */
48 #define FC_STYLE "style" /* String */
49 #define FC_SLANT "slant" /* Int */
50 #define FC_WEIGHT "weight" /* Int */
51 #define FC_SIZE "size" /* Double */
52 #define FC_ASPECT "aspect" /* Double */
53 #define FC_PIXEL_SIZE "pixelsize" /* Double */
54 #define FC_SPACING "spacing" /* Int */
55 #define FC_FOUNDRY "foundry" /* String */
56 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
57 #define FC_HINTING "hinting" /* Bool (true) */
58 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
59 #define FC_AUTOHINT "autohint" /* Bool (false) */
60 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
61 #define FC_FILE "file" /* String */
62 #define FC_INDEX "index" /* Int */
63 #define FC_FT_FACE "ftface" /* FT_Face */
64 #define FC_RASTERIZER "rasterizer" /* String */
65 #define FC_OUTLINE "outline" /* Bool */
66 #define FC_SCALABLE "scalable" /* Bool */
67 #define FC_SCALE "scale" /* double */
68 #define FC_DPI "dpi" /* double */
69 #define FC_RGBA "rgba" /* Int */
70 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
71 #define FC_SOURCE "source" /* String (X11, freetype) */
72 #define FC_CHARSET "charset" /* CharSet */
73 #define FC_LANG "lang" /* String OS/2 CodePageRange */
75 #define FC_DIR_CACHE_FILE "fonts.cache"
76 #define FC_USER_CACHE_FILE ".fonts.cache"
78 /* Adjust outline rasterizer */
79 #define FC_CHAR_WIDTH "charwidth" /* Int */
80 #define FC_CHAR_HEIGHT "charheight"/* Int */
81 #define FC_MATRIX "matrix" /* FcMatrix */
83 #define FC_WEIGHT_LIGHT 0
84 #define FC_WEIGHT_MEDIUM 100
85 #define FC_WEIGHT_DEMIBOLD 180
86 #define FC_WEIGHT_BOLD 200
87 #define FC_WEIGHT_BLACK 210
89 #define FC_SLANT_ROMAN 0
90 #define FC_SLANT_ITALIC 100
91 #define FC_SLANT_OBLIQUE 110
93 #define FC_PROPORTIONAL 0
95 #define FC_CHARCELL 110
98 #define FC_RGBA_NONE 0
100 #define FC_RGBA_BGR 2
101 #define FC_RGBA_VRGB 3
102 #define FC_RGBA_VBGR 4
104 /* language groups from the OS/2 CodePageRange bits */
105 #define FC_LANG_LATIN_1 "latin1" /* 0 */
106 #define FC_LANG_LATIN_2_EASTERN_EUROPE "latin2easterneurope" /* 1 */
107 #define FC_LANG_CYRILLIC "cyrillic" /* 2 */
108 #define FC_LANG_GREEK "greek" /* 3 */
109 #define FC_LANG_TURKISH "turkish" /* 4 */
110 #define FC_LANG_HEBREW "hebrew" /* 5 */
111 #define FC_LANG_ARABIC "arabic" /* 6 */
112 #define FC_LANG_WINDOWS_BALTIC "windowsbaltic" /* 7 */
113 #define FC_LANG_VIETNAMESE "vietnamese" /* 8 */
114 /* 9-15 reserved for Alternate ANSI */
115 #define FC_LANG_THAI "thai" /* 16 */
116 #define FC_LANG_JAPANESE "japanese" /* 17 */
117 #define FC_LANG_SIMPLIFIED_CHINESE "simplifiedchinese" /* 18 */
118 #define FC_LANG_KOREAN_WANSUNG "koreanwansung" /* 19 */
119 #define FC_LANG_TRADITIONAL_CHINESE "traditionalchinese" /* 20 */
120 #define FC_LANG_KOREAN_JOHAB "koreanjohab" /* 21 */
121 /* 22-28 reserved for Alternate ANSI & OEM */
122 #define FC_LANG_MACINTOSH "macintosh" /* 29 */
123 #define FC_LANG_OEM "oem" /* 30 */
124 #define FC_LANG_SYMBOL "symbol" /* 31 */
125 /* 32-47 reserved for OEM */
126 #define FC_LANG_IBM_GREEK "ibmgreek" /* 48 */
127 #define FC_LANG_MSDOS_RUSSIAN "msdosrussian" /* 49 */
128 #define FC_LANG_MSDOS_NORDIC "msdosnordic" /* 50 */
129 #define FC_LANG_ARABIC_864 "arabic864" /* 51 */
130 #define FC_LANG_MSDOS_CANADIAN_FRENCH "msdoscanadianfrench" /* 52 */
131 #define FC_LANG_HEBREW_862 "hebrew862" /* 53 */
132 #define FC_LANG_MSDOS_ICELANDIC "msdosicelandic" /* 54 */
133 #define FC_LANG_MSDOS_PORTUGUESE "msdosportuguese" /* 55 */
134 #define FC_LANG_IBM_TURKISH "ibmturkish" /* 56 */
135 #define FC_LANG_IBM_CYRILLIC "ibmcyrillic" /* 57 */
136 #define FC_LANG_LATIN_2 "latin2" /* 58 */
137 #define FC_LANG_MSDOS_BALTIC "msdosbaltic" /* 59 */
138 #define FC_LANG_GREEK_437_G "greek437g" /* 60 */
139 #define FC_LANG_ARABIC_ASMO_708 "arabicasmo708" /* 61 */
140 #define FC_LANG_WE_LATIN_1 "welatin1" /* 62 */
141 #define FC_LANG_US "us" /* 63 */
143 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 _FcValue {
196 typedef struct _FcPattern FcPattern;
198 typedef struct _FcFontSet {
204 typedef struct _FcObjectSet {
207 const char **objects;
210 typedef enum _FcMatchKind {
211 FcMatchPattern, FcMatchFont
214 typedef enum _FcSetName {
219 typedef struct _FcAtomic FcAtomic;
221 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
222 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
223 #define _FCFUNCPROTOEND }
225 #define _FCFUNCPROTOBEGIN
226 #define _FCFUNCPROTOEND
229 typedef struct _FcConfig FcConfig;
231 typedef struct _FcFileCache FcFileCache;
233 typedef struct _FcBlanks FcBlanks;
235 typedef struct _FcStrList FcStrList;
237 typedef struct _FcStrSet FcStrSet;
243 FcBlanksCreate (void);
246 FcBlanksDestroy (FcBlanks *b);
249 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
252 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
256 FcConfigFilename (const FcChar8 *url);
259 FcConfigCreate (void);
262 FcConfigDestroy (FcConfig *config);
265 FcConfigSetCurrent (FcConfig *config);
268 FcConfigGetCurrent (void);
271 FcConfigUptoDate (FcConfig *config);
274 FcConfigBuildFonts (FcConfig *config);
277 FcConfigGetFontDirs (FcConfig *config);
280 FcConfigGetConfigDirs (FcConfig *config);
283 FcConfigGetConfigFiles (FcConfig *config);
286 FcConfigGetCache (FcConfig *config);
289 FcConfigGetBlanks (FcConfig *config);
292 FcConfigGetRescanInverval (FcConfig *config);
295 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
298 FcConfigGetFonts (FcConfig *config,
302 FcConfigAppFontAddFile (FcConfig *config,
303 const FcChar8 *file);
306 FcConfigAppFontAddDir (FcConfig *config,
310 FcConfigAppFontClear (FcConfig *config);
313 FcConfigSubstitute (FcConfig *config,
319 FcCharSetCreate (void);
322 FcCharSetDestroy (FcCharSet *fcs);
325 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
328 FcCharSetCopy (FcCharSet *src);
331 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
334 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
337 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
340 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
343 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
346 FcCharSetCount (const FcCharSet *a);
349 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
352 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
355 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
357 #define FC_CHARSET_MAP_SIZE (256/32)
358 #define FC_CHARSET_DONE ((FcChar32) -1)
361 FcCharSetFirstPage (const FcCharSet *a,
362 FcChar32 map[FC_CHARSET_MAP_SIZE],
366 FcCharSetNextPage (const FcCharSet *a,
367 FcChar32 map[FC_CHARSET_MAP_SIZE],
373 FcValuePrint (FcValue v);
376 FcPatternPrint (FcPattern *p);
379 FcFontSetPrint (FcFontSet *s);
383 FcDefaultSubstitute (FcPattern *pattern);
387 FcFileScan (FcFontSet *set,
395 FcDirScan (FcFontSet *set,
403 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
406 FcDirCacheValid (const FcChar8 *dir);
410 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
415 FcFontSetCreate (void);
418 FcFontSetDestroy (FcFontSet *s);
421 FcFontSetAdd (FcFontSet *s, FcPattern *font);
425 FcInitLoadConfig (void);
428 FcInitLoadConfigAndFonts (void);
437 FcInitReinitialize (void);
440 FcInitBringUptoDate (void);
444 FcObjectSetCreate (void);
447 FcObjectSetAdd (FcObjectSet *os, const char *object);
450 FcObjectSetDestroy (FcObjectSet *os);
453 FcObjectSetVaBuild (const char *first, va_list va);
456 FcObjectSetBuild (const char *first, ...);
459 FcFontSetList (FcConfig *config,
466 FcFontList (FcConfig *config,
473 FcAtomicCreate (const FcChar8 *file);
476 FcAtomicLock (FcAtomic *atomic);
479 FcAtomicNewFile (FcAtomic *atomic);
482 FcAtomicOrigFile (FcAtomic *atomic);
485 FcAtomicReplaceOrig (FcAtomic *atomic);
488 FcAtomicDeleteNew (FcAtomic *atomic);
491 FcAtomicUnlock (FcAtomic *atomic);
494 FcAtomicDestroy (FcAtomic *atomic);
498 FcFontSetMatch (FcConfig *config,
505 FcFontMatch (FcConfig *config,
510 FcFontRenderPrepare (FcConfig *config,
515 FcFontSetSort (FcConfig *config,
524 FcFontSort (FcConfig *config,
531 FcFontSetSortDestroy (FcFontSet *fs);
535 FcMatrixCopy (const FcMatrix *mat);
538 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
541 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
544 FcMatrixRotate (FcMatrix *m, double c, double s);
547 FcMatrixScale (FcMatrix *m, double sx, double sy);
550 FcMatrixShear (FcMatrix *m, double sh, double sv);
555 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
558 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
561 FcNameGetObjectType (const char *object);
564 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
567 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
570 FcNameGetConstant (FcChar8 *string);
573 FcNameConstant (FcChar8 *string, int *result);
576 FcNameParse (const FcChar8 *name);
579 FcNameUnparse (FcPattern *pat);
583 FcPatternCreate (void);
586 FcPatternDuplicate (FcPattern *p);
589 FcValueDestroy (FcValue v);
592 FcValueEqual (FcValue va, FcValue vb);
595 FcValueSave (FcValue v);
598 FcPatternDestroy (FcPattern *p);
601 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
604 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
607 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
610 FcPatternGet (FcPattern *p, const char *object, int id, FcValue *v);
613 FcPatternDel (FcPattern *p, const char *object);
616 FcPatternAddInteger (FcPattern *p, const char *object, int i);
619 FcPatternAddDouble (FcPattern *p, const char *object, double d);
622 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
625 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
628 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
631 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
634 FcPatternGetInteger (FcPattern *p, const char *object, int n, int *i);
637 FcPatternGetDouble (FcPattern *p, const char *object, int n, double *d);
640 FcPatternGetString (FcPattern *p, const char *object, int n, FcChar8 ** s);
643 FcPatternGetMatrix (FcPattern *p, const char *object, int n, FcMatrix **s);
646 FcPatternGetCharSet (FcPattern *p, const char *object, int n, FcCharSet **c);
649 FcPatternGetBool (FcPattern *p, const char *object, int n, FcBool *b);
652 FcPatternVaBuild (FcPattern *orig, va_list va);
655 FcPatternBuild (FcPattern *orig, ...);
660 FcStrCopy (const FcChar8 *s);
663 FcStrCopyFilename (const FcChar8 *s);
665 #define FcToLower(c) (('A' <= (c) && (c) <= 'Z') ? (c) - 'A' + 'a' : (c))
668 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
671 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
674 FcUtf8ToUcs4 (FcChar8 *src_orig,
679 FcUtf8Len (FcChar8 *string,
685 FcStrDirname (const FcChar8 *file);
688 FcStrBasename (const FcChar8 *file);
691 FcStrSetCreate (void);
694 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
697 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
700 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
703 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
706 FcStrSetDestroy (FcStrSet *set);
709 FcStrListCreate (FcStrSet *set);
712 FcStrListNext (FcStrList *list);
715 FcStrListDone (FcStrList *list);
719 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
723 #endif /* _FONTCONFIG_H_ */