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 94
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 */
93 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
94 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
96 /* Adjust outline rasterizer */
97 #define FC_CHAR_WIDTH "charwidth" /* Int */
98 #define FC_CHAR_HEIGHT "charheight"/* Int */
99 #define FC_MATRIX "matrix" /* FcMatrix */
101 #define FC_WEIGHT_THIN 0
102 #define FC_WEIGHT_EXTRALIGHT 40
103 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
104 #define FC_WEIGHT_LIGHT 50
105 #define FC_WEIGHT_BOOK 75
106 #define FC_WEIGHT_REGULAR 80
107 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
108 #define FC_WEIGHT_MEDIUM 100
109 #define FC_WEIGHT_DEMIBOLD 180
110 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
111 #define FC_WEIGHT_BOLD 200
112 #define FC_WEIGHT_EXTRABOLD 205
113 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
114 #define FC_WEIGHT_BLACK 210
115 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
117 #define FC_SLANT_ROMAN 0
118 #define FC_SLANT_ITALIC 100
119 #define FC_SLANT_OBLIQUE 110
121 #define FC_WIDTH_ULTRACONDENSED 50
122 #define FC_WIDTH_EXTRACONDENSED 63
123 #define FC_WIDTH_CONDENSED 75
124 #define FC_WIDTH_SEMICONDENSED 87
125 #define FC_WIDTH_NORMAL 100
126 #define FC_WIDTH_SEMIEXPANDED 113
127 #define FC_WIDTH_EXPANDED 125
128 #define FC_WIDTH_EXTRAEXPANDED 150
129 #define FC_WIDTH_ULTRAEXPANDED 200
131 #define FC_PROPORTIONAL 0
134 #define FC_CHARCELL 110
136 /* sub-pixel order */
137 #define FC_RGBA_UNKNOWN 0
138 #define FC_RGBA_RGB 1
139 #define FC_RGBA_BGR 2
140 #define FC_RGBA_VRGB 3
141 #define FC_RGBA_VBGR 4
142 #define FC_RGBA_NONE 5
145 #define FC_HINT_NONE 0
146 #define FC_HINT_SLIGHT 1
147 #define FC_HINT_MEDIUM 2
148 #define FC_HINT_FULL 3
150 typedef enum _FcType
{
162 typedef struct _FcMatrix
{
163 double xx
, xy
, yx
, yy
;
166 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
167 (m)->xy = (m)->yx = 0)
170 * A data structure to represent the available glyphs in a font.
171 * This is represented as a sparse boolean btree.
174 typedef struct _FcCharSet FcCharSet
;
176 typedef struct _FcObjectType
{
181 typedef struct _FcConstant
{
187 typedef enum _FcResult
{
188 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
192 typedef struct _FcPattern FcPattern
;
194 typedef struct _FcLangSet FcLangSet
;
196 typedef struct _FcValue
{
211 typedef struct _FcFontSet
{
217 typedef struct _FcObjectSet
{
220 const char **objects
;
223 typedef enum _FcMatchKind
{
224 FcMatchPattern
, FcMatchFont
227 typedef enum _FcLangResult
{
228 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
231 typedef enum _FcSetName
{
236 typedef struct _FcAtomic FcAtomic
;
238 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
239 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
240 #define _FCFUNCPROTOEND }
242 #define _FCFUNCPROTOBEGIN
243 #define _FCFUNCPROTOEND
246 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
248 typedef struct _FcConfig FcConfig
;
250 typedef struct _FcGlobalCache FcFileCache
;
252 typedef struct _FcBlanks FcBlanks
;
254 typedef struct _FcStrList FcStrList
;
256 typedef struct _FcStrSet FcStrSet
;
261 FcDirCacheValid (const FcChar8
*cache_file
);
265 FcBlanksCreate (void);
268 FcBlanksDestroy (FcBlanks
*b
);
271 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
274 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
281 FcConfigEnableHome (FcBool enable
);
284 FcConfigFilename (const FcChar8
*url
);
287 FcConfigCreate (void);
290 FcConfigDestroy (FcConfig
*config
);
293 FcConfigSetCurrent (FcConfig
*config
);
296 FcConfigGetCurrent (void);
299 FcConfigUptoDate (FcConfig
*config
);
302 FcConfigBuildFonts (FcConfig
*config
);
305 FcConfigGetFontDirs (FcConfig
*config
);
308 FcConfigGetConfigDirs (FcConfig
*config
);
311 FcConfigGetConfigFiles (FcConfig
*config
);
314 FcConfigGetCache (FcConfig
*config
);
317 FcConfigGetBlanks (FcConfig
*config
);
320 FcConfigGetRescanInverval (FcConfig
*config
);
323 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
326 FcConfigGetFonts (FcConfig
*config
,
330 FcConfigAppFontAddFile (FcConfig
*config
,
331 const FcChar8
*file
);
334 FcConfigAppFontAddDir (FcConfig
*config
,
338 FcConfigAppFontClear (FcConfig
*config
);
341 FcConfigSubstituteWithPat (FcConfig
*config
,
347 FcConfigSubstitute (FcConfig
*config
,
353 FcCharSetCreate (void);
356 FcCharSetDestroy (FcCharSet
*fcs
);
359 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
362 FcCharSetCopy (FcCharSet
*src
);
365 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
368 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
371 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
374 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
377 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
380 FcCharSetCount (const FcCharSet
*a
);
383 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
386 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
389 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
391 #define FC_CHARSET_MAP_SIZE (256/32)
392 #define FC_CHARSET_DONE ((FcChar32) -1)
395 FcCharSetFirstPage (const FcCharSet
*a
,
396 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
400 FcCharSetNextPage (const FcCharSet
*a
,
401 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
407 FcValuePrint (const FcValue v
);
410 FcPatternPrint (const FcPattern
*p
);
413 FcFontSetPrint (const FcFontSet
*s
);
417 FcDefaultSubstitute (FcPattern
*pattern
);
421 FcFileScan (FcFontSet
*set
,
429 FcDirScan (FcFontSet
*set
,
437 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
441 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
446 FcFontSetCreate (void);
449 FcFontSetDestroy (FcFontSet
*s
);
452 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
456 FcInitLoadConfig (void);
459 FcInitLoadConfigAndFonts (void);
471 FcInitReinitialize (void);
474 FcInitBringUptoDate (void);
478 FcLangSetCreate (void);
481 FcLangSetDestroy (FcLangSet
*ls
);
484 FcLangSetCopy (const FcLangSet
*ls
);
487 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
490 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
493 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
496 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
499 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
502 FcLangSetHash (const FcLangSet
*ls
);
506 FcObjectSetCreate (void);
509 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
512 FcObjectSetDestroy (FcObjectSet
*os
);
515 FcObjectSetVaBuild (const char *first
, va_list va
);
518 FcObjectSetBuild (const char *first
, ...);
521 FcFontSetList (FcConfig
*config
,
528 FcFontList (FcConfig
*config
,
535 FcAtomicCreate (const FcChar8
*file
);
538 FcAtomicLock (FcAtomic
*atomic
);
541 FcAtomicNewFile (FcAtomic
*atomic
);
544 FcAtomicOrigFile (FcAtomic
*atomic
);
547 FcAtomicReplaceOrig (FcAtomic
*atomic
);
550 FcAtomicDeleteNew (FcAtomic
*atomic
);
553 FcAtomicUnlock (FcAtomic
*atomic
);
556 FcAtomicDestroy (FcAtomic
*atomic
);
560 FcFontSetMatch (FcConfig
*config
,
567 FcFontMatch (FcConfig
*config
,
572 FcFontRenderPrepare (FcConfig
*config
,
577 FcFontSetSort (FcConfig
*config
,
586 FcFontSort (FcConfig
*config
,
593 FcFontSetSortDestroy (FcFontSet
*fs
);
597 FcMatrixCopy (const FcMatrix
*mat
);
600 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
603 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
606 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
609 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
612 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
617 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
620 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
623 FcNameGetObjectType (const char *object
);
626 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
629 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
632 FcNameGetConstant (FcChar8
*string
);
635 FcNameConstant (FcChar8
*string
, int *result
);
638 FcNameParse (const FcChar8
*name
);
641 FcNameUnparse (FcPattern
*pat
);
645 FcPatternCreate (void);
648 FcPatternDuplicate (const FcPattern
*p
);
651 FcPatternReference (FcPattern
*p
);
654 FcValueDestroy (FcValue v
);
657 FcValueEqual (FcValue va
, FcValue vb
);
660 FcValueSave (FcValue v
);
663 FcPatternDestroy (FcPattern
*p
);
666 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
669 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
672 FcPatternHash (const FcPattern
*p
);
675 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
678 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
681 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
684 FcPatternDel (FcPattern
*p
, const char *object
);
687 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
690 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
693 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
696 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
699 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
702 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
705 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
708 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
711 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
714 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
717 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
720 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
723 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
726 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
729 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
732 FcPatternBuild (FcPattern
*orig
, ...);
737 FcStrCopy (const FcChar8
*s
);
740 FcStrCopyFilename (const FcChar8
*s
);
742 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
743 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
744 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
747 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
750 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
753 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
756 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
759 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
764 FcUtf8Len (const FcChar8
*string
,
769 #define FC_UTF8_MAX_LEN 6
772 FcUcs4ToUtf8 (FcChar32 ucs4
,
773 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
776 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
779 int len
); /* in bytes */
782 FcUtf16Len (const FcChar8
*string
,
784 int len
, /* in bytes */
789 FcStrDirname (const FcChar8
*file
);
792 FcStrBasename (const FcChar8
*file
);
795 FcStrSetCreate (void);
798 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
801 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
804 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
807 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
810 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
813 FcStrSetDestroy (FcStrSet
*set
);
816 FcStrListCreate (FcStrSet
*set
);
819 FcStrListNext (FcStrList
*list
);
822 FcStrListDone (FcStrList
*list
);
826 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
830 #endif /* _FONTCONFIG_H_ */