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 93
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_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
74 #define FC_AUTOHINT "autohint" /* Bool (false) */
75 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
76 #define FC_WIDTH "width" /* Int */
77 #define FC_FILE "file" /* String */
78 #define FC_INDEX "index" /* Int */
79 #define FC_FT_FACE "ftface" /* FT_Face */
80 #define FC_RASTERIZER "rasterizer" /* String */
81 #define FC_OUTLINE "outline" /* Bool */
82 #define FC_SCALABLE "scalable" /* Bool */
83 #define FC_SCALE "scale" /* double */
84 #define FC_DPI "dpi" /* double */
85 #define FC_RGBA "rgba" /* Int */
86 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
87 #define FC_SOURCE "source" /* String (X11, freetype) */
88 #define FC_CHARSET "charset" /* CharSet */
89 #define FC_LANG "lang" /* String RFC 3066 langs */
90 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
92 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
93 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
95 /* Adjust outline rasterizer */
96 #define FC_CHAR_WIDTH "charwidth" /* Int */
97 #define FC_CHAR_HEIGHT "charheight"/* Int */
98 #define FC_MATRIX "matrix" /* FcMatrix */
100 #define FC_WEIGHT_THIN 0
101 #define FC_WEIGHT_EXTRALIGHT 40
102 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
103 #define FC_WEIGHT_LIGHT 50
104 #define FC_WEIGHT_REGULAR 80
105 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
106 #define FC_WEIGHT_MEDIUM 100
107 #define FC_WEIGHT_DEMIBOLD 180
108 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
109 #define FC_WEIGHT_BOLD 200
110 #define FC_WEIGHT_EXTRABOLD 205
111 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
112 #define FC_WEIGHT_BLACK 210
113 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
115 #define FC_SLANT_ROMAN 0
116 #define FC_SLANT_ITALIC 100
117 #define FC_SLANT_OBLIQUE 110
119 #define FC_WIDTH_ULTRACONDENSED 50
120 #define FC_WIDTH_EXTRACONDENSED 63
121 #define FC_WIDTH_CONDENSED 75
122 #define FC_WIDTH_SEMICONDENSED 87
123 #define FC_WIDTH_NORMAL 100
124 #define FC_WIDTH_SEMIEXPANDED 113
125 #define FC_WIDTH_EXPANDED 125
126 #define FC_WIDTH_EXTRAEXPANDED 150
127 #define FC_WIDTH_ULTRAEXPANDED 200
129 #define FC_PROPORTIONAL 0
131 #define FC_CHARCELL 110
133 /* sub-pixel order */
134 #define FC_RGBA_UNKNOWN 0
135 #define FC_RGBA_RGB 1
136 #define FC_RGBA_BGR 2
137 #define FC_RGBA_VRGB 3
138 #define FC_RGBA_VBGR 4
139 #define FC_RGBA_NONE 5
141 typedef enum _FcType
{
153 typedef struct _FcMatrix
{
154 double xx
, xy
, yx
, yy
;
157 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
158 (m)->xy = (m)->yx = 0)
161 * A data structure to represent the available glyphs in a font.
162 * This is represented as a sparse boolean btree.
165 typedef struct _FcCharSet FcCharSet
;
167 typedef struct _FcObjectType
{
172 typedef struct _FcConstant
{
178 typedef enum _FcResult
{
179 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
182 typedef struct _FcPattern FcPattern
;
184 typedef struct _FcLangSet FcLangSet
;
186 typedef struct _FcValue
{
201 typedef struct _FcFontSet
{
207 typedef struct _FcObjectSet
{
210 const char **objects
;
213 typedef enum _FcMatchKind
{
214 FcMatchPattern
, FcMatchFont
217 typedef enum _FcLangResult
{
218 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
221 typedef enum _FcSetName
{
226 typedef struct _FcAtomic FcAtomic
;
228 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
229 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
230 #define _FCFUNCPROTOEND }
232 #define _FCFUNCPROTOBEGIN
233 #define _FCFUNCPROTOEND
236 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
238 typedef struct _FcConfig FcConfig
;
240 typedef struct _FcGlobalCache FcFileCache
;
242 typedef struct _FcBlanks FcBlanks
;
244 typedef struct _FcStrList FcStrList
;
246 typedef struct _FcStrSet FcStrSet
;
251 FcDirCacheValid (const FcChar8
*cache_file
);
255 FcBlanksCreate (void);
258 FcBlanksDestroy (FcBlanks
*b
);
261 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
264 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
271 FcConfigEnableHome (FcBool enable
);
274 FcConfigFilename (const FcChar8
*url
);
277 FcConfigCreate (void);
280 FcConfigDestroy (FcConfig
*config
);
283 FcConfigSetCurrent (FcConfig
*config
);
286 FcConfigGetCurrent (void);
289 FcConfigUptoDate (FcConfig
*config
);
292 FcConfigBuildFonts (FcConfig
*config
);
295 FcConfigGetFontDirs (FcConfig
*config
);
298 FcConfigGetConfigDirs (FcConfig
*config
);
301 FcConfigGetConfigFiles (FcConfig
*config
);
304 FcConfigGetCache (FcConfig
*config
);
307 FcConfigGetBlanks (FcConfig
*config
);
310 FcConfigGetRescanInverval (FcConfig
*config
);
313 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
316 FcConfigGetFonts (FcConfig
*config
,
320 FcConfigAppFontAddFile (FcConfig
*config
,
321 const FcChar8
*file
);
324 FcConfigAppFontAddDir (FcConfig
*config
,
328 FcConfigAppFontClear (FcConfig
*config
);
331 FcConfigSubstituteWithPat (FcConfig
*config
,
337 FcConfigSubstitute (FcConfig
*config
,
343 FcCharSetCreate (void);
346 FcCharSetDestroy (FcCharSet
*fcs
);
349 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
352 FcCharSetCopy (FcCharSet
*src
);
355 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
358 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
361 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
364 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
367 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
370 FcCharSetCount (const FcCharSet
*a
);
373 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
376 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
379 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
381 #define FC_CHARSET_MAP_SIZE (256/32)
382 #define FC_CHARSET_DONE ((FcChar32) -1)
385 FcCharSetFirstPage (const FcCharSet
*a
,
386 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
390 FcCharSetNextPage (const FcCharSet
*a
,
391 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
397 FcValuePrint (const FcValue v
);
400 FcPatternPrint (const FcPattern
*p
);
403 FcFontSetPrint (const FcFontSet
*s
);
407 FcDefaultSubstitute (FcPattern
*pattern
);
411 FcFileScan (FcFontSet
*set
,
419 FcDirScan (FcFontSet
*set
,
427 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
431 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
436 FcFontSetCreate (void);
439 FcFontSetDestroy (FcFontSet
*s
);
442 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
446 FcInitLoadConfig (void);
449 FcInitLoadConfigAndFonts (void);
458 FcInitReinitialize (void);
461 FcInitBringUptoDate (void);
465 FcLangSetCreate (void);
468 FcLangSetDestroy (FcLangSet
*ls
);
471 FcLangSetCopy (const FcLangSet
*ls
);
474 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
477 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
480 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
483 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
486 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
489 FcLangSetHash (const FcLangSet
*ls
);
493 FcObjectSetCreate (void);
496 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
499 FcObjectSetDestroy (FcObjectSet
*os
);
502 FcObjectSetVaBuild (const char *first
, va_list va
);
505 FcObjectSetBuild (const char *first
, ...);
508 FcFontSetList (FcConfig
*config
,
515 FcFontList (FcConfig
*config
,
522 FcAtomicCreate (const FcChar8
*file
);
525 FcAtomicLock (FcAtomic
*atomic
);
528 FcAtomicNewFile (FcAtomic
*atomic
);
531 FcAtomicOrigFile (FcAtomic
*atomic
);
534 FcAtomicReplaceOrig (FcAtomic
*atomic
);
537 FcAtomicDeleteNew (FcAtomic
*atomic
);
540 FcAtomicUnlock (FcAtomic
*atomic
);
543 FcAtomicDestroy (FcAtomic
*atomic
);
547 FcFontSetMatch (FcConfig
*config
,
554 FcFontMatch (FcConfig
*config
,
559 FcFontRenderPrepare (FcConfig
*config
,
564 FcFontSetSort (FcConfig
*config
,
573 FcFontSort (FcConfig
*config
,
580 FcFontSetSortDestroy (FcFontSet
*fs
);
584 FcMatrixCopy (const FcMatrix
*mat
);
587 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
590 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
593 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
596 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
599 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
604 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
607 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
610 FcNameGetObjectType (const char *object
);
613 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
616 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
619 FcNameGetConstant (FcChar8
*string
);
622 FcNameConstant (FcChar8
*string
, int *result
);
625 FcNameParse (const FcChar8
*name
);
628 FcNameUnparse (FcPattern
*pat
);
632 FcPatternCreate (void);
635 FcPatternDuplicate (const FcPattern
*p
);
638 FcPatternReference (FcPattern
*p
);
641 FcValueDestroy (FcValue v
);
644 FcValueEqual (FcValue va
, FcValue vb
);
647 FcValueSave (FcValue v
);
650 FcPatternDestroy (FcPattern
*p
);
653 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
656 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
659 FcPatternHash (const FcPattern
*p
);
662 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
665 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
668 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
671 FcPatternDel (FcPattern
*p
, const char *object
);
674 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
677 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
680 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
683 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
686 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
689 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
692 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
695 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
698 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
701 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
704 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
707 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
710 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
713 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
716 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
719 FcPatternBuild (FcPattern
*orig
, ...);
724 FcStrCopy (const FcChar8
*s
);
727 FcStrCopyFilename (const FcChar8
*s
);
729 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
730 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
731 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
734 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
737 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
740 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
745 FcUtf8Len (const FcChar8
*string
,
750 #define FC_UTF8_MAX_LEN 6
753 FcUcs4ToUtf8 (FcChar32 ucs4
,
754 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
757 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
760 int len
); /* in bytes */
763 FcUtf16Len (const FcChar8
*string
,
765 int len
, /* in bytes */
770 FcStrDirname (const FcChar8
*file
);
773 FcStrBasename (const FcChar8
*file
);
776 FcStrSetCreate (void);
779 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
782 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
785 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
788 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
791 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
794 FcStrSetDestroy (FcStrSet
*set
);
797 FcStrListCreate (FcStrSet
*set
);
800 FcStrListNext (FcStrList
*list
);
803 FcStrListDone (FcStrList
*list
);
807 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
811 #endif /* _FONTCONFIG_H_ */