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 "2"
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*/
99 #define FC_RENDER "render" /* Bool */
101 #define FC_DIR_CACHE_FILE "fonts.cache-"FC_CACHE_VERSION
102 #define FC_USER_CACHE_FILE ".fonts.cache-"FC_CACHE_VERSION
104 /* Adjust outline rasterizer */
105 #define FC_CHAR_WIDTH "charwidth" /* Int */
106 #define FC_CHAR_HEIGHT "charheight"/* Int */
107 #define FC_MATRIX "matrix" /* FcMatrix */
109 #define FC_WEIGHT_THIN 0
110 #define FC_WEIGHT_EXTRALIGHT 40
111 #define FC_WEIGHT_ULTRALIGHT FC_WEIGHT_EXTRALIGHT
112 #define FC_WEIGHT_LIGHT 50
113 #define FC_WEIGHT_BOOK 75
114 #define FC_WEIGHT_REGULAR 80
115 #define FC_WEIGHT_NORMAL FC_WEIGHT_REGULAR
116 #define FC_WEIGHT_MEDIUM 100
117 #define FC_WEIGHT_DEMIBOLD 180
118 #define FC_WEIGHT_SEMIBOLD FC_WEIGHT_DEMIBOLD
119 #define FC_WEIGHT_BOLD 200
120 #define FC_WEIGHT_EXTRABOLD 205
121 #define FC_WEIGHT_ULTRABOLD FC_WEIGHT_EXTRABOLD
122 #define FC_WEIGHT_BLACK 210
123 #define FC_WEIGHT_HEAVY FC_WEIGHT_BLACK
125 #define FC_SLANT_ROMAN 0
126 #define FC_SLANT_ITALIC 100
127 #define FC_SLANT_OBLIQUE 110
129 #define FC_WIDTH_ULTRACONDENSED 50
130 #define FC_WIDTH_EXTRACONDENSED 63
131 #define FC_WIDTH_CONDENSED 75
132 #define FC_WIDTH_SEMICONDENSED 87
133 #define FC_WIDTH_NORMAL 100
134 #define FC_WIDTH_SEMIEXPANDED 113
135 #define FC_WIDTH_EXPANDED 125
136 #define FC_WIDTH_EXTRAEXPANDED 150
137 #define FC_WIDTH_ULTRAEXPANDED 200
139 #define FC_PROPORTIONAL 0
142 #define FC_CHARCELL 110
144 /* sub-pixel order */
145 #define FC_RGBA_UNKNOWN 0
146 #define FC_RGBA_RGB 1
147 #define FC_RGBA_BGR 2
148 #define FC_RGBA_VRGB 3
149 #define FC_RGBA_VBGR 4
150 #define FC_RGBA_NONE 5
153 #define FC_HINT_NONE 0
154 #define FC_HINT_SLIGHT 1
155 #define FC_HINT_MEDIUM 2
156 #define FC_HINT_FULL 3
158 typedef enum _FcType
{
170 typedef struct _FcMatrix
{
171 double xx
, xy
, yx
, yy
;
174 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
175 (m)->xy = (m)->yx = 0)
178 * A data structure to represent the available glyphs in a font.
179 * This is represented as a sparse boolean btree.
182 typedef struct _FcCharSet FcCharSet
;
184 typedef struct _FcObjectType
{
189 typedef struct _FcConstant
{
195 typedef enum _FcResult
{
196 FcResultMatch
, FcResultNoMatch
, FcResultTypeMismatch
, FcResultNoId
,
200 typedef struct _FcPattern FcPattern
;
202 typedef struct _FcLangSet FcLangSet
;
204 #define FC_BANK_DYNAMIC 0
205 #define FC_BANK_FIRST 1
207 typedef struct _FcValue
{
221 int l_off
; // this is a difference of char *s
225 typedef struct _FcFontSet
{
231 typedef struct _FcObjectSet
{
234 const char **objects
;
237 typedef enum _FcMatchKind
{
238 FcMatchPattern
, FcMatchFont
241 typedef enum _FcLangResult
{
242 FcLangEqual
, FcLangDifferentCountry
, FcLangDifferentLang
245 typedef enum _FcSetName
{
250 typedef struct _FcAtomic FcAtomic
;
252 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
253 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
254 #define _FCFUNCPROTOEND }
256 #define _FCFUNCPROTOBEGIN
257 #define _FCFUNCPROTOEND
260 typedef enum { FcEndianBig
, FcEndianLittle
} FcEndian
;
262 typedef struct _FcConfig FcConfig
;
264 typedef struct _FcGlobalCache FcFileCache
;
266 typedef struct _FcBlanks FcBlanks
;
268 typedef struct _FcStrList FcStrList
;
270 typedef struct _FcStrSet FcStrSet
;
275 FcDirCacheValid (const FcChar8
*cache_file
);
279 FcBlanksCreate (void);
282 FcBlanksDestroy (FcBlanks
*b
);
285 FcBlanksAdd (FcBlanks
*b
, FcChar32 ucs4
);
288 FcBlanksIsMember (FcBlanks
*b
, FcChar32 ucs4
);
295 FcConfigEnableHome (FcBool enable
);
298 FcConfigFilename (const FcChar8
*url
);
301 FcConfigCreate (void);
304 FcConfigDestroy (FcConfig
*config
);
307 FcConfigSetCurrent (FcConfig
*config
);
310 FcConfigGetCurrent (void);
313 FcConfigUptoDate (FcConfig
*config
);
316 FcConfigBuildFonts (FcConfig
*config
);
319 FcConfigGetFontDirs (FcConfig
*config
);
322 FcConfigGetConfigDirs (FcConfig
*config
);
325 FcConfigGetConfigFiles (FcConfig
*config
);
328 FcConfigGetCache (FcConfig
*config
);
331 FcConfigGetBlanks (FcConfig
*config
);
334 FcConfigGetRescanInverval (FcConfig
*config
);
337 FcConfigSetRescanInverval (FcConfig
*config
, int rescanInterval
);
340 FcConfigGetFonts (FcConfig
*config
,
344 FcConfigAppFontAddFile (FcConfig
*config
,
345 const FcChar8
*file
);
348 FcConfigAppFontAddDir (FcConfig
*config
,
352 FcConfigAppFontClear (FcConfig
*config
);
355 FcConfigSubstituteWithPat (FcConfig
*config
,
361 FcConfigSubstitute (FcConfig
*config
,
367 FcCharSetCreate (void);
370 FcCharSetDestroy (FcCharSet
*fcs
);
373 FcCharSetAddChar (FcCharSet
*fcs
, FcChar32 ucs4
);
376 FcCharSetCopy (FcCharSet
*src
);
379 FcCharSetEqual (const FcCharSet
*a
, const FcCharSet
*b
);
382 FcCharSetIntersect (const FcCharSet
*a
, const FcCharSet
*b
);
385 FcCharSetUnion (const FcCharSet
*a
, const FcCharSet
*b
);
388 FcCharSetSubtract (const FcCharSet
*a
, const FcCharSet
*b
);
391 FcCharSetHasChar (const FcCharSet
*fcs
, FcChar32 ucs4
);
394 FcCharSetCount (const FcCharSet
*a
);
397 FcCharSetIntersectCount (const FcCharSet
*a
, const FcCharSet
*b
);
400 FcCharSetSubtractCount (const FcCharSet
*a
, const FcCharSet
*b
);
403 FcCharSetIsSubset (const FcCharSet
*a
, const FcCharSet
*b
);
405 #define FC_CHARSET_MAP_SIZE (256/32)
406 #define FC_CHARSET_DONE ((FcChar32) -1)
409 FcCharSetFirstPage (const FcCharSet
*a
,
410 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
414 FcCharSetNextPage (const FcCharSet
*a
,
415 FcChar32 map
[FC_CHARSET_MAP_SIZE
],
421 FcValuePrint (const FcValue v
);
424 FcPatternPrint (const FcPattern
*p
);
427 FcFontSetPrint (const FcFontSet
*s
);
431 FcDefaultSubstitute (FcPattern
*pattern
);
435 FcFileScan (FcFontSet
*set
,
443 FcDirScan (FcFontSet
*set
,
451 FcDirSave (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
455 FcFreeTypeQuery (const FcChar8
*file
, int id
, FcBlanks
*blanks
, int *count
);
460 FcFontSetCreate (void);
463 FcFontSetDestroy (FcFontSet
*s
);
466 FcFontSetAdd (FcFontSet
*s
, FcPattern
*font
);
470 FcInitLoadConfig (void);
473 FcInitLoadConfigAndFonts (void);
485 FcInitReinitialize (void);
488 FcInitBringUptoDate (void);
492 FcLangSetCreate (void);
495 FcLangSetDestroy (FcLangSet
*ls
);
498 FcLangSetCopy (const FcLangSet
*ls
);
501 FcLangSetAdd (FcLangSet
*ls
, const FcChar8
*lang
);
504 FcLangSetHasLang (const FcLangSet
*ls
, const FcChar8
*lang
);
507 FcLangSetCompare (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
510 FcLangSetContains (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
513 FcLangSetEqual (const FcLangSet
*lsa
, const FcLangSet
*lsb
);
516 FcLangSetHash (const FcLangSet
*ls
);
520 FcObjectSetCreate (void);
523 FcObjectSetAdd (FcObjectSet
*os
, const char *object
);
526 FcObjectSetDestroy (FcObjectSet
*os
);
529 FcObjectSetVaBuild (const char *first
, va_list va
);
532 FcObjectSetBuild (const char *first
, ...);
535 FcFontSetList (FcConfig
*config
,
542 FcFontList (FcConfig
*config
,
549 FcAtomicCreate (const FcChar8
*file
);
552 FcAtomicLock (FcAtomic
*atomic
);
555 FcAtomicNewFile (FcAtomic
*atomic
);
558 FcAtomicOrigFile (FcAtomic
*atomic
);
561 FcAtomicReplaceOrig (FcAtomic
*atomic
);
564 FcAtomicDeleteNew (FcAtomic
*atomic
);
567 FcAtomicUnlock (FcAtomic
*atomic
);
570 FcAtomicDestroy (FcAtomic
*atomic
);
574 FcFontSetMatch (FcConfig
*config
,
581 FcFontMatch (FcConfig
*config
,
586 FcFontRenderPrepare (FcConfig
*config
,
591 FcFontSetSort (FcConfig
*config
,
600 FcFontSort (FcConfig
*config
,
607 FcFontSetSortDestroy (FcFontSet
*fs
);
611 FcMatrixCopy (const FcMatrix
*mat
);
614 FcMatrixEqual (const FcMatrix
*mat1
, const FcMatrix
*mat2
);
617 FcMatrixMultiply (FcMatrix
*result
, const FcMatrix
*a
, const FcMatrix
*b
);
620 FcMatrixRotate (FcMatrix
*m
, double c
, double s
);
623 FcMatrixScale (FcMatrix
*m
, double sx
, double sy
);
626 FcMatrixShear (FcMatrix
*m
, double sh
, double sv
);
631 FcNameRegisterObjectTypes (const FcObjectType
*types
, int ntype
);
634 FcNameUnregisterObjectTypes (const FcObjectType
*types
, int ntype
);
637 FcNameGetObjectType (const char *object
);
640 FcNameRegisterConstants (const FcConstant
*consts
, int nconsts
);
643 FcNameUnregisterConstants (const FcConstant
*consts
, int nconsts
);
646 FcNameGetConstant (FcChar8
*string
);
649 FcNameConstant (FcChar8
*string
, int *result
);
652 FcNameParse (const FcChar8
*name
);
655 FcNameUnparse (FcPattern
*pat
);
659 FcPatternCreate (void);
662 FcPatternDuplicate (const FcPattern
*p
);
665 FcPatternReference (FcPattern
*p
);
668 FcValueDestroy (FcValue v
);
671 FcValueEqual (FcValue va
, FcValue vb
);
674 FcValueSave (FcValue v
);
677 FcPatternDestroy (FcPattern
*p
);
680 FcPatternEqual (const FcPattern
*pa
, const FcPattern
*pb
);
683 FcPatternEqualSubset (const FcPattern
*pa
, const FcPattern
*pb
, const FcObjectSet
*os
);
686 FcPatternHash (const FcPattern
*p
);
689 FcPatternAdd (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
692 FcPatternAddWeak (FcPattern
*p
, const char *object
, FcValue value
, FcBool append
);
695 FcPatternGet (const FcPattern
*p
, const char *object
, int id
, FcValue
*v
);
698 FcPatternDel (FcPattern
*p
, const char *object
);
701 FcPatternRemove (FcPattern
*p
, const char *object
, int id
);
704 FcPatternAddInteger (FcPattern
*p
, const char *object
, int i
);
707 FcPatternAddDouble (FcPattern
*p
, const char *object
, double d
);
710 FcPatternAddString (FcPattern
*p
, const char *object
, const FcChar8
*s
);
713 FcPatternAddMatrix (FcPattern
*p
, const char *object
, const FcMatrix
*s
);
716 FcPatternAddCharSet (FcPattern
*p
, const char *object
, const FcCharSet
*c
);
719 FcPatternAddBool (FcPattern
*p
, const char *object
, FcBool b
);
722 FcPatternAddLangSet (FcPattern
*p
, const char *object
, const FcLangSet
*ls
);
725 FcPatternGetInteger (const FcPattern
*p
, const char *object
, int n
, int *i
);
728 FcPatternGetDouble (const FcPattern
*p
, const char *object
, int n
, double *d
);
731 FcPatternGetString (const FcPattern
*p
, const char *object
, int n
, FcChar8
** s
);
734 FcPatternGetMatrix (const FcPattern
*p
, const char *object
, int n
, FcMatrix
**s
);
737 FcPatternGetCharSet (const FcPattern
*p
, const char *object
, int n
, FcCharSet
**c
);
740 FcPatternGetBool (const FcPattern
*p
, const char *object
, int n
, FcBool
*b
);
743 FcPatternGetLangSet (const FcPattern
*p
, const char *object
, int n
, FcLangSet
**ls
);
746 FcPatternVaBuild (FcPattern
*orig
, va_list va
);
749 FcPatternBuild (FcPattern
*orig
, ...);
754 FcStrCopy (const FcChar8
*s
);
757 FcStrCopyFilename (const FcChar8
*s
);
759 /* These are ASCII only, suitable only for pattern element names */
760 #define FcIsUpper(c) ((0101 <= (c) && (c) <= 0132))
761 #define FcIsLower(c) ((0141 <= (c) && (c) <= 0172))
762 #define FcToLower(c) (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
765 FcStrDowncase (const FcChar8
*s
);
768 FcStrCmpIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
771 FcStrCmp (const FcChar8
*s1
, const FcChar8
*s2
);
774 FcStrStrIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
777 FcStrStr (const FcChar8
*s1
, const FcChar8
*s2
);
780 FcUtf8ToUcs4 (const FcChar8
*src_orig
,
785 FcUtf8Len (const FcChar8
*string
,
790 #define FC_UTF8_MAX_LEN 6
793 FcUcs4ToUtf8 (FcChar32 ucs4
,
794 FcChar8 dest
[FC_UTF8_MAX_LEN
]);
797 FcUtf16ToUcs4 (const FcChar8
*src_orig
,
800 int len
); /* in bytes */
803 FcUtf16Len (const FcChar8
*string
,
805 int len
, /* in bytes */
810 FcStrDirname (const FcChar8
*file
);
813 FcStrBasename (const FcChar8
*file
);
816 FcStrSetCreate (void);
819 FcStrSetMember (FcStrSet
*set
, const FcChar8
*s
);
822 FcStrSetEqual (FcStrSet
*sa
, FcStrSet
*sb
);
825 FcStrSetAdd (FcStrSet
*set
, const FcChar8
*s
);
828 FcStrSetAddFilename (FcStrSet
*set
, const FcChar8
*s
);
831 FcStrSetDel (FcStrSet
*set
, const FcChar8
*s
);
834 FcStrSetDestroy (FcStrSet
*set
);
837 FcStrListCreate (FcStrSet
*set
);
840 FcStrListNext (FcStrList
*list
);
843 FcStrListDone (FcStrList
*list
);
847 FcConfigParseAndLoad (FcConfig
*config
, const FcChar8
*file
, FcBool complain
);
851 #endif /* _FONTCONFIG_H_ */