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
191 typedef struct _FcPattern FcPattern
;
193 typedef struct _FcLangSet FcLangSet
;
195 typedef struct _FcValue
{
210 typedef struct _FcFontSet
{
216 typedef struct _FcObjectSet
{
219 const char **objects
;
222 typedef enum _FcMatchKind
{
223 FcMatchPattern
, FcMatchFont
226 typedef enum _FcLangResult
{
227 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
230 typedef enum _FcSetName
{
235 typedef struct _FcAtomic FcAtomic
;
237 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
238 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
239 #define _FCFUNCPROTOEND }
241 #define _FCFUNCPROTOBEGIN
242 #define _FCFUNCPROTOEND
245 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
247 typedef struct _FcConfig FcConfig
;
249 typedef struct _FcGlobalCache FcFileCache
;
251 typedef struct _FcBlanks FcBlanks
;
253 typedef struct _FcStrList FcStrList
;
255 typedef struct _FcStrSet FcStrSet
;
260 FcDirCacheValid (const FcChar8
*cache_file
);
264 FcBlanksCreate (void);
267 FcBlanksDestroy (FcBlanks
*b
);
270 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
273 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
280 FcConfigEnableHome (FcBool enable
);
283 FcConfigFilename (const FcChar8
*url
);
286 FcConfigCreate (void);
289 FcConfigDestroy (FcConfig
*config
);
292 FcConfigSetCurrent (FcConfig
*config
);
295 FcConfigGetCurrent (void);
298 FcConfigUptoDate (FcConfig
*config
);
301 FcConfigBuildFonts (FcConfig
*config
);
304 FcConfigGetFontDirs (FcConfig
*config
);
307 FcConfigGetConfigDirs (FcConfig
*config
);
310 FcConfigGetConfigFiles (FcConfig
*config
);
313 FcConfigGetCache (FcConfig
*config
);
316 FcConfigGetBlanks (FcConfig
*config
);
319 FcConfigGetRescanInverval (FcConfig
*config
);
322 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
325 FcConfigGetFonts (FcConfig
*config
,
329 FcConfigAppFontAddFile (FcConfig
*config
,
330 const FcChar8
*file
);
333 FcConfigAppFontAddDir (FcConfig
*config
,
337 FcConfigAppFontClear (FcConfig
*config
);
340 FcConfigSubstituteWithPat (FcConfig
*config
,
346 FcConfigSubstitute (FcConfig
*config
,
352 FcCharSetCreate (void);
355 FcCharSetDestroy (FcCharSet
*fcs
);
358 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
361 FcCharSetCopy (FcCharSet
*src
);
364 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
367 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
370 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
373 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
376 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
379 FcCharSetCount (const FcCharSet
*a
);
382 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
385 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
388 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
390 #define FC_CHARSET_MAP_SIZE (256/32)
391 #define FC_CHARSET_DONE ((FcChar32) -1)
394 FcCharSetFirstPage (const FcCharSet
*a
,
395 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
399 FcCharSetNextPage (const FcCharSet
*a
,
400 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
406 FcValuePrint (const FcValue v
);
409 FcPatternPrint (const FcPattern
*p
);
412 FcFontSetPrint (const FcFontSet
*s
);
416 FcDefaultSubstitute (FcPattern
*pattern
);
420 FcFileScan (FcFontSet
*set
,
428 FcDirScan (FcFontSet
*set
,
436 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
440 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
445 FcFontSetCreate (void);
448 FcFontSetDestroy (FcFontSet
*s
);
451 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
455 FcInitLoadConfig (void);
458 FcInitLoadConfigAndFonts (void);
470 FcInitReinitialize (void);
473 FcInitBringUptoDate (void);
477 FcLangSetCreate (void);
480 FcLangSetDestroy (FcLangSet
*ls
);
483 FcLangSetCopy (const FcLangSet
*ls
);
486 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
489 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
492 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
495 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
498 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
501 FcLangSetHash (const FcLangSet
*ls
);
505 FcObjectSetCreate (void);
508 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
511 FcObjectSetDestroy (FcObjectSet
*os
);
514 FcObjectSetVaBuild (const char *first
, va_list va
);
517 FcObjectSetBuild (const char *first
, ...);
520 FcFontSetList (FcConfig
*config
,
527 FcFontList (FcConfig
*config
,
534 FcAtomicCreate (const FcChar8
*file
);
537 FcAtomicLock (FcAtomic
*atomic
);
540 FcAtomicNewFile (FcAtomic
*atomic
);
543 FcAtomicOrigFile (FcAtomic
*atomic
);
546 FcAtomicReplaceOrig (FcAtomic
*atomic
);
549 FcAtomicDeleteNew (FcAtomic
*atomic
);
552 FcAtomicUnlock (FcAtomic
*atomic
);
555 FcAtomicDestroy (FcAtomic
*atomic
);
559 FcFontSetMatch (FcConfig
*config
,
566 FcFontMatch (FcConfig
*config
,
571 FcFontRenderPrepare (FcConfig
*config
,
576 FcFontSetSort (FcConfig
*config
,
585 FcFontSort (FcConfig
*config
,
592 FcFontSetSortDestroy (FcFontSet
*fs
);
596 FcMatrixCopy (const FcMatrix
*mat
);
599 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
602 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
605 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
608 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
611 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
616 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
619 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
622 FcNameGetObjectType (const char *object
);
625 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
628 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
631 FcNameGetConstant (FcChar8
*string
);
634 FcNameConstant (FcChar8
*string
, int *result
);
637 FcNameParse (const FcChar8
*name
);
640 FcNameUnparse (FcPattern
*pat
);
644 FcPatternCreate (void);
647 FcPatternDuplicate (const FcPattern
*p
);
650 FcPatternReference (FcPattern
*p
);
653 FcValueDestroy (FcValue v
);
656 FcValueEqual (FcValue va
, FcValue vb
);
659 FcValueSave (FcValue v
);
662 FcPatternDestroy (FcPattern
*p
);
665 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
668 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
671 FcPatternHash (const FcPattern
*p
);
674 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
677 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
680 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
683 FcPatternDel (FcPattern
*p
, const char *object
);
686 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
689 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
692 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
695 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
698 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
701 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
704 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
707 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
710 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
713 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
716 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
719 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
722 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
725 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
728 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
731 FcPatternBuild (FcPattern
*orig
, ...);
736 FcStrCopy (const FcChar8
*s
);
739 FcStrCopyFilename (const FcChar8
*s
);
741 #define FcIsUpper(c) (('A' <= (c) && (c) <= 'Z'))
742 #define FcIsLower(c) (('a' <= (c) && (c) <= 'z'))
743 #define FcToLower(c) (FcIsUpper(c) ? (c) - 'A' + 'a' : (c))
746 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
749 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
752 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
755 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
758 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
763 FcUtf8Len (const FcChar8
*string
,
768 #define FC_UTF8_MAX_LEN 6
771 FcUcs4ToUtf8 (FcChar32 ucs4
,
772 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
775 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
778 int len
); /* in bytes */
781 FcUtf16Len (const FcChar8
*string
,
783 int len
, /* in bytes */
788 FcStrDirname (const FcChar8
*file
);
791 FcStrBasename (const FcChar8
*file
);
794 FcStrSetCreate (void);
797 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
800 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
803 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
806 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
809 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
812 FcStrSetDestroy (FcStrSet
*set
);
815 FcStrListCreate (FcStrSet
*set
);
818 FcStrListNext (FcStrList
*list
);
821 FcStrListDone (FcStrList
*list
);
825 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
829 #endif /* _FONTCONFIG_H_ */