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_
28 #include <sys/types.h>
33 #if defined(__GNUC__) && (__GNUC__ >= 4)
34 #define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
36 #define FC_ATTRIBUTE_SENTINEL(x)
43 typedef unsigned char FcChar8
;
44 typedef unsigned short FcChar16
;
45 typedef unsigned int FcChar32
;
49 * Current Fontconfig version number. This same number
50 * must appear in the fontconfig configure.in file. Yes,
51 * it'a a pain to synchronize version numbers like this.
56 #define FC_REVISION 91
58 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
61 * Current font cache file format version
62 * This is appended to the cache files so that multiple
63 * versions of the library will peacefully coexist
65 * Change this value whenever the disk format for the cache file
66 * changes in any non-compatible way. Try to avoid such changes as
67 * it means multiple copies of the font information.
70 #define FC_CACHE_VERSION "2"
75 #define FC_FAMILY "family" /* String */
76 #define FC_STYLE "style" /* String */
77 #define FC_SLANT "slant" /* Int */
78 #define FC_WEIGHT "weight" /* Int */
79 #define FC_SIZE "size" /* Double */
80 #define FC_ASPECT "aspect" /* Double */
81 #define FC_PIXEL_SIZE "pixelsize" /* Double */
82 #define FC_SPACING "spacing" /* Int */
83 #define FC_FOUNDRY "foundry" /* String */
84 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
85 #define FC_HINTING "hinting" /* Bool (true) */
86 #define FC_HINT_STYLE "hintstyle" /* Int */
87 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
88 #define FC_AUTOHINT "autohint" /* Bool (false) */
89 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
90 #define FC_WIDTH "width" /* Int */
91 #define FC_FILE "file" /* String */
92 #define FC_INDEX "index" /* Int */
93 #define FC_FT_FACE "ftface" /* FT_Face */
94 #define FC_RASTERIZER "rasterizer" /* String */
95 #define FC_OUTLINE "outline" /* Bool */
96 #define FC_SCALABLE "scalable" /* Bool */
97 #define FC_SCALE "scale" /* double */
98 #define FC_DPI "dpi" /* double */
99 #define FC_RGBA "rgba" /* Int */
100 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
101 #define FC_SOURCE "source" /* String (deprecated) */
102 #define FC_CHARSET "charset" /* CharSet */
103 #define FC_LANG "lang" /* String RFC 3066 langs */
104 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
105 #define FC_FULLNAME "fullname" /* String */
106 #define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
107 #define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
108 #define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
109 #define FC_CAPABILITY "capability" /* String */
110 #define FC_FONTFORMAT "fontformat" /* String */
111 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
112 #define FC_EMBEDDED_BITMAP "embeddedbitmap" /* Bool - true to enable embedded bitmaps */
113 #define FC_DECORATIVE "decorative" /* Bool - true if style is a decorative variant */
114 #define FC_LCD_FILTER "lcdfilter" /* Int */
116 #define FC_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
117 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
118 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
120 /* Adjust outline rasterizer */
121 #define FC_CHAR_WIDTH "charwidth" /* Int */
122 #define FC_CHAR_HEIGHT "charheight"/* Int */
123 #define FC_MATRIX "matrix" /* FcMatrix */
125 #define FC_WEIGHT_THIN 0
126 #define FC_WEIGHT_EXTRALIGHT 40
127 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
128 #define FC_WEIGHT_LIGHT 50
129 #define FC_WEIGHT_BOOK 75
130 #define FC_WEIGHT_REGULAR 80
131 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
132 #define FC_WEIGHT_MEDIUM 100
133 #define FC_WEIGHT_DEMIBOLD 180
134 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
135 #define FC_WEIGHT_BOLD 200
136 #define FC_WEIGHT_EXTRABOLD 205
137 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
138 #define FC_WEIGHT_BLACK 210
139 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
140 #define FC_WEIGHT_EXTRABLACK 215
141 #define FC_WEIGHT_ULTRABLACK FC_WEIGHT_EXTRABLACK
143 #define FC_SLANT_ROMAN 0
144 #define FC_SLANT_ITALIC 100
145 #define FC_SLANT_OBLIQUE 110
147 #define FC_WIDTH_ULTRACONDENSED 50
148 #define FC_WIDTH_EXTRACONDENSED 63
149 #define FC_WIDTH_CONDENSED 75
150 #define FC_WIDTH_SEMICONDENSED 87
151 #define FC_WIDTH_NORMAL 100
152 #define FC_WIDTH_SEMIEXPANDED 113
153 #define FC_WIDTH_EXPANDED 125
154 #define FC_WIDTH_EXTRAEXPANDED 150
155 #define FC_WIDTH_ULTRAEXPANDED 200
157 #define FC_PROPORTIONAL 0
160 #define FC_CHARCELL 110
162 /* sub-pixel order */
163 #define FC_RGBA_UNKNOWN 0
164 #define FC_RGBA_RGB 1
165 #define FC_RGBA_BGR 2
166 #define FC_RGBA_VRGB 3
167 #define FC_RGBA_VBGR 4
168 #define FC_RGBA_NONE 5
171 #define FC_HINT_NONE 0
172 #define FC_HINT_SLIGHT 1
173 #define FC_HINT_MEDIUM 2
174 #define FC_HINT_FULL 3
177 #define FC_LCD_NONE 0
178 #define FC_LCD_DEFAULT 1
179 #define FC_LCD_LIGHT 2
180 #define FC_LCD_LEGACY 3
182 typedef enum _FcType
{
194 typedef struct _FcMatrix
{
195 double xx
, xy
, yx
, yy
;
198 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
199 (m)->xy = (m)->yx = 0)
202 * A data structure to represent the available glyphs in a font.
203 * This is represented as a sparse boolean btree.
206 typedef struct _FcCharSet FcCharSet
;
208 typedef struct _FcObjectType
{
213 typedef struct _FcConstant
{
219 typedef enum _FcResult
{
220 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
224 typedef struct _FcPattern FcPattern
;
226 typedef struct _FcLangSet FcLangSet
;
228 typedef struct _FcValue
{
242 typedef struct _FcFontSet
{
248 typedef struct _FcObjectSet
{
251 const char **objects
;
254 typedef enum _FcMatchKind
{
255 FcMatchPattern
, FcMatchFont
, FcMatchScan
258 typedef enum _FcLangResult
{
260 FcLangDifferentCountry
= 1,
261 FcLangDifferentTerritory
= 1,
262 FcLangDifferentLang
= 2
265 typedef enum _FcSetName
{
270 typedef struct _FcAtomic FcAtomic
;
272 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
273 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
274 #define _FCFUNCPROTOEND }
276 #define _FCFUNCPROTOBEGIN
277 #define _FCFUNCPROTOEND
280 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
282 typedef struct _FcConfig FcConfig
;
284 typedef struct _FcGlobalCache FcFileCache
;
286 typedef struct _FcBlanks FcBlanks
;
288 typedef struct _FcStrList FcStrList
;
290 typedef struct _FcStrSet FcStrSet
;
292 typedef struct _FcCache FcCache
;
298 FcBlanksCreate (void);
301 FcBlanksDestroy (FcBlanks
*b
);
304 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
307 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
311 FcPublic
const FcChar8
*
312 FcCacheDir(const FcCache
*c
);
315 FcCacheCopySet(const FcCache
*c
);
317 FcPublic
const FcChar8
*
318 FcCacheSubdir (const FcCache
*c
, int i
);
321 FcCacheNumSubdir (const FcCache
*c
);
324 FcCacheNumFont (const FcCache
*c
);
327 FcDirCacheUnlink (const FcChar8
*dir
, FcConfig
*config
);
330 FcDirCacheValid (const FcChar8
*cache_file
);
337 FcConfigEnableHome (FcBool enable
);
340 FcConfigFilename (const FcChar8
*url
);
343 FcConfigCreate (void);
346 FcConfigDestroy (FcConfig
*config
);
349 FcConfigSetCurrent (FcConfig
*config
);
352 FcConfigGetCurrent (void);
355 FcConfigUptoDate (FcConfig
*config
);
358 FcConfigBuildFonts (FcConfig
*config
);
361 FcConfigGetFontDirs (FcConfig
*config
);
364 FcConfigGetConfigDirs (FcConfig
*config
);
367 FcConfigGetConfigFiles (FcConfig
*config
);
370 FcConfigGetCache (FcConfig
*config
);
373 FcConfigGetBlanks (FcConfig
*config
);
376 FcConfigGetCacheDirs (FcConfig
*config
);
379 FcConfigGetRescanInterval (FcConfig
*config
);
382 FcConfigSetRescanInterval (FcConfig
*config
, int rescanInterval
);
385 FcConfigGetFonts (FcConfig
*config
,
389 FcConfigAppFontAddFile (FcConfig
*config
,
390 const FcChar8
*file
);
393 FcConfigAppFontAddDir (FcConfig
*config
,
397 FcConfigAppFontClear (FcConfig
*config
);
400 FcConfigSubstituteWithPat (FcConfig
*config
,
406 FcConfigSubstitute (FcConfig
*config
,
412 FcCharSetCreate (void);
414 /* deprecated alias for FcCharSetCreate */
419 FcCharSetDestroy (FcCharSet
*fcs
);
422 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
425 FcCharSetCopy (FcCharSet
*src
);
428 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
431 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
434 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
437 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
440 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
443 FcCharSetCount (const FcCharSet
*a
);
446 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
449 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
452 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
454 #define FC_CHARSET_MAP_SIZE (256/32)
455 #define FC_CHARSET_DONE ((FcChar32) -1)
458 FcCharSetFirstPage (const FcCharSet
*a
,
459 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
463 FcCharSetNextPage (const FcCharSet
*a
,
464 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
468 * old coverage API, rather hard to use correctly
472 FcCharSetCoverage (const FcCharSet
*a
, FcChar32 page
, FcChar32
*result
);
476 FcValuePrint (const FcValue v
);
479 FcPatternPrint (const FcPattern
*p
);
482 FcFontSetPrint (const FcFontSet
*s
);
486 FcDefaultSubstitute (FcPattern
*pattern
);
490 FcFileIsDir (const FcChar8
*file
);
493 FcFileScan (FcFontSet
*set
,
501 FcDirScan (FcFontSet
*set
,
509 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
512 FcDirCacheLoad (const FcChar8
*dir
, FcConfig
*config
, FcChar8
**cache_file
);
515 FcDirCacheRead (const FcChar8
*dir
, FcBool force
, FcConfig
*config
);
518 FcDirCacheLoadFile (const FcChar8
*cache_file
, struct stat
*file_stat
);
521 FcDirCacheUnload (FcCache
*cache
);
525 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
530 FcFontSetCreate (void);
533 FcFontSetDestroy (FcFontSet
*s
);
536 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
540 FcInitLoadConfig (void);
543 FcInitLoadConfigAndFonts (void);
555 FcInitReinitialize (void);
558 FcInitBringUptoDate (void);
564 FcPublic
const FcCharSet
*
565 FcLangGetCharSet (const FcChar8
*lang
);
568 FcLangSetCreate (void);
571 FcLangSetDestroy (FcLangSet
*ls
);
574 FcLangSetCopy (const FcLangSet
*ls
);
577 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
579 FcPublic FcLangResult
580 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
582 FcPublic FcLangResult
583 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
586 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
589 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
592 FcLangSetHash (const FcLangSet
*ls
);
595 FcPublic FcObjectSet
*
596 FcObjectSetCreate (void);
599 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
602 FcObjectSetDestroy (FcObjectSet
*os
);
604 FcPublic FcObjectSet
*
605 FcObjectSetVaBuild (const char *first
, va_list va
);
607 FcPublic FcObjectSet
*
608 FcObjectSetBuild (const char *first
, ...) FC_ATTRIBUTE_SENTINEL(0);
611 FcFontSetList (FcConfig
*config
,
618 FcFontList (FcConfig
*config
,
625 FcAtomicCreate (const FcChar8
*file
);
628 FcAtomicLock (FcAtomic
*atomic
);
631 FcAtomicNewFile (FcAtomic
*atomic
);
634 FcAtomicOrigFile (FcAtomic
*atomic
);
637 FcAtomicReplaceOrig (FcAtomic
*atomic
);
640 FcAtomicDeleteNew (FcAtomic
*atomic
);
643 FcAtomicUnlock (FcAtomic
*atomic
);
646 FcAtomicDestroy (FcAtomic
*atomic
);
650 FcFontSetMatch (FcConfig
*config
,
657 FcFontMatch (FcConfig
*config
,
662 FcFontRenderPrepare (FcConfig
*config
,
667 FcFontSetSort (FcConfig
*config
,
676 FcFontSort (FcConfig
*config
,
683 FcFontSetSortDestroy (FcFontSet
*fs
);
687 FcMatrixCopy (const FcMatrix
*mat
);
690 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
693 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
696 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
699 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
702 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
707 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
710 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
712 FcPublic
const FcObjectType
*
713 FcNameGetObjectType (const char *object
);
716 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
719 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
721 FcPublic
const FcConstant
*
722 FcNameGetConstant (FcChar8
*string
);
725 FcNameConstant (FcChar8
*string
, int *result
);
728 FcNameParse (const FcChar8
*name
);
731 FcNameUnparse (FcPattern
*pat
);
735 FcPatternCreate (void);
738 FcPatternDuplicate (const FcPattern
*p
);
741 FcPatternReference (FcPattern
*p
);
744 FcValueDestroy (FcValue v
);
747 FcValueEqual (FcValue va
, FcValue vb
);
750 FcValueSave (FcValue v
);
753 FcPatternDestroy (FcPattern
*p
);
756 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
759 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
762 FcPatternHash (const FcPattern
*p
);
765 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
768 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
771 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
774 FcPatternDel (FcPattern
*p
, const char *object
);
777 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
780 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
783 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
786 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
789 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
792 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
795 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
798 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
801 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
804 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
807 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
810 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
813 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
816 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
819 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
822 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
825 FcPatternBuild (FcPattern
*orig
, ...) FC_ATTRIBUTE_SENTINEL(0);
830 FcStrCopy (const FcChar8
*s
);
833 FcStrCopyFilename (const FcChar8
*s
);
836 FcStrPlus (const FcChar8
*s1
, const FcChar8
*s2
);
839 FcStrFree (FcChar8
*s
);
841 /* These are ASCII only, suitable only for pattern element names */
842 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
843 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
844 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
847 FcStrDowncase (const FcChar8
*s
);
850 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
853 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
855 FcPublic
const FcChar8
*
856 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
858 FcPublic
const FcChar8
*
859 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
862 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
867 FcUtf8Len (const FcChar8
*string
,
872 #define FC_UTF8_MAX_LEN 6
875 FcUcs4ToUtf8 (FcChar32 ucs4
,
876 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
879 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
882 int len
); /* in bytes */
885 FcUtf16Len (const FcChar8
*string
,
887 int len
, /* in bytes */
892 FcStrDirname (const FcChar8
*file
);
895 FcStrBasename (const FcChar8
*file
);
898 FcStrSetCreate (void);
901 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
904 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
907 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
910 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
913 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
916 FcStrSetDestroy (FcStrSet
*set
);
919 FcStrListCreate (FcStrSet
*set
);
922 FcStrListNext (FcStrList
*list
);
925 FcStrListDone (FcStrList
*list
);
929 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
933 #undef FC_ATTRIBUTE_SENTINEL
939 * Deprecated functions are placed here to help users fix their code without
940 * digging through documentation
943 #define FcConfigGetRescanInverval FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
944 #define FcConfigSetRescanInverval FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
948 #endif /* _FONTCONFIG_H_ */