2 * $XFree86: xc/lib/fontconfig/fontconfig/fontconfig.h,v 1.25 2002/08/11 18:10:41 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
42 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
47 #define FC_FAMILY "family" /* String */
48 #define FC_STYLE "style" /* String */
49 #define FC_SLANT "slant" /* Int */
50 #define FC_WEIGHT "weight" /* Int */
51 #define FC_SIZE "size" /* Double */
52 #define FC_ASPECT "aspect" /* Double */
53 #define FC_PIXEL_SIZE "pixelsize" /* Double */
54 #define FC_SPACING "spacing" /* Int */
55 #define FC_FOUNDRY "foundry" /* String */
56 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
57 #define FC_HINTING "hinting" /* Bool (true) */
58 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
59 #define FC_AUTOHINT "autohint" /* Bool (false) */
60 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
61 #define FC_FILE "file" /* String */
62 #define FC_INDEX "index" /* Int */
63 #define FC_FT_FACE "ftface" /* FT_Face */
64 #define FC_RASTERIZER "rasterizer" /* String */
65 #define FC_OUTLINE "outline" /* Bool */
66 #define FC_SCALABLE "scalable" /* Bool */
67 #define FC_SCALE "scale" /* double */
68 #define FC_DPI "dpi" /* double */
69 #define FC_RGBA "rgba" /* Int */
70 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
71 #define FC_SOURCE "source" /* String (X11, freetype) */
72 #define FC_CHARSET "charset" /* CharSet */
73 #define FC_LANG "lang" /* String OS/2 CodePageRange */
75 #define FC_DIR_CACHE_FILE "fonts.cache"
76 #define FC_USER_CACHE_FILE ".fonts.cache"
78 /* Adjust outline rasterizer */
79 #define FC_CHAR_WIDTH "charwidth" /* Int */
80 #define FC_CHAR_HEIGHT "charheight"/* Int */
81 #define FC_MATRIX "matrix" /* FcMatrix */
83 #define FC_WEIGHT_LIGHT 0
84 #define FC_WEIGHT_MEDIUM 100
85 #define FC_WEIGHT_DEMIBOLD 180
86 #define FC_WEIGHT_BOLD 200
87 #define FC_WEIGHT_BLACK 210
89 #define FC_SLANT_ROMAN 0
90 #define FC_SLANT_ITALIC 100
91 #define FC_SLANT_OBLIQUE 110
93 #define FC_PROPORTIONAL 0
95 #define FC_CHARCELL 110
98 #define FC_RGBA_NONE 0
100 #define FC_RGBA_BGR 2
101 #define FC_RGBA_VRGB 3
102 #define FC_RGBA_VBGR 4
104 typedef enum _FcType
{
115 typedef struct _FcMatrix
{
116 double xx
, xy
, yx
, yy
;
119 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
120 (m)->xy = (m)->yx = 0)
123 * A data structure to represent the available glyphs in a font.
124 * This is represented as a sparse boolean btree.
127 typedef struct _FcCharSet FcCharSet
;
129 typedef struct _FcObjectType
{
134 typedef struct _FcConstant
{
140 typedef enum _FcResult
{
141 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
144 typedef struct _FcPattern FcPattern
;
146 typedef struct _FcValue
{
160 typedef struct _FcFontSet
{
166 typedef struct _FcObjectSet
{
169 const char **objects
;
172 typedef enum _FcMatchKind
{
173 FcMatchPattern
, FcMatchFont
176 typedef enum _FcSetName
{
181 typedef struct _FcAtomic FcAtomic
;
183 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
184 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
185 #define _FCFUNCPROTOEND }
187 #define _FCFUNCPROTOBEGIN
188 #define _FCFUNCPROTOEND
191 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
193 typedef struct _FcConfig FcConfig
;
195 typedef struct _FcGlobalCache FcFileCache
;
197 typedef struct _FcBlanks FcBlanks
;
199 typedef struct _FcStrList FcStrList
;
201 typedef struct _FcStrSet FcStrSet
;
206 FcDirCacheValid (const FcChar8
*cache_file
);
210 FcBlanksCreate (void);
213 FcBlanksDestroy (FcBlanks
*b
);
216 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
219 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
223 FcConfigFilename (const FcChar8
*url
);
226 FcConfigCreate (void);
229 FcConfigDestroy (FcConfig
*config
);
232 FcConfigSetCurrent (FcConfig
*config
);
235 FcConfigGetCurrent (void);
238 FcConfigUptoDate (FcConfig
*config
);
241 FcConfigBuildFonts (FcConfig
*config
);
244 FcConfigGetFontDirs (FcConfig
*config
);
247 FcConfigGetConfigDirs (FcConfig
*config
);
250 FcConfigGetConfigFiles (FcConfig
*config
);
253 FcConfigGetCache (FcConfig
*config
);
256 FcConfigGetBlanks (FcConfig
*config
);
259 FcConfigGetRescanInverval (FcConfig
*config
);
262 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
265 FcConfigGetFonts (FcConfig
*config
,
269 FcConfigAppFontAddFile (FcConfig
*config
,
270 const FcChar8
*file
);
273 FcConfigAppFontAddDir (FcConfig
*config
,
277 FcConfigAppFontClear (FcConfig
*config
);
280 FcConfigSubstituteWithPat (FcConfig
*config
,
286 FcConfigSubstitute (FcConfig
*config
,
292 FcCharSetCreate (void);
295 FcCharSetDestroy (FcCharSet
*fcs
);
298 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
301 FcCharSetCopy (FcCharSet
*src
);
304 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
307 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
310 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
313 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
316 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
319 FcCharSetCount (const FcCharSet
*a
);
322 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
325 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
328 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
330 #define FC_CHARSET_MAP_SIZE (256/32)
331 #define FC_CHARSET_DONE ((FcChar32) -1)
334 FcCharSetFirstPage (const FcCharSet
*a
,
335 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
339 FcCharSetNextPage (const FcCharSet
*a
,
340 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
346 FcValuePrint (const FcValue v
);
349 FcPatternPrint (const FcPattern
*p
);
352 FcFontSetPrint (const FcFontSet
*s
);
356 FcDefaultSubstitute (FcPattern
*pattern
);
360 FcFileScan (FcFontSet
*set
,
368 FcDirScan (FcFontSet
*set
,
376 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
380 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
385 FcFontSetCreate (void);
388 FcFontSetDestroy (FcFontSet
*s
);
391 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
395 FcInitLoadConfig (void);
398 FcInitLoadConfigAndFonts (void);
407 FcInitReinitialize (void);
410 FcInitBringUptoDate (void);
414 FcObjectSetCreate (void);
417 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
420 FcObjectSetDestroy (FcObjectSet
*os
);
423 FcObjectSetVaBuild (const char *first
, va_list va
);
426 FcObjectSetBuild (const char *first
, ...);
429 FcFontSetList (FcConfig
*config
,
436 FcFontList (FcConfig
*config
,
443 FcAtomicCreate (const FcChar8
*file
);
446 FcAtomicLock (FcAtomic
*atomic
);
449 FcAtomicNewFile (FcAtomic
*atomic
);
452 FcAtomicOrigFile (FcAtomic
*atomic
);
455 FcAtomicReplaceOrig (FcAtomic
*atomic
);
458 FcAtomicDeleteNew (FcAtomic
*atomic
);
461 FcAtomicUnlock (FcAtomic
*atomic
);
464 FcAtomicDestroy (FcAtomic
*atomic
);
468 FcFontSetMatch (FcConfig
*config
,
475 FcFontMatch (FcConfig
*config
,
480 FcFontRenderPrepare (FcConfig
*config
,
485 FcFontSetSort (FcConfig
*config
,
494 FcFontSort (FcConfig
*config
,
501 FcFontSetSortDestroy (FcFontSet
*fs
);
505 FcMatrixCopy (const FcMatrix
*mat
);
508 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
511 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
514 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
517 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
520 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
525 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
528 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
531 FcNameGetObjectType (const char *object
);
534 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
537 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
540 FcNameGetConstant (FcChar8
*string
);
543 FcNameConstant (FcChar8
*string
, int *result
);
546 FcNameParse (const FcChar8
*name
);
549 FcNameUnparse (FcPattern
*pat
);
553 FcPatternCreate (void);
556 FcPatternDuplicate (FcPattern
*p
);
559 FcPatternReference (FcPattern
*p
);
562 FcValueDestroy (FcValue v
);
565 FcValueEqual (FcValue va
, FcValue vb
);
568 FcValueSave (FcValue v
);
571 FcPatternDestroy (FcPattern
*p
);
574 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
577 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
580 FcPatternHash (const FcPattern
*p
);
583 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
586 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
589 FcPatternGet (FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
592 FcPatternDel (FcPattern
*p
, const char *object
);
595 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
598 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
601 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
604 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
607 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
610 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
613 FcPatternGetInteger (FcPattern
*p
, const char *object
, int n
, int *i
);
616 FcPatternGetDouble (FcPattern
*p
, const char *object
, int n
, double *d
);
619 FcPatternGetString (FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
622 FcPatternGetMatrix (FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
625 FcPatternGetCharSet (FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
628 FcPatternGetBool (FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
631 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
634 FcPatternBuild (FcPattern
*orig
, ...);
639 FcStrCopy (const FcChar8
*s
);
642 FcStrCopyFilename (const FcChar8
*s
);
644 #define FcToLower(c) (('A' <= (c) && (c) <= 'Z') ? (c) - 'A' + 'a' : (c))
647 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
650 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
653 FcUtf8ToUcs4 (FcChar8
*src_orig
,
658 FcUtf8Len (FcChar8
*string
,
663 #define FC_UTF8_MAX_LEN 6
666 FcUcs4ToUtf8 (FcChar32 ucs4
,
667 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
670 FcUtf16ToUcs4 (FcChar8
*src_orig
,
673 int len
); /* in bytes */
676 FcUtf16Len (FcChar8
*string
,
678 int len
, /* in bytes */
683 FcStrDirname (const FcChar8
*file
);
686 FcStrBasename (const FcChar8
*file
);
689 FcStrSetCreate (void);
692 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
695 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
698 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
701 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
704 FcStrSetDestroy (FcStrSet
*set
);
707 FcStrListCreate (FcStrSet
*set
);
710 FcStrListNext (FcStrList
*list
);
713 FcStrListDone (FcStrList
*list
);
717 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
721 #endif /* _FONTCONFIG_H_ */