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 96
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_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 (X11, freetype) */
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 */
98 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
99 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
101 /* Adjust outline rasterizer */
102 #define FC_CHAR_WIDTH "charwidth" /* Int */
103 #define FC_CHAR_HEIGHT "charheight"/* Int */
104 #define FC_MATRIX "matrix" /* FcMatrix */
106 #define FC_WEIGHT_THIN 0
107 #define FC_WEIGHT_EXTRALIGHT 40
108 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
109 #define FC_WEIGHT_LIGHT 50
110 #define FC_WEIGHT_BOOK 75
111 #define FC_WEIGHT_REGULAR 80
112 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
113 #define FC_WEIGHT_MEDIUM 100
114 #define FC_WEIGHT_DEMIBOLD 180
115 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
116 #define FC_WEIGHT_BOLD 200
117 #define FC_WEIGHT_EXTRABOLD 205
118 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
119 #define FC_WEIGHT_BLACK 210
120 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
122 #define FC_SLANT_ROMAN 0
123 #define FC_SLANT_ITALIC 100
124 #define FC_SLANT_OBLIQUE 110
126 #define FC_WIDTH_ULTRACONDENSED 50
127 #define FC_WIDTH_EXTRACONDENSED 63
128 #define FC_WIDTH_CONDENSED 75
129 #define FC_WIDTH_SEMICONDENSED 87
130 #define FC_WIDTH_NORMAL 100
131 #define FC_WIDTH_SEMIEXPANDED 113
132 #define FC_WIDTH_EXPANDED 125
133 #define FC_WIDTH_EXTRAEXPANDED 150
134 #define FC_WIDTH_ULTRAEXPANDED 200
136 #define FC_PROPORTIONAL 0
139 #define FC_CHARCELL 110
141 /* sub-pixel order */
142 #define FC_RGBA_UNKNOWN 0
143 #define FC_RGBA_RGB 1
144 #define FC_RGBA_BGR 2
145 #define FC_RGBA_VRGB 3
146 #define FC_RGBA_VBGR 4
147 #define FC_RGBA_NONE 5
150 #define FC_HINT_NONE 0
151 #define FC_HINT_SLIGHT 1
152 #define FC_HINT_MEDIUM 2
153 #define FC_HINT_FULL 3
155 typedef enum _FcType {
167 typedef struct _FcMatrix {
168 double xx, xy, yx, yy;
171 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
172 (m)->xy = (m)->yx = 0)
175 * A data structure to represent the available glyphs in a font.
176 * This is represented as a sparse boolean btree.
179 typedef struct _FcCharSet FcCharSet;
181 typedef struct _FcObjectType {
186 typedef struct _FcConstant {
192 typedef enum _FcResult {
193 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
197 typedef struct _FcPattern FcPattern;
199 typedef struct _FcLangSet FcLangSet;
201 typedef struct _FcValue {
216 typedef struct _FcFontSet {
222 typedef struct _FcObjectSet {
225 const char **objects;
228 typedef enum _FcMatchKind {
229 FcMatchPattern, FcMatchFont
232 typedef enum _FcLangResult {
233 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
236 typedef enum _FcSetName {
241 typedef struct _FcAtomic FcAtomic;
243 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
244 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
245 #define _FCFUNCPROTOEND }
247 #define _FCFUNCPROTOBEGIN
248 #define _FCFUNCPROTOEND
251 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
253 typedef struct _FcConfig FcConfig;
255 typedef struct _FcGlobalCache FcFileCache;
257 typedef struct _FcBlanks FcBlanks;
259 typedef struct _FcStrList FcStrList;
261 typedef struct _FcStrSet FcStrSet;
266 FcDirCacheValid (const FcChar8 *cache_file);
270 FcBlanksCreate (void);
273 FcBlanksDestroy (FcBlanks *b);
276 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
279 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
286 FcConfigEnableHome (FcBool enable);
289 FcConfigFilename (const FcChar8 *url);
292 FcConfigCreate (void);
295 FcConfigDestroy (FcConfig *config);
298 FcConfigSetCurrent (FcConfig *config);
301 FcConfigGetCurrent (void);
304 FcConfigUptoDate (FcConfig *config);
307 FcConfigBuildFonts (FcConfig *config);
310 FcConfigGetFontDirs (FcConfig *config);
313 FcConfigGetConfigDirs (FcConfig *config);
316 FcConfigGetConfigFiles (FcConfig *config);
319 FcConfigGetCache (FcConfig *config);
322 FcConfigGetBlanks (FcConfig *config);
325 FcConfigGetRescanInverval (FcConfig *config);
328 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
331 FcConfigGetFonts (FcConfig *config,
335 FcConfigAppFontAddFile (FcConfig *config,
336 const FcChar8 *file);
339 FcConfigAppFontAddDir (FcConfig *config,
343 FcConfigAppFontClear (FcConfig *config);
346 FcConfigSubstituteWithPat (FcConfig *config,
352 FcConfigSubstitute (FcConfig *config,
358 FcCharSetCreate (void);
361 FcCharSetDestroy (FcCharSet *fcs);
364 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
367 FcCharSetCopy (FcCharSet *src);
370 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
373 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
376 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
379 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
382 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
385 FcCharSetCount (const FcCharSet *a);
388 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
391 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
394 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
396 #define FC_CHARSET_MAP_SIZE (256/32)
397 #define FC_CHARSET_DONE ((FcChar32) -1)
400 FcCharSetFirstPage (const FcCharSet *a,
401 FcChar32 map[FC_CHARSET_MAP_SIZE],
405 FcCharSetNextPage (const FcCharSet *a,
406 FcChar32 map[FC_CHARSET_MAP_SIZE],
412 FcValuePrint (const FcValue v);
415 FcPatternPrint (const FcPattern *p);
418 FcFontSetPrint (const FcFontSet *s);
422 FcDefaultSubstitute (FcPattern *pattern);
426 FcFileScan (FcFontSet *set,
434 FcDirScan (FcFontSet *set,
442 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
446 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
451 FcFontSetCreate (void);
454 FcFontSetDestroy (FcFontSet *s);
457 FcFontSetAdd (FcFontSet *s, FcPattern *font);
461 FcInitLoadConfig (void);
464 FcInitLoadConfigAndFonts (void);
476 FcInitReinitialize (void);
479 FcInitBringUptoDate (void);
483 FcLangSetCreate (void);
486 FcLangSetDestroy (FcLangSet *ls);
489 FcLangSetCopy (const FcLangSet *ls);
492 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
495 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
498 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
501 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
504 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
507 FcLangSetHash (const FcLangSet *ls);
511 FcObjectSetCreate (void);
514 FcObjectSetAdd (FcObjectSet *os, const char *object);
517 FcObjectSetDestroy (FcObjectSet *os);
520 FcObjectSetVaBuild (const char *first, va_list va);
523 FcObjectSetBuild (const char *first, ...);
526 FcFontSetList (FcConfig *config,
533 FcFontList (FcConfig *config,
540 FcAtomicCreate (const FcChar8 *file);
543 FcAtomicLock (FcAtomic *atomic);
546 FcAtomicNewFile (FcAtomic *atomic);
549 FcAtomicOrigFile (FcAtomic *atomic);
552 FcAtomicReplaceOrig (FcAtomic *atomic);
555 FcAtomicDeleteNew (FcAtomic *atomic);
558 FcAtomicUnlock (FcAtomic *atomic);
561 FcAtomicDestroy (FcAtomic *atomic);
565 FcFontSetMatch (FcConfig *config,
572 FcFontMatch (FcConfig *config,
577 FcFontRenderPrepare (FcConfig *config,
582 FcFontSetSort (FcConfig *config,
591 FcFontSort (FcConfig *config,
598 FcFontSetSortDestroy (FcFontSet *fs);
602 FcMatrixCopy (const FcMatrix *mat);
605 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
608 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
611 FcMatrixRotate (FcMatrix *m, double c, double s);
614 FcMatrixScale (FcMatrix *m, double sx, double sy);
617 FcMatrixShear (FcMatrix *m, double sh, double sv);
622 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
625 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
628 FcNameGetObjectType (const char *object);
631 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
634 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
637 FcNameGetConstant (FcChar8 *string);
640 FcNameConstant (FcChar8 *string, int *result);
643 FcNameParse (const FcChar8 *name);
646 FcNameUnparse (FcPattern *pat);
650 FcPatternCreate (void);
653 FcPatternDuplicate (const FcPattern *p);
656 FcPatternReference (FcPattern *p);
659 FcValueDestroy (FcValue v);
662 FcValueEqual (FcValue va, FcValue vb);
665 FcValueSave (FcValue v);
668 FcPatternDestroy (FcPattern *p);
671 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
674 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
677 FcPatternHash (const FcPattern *p);
680 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
683 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
686 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
689 FcPatternDel (FcPattern *p, const char *object);
692 FcPatternRemove (FcPattern *p, const char *object, int id);
695 FcPatternAddInteger (FcPattern *p, const char *object, int i);
698 FcPatternAddDouble (FcPattern *p, const char *object, double d);
701 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
704 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
707 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
710 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
713 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
716 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
719 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
722 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
725 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
728 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
731 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
734 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
737 FcPatternVaBuild (FcPattern *orig, va_list va);
740 FcPatternBuild (FcPattern *orig, ...);
745 FcStrCopy (const FcChar8 *s);
748 FcStrCopyFilename (const FcChar8 *s);
750 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
751 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
752 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
755 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
758 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
761 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
764 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
767 FcUtf8ToUcs4 (const FcChar8 *src_orig,
772 FcUtf8Len (const FcChar8 *string,
777 #define FC_UTF8_MAX_LEN 6
780 FcUcs4ToUtf8 (FcChar32 ucs4,
781 FcChar8 dest[FC_UTF8_MAX_LEN]);
784 FcUtf16ToUcs4 (const FcChar8 *src_orig,
787 int len); /* in bytes */
790 FcUtf16Len (const FcChar8 *string,
792 int len, /* in bytes */
797 FcStrDirname (const FcChar8 *file);
800 FcStrBasename (const FcChar8 *file);
803 FcStrSetCreate (void);
806 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
809 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
812 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
815 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
818 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
821 FcStrSetDestroy (FcStrSet *set);
824 FcStrListCreate (FcStrSet *set);
827 FcStrListNext (FcStrList *list);
830 FcStrListDone (FcStrList *list);
834 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
838 #endif /* _FONTCONFIG_H_ */