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.
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 (deprecated) */
89 #define FC_CHARSET "charset" /* CharSet */
90 #define FC_LANG "lang" /* String RFC 3066 langs */
91 #define FC_FONTVERSION "fontversion" /* Int from 'head' table */
92 #define FC_FULLNAME "fullname" /* String */
93 #define FC_FAMILYLANG "familylang" /* String RFC 3066 langs */
94 #define FC_STYLELANG "stylelang" /* String RFC 3066 langs */
95 #define FC_FULLNAMELANG "fullnamelang" /* String RFC 3066 langs */
96 #define FC_CAPABILITY "capability" /* String */
97 #define FC_FONTFORMAT "fontformat" /* String */
98 #define FC_EMBOLDEN "embolden" /* Bool - true if emboldening needed*/
100 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
101 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
103 /* Adjust outline rasterizer */
104 #define FC_CHAR_WIDTH "charwidth" /* Int */
105 #define FC_CHAR_HEIGHT "charheight"/* Int */
106 #define FC_MATRIX "matrix" /* FcMatrix */
108 #define FC_WEIGHT_THIN 0
109 #define FC_WEIGHT_EXTRALIGHT 40
110 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
111 #define FC_WEIGHT_LIGHT 50
112 #define FC_WEIGHT_BOOK 75
113 #define FC_WEIGHT_REGULAR 80
114 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
115 #define FC_WEIGHT_MEDIUM 100
116 #define FC_WEIGHT_DEMIBOLD 180
117 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
118 #define FC_WEIGHT_BOLD 200
119 #define FC_WEIGHT_EXTRABOLD 205
120 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
121 #define FC_WEIGHT_BLACK 210
122 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
124 #define FC_SLANT_ROMAN 0
125 #define FC_SLANT_ITALIC 100
126 #define FC_SLANT_OBLIQUE 110
128 #define FC_WIDTH_ULTRACONDENSED 50
129 #define FC_WIDTH_EXTRACONDENSED 63
130 #define FC_WIDTH_CONDENSED 75
131 #define FC_WIDTH_SEMICONDENSED 87
132 #define FC_WIDTH_NORMAL 100
133 #define FC_WIDTH_SEMIEXPANDED 113
134 #define FC_WIDTH_EXPANDED 125
135 #define FC_WIDTH_EXTRAEXPANDED 150
136 #define FC_WIDTH_ULTRAEXPANDED 200
138 #define FC_PROPORTIONAL 0
141 #define FC_CHARCELL 110
143 /* sub-pixel order */
144 #define FC_RGBA_UNKNOWN 0
145 #define FC_RGBA_RGB 1
146 #define FC_RGBA_BGR 2
147 #define FC_RGBA_VRGB 3
148 #define FC_RGBA_VBGR 4
149 #define FC_RGBA_NONE 5
152 #define FC_HINT_NONE 0
153 #define FC_HINT_SLIGHT 1
154 #define FC_HINT_MEDIUM 2
155 #define FC_HINT_FULL 3
157 typedef enum _FcType
{
169 typedef struct _FcMatrix
{
170 double xx
, xy
, yx
, yy
;
173 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
174 (m)->xy = (m)->yx = 0)
177 * A data structure to represent the available glyphs in a font.
178 * This is represented as a sparse boolean btree.
181 typedef struct _FcCharSet FcCharSet
;
183 typedef struct _FcObjectType
{
188 typedef struct _FcConstant
{
194 typedef enum _FcResult
{
195 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
199 typedef enum _FcStorage
{
200 FcStorageStatic
, FcStorageDynamic
203 typedef struct _FcPattern FcPattern
;
205 typedef struct _FcLangSet FcLangSet
;
207 typedef struct _FcMatrixPtr
{
215 typedef struct _FcCharSetPtr
{
223 typedef struct _FcLangSetPtr
{
231 typedef struct _FcObjectPtr
{
240 typedef struct _FcValue
{
255 typedef struct _FcFontSet
{
261 typedef struct _FcObjectSet
{
264 FcObjectPtr
*objects
;
267 typedef enum _FcMatchKind
{
268 FcMatchPattern
, FcMatchFont
271 typedef enum _FcLangResult
{
272 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
275 typedef enum _FcSetName
{
280 typedef struct _FcAtomic FcAtomic
;
282 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
283 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
284 #define _FCFUNCPROTOEND }
286 #define _FCFUNCPROTOBEGIN
287 #define _FCFUNCPROTOEND
290 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
292 typedef struct _FcConfig FcConfig
;
294 typedef struct _FcGlobalCache FcFileCache
;
296 typedef struct _FcBlanks FcBlanks
;
298 typedef struct _FcStrList FcStrList
;
300 typedef struct _FcStrSet FcStrSet
;
305 FcDirCacheValid (const FcChar8
*cache_file
);
309 FcBlanksCreate (void);
312 FcBlanksDestroy (FcBlanks
*b
);
315 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
318 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
325 FcConfigEnableHome (FcBool enable
);
328 FcConfigFilename (const FcChar8
*url
);
331 FcConfigCreate (void);
334 FcConfigDestroy (FcConfig
*config
);
337 FcConfigSetCurrent (FcConfig
*config
);
340 FcConfigGetCurrent (void);
343 FcConfigUptoDate (FcConfig
*config
);
346 FcConfigBuildFonts (FcConfig
*config
);
349 FcConfigGetFontDirs (FcConfig
*config
);
352 FcConfigGetConfigDirs (FcConfig
*config
);
355 FcConfigGetConfigFiles (FcConfig
*config
);
358 FcConfigGetCache (FcConfig
*config
);
361 FcConfigGetBlanks (FcConfig
*config
);
364 FcConfigGetRescanInverval (FcConfig
*config
);
367 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
370 FcConfigGetFonts (FcConfig
*config
,
374 FcConfigAppFontAddFile (FcConfig
*config
,
375 const FcChar8
*file
);
378 FcConfigAppFontAddDir (FcConfig
*config
,
382 FcConfigAppFontClear (FcConfig
*config
);
385 FcConfigSubstituteWithPat (FcConfig
*config
,
391 FcConfigSubstitute (FcConfig
*config
,
397 FcCharSetCreate (void);
400 FcCharSetDestroy (FcCharSet
*fcs
);
403 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
406 FcCharSetCopy (FcCharSet
*src
);
409 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
412 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
415 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
418 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
421 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
424 FcCharSetCount (const FcCharSet
*a
);
427 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
430 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
433 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
435 #define FC_CHARSET_MAP_SIZE (256/32)
436 #define FC_CHARSET_DONE ((FcChar32) -1)
439 FcCharSetFirstPage (const FcCharSet
*a
,
440 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
444 FcCharSetNextPage (const FcCharSet
*a
,
445 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
451 FcValuePrint (const FcValue v
);
454 FcPatternPrint (const FcPattern
*p
);
457 FcFontSetPrint (const FcFontSet
*s
);
461 FcDefaultSubstitute (FcPattern
*pattern
);
465 FcFileScan (FcFontSet
*set
,
473 FcDirScan (FcFontSet
*set
,
481 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
485 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
490 FcFontSetCreate (void);
493 FcFontSetDestroy (FcFontSet
*s
);
496 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
500 FcInitLoadConfig (void);
503 FcInitLoadConfigAndFonts (void);
515 FcInitReinitialize (void);
518 FcInitBringUptoDate (void);
522 FcLangSetCreate (void);
525 FcLangSetDestroy (FcLangSet
*ls
);
528 FcLangSetCopy (const FcLangSet
*ls
);
531 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
534 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
537 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
540 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
543 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
546 FcLangSetHash (const FcLangSet
*ls
);
550 FcObjectSetCreate (void);
553 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
556 FcObjectSetDestroy (FcObjectSet
*os
);
559 FcObjectSetVaBuild (const char *first
, va_list va
);
562 FcObjectSetBuild (const char *first
, ...);
565 FcFontSetList (FcConfig
*config
,
572 FcFontList (FcConfig
*config
,
579 FcAtomicCreate (const FcChar8
*file
);
582 FcAtomicLock (FcAtomic
*atomic
);
585 FcAtomicNewFile (FcAtomic
*atomic
);
588 FcAtomicOrigFile (FcAtomic
*atomic
);
591 FcAtomicReplaceOrig (FcAtomic
*atomic
);
594 FcAtomicDeleteNew (FcAtomic
*atomic
);
597 FcAtomicUnlock (FcAtomic
*atomic
);
600 FcAtomicDestroy (FcAtomic
*atomic
);
604 FcFontSetMatch (FcConfig
*config
,
611 FcFontMatch (FcConfig
*config
,
616 FcFontRenderPrepare (FcConfig
*config
,
621 FcFontSetSort (FcConfig
*config
,
630 FcFontSort (FcConfig
*config
,
637 FcFontSetSortDestroy (FcFontSet
*fs
);
641 FcMatrixCopy (const FcMatrix
*mat
);
644 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
647 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
650 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
653 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
656 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
659 FcMatrixPtrU (FcMatrixPtr mi
);
664 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
667 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
670 FcNameGetObjectType (const char *object
);
673 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
676 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
679 FcNameGetConstant (FcChar8
*string
);
682 FcNameConstant (FcChar8
*string
, int *result
);
685 FcNameParse (const FcChar8
*name
);
688 FcNameUnparse (FcPattern
*pat
);
692 FcPatternCreate (void);
695 FcPatternDuplicate (const FcPattern
*p
);
698 FcPatternReference (FcPattern
*p
);
701 FcValueDestroy (FcValue v
);
704 FcValueEqual (FcValue va
, FcValue vb
);
707 FcValueSave (FcValue v
);
710 FcPatternDestroy (FcPattern
*p
);
713 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
716 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
719 FcPatternHash (const FcPattern
*p
);
722 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
725 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
728 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
731 FcPatternDel (FcPattern
*p
, const char *object
);
734 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
737 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
740 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
743 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
746 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
749 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
752 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
755 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
758 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
761 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
764 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
767 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
770 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
773 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
776 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
779 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
782 FcPatternBuild (FcPattern
*orig
, ...);
787 FcStrCopy (const FcChar8
*s
);
790 FcStrCopyFilename (const FcChar8
*s
);
792 /* These are ASCII only, suitable only for pattern element names */
793 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
794 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
795 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
798 FcStrDowncase (const FcChar8
*s
);
801 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
804 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
807 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
810 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
813 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
818 FcUtf8Len (const FcChar8
*string
,
823 #define FC_UTF8_MAX_LEN 6
826 FcUcs4ToUtf8 (FcChar32 ucs4
,
827 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
830 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
833 int len
); /* in bytes */
836 FcUtf16Len (const FcChar8
*string
,
838 int len
, /* in bytes */
843 FcStrDirname (const FcChar8
*file
);
846 FcStrBasename (const FcChar8
*file
);
849 FcStrSetCreate (void);
852 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
855 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
858 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
861 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
864 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
867 FcStrSetDestroy (FcStrSet
*set
);
870 FcStrListCreate (FcStrSet
*set
);
873 FcStrListNext (FcStrList
*list
);
876 FcStrListDone (FcStrList
*list
);
880 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
884 #endif /* _FONTCONFIG_H_ */