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 92
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_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
108 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
109 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
111 /* Adjust outline rasterizer */
112 #define FC_CHAR_WIDTH "charwidth" /* Int */
113 #define FC_CHAR_HEIGHT "charheight"/* Int */
114 #define FC_MATRIX "matrix" /* FcMatrix */
116 #define FC_WEIGHT_THIN 0
117 #define FC_WEIGHT_EXTRALIGHT 40
118 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
119 #define FC_WEIGHT_LIGHT 50
120 #define FC_WEIGHT_BOOK 75
121 #define FC_WEIGHT_REGULAR 80
122 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
123 #define FC_WEIGHT_MEDIUM 100
124 #define FC_WEIGHT_DEMIBOLD 180
125 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
126 #define FC_WEIGHT_BOLD 200
127 #define FC_WEIGHT_EXTRABOLD 205
128 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
129 #define FC_WEIGHT_BLACK 210
130 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
132 #define FC_SLANT_ROMAN 0
133 #define FC_SLANT_ITALIC 100
134 #define FC_SLANT_OBLIQUE 110
136 #define FC_WIDTH_ULTRACONDENSED 50
137 #define FC_WIDTH_EXTRACONDENSED 63
138 #define FC_WIDTH_CONDENSED 75
139 #define FC_WIDTH_SEMICONDENSED 87
140 #define FC_WIDTH_NORMAL 100
141 #define FC_WIDTH_SEMIEXPANDED 113
142 #define FC_WIDTH_EXPANDED 125
143 #define FC_WIDTH_EXTRAEXPANDED 150
144 #define FC_WIDTH_ULTRAEXPANDED 200
146 #define FC_PROPORTIONAL 0
149 #define FC_CHARCELL 110
151 /* sub-pixel order */
152 #define FC_RGBA_UNKNOWN 0
153 #define FC_RGBA_RGB 1
154 #define FC_RGBA_BGR 2
155 #define FC_RGBA_VRGB 3
156 #define FC_RGBA_VBGR 4
157 #define FC_RGBA_NONE 5
160 #define FC_HINT_NONE 0
161 #define FC_HINT_SLIGHT 1
162 #define FC_HINT_MEDIUM 2
163 #define FC_HINT_FULL 3
165 typedef enum _FcType
{
177 typedef struct _FcMatrix
{
178 double xx
, xy
, yx
, yy
;
181 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
182 (m)->xy = (m)->yx = 0)
185 * A data structure to represent the available glyphs in a font.
186 * This is represented as a sparse boolean btree.
189 typedef struct _FcCharSet FcCharSet
;
191 typedef struct _FcObjectType
{
196 typedef struct _FcConstant
{
202 typedef enum _FcResult
{
203 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
207 typedef struct _FcPattern FcPattern
;
209 typedef struct _FcLangSet FcLangSet
;
211 typedef struct _FcValue
{
225 int l_off
; /* this is a difference of char *s */
229 typedef struct _FcFontSet
{
235 typedef struct _FcObjectSet
{
238 const char **objects
;
241 typedef enum _FcMatchKind
{
242 FcMatchPattern
, FcMatchFont
245 typedef enum _FcLangResult
{
246 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
249 typedef enum _FcSetName
{
254 typedef struct _FcAtomic FcAtomic
;
256 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
257 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
258 #define _FCFUNCPROTOEND }
260 #define _FCFUNCPROTOBEGIN
261 #define _FCFUNCPROTOEND
264 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
266 typedef struct _FcConfig FcConfig
;
268 typedef struct _FcGlobalCache FcFileCache
;
270 typedef struct _FcBlanks FcBlanks
;
272 typedef struct _FcStrList FcStrList
;
274 typedef struct _FcStrSet FcStrSet
;
279 FcDirCacheValid (const FcChar8
*cache_file
);
282 FcDirCacheHasCurrentArch (const FcChar8
*dir
);
285 FcDirCacheUnlink (const FcChar8
*dir
);
289 FcBlanksCreate (void);
292 FcBlanksDestroy (FcBlanks
*b
);
295 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
298 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
305 FcConfigEnableHome (FcBool enable
);
308 FcConfigFilename (const FcChar8
*url
);
311 FcConfigCreate (void);
314 FcConfigDestroy (FcConfig
*config
);
317 FcConfigSetCurrent (FcConfig
*config
);
320 FcConfigGetCurrent (void);
323 FcConfigUptoDate (FcConfig
*config
);
326 FcConfigBuildFonts (FcConfig
*config
);
329 FcConfigGetFontDirs (FcConfig
*config
);
332 FcConfigGetConfigDirs (FcConfig
*config
);
335 FcConfigGetConfigFiles (FcConfig
*config
);
338 FcConfigGetCache (FcConfig
*config
);
341 FcConfigGetBlanks (FcConfig
*config
);
344 FcConfigGetRescanInverval (FcConfig
*config
);
347 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
350 FcConfigGetFonts (FcConfig
*config
,
354 FcConfigAppFontAddFile (FcConfig
*config
,
355 const FcChar8
*file
);
358 FcConfigAppFontAddDir (FcConfig
*config
,
362 FcConfigAppFontClear (FcConfig
*config
);
365 FcConfigSubstituteWithPat (FcConfig
*config
,
371 FcConfigSubstitute (FcConfig
*config
,
377 FcCharSetCreate (void);
380 FcCharSetDestroy (FcCharSet
*fcs
);
383 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
386 FcCharSetCopy (FcCharSet
*src
);
389 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
392 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
395 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
398 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
401 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
404 FcCharSetCount (const FcCharSet
*a
);
407 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
410 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
413 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
415 #define FC_CHARSET_MAP_SIZE (256/32)
416 #define FC_CHARSET_DONE ((FcChar32) -1)
419 FcCharSetFirstPage (const FcCharSet
*a
,
420 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
424 FcCharSetNextPage (const FcCharSet
*a
,
425 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
431 FcValuePrint (const FcValue v
);
434 FcPatternPrint (const FcPattern
*p
);
437 FcFontSetPrint (const FcFontSet
*s
);
441 FcDefaultSubstitute (FcPattern
*pattern
);
445 FcFileScan (FcFontSet
*set
,
453 FcDirScan (FcFontSet
*set
,
461 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
465 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
470 FcFontSetCreate (void);
473 FcFontSetDestroy (FcFontSet
*s
);
476 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
480 FcInitLoadConfig (void);
483 FcInitLoadConfigAndFonts (void);
495 FcInitReinitialize (void);
498 FcInitBringUptoDate (void);
502 FcLangSetCreate (void);
505 FcLangSetDestroy (FcLangSet
*ls
);
508 FcLangSetCopy (const FcLangSet
*ls
);
511 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
514 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
517 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
520 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
523 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
526 FcLangSetHash (const FcLangSet
*ls
);
530 FcObjectSetCreate (void);
533 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
536 FcObjectSetDestroy (FcObjectSet
*os
);
539 FcObjectSetVaBuild (const char *first
, va_list va
);
542 FcObjectSetBuild (const char *first
, ...) FC_ATTRIBUTE_SENTINEL(0);
545 FcFontSetList (FcConfig
*config
,
552 FcFontList (FcConfig
*config
,
559 FcAtomicCreate (const FcChar8
*file
);
562 FcAtomicLock (FcAtomic
*atomic
);
565 FcAtomicNewFile (FcAtomic
*atomic
);
568 FcAtomicOrigFile (FcAtomic
*atomic
);
571 FcAtomicReplaceOrig (FcAtomic
*atomic
);
574 FcAtomicDeleteNew (FcAtomic
*atomic
);
577 FcAtomicUnlock (FcAtomic
*atomic
);
580 FcAtomicDestroy (FcAtomic
*atomic
);
584 FcFontSetMatch (FcConfig
*config
,
591 FcFontMatch (FcConfig
*config
,
596 FcFontRenderPrepare (FcConfig
*config
,
601 FcFontSetSort (FcConfig
*config
,
610 FcFontSort (FcConfig
*config
,
617 FcFontSetSortDestroy (FcFontSet
*fs
);
621 FcMatrixCopy (const FcMatrix
*mat
);
624 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
627 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
630 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
633 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
636 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
641 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
644 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
647 FcNameGetObjectType (const char *object
);
650 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
653 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
656 FcNameGetConstant (FcChar8
*string
);
659 FcNameConstant (FcChar8
*string
, int *result
);
662 FcNameParse (const FcChar8
*name
);
665 FcNameUnparse (FcPattern
*pat
);
668 FcNameUnparseEscaped (FcPattern
*pat
, FcBool escape
);
672 FcPatternCreate (void);
675 FcPatternDuplicate (const FcPattern
*p
);
678 FcPatternReference (FcPattern
*p
);
681 FcValueDestroy (FcValue v
);
684 FcValueEqual (FcValue va
, FcValue vb
);
687 FcValueSave (FcValue v
);
690 FcPatternDestroy (FcPattern
*p
);
693 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
696 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
699 FcPatternHash (const FcPattern
*p
);
702 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
705 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
708 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
711 FcPatternDel (FcPattern
*p
, const char *object
);
714 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
717 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
720 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
723 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
726 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
729 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
732 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
735 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
738 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
741 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
744 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
747 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
750 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
753 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
756 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
759 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
762 FcPatternBuild (FcPattern
*orig
, ...) FC_ATTRIBUTE_SENTINEL(0);
767 FcStrCopy (const FcChar8
*s
);
770 FcStrCopyFilename (const FcChar8
*s
);
772 /* These are ASCII only, suitable only for pattern element names */
773 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
774 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
775 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
778 FcStrDowncase (const FcChar8
*s
);
781 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
784 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
787 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
790 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
793 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
798 FcUtf8Len (const FcChar8
*string
,
803 #define FC_UTF8_MAX_LEN 6
806 FcUcs4ToUtf8 (FcChar32 ucs4
,
807 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
810 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
813 int len
); /* in bytes */
816 FcUtf16Len (const FcChar8
*string
,
818 int len
, /* in bytes */
823 FcStrDirname (const FcChar8
*file
);
826 FcStrBasename (const FcChar8
*file
);
829 FcStrSetCreate (void);
832 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
835 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
838 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
841 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
844 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
847 FcStrSetDestroy (FcStrSet
*set
);
850 FcStrListCreate (FcStrSet
*set
);
853 FcStrListNext (FcStrList
*list
);
856 FcStrListDone (FcStrList
*list
);
860 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
864 #undef FC_ATTRIBUTE_SENTINEL
866 #endif /* _FONTCONFIG_H_ */