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 #if defined(__GNUC__) && (__GNUC__ >= 4)
31 #define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
33 #define FC_ATTRIBUTE_SENTINEL(x)
36 typedef unsigned char FcChar8;
37 typedef unsigned short FcChar16;
38 typedef unsigned int FcChar32;
42 * Current Fontconfig version number. This same number
43 * must appear in the fontconfig configure.in file. Yes,
44 * it'a a pain to synchronize version numbers like this.
49 #define FC_REVISION 91
51 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
54 * Current font cache file format version
55 * This is appended to the cache files so that multiple
56 * versions of the library will peacefully coexist
58 * Change this value whenever the disk format for the cache file
59 * changes in any non-compatible way. Try to avoid such changes as
60 * it means multiple copies of the font information.
63 #define FC_CACHE_VERSION "2"
68 #define FC_FAMILY "family" /* String */
69 #define FC_STYLE "style" /* String */
70 #define FC_SLANT "slant" /* Int */
71 #define FC_WEIGHT "weight" /* Int */
72 #define FC_SIZE "size" /* Double */
73 #define FC_ASPECT "aspect" /* Double */
74 #define FC_PIXEL_SIZE "pixelsize" /* Double */
75 #define FC_SPACING "spacing" /* Int */
76 #define FC_FOUNDRY "foundry" /* String */
77 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
78 #define FC_HINTING "hinting" /* Bool (true) */
79 #define FC_HINT_STYLE "hintstyle" /* Int */
80 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
81 #define FC_AUTOHINT "autohint" /* Bool (false) */
82 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
83 #define FC_WIDTH "width" /* Int */
84 #define FC_FILE "file" /* String */
85 #define FC_INDEX "index" /* Int */
86 #define FC_FT_FACE "ftface" /* FT_Face */
87 #define FC_RASTERIZER "rasterizer" /* String */
88 #define FC_OUTLINE "outline" /* Bool */
89 #define FC_SCALABLE "scalable" /* Bool */
90 #define FC_SCALE "scale" /* double */
91 #define FC_DPI "dpi" /* double */
92 #define FC_RGBA "rgba" /* Int */
93 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
94 #define FC_SOURCE "source" /* String (deprecated) */
95 #define FC_CHARSET "charset" /* CharSet */
96 #define FC_LANG "lang" /* String RFC 3066 langs */
97 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
98 #define FC_FULLNAME "fullname" /* String */
99 #define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
100 #define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
101 #define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
102 #define FC_CAPABILITY "capability" /* String */
103 #define FC_FONTFORMAT "fontformat" /* String */
104 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
105 #define FC_EMBEDDED_BITMAP "embeddedbitmap" /* Bool - true to enable embedded bitmaps */
107 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
108 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
110 /* Adjust outline rasterizer */
111 #define FC_CHAR_WIDTH "charwidth" /* Int */
112 #define FC_CHAR_HEIGHT "charheight"/* Int */
113 #define FC_MATRIX "matrix" /* FcMatrix */
115 #define FC_WEIGHT_THIN 0
116 #define FC_WEIGHT_EXTRALIGHT 40
117 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
118 #define FC_WEIGHT_LIGHT 50
119 #define FC_WEIGHT_BOOK 75
120 #define FC_WEIGHT_REGULAR 80
121 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
122 #define FC_WEIGHT_MEDIUM 100
123 #define FC_WEIGHT_DEMIBOLD 180
124 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
125 #define FC_WEIGHT_BOLD 200
126 #define FC_WEIGHT_EXTRABOLD 205
127 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
128 #define FC_WEIGHT_BLACK 210
129 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
131 #define FC_SLANT_ROMAN 0
132 #define FC_SLANT_ITALIC 100
133 #define FC_SLANT_OBLIQUE 110
135 #define FC_WIDTH_ULTRACONDENSED 50
136 #define FC_WIDTH_EXTRACONDENSED 63
137 #define FC_WIDTH_CONDENSED 75
138 #define FC_WIDTH_SEMICONDENSED 87
139 #define FC_WIDTH_NORMAL 100
140 #define FC_WIDTH_SEMIEXPANDED 113
141 #define FC_WIDTH_EXPANDED 125
142 #define FC_WIDTH_EXTRAEXPANDED 150
143 #define FC_WIDTH_ULTRAEXPANDED 200
145 #define FC_PROPORTIONAL 0
148 #define FC_CHARCELL 110
150 /* sub-pixel order */
151 #define FC_RGBA_UNKNOWN 0
152 #define FC_RGBA_RGB 1
153 #define FC_RGBA_BGR 2
154 #define FC_RGBA_VRGB 3
155 #define FC_RGBA_VBGR 4
156 #define FC_RGBA_NONE 5
159 #define FC_HINT_NONE 0
160 #define FC_HINT_SLIGHT 1
161 #define FC_HINT_MEDIUM 2
162 #define FC_HINT_FULL 3
164 typedef enum _FcType {
176 typedef struct _FcMatrix {
177 double xx, xy, yx, yy;
180 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
181 (m)->xy = (m)->yx = 0)
184 * A data structure to represent the available glyphs in a font.
185 * This is represented as a sparse boolean btree.
188 typedef struct _FcCharSet FcCharSet;
190 typedef struct _FcObjectType {
195 typedef struct _FcConstant {
201 typedef enum _FcResult {
202 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
206 typedef struct _FcPattern FcPattern;
208 typedef struct _FcLangSet FcLangSet;
210 #define FC_BANK_DYNAMIC 0
211 #define FC_BANK_FIRST 1
213 typedef struct _FcValue {
227 int l_off; // this is a difference of char *s
231 typedef struct _FcFontSet {
237 typedef struct _FcObjectSet {
240 const char **objects;
243 typedef enum _FcMatchKind {
244 FcMatchPattern, FcMatchFont
247 typedef enum _FcLangResult {
248 FcLangEqual, FcLangDifferentCountry, FcLangDifferentLang
251 typedef enum _FcSetName {
256 typedef struct _FcAtomic FcAtomic;
258 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
259 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
260 #define _FCFUNCPROTOEND }
262 #define _FCFUNCPROTOBEGIN
263 #define _FCFUNCPROTOEND
266 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
268 typedef struct _FcConfig FcConfig;
270 typedef struct _FcGlobalCache FcFileCache;
272 typedef struct _FcBlanks FcBlanks;
274 typedef struct _FcStrList FcStrList;
276 typedef struct _FcStrSet FcStrSet;
281 FcDirCacheValid (const FcChar8 *cache_file);
284 FcDirCacheHasCurrentArch (const FcChar8 *dir);
287 FcDirCacheUnlink (const FcChar8 *dir);
291 FcBlanksCreate (void);
294 FcBlanksDestroy (FcBlanks *b);
297 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
300 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
307 FcConfigEnableHome (FcBool enable);
310 FcConfigFilename (const FcChar8 *url);
313 FcConfigCreate (void);
316 FcConfigDestroy (FcConfig *config);
319 FcConfigSetCurrent (FcConfig *config);
322 FcConfigGetCurrent (void);
325 FcConfigUptoDate (FcConfig *config);
328 FcConfigBuildFonts (FcConfig *config);
331 FcConfigGetFontDirs (FcConfig *config);
334 FcConfigGetConfigDirs (FcConfig *config);
337 FcConfigGetConfigFiles (FcConfig *config);
340 FcConfigGetCache (FcConfig *config);
343 FcConfigGetBlanks (FcConfig *config);
346 FcConfigGetRescanInverval (FcConfig *config);
349 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
352 FcConfigGetFonts (FcConfig *config,
356 FcConfigAppFontAddFile (FcConfig *config,
357 const FcChar8 *file);
360 FcConfigAppFontAddDir (FcConfig *config,
364 FcConfigAppFontClear (FcConfig *config);
367 FcConfigSubstituteWithPat (FcConfig *config,
373 FcConfigSubstitute (FcConfig *config,
379 FcCharSetCreate (void);
382 FcCharSetDestroy (FcCharSet *fcs);
385 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
388 FcCharSetCopy (FcCharSet *src);
391 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
394 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
397 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
400 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
403 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
406 FcCharSetCount (const FcCharSet *a);
409 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
412 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
415 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
417 #define FC_CHARSET_MAP_SIZE (256/32)
418 #define FC_CHARSET_DONE ((FcChar32) -1)
421 FcCharSetFirstPage (const FcCharSet *a,
422 FcChar32 map[FC_CHARSET_MAP_SIZE],
426 FcCharSetNextPage (const FcCharSet *a,
427 FcChar32 map[FC_CHARSET_MAP_SIZE],
433 FcValuePrint (const FcValue v);
436 FcPatternPrint (const FcPattern *p);
439 FcFontSetPrint (const FcFontSet *s);
443 FcDefaultSubstitute (FcPattern *pattern);
447 FcFileScan (FcFontSet *set,
455 FcDirScan (FcFontSet *set,
463 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
467 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
472 FcFontSetCreate (void);
475 FcFontSetDestroy (FcFontSet *s);
478 FcFontSetAdd (FcFontSet *s, FcPattern *font);
482 FcInitLoadConfig (void);
485 FcInitLoadConfigAndFonts (void);
497 FcInitReinitialize (void);
500 FcInitBringUptoDate (void);
504 FcLangSetCreate (void);
507 FcLangSetDestroy (FcLangSet *ls);
510 FcLangSetCopy (const FcLangSet *ls);
513 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
516 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
519 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
522 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
525 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
528 FcLangSetHash (const FcLangSet *ls);
532 FcObjectSetCreate (void);
535 FcObjectSetAdd (FcObjectSet *os, const char *object);
538 FcObjectSetDestroy (FcObjectSet *os);
541 FcObjectSetVaBuild (const char *first, va_list va);
544 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
547 FcFontSetList (FcConfig *config,
554 FcFontList (FcConfig *config,
561 FcAtomicCreate (const FcChar8 *file);
564 FcAtomicLock (FcAtomic *atomic);
567 FcAtomicNewFile (FcAtomic *atomic);
570 FcAtomicOrigFile (FcAtomic *atomic);
573 FcAtomicReplaceOrig (FcAtomic *atomic);
576 FcAtomicDeleteNew (FcAtomic *atomic);
579 FcAtomicUnlock (FcAtomic *atomic);
582 FcAtomicDestroy (FcAtomic *atomic);
586 FcFontSetMatch (FcConfig *config,
593 FcFontMatch (FcConfig *config,
598 FcFontRenderPrepare (FcConfig *config,
603 FcFontSetSort (FcConfig *config,
612 FcFontSort (FcConfig *config,
619 FcFontSetSortDestroy (FcFontSet *fs);
623 FcMatrixCopy (const FcMatrix *mat);
626 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
629 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
632 FcMatrixRotate (FcMatrix *m, double c, double s);
635 FcMatrixScale (FcMatrix *m, double sx, double sy);
638 FcMatrixShear (FcMatrix *m, double sh, double sv);
643 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
646 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
649 FcNameGetObjectType (const char *object);
652 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
655 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
658 FcNameGetConstant (FcChar8 *string);
661 FcNameConstant (FcChar8 *string, int *result);
664 FcNameParse (const FcChar8 *name);
667 FcNameUnparse (FcPattern *pat);
670 FcNameUnparseEscaped (FcPattern *pat, FcBool escape);
674 FcPatternCreate (void);
677 FcPatternDuplicate (const FcPattern *p);
680 FcPatternReference (FcPattern *p);
683 FcValueDestroy (FcValue v);
686 FcValueEqual (FcValue va, FcValue vb);
689 FcValueSave (FcValue v);
692 FcPatternDestroy (FcPattern *p);
695 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
698 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
701 FcPatternHash (const FcPattern *p);
704 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
707 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
710 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
713 FcPatternDel (FcPattern *p, const char *object);
716 FcPatternRemove (FcPattern *p, const char *object, int id);
719 FcPatternAddInteger (FcPattern *p, const char *object, int i);
722 FcPatternAddDouble (FcPattern *p, const char *object, double d);
725 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
728 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
731 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
734 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
737 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
740 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
743 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
746 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
749 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
752 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
755 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
758 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
761 FcPatternVaBuild (FcPattern *orig, va_list va);
764 FcPatternBuild (FcPattern *orig, ...) FC_ATTRIBUTE_SENTINEL(0);
769 FcStrCopy (const FcChar8 *s);
772 FcStrCopyFilename (const FcChar8 *s);
774 /* These are ASCII only, suitable only for pattern element names */
775 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
776 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
777 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
780 FcStrDowncase (const FcChar8 *s);
783 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
786 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
789 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
792 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
795 FcUtf8ToUcs4 (const FcChar8 *src_orig,
800 FcUtf8Len (const FcChar8 *string,
805 #define FC_UTF8_MAX_LEN 6
808 FcUcs4ToUtf8 (FcChar32 ucs4,
809 FcChar8 dest[FC_UTF8_MAX_LEN]);
812 FcUtf16ToUcs4 (const FcChar8 *src_orig,
815 int len); /* in bytes */
818 FcUtf16Len (const FcChar8 *string,
820 int len, /* in bytes */
825 FcStrDirname (const FcChar8 *file);
828 FcStrBasename (const FcChar8 *file);
831 FcStrSetCreate (void);
834 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
837 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
840 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
843 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
846 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
849 FcStrSetDestroy (FcStrSet *set);
852 FcStrListCreate (FcStrSet *set);
855 FcStrListNext (FcStrList *list);
858 FcStrListDone (FcStrList *list);
862 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
866 #undef FC_ATTRIBUTE_SENTINEL
868 #endif /* _FONTCONFIG_H_ */