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.
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 "2"
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 (deprecated) */
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 */
97 #define FC_FONTFORMAT "fontformat" /* String */
98 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
100 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
101 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
103 /* Adjust outline rasterizer */
104 #define FC_CHAR_WIDTH "charwidth" /* Int */
105 #define FC_CHAR_HEIGHT "charheight"/* Int */
106 #define FC_MATRIX "matrix" /* FcMatrix */
108 #define FC_WEIGHT_THIN 0
109 #define FC_WEIGHT_EXTRALIGHT 40
110 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
111 #define FC_WEIGHT_LIGHT 50
112 #define FC_WEIGHT_BOOK 75
113 #define FC_WEIGHT_REGULAR 80
114 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
115 #define FC_WEIGHT_MEDIUM 100
116 #define FC_WEIGHT_DEMIBOLD 180
117 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
118 #define FC_WEIGHT_BOLD 200
119 #define FC_WEIGHT_EXTRABOLD 205
120 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
121 #define FC_WEIGHT_BLACK 210
122 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
124 #define FC_SLANT_ROMAN 0
125 #define FC_SLANT_ITALIC 100
126 #define FC_SLANT_OBLIQUE 110
128 #define FC_WIDTH_ULTRACONDENSED 50
129 #define FC_WIDTH_EXTRACONDENSED 63
130 #define FC_WIDTH_CONDENSED 75
131 #define FC_WIDTH_SEMICONDENSED 87
132 #define FC_WIDTH_NORMAL 100
133 #define FC_WIDTH_SEMIEXPANDED 113
134 #define FC_WIDTH_EXPANDED 125
135 #define FC_WIDTH_EXTRAEXPANDED 150
136 #define FC_WIDTH_ULTRAEXPANDED 200
138 #define FC_PROPORTIONAL 0
141 #define FC_CHARCELL 110
143 /* sub-pixel order */
144 #define FC_RGBA_UNKNOWN 0
145 #define FC_RGBA_RGB 1
146 #define FC_RGBA_BGR 2
147 #define FC_RGBA_VRGB 3
148 #define FC_RGBA_VBGR 4
149 #define FC_RGBA_NONE 5
152 #define FC_HINT_NONE 0
153 #define FC_HINT_SLIGHT 1
154 #define FC_HINT_MEDIUM 2
155 #define FC_HINT_FULL 3
157 typedef enum _FcType
{
169 typedef struct _FcMatrix
{
170 double xx
, xy
, yx
, yy
;
173 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
174 (m)->xy = (m)->yx = 0)
177 * A data structure to represent the available glyphs in a font.
178 * This is represented as a sparse boolean btree.
181 typedef struct _FcCharSet FcCharSet
;
183 typedef struct _FcObjectType
{
188 typedef struct _FcConstant
{
194 typedef enum _FcResult
{
195 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
199 typedef struct _FcPattern FcPattern
;
201 typedef struct _FcLangSet FcLangSet
;
203 #define FC_BANK_DYNAMIC 0
204 #define FC_BANK_FIRST 1
206 typedef struct _FcValue
{
220 int l_off
; // this is a difference of char *s
224 typedef struct _FcFontSet
{
230 typedef struct _FcObjectSet
{
233 const char **objects
;
236 typedef enum _FcMatchKind
{
237 FcMatchPattern
, FcMatchFont
240 typedef enum _FcLangResult
{
241 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
244 typedef enum _FcSetName
{
249 typedef struct _FcAtomic FcAtomic
;
251 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
252 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
253 #define _FCFUNCPROTOEND }
255 #define _FCFUNCPROTOBEGIN
256 #define _FCFUNCPROTOEND
259 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
261 typedef struct _FcConfig FcConfig
;
263 typedef struct _FcGlobalCache FcFileCache
;
265 typedef struct _FcBlanks FcBlanks
;
267 typedef struct _FcStrList FcStrList
;
269 typedef struct _FcStrSet FcStrSet
;
274 FcDirCacheValid (const FcChar8
*cache_file
);
278 FcBlanksCreate (void);
281 FcBlanksDestroy (FcBlanks
*b
);
284 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
287 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
294 FcConfigEnableHome (FcBool enable
);
297 FcConfigFilename (const FcChar8
*url
);
300 FcConfigCreate (void);
303 FcConfigDestroy (FcConfig
*config
);
306 FcConfigSetCurrent (FcConfig
*config
);
309 FcConfigGetCurrent (void);
312 FcConfigUptoDate (FcConfig
*config
);
315 FcConfigBuildFonts (FcConfig
*config
);
318 FcConfigGetFontDirs (FcConfig
*config
);
321 FcConfigGetConfigDirs (FcConfig
*config
);
324 FcConfigGetConfigFiles (FcConfig
*config
);
327 FcConfigGetCache (FcConfig
*config
);
330 FcConfigGetBlanks (FcConfig
*config
);
333 FcConfigGetRescanInverval (FcConfig
*config
);
336 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
339 FcConfigGetFonts (FcConfig
*config
,
343 FcConfigAppFontAddFile (FcConfig
*config
,
344 const FcChar8
*file
);
347 FcConfigAppFontAddDir (FcConfig
*config
,
351 FcConfigAppFontClear (FcConfig
*config
);
354 FcConfigSubstituteWithPat (FcConfig
*config
,
360 FcConfigSubstitute (FcConfig
*config
,
366 FcCharSetCreate (void);
369 FcCharSetDestroy (FcCharSet
*fcs
);
372 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
375 FcCharSetCopy (FcCharSet
*src
);
378 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
381 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
384 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
387 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
390 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
393 FcCharSetCount (const FcCharSet
*a
);
396 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
399 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
402 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
404 #define FC_CHARSET_MAP_SIZE (256/32)
405 #define FC_CHARSET_DONE ((FcChar32) -1)
408 FcCharSetFirstPage (const FcCharSet
*a
,
409 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
413 FcCharSetNextPage (const FcCharSet
*a
,
414 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
420 FcValuePrint (const FcValue v
);
423 FcPatternPrint (const FcPattern
*p
);
426 FcFontSetPrint (const FcFontSet
*s
);
430 FcDefaultSubstitute (FcPattern
*pattern
);
434 FcFileScan (FcFontSet
*set
,
442 FcDirScan (FcFontSet
*set
,
450 FcDirSave (FcFontSet
*set
, const FcChar8
*dir
);
454 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
459 FcFontSetCreate (void);
462 FcFontSetDestroy (FcFontSet
*s
);
465 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
469 FcInitLoadConfig (void);
472 FcInitLoadConfigAndFonts (void);
484 FcInitReinitialize (void);
487 FcInitBringUptoDate (void);
491 FcLangSetCreate (void);
494 FcLangSetDestroy (FcLangSet
*ls
);
497 FcLangSetCopy (const FcLangSet
*ls
);
500 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
503 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
506 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
509 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
512 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
515 FcLangSetHash (const FcLangSet
*ls
);
519 FcObjectSetCreate (void);
522 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
525 FcObjectSetDestroy (FcObjectSet
*os
);
528 FcObjectSetVaBuild (const char *first
, va_list va
);
531 FcObjectSetBuild (const char *first
, ...);
534 FcFontSetList (FcConfig
*config
,
541 FcFontList (FcConfig
*config
,
548 FcAtomicCreate (const FcChar8
*file
);
551 FcAtomicLock (FcAtomic
*atomic
);
554 FcAtomicNewFile (FcAtomic
*atomic
);
557 FcAtomicOrigFile (FcAtomic
*atomic
);
560 FcAtomicReplaceOrig (FcAtomic
*atomic
);
563 FcAtomicDeleteNew (FcAtomic
*atomic
);
566 FcAtomicUnlock (FcAtomic
*atomic
);
569 FcAtomicDestroy (FcAtomic
*atomic
);
573 FcFontSetMatch (FcConfig
*config
,
580 FcFontMatch (FcConfig
*config
,
585 FcFontRenderPrepare (FcConfig
*config
,
590 FcFontSetSort (FcConfig
*config
,
599 FcFontSort (FcConfig
*config
,
606 FcFontSetSortDestroy (FcFontSet
*fs
);
610 FcMatrixCopy (const FcMatrix
*mat
);
613 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
616 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
619 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
622 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
625 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
630 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
633 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
636 FcNameGetObjectType (const char *object
);
639 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
642 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
645 FcNameGetConstant (FcChar8
*string
);
648 FcNameConstant (FcChar8
*string
, int *result
);
651 FcNameParse (const FcChar8
*name
);
654 FcNameUnparse (FcPattern
*pat
);
658 FcPatternCreate (void);
661 FcPatternDuplicate (const FcPattern
*p
);
664 FcPatternReference (FcPattern
*p
);
667 FcValueDestroy (FcValue v
);
670 FcValueEqual (FcValue va
, FcValue vb
);
673 FcValueSave (FcValue v
);
676 FcPatternDestroy (FcPattern
*p
);
679 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
682 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
685 FcPatternHash (const FcPattern
*p
);
688 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
691 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
694 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
697 FcPatternDel (FcPattern
*p
, const char *object
);
700 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
703 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
706 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
709 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
712 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
715 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
718 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
721 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
724 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
727 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
730 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
733 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
736 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
739 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
742 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
745 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
748 FcPatternBuild (FcPattern
*orig
, ...);
753 FcStrCopy (const FcChar8
*s
);
756 FcStrCopyFilename (const FcChar8
*s
);
758 /* These are ASCII only, suitable only for pattern element names */
759 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
760 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
761 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
764 FcStrDowncase (const FcChar8
*s
);
767 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
770 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
773 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
776 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
779 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
784 FcUtf8Len (const FcChar8
*string
,
789 #define FC_UTF8_MAX_LEN 6
792 FcUcs4ToUtf8 (FcChar32 ucs4
,
793 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
796 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
799 int len
); /* in bytes */
802 FcUtf16Len (const FcChar8
*string
,
804 int len
, /* in bytes */
809 FcStrDirname (const FcChar8
*file
);
812 FcStrBasename (const FcChar8
*file
);
815 FcStrSetCreate (void);
818 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
821 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
824 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
827 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
830 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
833 FcStrSetDestroy (FcStrSet
*set
);
836 FcStrListCreate (FcStrSet
*set
);
839 FcStrListNext (FcStrList
*list
);
842 FcStrListDone (FcStrList
*list
);
846 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
850 #endif /* _FONTCONFIG_H_ */