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 96
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 */
97 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
98 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
100 /* Adjust outline rasterizer */
101 #define FC_CHAR_WIDTH "charwidth" /* Int */
102 #define FC_CHAR_HEIGHT "charheight"/* Int */
103 #define FC_MATRIX "matrix" /* FcMatrix */
105 #define FC_WEIGHT_THIN 0
106 #define FC_WEIGHT_EXTRALIGHT 40
107 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
108 #define FC_WEIGHT_LIGHT 50
109 #define FC_WEIGHT_BOOK 75
110 #define FC_WEIGHT_REGULAR 80
111 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
112 #define FC_WEIGHT_MEDIUM 100
113 #define FC_WEIGHT_DEMIBOLD 180
114 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
115 #define FC_WEIGHT_BOLD 200
116 #define FC_WEIGHT_EXTRABOLD 205
117 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
118 #define FC_WEIGHT_BLACK 210
119 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
121 #define FC_SLANT_ROMAN 0
122 #define FC_SLANT_ITALIC 100
123 #define FC_SLANT_OBLIQUE 110
125 #define FC_WIDTH_ULTRACONDENSED 50
126 #define FC_WIDTH_EXTRACONDENSED 63
127 #define FC_WIDTH_CONDENSED 75
128 #define FC_WIDTH_SEMICONDENSED 87
129 #define FC_WIDTH_NORMAL 100
130 #define FC_WIDTH_SEMIEXPANDED 113
131 #define FC_WIDTH_EXPANDED 125
132 #define FC_WIDTH_EXTRAEXPANDED 150
133 #define FC_WIDTH_ULTRAEXPANDED 200
135 #define FC_PROPORTIONAL 0
138 #define FC_CHARCELL 110
140 /* sub-pixel order */
141 #define FC_RGBA_UNKNOWN 0
142 #define FC_RGBA_RGB 1
143 #define FC_RGBA_BGR 2
144 #define FC_RGBA_VRGB 3
145 #define FC_RGBA_VBGR 4
146 #define FC_RGBA_NONE 5
149 #define FC_HINT_NONE 0
150 #define FC_HINT_SLIGHT 1
151 #define FC_HINT_MEDIUM 2
152 #define FC_HINT_FULL 3
154 typedef enum _FcType
{
166 typedef struct _FcMatrix
{
167 double xx
, xy
, yx
, yy
;
170 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
171 (m)->xy = (m)->yx = 0)
174 * A data structure to represent the available glyphs in a font.
175 * This is represented as a sparse boolean btree.
178 typedef struct _FcCharSet FcCharSet
;
180 typedef struct _FcObjectType
{
185 typedef struct _FcConstant
{
191 typedef enum _FcResult
{
192 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
196 typedef struct _FcPattern FcPattern
;
198 typedef struct _FcLangSet FcLangSet
;
200 typedef struct _FcValue
{
215 typedef struct _FcFontSet
{
221 typedef struct _FcObjectSet
{
224 const char **objects
;
227 typedef enum _FcMatchKind
{
228 FcMatchPattern
, FcMatchFont
231 typedef enum _FcLangResult
{
232 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
235 typedef enum _FcSetName
{
240 typedef struct _FcAtomic FcAtomic
;
242 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
243 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
244 #define _FCFUNCPROTOEND }
246 #define _FCFUNCPROTOBEGIN
247 #define _FCFUNCPROTOEND
250 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
252 typedef struct _FcConfig FcConfig
;
254 typedef struct _FcGlobalCache FcFileCache
;
256 typedef struct _FcBlanks FcBlanks
;
258 typedef struct _FcStrList FcStrList
;
260 typedef struct _FcStrSet FcStrSet
;
265 FcDirCacheValid (const FcChar8
*cache_file
);
269 FcBlanksCreate (void);
272 FcBlanksDestroy (FcBlanks
*b
);
275 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
278 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
285 FcConfigEnableHome (FcBool enable
);
288 FcConfigFilename (const FcChar8
*url
);
291 FcConfigCreate (void);
294 FcConfigDestroy (FcConfig
*config
);
297 FcConfigSetCurrent (FcConfig
*config
);
300 FcConfigGetCurrent (void);
303 FcConfigUptoDate (FcConfig
*config
);
306 FcConfigBuildFonts (FcConfig
*config
);
309 FcConfigGetFontDirs (FcConfig
*config
);
312 FcConfigGetConfigDirs (FcConfig
*config
);
315 FcConfigGetConfigFiles (FcConfig
*config
);
318 FcConfigGetCache (FcConfig
*config
);
321 FcConfigGetBlanks (FcConfig
*config
);
324 FcConfigGetRescanInverval (FcConfig
*config
);
327 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
330 FcConfigGetFonts (FcConfig
*config
,
334 FcConfigAppFontAddFile (FcConfig
*config
,
335 const FcChar8
*file
);
338 FcConfigAppFontAddDir (FcConfig
*config
,
342 FcConfigAppFontClear (FcConfig
*config
);
345 FcConfigSubstituteWithPat (FcConfig
*config
,
351 FcConfigSubstitute (FcConfig
*config
,
357 FcCharSetCreate (void);
360 FcCharSetDestroy (FcCharSet
*fcs
);
363 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
366 FcCharSetCopy (FcCharSet
*src
);
369 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
372 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
375 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
378 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
381 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
384 FcCharSetCount (const FcCharSet
*a
);
387 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
390 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
393 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
395 #define FC_CHARSET_MAP_SIZE (256/32)
396 #define FC_CHARSET_DONE ((FcChar32) -1)
399 FcCharSetFirstPage (const FcCharSet
*a
,
400 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
404 FcCharSetNextPage (const FcCharSet
*a
,
405 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
411 FcValuePrint (const FcValue v
);
414 FcPatternPrint (const FcPattern
*p
);
417 FcFontSetPrint (const FcFontSet
*s
);
421 FcDefaultSubstitute (FcPattern
*pattern
);
425 FcFileScan (FcFontSet
*set
,
433 FcDirScan (FcFontSet
*set
,
441 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
445 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
450 FcFontSetCreate (void);
453 FcFontSetDestroy (FcFontSet
*s
);
456 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
460 FcInitLoadConfig (void);
463 FcInitLoadConfigAndFonts (void);
475 FcInitReinitialize (void);
478 FcInitBringUptoDate (void);
482 FcLangSetCreate (void);
485 FcLangSetDestroy (FcLangSet
*ls
);
488 FcLangSetCopy (const FcLangSet
*ls
);
491 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
494 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
497 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
500 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
503 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
506 FcLangSetHash (const FcLangSet
*ls
);
510 FcObjectSetCreate (void);
513 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
516 FcObjectSetDestroy (FcObjectSet
*os
);
519 FcObjectSetVaBuild (const char *first
, va_list va
);
522 FcObjectSetBuild (const char *first
, ...);
525 FcFontSetList (FcConfig
*config
,
532 FcFontList (FcConfig
*config
,
539 FcAtomicCreate (const FcChar8
*file
);
542 FcAtomicLock (FcAtomic
*atomic
);
545 FcAtomicNewFile (FcAtomic
*atomic
);
548 FcAtomicOrigFile (FcAtomic
*atomic
);
551 FcAtomicReplaceOrig (FcAtomic
*atomic
);
554 FcAtomicDeleteNew (FcAtomic
*atomic
);
557 FcAtomicUnlock (FcAtomic
*atomic
);
560 FcAtomicDestroy (FcAtomic
*atomic
);
564 FcFontSetMatch (FcConfig
*config
,
571 FcFontMatch (FcConfig
*config
,
576 FcFontRenderPrepare (FcConfig
*config
,
581 FcFontSetSort (FcConfig
*config
,
590 FcFontSort (FcConfig
*config
,
597 FcFontSetSortDestroy (FcFontSet
*fs
);
601 FcMatrixCopy (const FcMatrix
*mat
);
604 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
607 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
610 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
613 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
616 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
621 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
624 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
627 FcNameGetObjectType (const char *object
);
630 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
633 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
636 FcNameGetConstant (FcChar8
*string
);
639 FcNameConstant (FcChar8
*string
, int *result
);
642 FcNameParse (const FcChar8
*name
);
645 FcNameUnparse (FcPattern
*pat
);
649 FcPatternCreate (void);
652 FcPatternDuplicate (const FcPattern
*p
);
655 FcPatternReference (FcPattern
*p
);
658 FcValueDestroy (FcValue v
);
661 FcValueEqual (FcValue va
, FcValue vb
);
664 FcValueSave (FcValue v
);
667 FcPatternDestroy (FcPattern
*p
);
670 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
673 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
676 FcPatternHash (const FcPattern
*p
);
679 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
682 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
685 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
688 FcPatternDel (FcPattern
*p
, const char *object
);
691 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
694 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
697 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
700 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
703 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
706 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
709 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
712 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
715 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
718 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
721 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
724 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
727 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
730 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
733 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
736 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
739 FcPatternBuild (FcPattern
*orig
, ...);
744 FcStrCopy (const FcChar8
*s
);
747 FcStrCopyFilename (const FcChar8
*s
);
749 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
750 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
751 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
754 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
757 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
760 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
763 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
766 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
771 FcUtf8Len (const FcChar8
*string
,
776 #define FC_UTF8_MAX_LEN 6
779 FcUcs4ToUtf8 (FcChar32 ucs4
,
780 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
783 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
786 int len
); /* in bytes */
789 FcUtf16Len (const FcChar8
*string
,
791 int len
, /* in bytes */
796 FcStrDirname (const FcChar8
*file
);
799 FcStrBasename (const FcChar8
*file
);
802 FcStrSetCreate (void);
805 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
808 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
811 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
814 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
817 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
820 FcStrSetDestroy (FcStrSet
*set
);
823 FcStrListCreate (FcStrSet
*set
);
826 FcStrListNext (FcStrList
*list
);
829 FcStrListDone (FcStrList
*list
);
833 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
837 #endif /* _FONTCONFIG_H_ */