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_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 typedef struct _FcValue
{
224 int l_off
; /* this is a difference of char *s */
228 typedef struct _FcFontSet
{
234 typedef struct _FcObjectSet
{
237 const char **objects
;
240 typedef enum _FcMatchKind
{
241 FcMatchPattern
, FcMatchFont
244 typedef enum _FcLangResult
{
245 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
248 typedef enum _FcSetName
{
253 typedef struct _FcAtomic FcAtomic
;
255 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
256 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
257 #define _FCFUNCPROTOEND }
259 #define _FCFUNCPROTOBEGIN
260 #define _FCFUNCPROTOEND
263 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
265 typedef struct _FcConfig FcConfig
;
267 typedef struct _FcGlobalCache FcFileCache
;
269 typedef struct _FcBlanks FcBlanks
;
271 typedef struct _FcStrList FcStrList
;
273 typedef struct _FcStrSet FcStrSet
;
278 FcDirCacheValid (const FcChar8
*cache_file
);
281 FcDirCacheHasCurrentArch (const FcChar8
*dir
);
284 FcDirCacheUnlink (const FcChar8
*dir
);
288 FcBlanksCreate (void);
291 FcBlanksDestroy (FcBlanks
*b
);
294 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
297 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
304 FcConfigEnableHome (FcBool enable
);
307 FcConfigFilename (const FcChar8
*url
);
310 FcConfigCreate (void);
313 FcConfigDestroy (FcConfig
*config
);
316 FcConfigSetCurrent (FcConfig
*config
);
319 FcConfigGetCurrent (void);
322 FcConfigUptoDate (FcConfig
*config
);
325 FcConfigBuildFonts (FcConfig
*config
);
328 FcConfigGetFontDirs (FcConfig
*config
);
331 FcConfigGetConfigDirs (FcConfig
*config
);
334 FcConfigGetConfigFiles (FcConfig
*config
);
337 FcConfigGetCache (FcConfig
*config
);
340 FcConfigGetBlanks (FcConfig
*config
);
343 FcConfigGetRescanInverval (FcConfig
*config
);
346 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
349 FcConfigGetFonts (FcConfig
*config
,
353 FcConfigAppFontAddFile (FcConfig
*config
,
354 const FcChar8
*file
);
357 FcConfigAppFontAddDir (FcConfig
*config
,
361 FcConfigAppFontClear (FcConfig
*config
);
364 FcConfigSubstituteWithPat (FcConfig
*config
,
370 FcConfigSubstitute (FcConfig
*config
,
376 FcCharSetCreate (void);
379 FcCharSetDestroy (FcCharSet
*fcs
);
382 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
385 FcCharSetCopy (FcCharSet
*src
);
388 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
391 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
394 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
397 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
400 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
403 FcCharSetCount (const FcCharSet
*a
);
406 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
409 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
412 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
414 #define FC_CHARSET_MAP_SIZE (256/32)
415 #define FC_CHARSET_DONE ((FcChar32) -1)
418 FcCharSetFirstPage (const FcCharSet
*a
,
419 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
423 FcCharSetNextPage (const FcCharSet
*a
,
424 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
430 FcValuePrint (const FcValue v
);
433 FcPatternPrint (const FcPattern
*p
);
436 FcFontSetPrint (const FcFontSet
*s
);
440 FcDefaultSubstitute (FcPattern
*pattern
);
444 FcFileScan (FcFontSet
*set
,
452 FcDirScan (FcFontSet
*set
,
460 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
464 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
469 FcFontSetCreate (void);
472 FcFontSetDestroy (FcFontSet
*s
);
475 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
479 FcInitLoadConfig (void);
482 FcInitLoadConfigAndFonts (void);
494 FcInitReinitialize (void);
497 FcInitBringUptoDate (void);
501 FcLangSetCreate (void);
504 FcLangSetDestroy (FcLangSet
*ls
);
507 FcLangSetCopy (const FcLangSet
*ls
);
510 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
513 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
516 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
519 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
522 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
525 FcLangSetHash (const FcLangSet
*ls
);
529 FcObjectSetCreate (void);
532 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
535 FcObjectSetDestroy (FcObjectSet
*os
);
538 FcObjectSetVaBuild (const char *first
, va_list va
);
541 FcObjectSetBuild (const char *first
, ...) FC_ATTRIBUTE_SENTINEL(0);
544 FcFontSetList (FcConfig
*config
,
551 FcFontList (FcConfig
*config
,
558 FcAtomicCreate (const FcChar8
*file
);
561 FcAtomicLock (FcAtomic
*atomic
);
564 FcAtomicNewFile (FcAtomic
*atomic
);
567 FcAtomicOrigFile (FcAtomic
*atomic
);
570 FcAtomicReplaceOrig (FcAtomic
*atomic
);
573 FcAtomicDeleteNew (FcAtomic
*atomic
);
576 FcAtomicUnlock (FcAtomic
*atomic
);
579 FcAtomicDestroy (FcAtomic
*atomic
);
583 FcFontSetMatch (FcConfig
*config
,
590 FcFontMatch (FcConfig
*config
,
595 FcFontRenderPrepare (FcConfig
*config
,
600 FcFontSetSort (FcConfig
*config
,
609 FcFontSort (FcConfig
*config
,
616 FcFontSetSortDestroy (FcFontSet
*fs
);
620 FcMatrixCopy (const FcMatrix
*mat
);
623 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
626 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
629 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
632 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
635 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
640 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
643 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
646 FcNameGetObjectType (const char *object
);
649 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
652 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
655 FcNameGetConstant (FcChar8
*string
);
658 FcNameConstant (FcChar8
*string
, int *result
);
661 FcNameParse (const FcChar8
*name
);
664 FcNameUnparse (FcPattern
*pat
);
667 FcNameUnparseEscaped (FcPattern
*pat
, FcBool escape
);
671 FcPatternCreate (void);
674 FcPatternDuplicate (const FcPattern
*p
);
677 FcPatternReference (FcPattern
*p
);
680 FcValueDestroy (FcValue v
);
683 FcValueEqual (FcValue va
, FcValue vb
);
686 FcValueSave (FcValue v
);
689 FcPatternDestroy (FcPattern
*p
);
692 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
695 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
698 FcPatternHash (const FcPattern
*p
);
701 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
704 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
707 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
710 FcPatternDel (FcPattern
*p
, const char *object
);
713 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
716 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
719 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
722 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
725 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
728 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
731 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
734 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
737 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
740 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
743 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
746 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
749 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
752 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
755 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
758 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
761 FcPatternBuild (FcPattern
*orig
, ...) FC_ATTRIBUTE_SENTINEL(0);
766 FcStrCopy (const FcChar8
*s
);
769 FcStrCopyFilename (const FcChar8
*s
);
771 /* These are ASCII only, suitable only for pattern element names */
772 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
773 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
774 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
777 FcStrDowncase (const FcChar8
*s
);
780 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
783 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
786 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
789 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
792 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
797 FcUtf8Len (const FcChar8
*string
,
802 #define FC_UTF8_MAX_LEN 6
805 FcUcs4ToUtf8 (FcChar32 ucs4
,
806 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
809 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
812 int len
); /* in bytes */
815 FcUtf16Len (const FcChar8
*string
,
817 int len
, /* in bytes */
822 FcStrDirname (const FcChar8
*file
);
825 FcStrBasename (const FcChar8
*file
);
828 FcStrSetCreate (void);
831 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
834 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
837 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
840 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
843 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
846 FcStrSetDestroy (FcStrSet
*set
);
849 FcStrListCreate (FcStrSet
*set
);
852 FcStrListNext (FcStrList
*list
);
855 FcStrListDone (FcStrList
*list
);
859 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
863 #undef FC_ATTRIBUTE_SENTINEL
865 #endif /* _FONTCONFIG_H_ */