2 * $XFree86: xc/lib/fontconfig/fontconfig/fontconfig.h,v 1.30 2002/09/26 00:17:27 keithp Exp $
4 * Copyright © 2001 Keith Packard, member of The XFree86 Project, Inc.
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 90
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_FILE "file" /* String */
77 #define FC_INDEX "index" /* Int */
78 #define FC_FT_FACE "ftface" /* FT_Face */
79 #define FC_RASTERIZER "rasterizer" /* String */
80 #define FC_OUTLINE "outline" /* Bool */
81 #define FC_SCALABLE "scalable" /* Bool */
82 #define FC_SCALE "scale" /* double */
83 #define FC_DPI "dpi" /* double */
84 #define FC_RGBA "rgba" /* Int */
85 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
86 #define FC_SOURCE "source" /* String (X11, freetype) */
87 #define FC_CHARSET "charset" /* CharSet */
88 #define FC_LANG "lang" /* String RFC 3066 langs */
89 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
91 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
92 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
94 /* Adjust outline rasterizer */
95 #define FC_CHAR_WIDTH "charwidth" /* Int */
96 #define FC_CHAR_HEIGHT "charheight"/* Int */
97 #define FC_MATRIX "matrix" /* FcMatrix */
99 #define FC_WEIGHT_LIGHT 0
100 #define FC_WEIGHT_MEDIUM 100
101 #define FC_WEIGHT_DEMIBOLD 180
102 #define FC_WEIGHT_BOLD 200
103 #define FC_WEIGHT_BLACK 210
105 #define FC_SLANT_ROMAN 0
106 #define FC_SLANT_ITALIC 100
107 #define FC_SLANT_OBLIQUE 110
109 #define FC_PROPORTIONAL 0
111 #define FC_CHARCELL 110
113 /* sub-pixel order */
114 #define FC_RGBA_UNKNOWN 0
115 #define FC_RGBA_RGB 1
116 #define FC_RGBA_BGR 2
117 #define FC_RGBA_VRGB 3
118 #define FC_RGBA_VBGR 4
119 #define FC_RGBA_NONE 5
121 typedef enum _FcType
{
133 typedef struct _FcMatrix
{
134 double xx
, xy
, yx
, yy
;
137 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
138 (m)->xy = (m)->yx = 0)
141 * A data structure to represent the available glyphs in a font.
142 * This is represented as a sparse boolean btree.
145 typedef struct _FcCharSet FcCharSet
;
147 typedef struct _FcObjectType
{
152 typedef struct _FcConstant
{
158 typedef enum _FcResult
{
159 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
162 typedef struct _FcPattern FcPattern
;
164 typedef struct _FcLangSet FcLangSet
;
166 typedef struct _FcValue
{
181 typedef struct _FcFontSet
{
187 typedef struct _FcObjectSet
{
190 const char **objects
;
193 typedef enum _FcMatchKind
{
194 FcMatchPattern
, FcMatchFont
197 typedef enum _FcLangResult
{
198 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
201 typedef enum _FcSetName
{
206 typedef struct _FcAtomic FcAtomic
;
208 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
209 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
210 #define _FCFUNCPROTOEND }
212 #define _FCFUNCPROTOBEGIN
213 #define _FCFUNCPROTOEND
216 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
218 typedef struct _FcConfig FcConfig
;
220 typedef struct _FcGlobalCache FcFileCache
;
222 typedef struct _FcBlanks FcBlanks
;
224 typedef struct _FcStrList FcStrList
;
226 typedef struct _FcStrSet FcStrSet
;
231 FcDirCacheValid (const FcChar8
*cache_file
);
235 FcBlanksCreate (void);
238 FcBlanksDestroy (FcBlanks
*b
);
241 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
244 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
251 FcConfigEnableHome (FcBool enable
);
254 FcConfigFilename (const FcChar8
*url
);
257 FcConfigCreate (void);
260 FcConfigDestroy (FcConfig
*config
);
263 FcConfigSetCurrent (FcConfig
*config
);
266 FcConfigGetCurrent (void);
269 FcConfigUptoDate (FcConfig
*config
);
272 FcConfigBuildFonts (FcConfig
*config
);
275 FcConfigGetFontDirs (FcConfig
*config
);
278 FcConfigGetConfigDirs (FcConfig
*config
);
281 FcConfigGetConfigFiles (FcConfig
*config
);
284 FcConfigGetCache (FcConfig
*config
);
287 FcConfigGetBlanks (FcConfig
*config
);
290 FcConfigGetRescanInverval (FcConfig
*config
);
293 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
296 FcConfigGetFonts (FcConfig
*config
,
300 FcConfigAppFontAddFile (FcConfig
*config
,
301 const FcChar8
*file
);
304 FcConfigAppFontAddDir (FcConfig
*config
,
308 FcConfigAppFontClear (FcConfig
*config
);
311 FcConfigSubstituteWithPat (FcConfig
*config
,
317 FcConfigSubstitute (FcConfig
*config
,
323 FcCharSetCreate (void);
326 FcCharSetDestroy (FcCharSet
*fcs
);
329 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
332 FcCharSetCopy (FcCharSet
*src
);
335 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
338 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
341 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
344 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
347 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
350 FcCharSetCount (const FcCharSet
*a
);
353 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
356 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
359 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
361 #define FC_CHARSET_MAP_SIZE (256/32)
362 #define FC_CHARSET_DONE ((FcChar32) -1)
365 FcCharSetFirstPage (const FcCharSet
*a
,
366 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
370 FcCharSetNextPage (const FcCharSet
*a
,
371 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
377 FcValuePrint (const FcValue v
);
380 FcPatternPrint (const FcPattern
*p
);
383 FcFontSetPrint (const FcFontSet
*s
);
387 FcDefaultSubstitute (FcPattern
*pattern
);
391 FcFileScan (FcFontSet
*set
,
399 FcDirScan (FcFontSet
*set
,
407 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
411 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
416 FcFontSetCreate (void);
419 FcFontSetDestroy (FcFontSet
*s
);
422 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
426 FcInitLoadConfig (void);
429 FcInitLoadConfigAndFonts (void);
438 FcInitReinitialize (void);
441 FcInitBringUptoDate (void);
445 FcLangSetCreate (void);
448 FcLangSetDestroy (FcLangSet
*ls
);
451 FcLangSetCopy (const FcLangSet
*ls
);
454 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
457 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
460 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
463 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
466 FcLangSetHash (const FcLangSet
*ls
);
470 FcObjectSetCreate (void);
473 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
476 FcObjectSetDestroy (FcObjectSet
*os
);
479 FcObjectSetVaBuild (const char *first
, va_list va
);
482 FcObjectSetBuild (const char *first
, ...);
485 FcFontSetList (FcConfig
*config
,
492 FcFontList (FcConfig
*config
,
499 FcAtomicCreate (const FcChar8
*file
);
502 FcAtomicLock (FcAtomic
*atomic
);
505 FcAtomicNewFile (FcAtomic
*atomic
);
508 FcAtomicOrigFile (FcAtomic
*atomic
);
511 FcAtomicReplaceOrig (FcAtomic
*atomic
);
514 FcAtomicDeleteNew (FcAtomic
*atomic
);
517 FcAtomicUnlock (FcAtomic
*atomic
);
520 FcAtomicDestroy (FcAtomic
*atomic
);
524 FcFontSetMatch (FcConfig
*config
,
531 FcFontMatch (FcConfig
*config
,
536 FcFontRenderPrepare (FcConfig
*config
,
541 FcFontSetSort (FcConfig
*config
,
550 FcFontSort (FcConfig
*config
,
557 FcFontSetSortDestroy (FcFontSet
*fs
);
561 FcMatrixCopy (const FcMatrix
*mat
);
564 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
567 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
570 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
573 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
576 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
581 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
584 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
587 FcNameGetObjectType (const char *object
);
590 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
593 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
596 FcNameGetConstant (FcChar8
*string
);
599 FcNameConstant (FcChar8
*string
, int *result
);
602 FcNameParse (const FcChar8
*name
);
605 FcNameUnparse (FcPattern
*pat
);
609 FcPatternCreate (void);
612 FcPatternDuplicate (const FcPattern
*p
);
615 FcPatternReference (FcPattern
*p
);
618 FcValueDestroy (FcValue v
);
621 FcValueEqual (FcValue va
, FcValue vb
);
624 FcValueSave (FcValue v
);
627 FcPatternDestroy (FcPattern
*p
);
630 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
633 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
636 FcPatternHash (const FcPattern
*p
);
639 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
642 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
645 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
648 FcPatternDel (FcPattern
*p
, const char *object
);
651 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
654 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
657 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
660 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
663 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
666 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
669 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
672 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
675 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
678 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
681 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
684 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
687 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
690 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
693 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
696 FcPatternBuild (FcPattern
*orig
, ...);
701 FcStrCopy (const FcChar8
*s
);
704 FcStrCopyFilename (const FcChar8
*s
);
706 #define FcToLower(c) (('A' <= (c) && (c) <= 'Z') ? (c) - 'A' + 'a' : (c))
709 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
712 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
715 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
720 FcUtf8Len (const FcChar8
*string
,
725 #define FC_UTF8_MAX_LEN 6
728 FcUcs4ToUtf8 (FcChar32 ucs4
,
729 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
732 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
735 int len
); /* in bytes */
738 FcUtf16Len (const FcChar8
*string
,
740 int len
, /* in bytes */
745 FcStrDirname (const FcChar8
*file
);
748 FcStrBasename (const FcChar8
*file
);
751 FcStrSetCreate (void);
754 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
757 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
760 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
763 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
766 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
769 FcStrSetDestroy (FcStrSet
*set
);
772 FcStrListCreate (FcStrSet
*set
);
775 FcStrListNext (FcStrList
*list
);
778 FcStrListDone (FcStrList
*list
);
782 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
786 #endif /* _FONTCONFIG_H_ */