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.
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 */
115 #define FC_CACHE_SUFFIX ".cache-"FC_CACHE_VERSION
116 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
117 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
119 /* Adjust outline rasterizer */
120 #define FC_CHAR_WIDTH "charwidth" /* Int */
121 #define FC_CHAR_HEIGHT "charheight"/* Int */
122 #define FC_MATRIX "matrix" /* FcMatrix */
124 #define FC_WEIGHT_THIN 0
125 #define FC_WEIGHT_EXTRALIGHT 40
126 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
127 #define FC_WEIGHT_LIGHT 50
128 #define FC_WEIGHT_BOOK 75
129 #define FC_WEIGHT_REGULAR 80
130 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
131 #define FC_WEIGHT_MEDIUM 100
132 #define FC_WEIGHT_DEMIBOLD 180
133 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
134 #define FC_WEIGHT_BOLD 200
135 #define FC_WEIGHT_EXTRABOLD 205
136 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
137 #define FC_WEIGHT_BLACK 210
138 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
140 #define FC_SLANT_ROMAN 0
141 #define FC_SLANT_ITALIC 100
142 #define FC_SLANT_OBLIQUE 110
144 #define FC_WIDTH_ULTRACONDENSED 50
145 #define FC_WIDTH_EXTRACONDENSED 63
146 #define FC_WIDTH_CONDENSED 75
147 #define FC_WIDTH_SEMICONDENSED 87
148 #define FC_WIDTH_NORMAL 100
149 #define FC_WIDTH_SEMIEXPANDED 113
150 #define FC_WIDTH_EXPANDED 125
151 #define FC_WIDTH_EXTRAEXPANDED 150
152 #define FC_WIDTH_ULTRAEXPANDED 200
154 #define FC_PROPORTIONAL 0
157 #define FC_CHARCELL 110
159 /* sub-pixel order */
160 #define FC_RGBA_UNKNOWN 0
161 #define FC_RGBA_RGB 1
162 #define FC_RGBA_BGR 2
163 #define FC_RGBA_VRGB 3
164 #define FC_RGBA_VBGR 4
165 #define FC_RGBA_NONE 5
168 #define FC_HINT_NONE 0
169 #define FC_HINT_SLIGHT 1
170 #define FC_HINT_MEDIUM 2
171 #define FC_HINT_FULL 3
173 typedef enum _FcType
{
185 typedef struct _FcMatrix
{
186 double xx
, xy
, yx
, yy
;
189 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
190 (m)->xy = (m)->yx = 0)
193 * A data structure to represent the available glyphs in a font.
194 * This is represented as a sparse boolean btree.
197 typedef struct _FcCharSet FcCharSet
;
199 typedef struct _FcObjectType
{
204 typedef struct _FcConstant
{
210 typedef enum _FcResult
{
211 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
215 typedef struct _FcPattern FcPattern
;
217 typedef struct _FcLangSet FcLangSet
;
219 typedef struct _FcValue
{
234 typedef struct _FcFontSet
{
240 typedef struct _FcObjectSet
{
243 const char **objects
;
246 typedef enum _FcMatchKind
{
247 FcMatchPattern
, FcMatchFont
, FcMatchScan
250 typedef enum _FcLangResult
{
251 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
254 typedef enum _FcSetName
{
259 typedef struct _FcAtomic FcAtomic
;
261 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
262 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
263 #define _FCFUNCPROTOEND }
265 #define _FCFUNCPROTOBEGIN
266 #define _FCFUNCPROTOEND
269 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
271 typedef struct _FcConfig FcConfig
;
273 typedef struct _FcGlobalCache FcFileCache
;
275 typedef struct _FcBlanks FcBlanks
;
277 typedef struct _FcStrList FcStrList
;
279 typedef struct _FcStrSet FcStrSet
;
281 typedef struct _FcCache FcCache
;
287 FcBlanksCreate (void);
290 FcBlanksDestroy (FcBlanks
*b
);
293 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
296 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
300 FcPublic
const FcChar8
*
301 FcCacheDir(const FcCache
*c
);
304 FcCacheCopySet(const FcCache
*c
);
306 FcPublic
const FcChar8
*
307 FcCacheSubdir (const FcCache
*c
, int i
);
310 FcCacheNumSubdir (const FcCache
*c
);
313 FcCacheNumFont (const FcCache
*c
);
316 FcDirCacheUnlink (const FcChar8
*dir
, FcConfig
*config
);
319 FcDirCacheValid (const FcChar8
*cache_file
);
326 FcConfigEnableHome (FcBool enable
);
329 FcConfigFilename (const FcChar8
*url
);
332 FcConfigCreate (void);
335 FcConfigDestroy (FcConfig
*config
);
338 FcConfigSetCurrent (FcConfig
*config
);
341 FcConfigGetCurrent (void);
344 FcConfigUptoDate (FcConfig
*config
);
347 FcConfigBuildFonts (FcConfig
*config
);
350 FcConfigGetFontDirs (FcConfig
*config
);
353 FcConfigGetConfigDirs (FcConfig
*config
);
356 FcConfigGetConfigFiles (FcConfig
*config
);
359 FcConfigGetCache (FcConfig
*config
);
362 FcConfigGetBlanks (FcConfig
*config
);
365 FcConfigGetCacheDirs (FcConfig
*config
);
368 FcConfigGetRescanInverval (FcConfig
*config
);
371 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
374 FcConfigGetFonts (FcConfig
*config
,
378 FcConfigAppFontAddFile (FcConfig
*config
,
379 const FcChar8
*file
);
382 FcConfigAppFontAddDir (FcConfig
*config
,
386 FcConfigAppFontClear (FcConfig
*config
);
389 FcConfigSubstituteWithPat (FcConfig
*config
,
395 FcConfigSubstitute (FcConfig
*config
,
401 FcCharSetCreate (void);
403 /* deprecated alias for FcCharSetCreate */
408 FcCharSetDestroy (FcCharSet
*fcs
);
411 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
414 FcCharSetCopy (FcCharSet
*src
);
417 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
420 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
423 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
426 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
429 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
432 FcCharSetCount (const FcCharSet
*a
);
435 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
438 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
441 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
443 #define FC_CHARSET_MAP_SIZE (256/32)
444 #define FC_CHARSET_DONE ((FcChar32) -1)
447 FcCharSetFirstPage (const FcCharSet
*a
,
448 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
452 FcCharSetNextPage (const FcCharSet
*a
,
453 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
457 * old coverage API, rather hard to use correctly
461 FcCharSetCoverage (const FcCharSet
*a
, FcChar32 page
, FcChar32
*result
);
465 FcValuePrint (const FcValue v
);
468 FcPatternPrint (const FcPattern
*p
);
471 FcFontSetPrint (const FcFontSet
*s
);
475 FcDefaultSubstitute (FcPattern
*pattern
);
479 FcFileIsDir (const FcChar8
*file
);
482 FcFileScan (FcFontSet
*set
,
490 FcDirScan (FcFontSet
*set
,
498 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
501 FcDirCacheLoad (const FcChar8
*dir
, FcConfig
*config
, FcChar8
**cache_file
);
504 FcDirCacheRead (const FcChar8
*dir
, FcBool force
, FcConfig
*config
);
507 FcDirCacheLoadFile (const FcChar8
*cache_file
, struct stat
*file_stat
);
510 FcDirCacheUnload (FcCache
*cache
);
514 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
519 FcFontSetCreate (void);
522 FcFontSetDestroy (FcFontSet
*s
);
525 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
529 FcInitLoadConfig (void);
532 FcInitLoadConfigAndFonts (void);
544 FcInitReinitialize (void);
547 FcInitBringUptoDate (void);
551 FcLangSetCreate (void);
554 FcLangSetDestroy (FcLangSet
*ls
);
557 FcLangSetCopy (const FcLangSet
*ls
);
560 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
562 FcPublic FcLangResult
563 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
565 FcPublic FcLangResult
566 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
569 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
572 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
575 FcLangSetHash (const FcLangSet
*ls
);
578 FcPublic FcObjectSet
*
579 FcObjectSetCreate (void);
582 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
585 FcObjectSetDestroy (FcObjectSet
*os
);
587 FcPublic FcObjectSet
*
588 FcObjectSetVaBuild (const char *first
, va_list va
);
590 FcPublic FcObjectSet
*
591 FcObjectSetBuild (const char *first
, ...) FC_ATTRIBUTE_SENTINEL(0);
594 FcFontSetList (FcConfig
*config
,
601 FcFontList (FcConfig
*config
,
608 FcAtomicCreate (const FcChar8
*file
);
611 FcAtomicLock (FcAtomic
*atomic
);
614 FcAtomicNewFile (FcAtomic
*atomic
);
617 FcAtomicOrigFile (FcAtomic
*atomic
);
620 FcAtomicReplaceOrig (FcAtomic
*atomic
);
623 FcAtomicDeleteNew (FcAtomic
*atomic
);
626 FcAtomicUnlock (FcAtomic
*atomic
);
629 FcAtomicDestroy (FcAtomic
*atomic
);
633 FcFontSetMatch (FcConfig
*config
,
640 FcFontMatch (FcConfig
*config
,
645 FcFontRenderPrepare (FcConfig
*config
,
650 FcFontSetSort (FcConfig
*config
,
659 FcFontSort (FcConfig
*config
,
666 FcFontSetSortDestroy (FcFontSet
*fs
);
670 FcMatrixCopy (const FcMatrix
*mat
);
673 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
676 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
679 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
682 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
685 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
690 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
693 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
695 FcPublic
const FcObjectType
*
696 FcNameGetObjectType (const char *object
);
699 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
702 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
704 FcPublic
const FcConstant
*
705 FcNameGetConstant (FcChar8
*string
);
708 FcNameConstant (FcChar8
*string
, int *result
);
711 FcNameParse (const FcChar8
*name
);
714 FcNameUnparse (FcPattern
*pat
);
718 FcPatternCreate (void);
721 FcPatternDuplicate (const FcPattern
*p
);
724 FcPatternReference (FcPattern
*p
);
727 FcValueDestroy (FcValue v
);
730 FcValueEqual (FcValue va
, FcValue vb
);
733 FcValueSave (FcValue v
);
736 FcPatternDestroy (FcPattern
*p
);
739 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
742 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
745 FcPatternHash (const FcPattern
*p
);
748 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
751 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
754 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
757 FcPatternDel (FcPattern
*p
, const char *object
);
760 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
763 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
766 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
769 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
772 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
775 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
778 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
781 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
784 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
787 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
790 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
793 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
796 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
799 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
802 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
805 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
808 FcPatternBuild (FcPattern
*orig
, ...) FC_ATTRIBUTE_SENTINEL(0);
813 FcStrCopy (const FcChar8
*s
);
816 FcStrCopyFilename (const FcChar8
*s
);
819 FcStrPlus (const FcChar8
*s1
, const FcChar8
*s2
);
822 FcStrFree (FcChar8
*s
);
824 /* These are ASCII only, suitable only for pattern element names */
825 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
826 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
827 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
830 FcStrDowncase (const FcChar8
*s
);
833 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
836 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
838 FcPublic
const FcChar8
*
839 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
841 FcPublic
const FcChar8
*
842 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
845 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
850 FcUtf8Len (const FcChar8
*string
,
855 #define FC_UTF8_MAX_LEN 6
858 FcUcs4ToUtf8 (FcChar32 ucs4
,
859 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
862 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
865 int len
); /* in bytes */
868 FcUtf16Len (const FcChar8
*string
,
870 int len
, /* in bytes */
875 FcStrDirname (const FcChar8
*file
);
878 FcStrBasename (const FcChar8
*file
);
881 FcStrSetCreate (void);
884 FcStrSetMember (FcPublic FcStrSet
*set
, const FcChar8
*s
);
887 FcStrSetEqual (FcPublic FcStrSet
*sa
, FcPublic FcStrSet
*sb
);
890 FcStrSetAdd (FcPublic FcStrSet
*set
, const FcChar8
*s
);
893 FcStrSetAddFilename (FcPublic FcStrSet
*set
, const FcChar8
*s
);
896 FcStrSetDel (FcPublic FcStrSet
*set
, const FcChar8
*s
);
899 FcStrSetDestroy (FcPublic FcStrSet
*set
);
902 FcStrListCreate (FcPublic FcStrSet
*set
);
905 FcStrListNext (FcStrList
*list
);
908 FcStrListDone (FcStrList
*list
);
912 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
916 #undef FC_ATTRIBUTE_SENTINEL
918 #endif /* _FONTCONFIG_H_ */