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 "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_FILE "file" /* String */
77 #define FC_INDEX "index" /* Int */
78 #define FC_FT_FACE "ftface" /* FT_Face */
79 #define FC_RASTERIZER "rasterizer" /* String */
80 #define FC_OUTLINE "outline" /* Bool */
81 #define FC_SCALABLE "scalable" /* Bool */
82 #define FC_SCALE "scale" /* double */
83 #define FC_DPI "dpi" /* double */
84 #define FC_RGBA "rgba" /* Int */
85 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
86 #define FC_SOURCE "source" /* String (X11, freetype) */
87 #define FC_CHARSET "charset" /* CharSet */
88 #define FC_LANG "lang" /* String RFC 3066 langs */
89 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
91 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
92 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
94 /* Adjust outline rasterizer */
95 #define FC_CHAR_WIDTH "charwidth" /* Int */
96 #define FC_CHAR_HEIGHT "charheight"/* Int */
97 #define FC_MATRIX "matrix" /* FcMatrix */
99 #define FC_WEIGHT_LIGHT 0
100 #define FC_WEIGHT_MEDIUM 100
101 #define FC_WEIGHT_DEMIBOLD 180
102 #define FC_WEIGHT_BOLD 200
103 #define FC_WEIGHT_BLACK 210
105 #define FC_SLANT_ROMAN 0
106 #define FC_SLANT_ITALIC 100
107 #define FC_SLANT_OBLIQUE 110
109 #define FC_PROPORTIONAL 0
111 #define FC_CHARCELL 110
113 /* sub-pixel order */
114 #define FC_RGBA_UNKNOWN 0
115 #define FC_RGBA_RGB 1
116 #define FC_RGBA_BGR 2
117 #define FC_RGBA_VRGB 3
118 #define FC_RGBA_VBGR 4
119 #define FC_RGBA_NONE 5
121 typedef enum _FcType {
133 typedef struct _FcMatrix {
134 double xx, xy, yx, yy;
137 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
138 (m)->xy = (m)->yx = 0)
141 * A data structure to represent the available glyphs in a font.
142 * This is represented as a sparse boolean btree.
145 typedef struct _FcCharSet FcCharSet;
147 typedef struct _FcObjectType {
152 typedef struct _FcConstant {
158 typedef enum _FcResult {
159 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId
162 typedef struct _FcPattern FcPattern;
164 typedef struct _FcLangSet FcLangSet;
166 typedef struct _FcValue {
181 typedef struct _FcFontSet {
187 typedef struct _FcObjectSet {
190 const char **objects;
193 typedef enum _FcMatchKind {
194 FcMatchPattern, FcMatchFont
197 typedef enum _FcLangResult {
198 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
201 typedef enum _FcSetName {
206 typedef struct _FcAtomic FcAtomic;
208 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
209 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
210 #define _FCFUNCPROTOEND }
212 #define _FCFUNCPROTOBEGIN
213 #define _FCFUNCPROTOEND
216 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
218 typedef struct _FcConfig FcConfig;
220 typedef struct _FcGlobalCache FcFileCache;
222 typedef struct _FcBlanks FcBlanks;
224 typedef struct _FcStrList FcStrList;
226 typedef struct _FcStrSet FcStrSet;
231 FcDirCacheValid (const FcChar8 *cache_file);
235 FcBlanksCreate (void);
238 FcBlanksDestroy (FcBlanks *b);
241 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
244 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
251 FcConfigEnableHome (FcBool enable);
254 FcConfigFilename (const FcChar8 *url);
257 FcConfigCreate (void);
260 FcConfigDestroy (FcConfig *config);
263 FcConfigSetCurrent (FcConfig *config);
266 FcConfigGetCurrent (void);
269 FcConfigUptoDate (FcConfig *config);
272 FcConfigBuildFonts (FcConfig *config);
275 FcConfigGetFontDirs (FcConfig *config);
278 FcConfigGetConfigDirs (FcConfig *config);
281 FcConfigGetConfigFiles (FcConfig *config);
284 FcConfigGetCache (FcConfig *config);
287 FcConfigGetBlanks (FcConfig *config);
290 FcConfigGetRescanInverval (FcConfig *config);
293 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
296 FcConfigGetFonts (FcConfig *config,
300 FcConfigAppFontAddFile (FcConfig *config,
301 const FcChar8 *file);
304 FcConfigAppFontAddDir (FcConfig *config,
308 FcConfigAppFontClear (FcConfig *config);
311 FcConfigSubstituteWithPat (FcConfig *config,
317 FcConfigSubstitute (FcConfig *config,
323 FcCharSetCreate (void);
326 FcCharSetDestroy (FcCharSet *fcs);
329 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
332 FcCharSetCopy (FcCharSet *src);
335 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
338 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
341 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
344 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
347 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
350 FcCharSetCount (const FcCharSet *a);
353 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
356 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
359 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
361 #define FC_CHARSET_MAP_SIZE (256/32)
362 #define FC_CHARSET_DONE ((FcChar32) -1)
365 FcCharSetFirstPage (const FcCharSet *a,
366 FcChar32 map[FC_CHARSET_MAP_SIZE],
370 FcCharSetNextPage (const FcCharSet *a,
371 FcChar32 map[FC_CHARSET_MAP_SIZE],
377 FcValuePrint (const FcValue v);
380 FcPatternPrint (const FcPattern *p);
383 FcFontSetPrint (const FcFontSet *s);
387 FcDefaultSubstitute (FcPattern *pattern);
391 FcFileScan (FcFontSet *set,
399 FcDirScan (FcFontSet *set,
407 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
411 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
416 FcFontSetCreate (void);
419 FcFontSetDestroy (FcFontSet *s);
422 FcFontSetAdd (FcFontSet *s, FcPattern *font);
426 FcInitLoadConfig (void);
429 FcInitLoadConfigAndFonts (void);
438 FcInitReinitialize (void);
441 FcInitBringUptoDate (void);
445 FcLangSetCreate (void);
448 FcLangSetDestroy (FcLangSet *ls);
451 FcLangSetCopy (const FcLangSet *ls);
454 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
457 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
460 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
463 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
466 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
469 FcLangSetHash (const FcLangSet *ls);
473 FcObjectSetCreate (void);
476 FcObjectSetAdd (FcObjectSet *os, const char *object);
479 FcObjectSetDestroy (FcObjectSet *os);
482 FcObjectSetVaBuild (const char *first, va_list va);
485 FcObjectSetBuild (const char *first, ...);
488 FcFontSetList (FcConfig *config,
495 FcFontList (FcConfig *config,
502 FcAtomicCreate (const FcChar8 *file);
505 FcAtomicLock (FcAtomic *atomic);
508 FcAtomicNewFile (FcAtomic *atomic);
511 FcAtomicOrigFile (FcAtomic *atomic);
514 FcAtomicReplaceOrig (FcAtomic *atomic);
517 FcAtomicDeleteNew (FcAtomic *atomic);
520 FcAtomicUnlock (FcAtomic *atomic);
523 FcAtomicDestroy (FcAtomic *atomic);
527 FcFontSetMatch (FcConfig *config,
534 FcFontMatch (FcConfig *config,
539 FcFontRenderPrepare (FcConfig *config,
544 FcFontSetSort (FcConfig *config,
553 FcFontSort (FcConfig *config,
560 FcFontSetSortDestroy (FcFontSet *fs);
564 FcMatrixCopy (const FcMatrix *mat);
567 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
570 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
573 FcMatrixRotate (FcMatrix *m, double c, double s);
576 FcMatrixScale (FcMatrix *m, double sx, double sy);
579 FcMatrixShear (FcMatrix *m, double sh, double sv);
584 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
587 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
590 FcNameGetObjectType (const char *object);
593 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
596 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
599 FcNameGetConstant (FcChar8 *string);
602 FcNameConstant (FcChar8 *string, int *result);
605 FcNameParse (const FcChar8 *name);
608 FcNameUnparse (FcPattern *pat);
612 FcPatternCreate (void);
615 FcPatternDuplicate (const FcPattern *p);
618 FcPatternReference (FcPattern *p);
621 FcValueDestroy (FcValue v);
624 FcValueEqual (FcValue va, FcValue vb);
627 FcValueSave (FcValue v);
630 FcPatternDestroy (FcPattern *p);
633 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
636 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
639 FcPatternHash (const FcPattern *p);
642 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
645 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
648 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
651 FcPatternDel (FcPattern *p, const char *object);
654 FcPatternAddInteger (FcPattern *p, const char *object, int i);
657 FcPatternAddDouble (FcPattern *p, const char *object, double d);
660 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
663 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
666 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
669 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
672 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
675 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
678 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
681 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
684 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
687 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
690 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
693 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
696 FcPatternVaBuild (FcPattern *orig, va_list va);
699 FcPatternBuild (FcPattern *orig, ...);
704 FcStrCopy (const FcChar8 *s);
707 FcStrCopyFilename (const FcChar8 *s);
709 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
710 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
711 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
714 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
717 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
720 FcUtf8ToUcs4 (const FcChar8 *src_orig,
725 FcUtf8Len (const FcChar8 *string,
730 #define FC_UTF8_MAX_LEN 6
733 FcUcs4ToUtf8 (FcChar32 ucs4,
734 FcChar8 dest[FC_UTF8_MAX_LEN]);
737 FcUtf16ToUcs4 (const FcChar8 *src_orig,
740 int len); /* in bytes */
743 FcUtf16Len (const FcChar8 *string,
745 int len, /* in bytes */
750 FcStrDirname (const FcChar8 *file);
753 FcStrBasename (const FcChar8 *file);
756 FcStrSetCreate (void);
759 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
762 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
765 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
768 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
771 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
774 FcStrSetDestroy (FcStrSet *set);
777 FcStrListCreate (FcStrSet *set);
780 FcStrListNext (FcStrList *list);
783 FcStrListDone (FcStrList *list);
787 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
791 #endif /* _FONTCONFIG_H_ */