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.
43 #define FC_REVISION 97
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 "1"
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 (X11, freetype) */
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 */
99 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
100 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
102 /* Adjust outline rasterizer */
103 #define FC_CHAR_WIDTH "charwidth" /* Int */
104 #define FC_CHAR_HEIGHT "charheight"/* Int */
105 #define FC_MATRIX "matrix" /* FcMatrix */
107 #define FC_WEIGHT_THIN 0
108 #define FC_WEIGHT_EXTRALIGHT 40
109 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
110 #define FC_WEIGHT_LIGHT 50
111 #define FC_WEIGHT_BOOK 75
112 #define FC_WEIGHT_REGULAR 80
113 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
114 #define FC_WEIGHT_MEDIUM 100
115 #define FC_WEIGHT_DEMIBOLD 180
116 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
117 #define FC_WEIGHT_BOLD 200
118 #define FC_WEIGHT_EXTRABOLD 205
119 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
120 #define FC_WEIGHT_BLACK 210
121 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
123 #define FC_SLANT_ROMAN 0
124 #define FC_SLANT_ITALIC 100
125 #define FC_SLANT_OBLIQUE 110
127 #define FC_WIDTH_ULTRACONDENSED 50
128 #define FC_WIDTH_EXTRACONDENSED 63
129 #define FC_WIDTH_CONDENSED 75
130 #define FC_WIDTH_SEMICONDENSED 87
131 #define FC_WIDTH_NORMAL 100
132 #define FC_WIDTH_SEMIEXPANDED 113
133 #define FC_WIDTH_EXPANDED 125
134 #define FC_WIDTH_EXTRAEXPANDED 150
135 #define FC_WIDTH_ULTRAEXPANDED 200
137 #define FC_PROPORTIONAL 0
140 #define FC_CHARCELL 110
142 /* sub-pixel order */
143 #define FC_RGBA_UNKNOWN 0
144 #define FC_RGBA_RGB 1
145 #define FC_RGBA_BGR 2
146 #define FC_RGBA_VRGB 3
147 #define FC_RGBA_VBGR 4
148 #define FC_RGBA_NONE 5
151 #define FC_HINT_NONE 0
152 #define FC_HINT_SLIGHT 1
153 #define FC_HINT_MEDIUM 2
154 #define FC_HINT_FULL 3
156 typedef enum _FcType
{
168 typedef struct _FcMatrix
{
169 double xx
, xy
, yx
, yy
;
172 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
173 (m)->xy = (m)->yx = 0)
176 * A data structure to represent the available glyphs in a font.
177 * This is represented as a sparse boolean btree.
180 typedef struct _FcCharSet FcCharSet
;
182 typedef struct _FcObjectType
{
187 typedef struct _FcConstant
{
193 typedef enum _FcResult
{
194 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
198 typedef struct _FcPattern FcPattern
;
200 typedef struct _FcLangSet FcLangSet
;
202 typedef struct _FcValue
{
217 typedef struct _FcFontSet
{
223 typedef struct _FcObjectSet
{
226 const char **objects
;
229 typedef enum _FcMatchKind
{
230 FcMatchPattern
, FcMatchFont
233 typedef enum _FcLangResult
{
234 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
237 typedef enum _FcSetName
{
242 typedef struct _FcAtomic FcAtomic
;
244 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
245 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
246 #define _FCFUNCPROTOEND }
248 #define _FCFUNCPROTOBEGIN
249 #define _FCFUNCPROTOEND
252 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
254 typedef struct _FcConfig FcConfig
;
256 typedef struct _FcGlobalCache FcFileCache
;
258 typedef struct _FcBlanks FcBlanks
;
260 typedef struct _FcStrList FcStrList
;
262 typedef struct _FcStrSet FcStrSet
;
267 FcDirCacheValid (const FcChar8
*cache_file
);
271 FcBlanksCreate (void);
274 FcBlanksDestroy (FcBlanks
*b
);
277 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
280 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
287 FcConfigEnableHome (FcBool enable
);
290 FcConfigFilename (const FcChar8
*url
);
293 FcConfigCreate (void);
296 FcConfigDestroy (FcConfig
*config
);
299 FcConfigSetCurrent (FcConfig
*config
);
302 FcConfigGetCurrent (void);
305 FcConfigUptoDate (FcConfig
*config
);
308 FcConfigBuildFonts (FcConfig
*config
);
311 FcConfigGetFontDirs (FcConfig
*config
);
314 FcConfigGetConfigDirs (FcConfig
*config
);
317 FcConfigGetConfigFiles (FcConfig
*config
);
320 FcConfigGetCache (FcConfig
*config
);
323 FcConfigGetBlanks (FcConfig
*config
);
326 FcConfigGetRescanInverval (FcConfig
*config
);
329 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
332 FcConfigGetFonts (FcConfig
*config
,
336 FcConfigAppFontAddFile (FcConfig
*config
,
337 const FcChar8
*file
);
340 FcConfigAppFontAddDir (FcConfig
*config
,
344 FcConfigAppFontClear (FcConfig
*config
);
347 FcConfigSubstituteWithPat (FcConfig
*config
,
353 FcConfigSubstitute (FcConfig
*config
,
359 FcCharSetCreate (void);
362 FcCharSetDestroy (FcCharSet
*fcs
);
365 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
368 FcCharSetCopy (FcCharSet
*src
);
371 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
374 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
377 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
380 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
383 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
386 FcCharSetCount (const FcCharSet
*a
);
389 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
392 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
395 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
397 #define FC_CHARSET_MAP_SIZE (256/32)
398 #define FC_CHARSET_DONE ((FcChar32) -1)
401 FcCharSetFirstPage (const FcCharSet
*a
,
402 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
406 FcCharSetNextPage (const FcCharSet
*a
,
407 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
413 FcValuePrint (const FcValue v
);
416 FcPatternPrint (const FcPattern
*p
);
419 FcFontSetPrint (const FcFontSet
*s
);
423 FcDefaultSubstitute (FcPattern
*pattern
);
427 FcFileScan (FcFontSet
*set
,
435 FcDirScan (FcFontSet
*set
,
443 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
447 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
452 FcFontSetCreate (void);
455 FcFontSetDestroy (FcFontSet
*s
);
458 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
462 FcInitLoadConfig (void);
465 FcInitLoadConfigAndFonts (void);
477 FcInitReinitialize (void);
480 FcInitBringUptoDate (void);
484 FcLangSetCreate (void);
487 FcLangSetDestroy (FcLangSet
*ls
);
490 FcLangSetCopy (const FcLangSet
*ls
);
493 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
496 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
499 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
502 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
505 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
508 FcLangSetHash (const FcLangSet
*ls
);
512 FcObjectSetCreate (void);
515 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
518 FcObjectSetDestroy (FcObjectSet
*os
);
521 FcObjectSetVaBuild (const char *first
, va_list va
);
524 FcObjectSetBuild (const char *first
, ...);
527 FcFontSetList (FcConfig
*config
,
534 FcFontList (FcConfig
*config
,
541 FcAtomicCreate (const FcChar8
*file
);
544 FcAtomicLock (FcAtomic
*atomic
);
547 FcAtomicNewFile (FcAtomic
*atomic
);
550 FcAtomicOrigFile (FcAtomic
*atomic
);
553 FcAtomicReplaceOrig (FcAtomic
*atomic
);
556 FcAtomicDeleteNew (FcAtomic
*atomic
);
559 FcAtomicUnlock (FcAtomic
*atomic
);
562 FcAtomicDestroy (FcAtomic
*atomic
);
566 FcFontSetMatch (FcConfig
*config
,
573 FcFontMatch (FcConfig
*config
,
578 FcFontRenderPrepare (FcConfig
*config
,
583 FcFontSetSort (FcConfig
*config
,
592 FcFontSort (FcConfig
*config
,
599 FcFontSetSortDestroy (FcFontSet
*fs
);
603 FcMatrixCopy (const FcMatrix
*mat
);
606 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
609 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
612 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
615 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
618 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
623 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
626 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
629 FcNameGetObjectType (const char *object
);
632 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
635 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
638 FcNameGetConstant (FcChar8
*string
);
641 FcNameConstant (FcChar8
*string
, int *result
);
644 FcNameParse (const FcChar8
*name
);
647 FcNameUnparse (FcPattern
*pat
);
651 FcPatternCreate (void);
654 FcPatternDuplicate (const FcPattern
*p
);
657 FcPatternReference (FcPattern
*p
);
660 FcValueDestroy (FcValue v
);
663 FcValueEqual (FcValue va
, FcValue vb
);
666 FcValueSave (FcValue v
);
669 FcPatternDestroy (FcPattern
*p
);
672 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
675 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
678 FcPatternHash (const FcPattern
*p
);
681 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
684 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
687 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
690 FcPatternDel (FcPattern
*p
, const char *object
);
693 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
696 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
699 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
702 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
705 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
708 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
711 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
714 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
717 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
720 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
723 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
726 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
729 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
732 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
735 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
738 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
741 FcPatternBuild (FcPattern
*orig
, ...);
746 FcStrCopy (const FcChar8
*s
);
749 FcStrCopyFilename (const FcChar8
*s
);
751 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
752 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
753 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
756 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
759 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
762 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
765 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
768 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
773 FcUtf8Len (const FcChar8
*string
,
778 #define FC_UTF8_MAX_LEN 6
781 FcUcs4ToUtf8 (FcChar32 ucs4
,
782 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
785 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
788 int len
); /* in bytes */
791 FcUtf16Len (const FcChar8
*string
,
793 int len
, /* in bytes */
798 FcStrDirname (const FcChar8
*file
);
801 FcStrBasename (const FcChar8
*file
);
804 FcStrSetCreate (void);
807 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
810 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
813 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
816 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
819 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
822 FcStrSetDestroy (FcStrSet
*set
);
825 FcStrListCreate (FcStrSet
*set
);
828 FcStrListNext (FcStrList
*list
);
831 FcStrListDone (FcStrList
*list
);
835 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
839 #endif /* _FONTCONFIG_H_ */