2 * $RCSId: xc/lib/fontconfig/src/fcint.h,v 1.27 2002/08/31 22:17:32 keithp Exp $
4 * Copyright © 2000 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.
34 #include <sys/types.h>
37 #include <fontconfig/fontconfig.h>
38 #include <fontconfig/fcprivate.h>
39 #include <fontconfig/fcfreetype.h>
44 typedef struct _FcSymbolic
{
49 #ifndef FC_CONFIG_PATH
50 #define FC_CONFIG_PATH "fonts.conf"
53 #define FC_FONT_FILE_INVALID ((FcChar8 *) ".")
54 #define FC_FONT_FILE_DIR ((FcChar8 *) ".dir")
57 #define FC_SEARCH_PATH_SEPARATOR ';'
59 #define FC_SEARCH_PATH_SEPARATOR ':'
62 #define FC_DBG_MATCH 1
63 #define FC_DBG_MATCHV 2
65 #define FC_DBG_FONTSET 8
66 #define FC_DBG_CACHE 16
67 #define FC_DBG_CACHEV 32
68 #define FC_DBG_PARSE 64
69 #define FC_DBG_SCAN 128
70 #define FC_DBG_SCANV 256
71 #define FC_DBG_MEMORY 512
73 #define FC_MEM_CHARSET 0
74 #define FC_MEM_CHARLEAF 1
75 #define FC_MEM_FONTSET 2
76 #define FC_MEM_FONTPTR 3
77 #define FC_MEM_OBJECTSET 4
78 #define FC_MEM_OBJECTPTR 5
79 #define FC_MEM_MATRIX 6
80 #define FC_MEM_PATTERN 7
81 #define FC_MEM_PATELT 8
82 #define FC_MEM_VALLIST 9
83 #define FC_MEM_SUBSTATE 10
84 #define FC_MEM_STRING 11
85 #define FC_MEM_LISTBUCK 12
86 #define FC_MEM_STRSET 13
87 #define FC_MEM_STRLIST 14
88 #define FC_MEM_CONFIG 15
89 #define FC_MEM_LANGSET 16
90 #define FC_MEM_ATOMIC 17
91 #define FC_MEM_BLANKS 18
92 #define FC_MEM_CACHE 19
93 #define FC_MEM_STRBUF 20
94 #define FC_MEM_SUBST 21
95 #define FC_MEM_OBJECTTYPE 22
96 #define FC_MEM_CONSTANT 23
97 #define FC_MEM_TEST 24
98 #define FC_MEM_EXPR 25
99 #define FC_MEM_VSTACK 26
100 #define FC_MEM_ATTR 27
101 #define FC_MEM_PSTACK 28
103 #define FC_MEM_NUM 29
105 typedef enum _FcValueBinding
{
106 FcValueBindingWeak
, FcValueBindingStrong
, FcValueBindingSame
109 typedef struct _FcValueList
{
110 struct _FcValueList
*next
;
112 FcValueBinding binding
;
115 typedef struct _FcPatternElt
{
129 FcOpInteger
, FcOpDouble
, FcOpString
, FcOpMatrix
, FcOpBool
, FcOpCharSet
,
131 FcOpField
, FcOpConst
,
132 FcOpAssign
, FcOpAssignReplace
,
133 FcOpPrependFirst
, FcOpPrepend
, FcOpAppend
, FcOpAppendLast
,
135 FcOpOr
, FcOpAnd
, FcOpEqual
, FcOpNotEqual
, FcOpContains
, FcOpNotContains
,
136 FcOpLess
, FcOpLessEqual
, FcOpMore
, FcOpMoreEqual
,
137 FcOpPlus
, FcOpMinus
, FcOpTimes
, FcOpDivide
,
138 FcOpNot
, FcOpComma
, FcOpFloor
, FcOpCeil
, FcOpRound
, FcOpTrunc
,
142 typedef struct _FcExpr
{
154 struct _FcExpr
*left
, *right
;
159 typedef enum _FcQual
{
160 FcQualAny
, FcQualAll
, FcQualFirst
, FcQualNotFirst
163 #define FcMatchDefault ((FcMatchKind) -1)
165 typedef struct _FcTest
{
166 struct _FcTest
*next
;
174 typedef struct _FcEdit
{
175 struct _FcEdit
*next
;
179 FcValueBinding binding
;
182 typedef struct _FcSubst
{
183 struct _FcSubst
*next
;
188 typedef struct _FcCharLeaf
{
189 FcChar32 map
[256/32];
192 #define FC_REF_CONSTANT -1
195 int ref
; /* reference count */
196 int num
; /* size of leaves and numbers arrays */
202 int ref
; /* reference count */
213 typedef struct _FcStrBuf
{
222 * The per-user ~/.fonts.cache-<version> file is loaded into
223 * this data structure. Each directory gets a substructure
224 * which is validated by comparing the directory timestamp with
225 * that saved in the cache. When valid, the entire directory cache
226 * can be immediately loaded without reading the directory. Otherwise,
227 * the files are checked individually; updated files are loaded into the
228 * cache which is then rewritten to the users home directory
231 #define FC_GLOBAL_CACHE_DIR_HASH_SIZE 37
232 #define FC_GLOBAL_CACHE_FILE_HASH_SIZE 67
234 typedef struct _FcGlobalCacheInfo
{
241 typedef struct _FcGlobalCacheFile
{
242 struct _FcGlobalCacheFile
*next
;
243 FcGlobalCacheInfo info
;
248 typedef struct _FcGlobalCacheDir FcGlobalCacheDir
;
250 typedef struct _FcGlobalCacheSubdir
{
251 struct _FcGlobalCacheSubdir
*next
;
252 FcGlobalCacheDir
*ent
;
253 } FcGlobalCacheSubdir
;
255 struct _FcGlobalCacheDir
{
256 struct _FcGlobalCacheDir
*next
;
257 FcGlobalCacheInfo info
;
259 FcGlobalCacheFile
*ents
[FC_GLOBAL_CACHE_FILE_HASH_SIZE
];
260 FcGlobalCacheSubdir
*subdirs
;
263 typedef struct _FcGlobalCache
{
264 FcGlobalCacheDir
*ents
[FC_GLOBAL_CACHE_DIR_HASH_SIZE
];
272 FcChar8
*file
; /* original file name */
273 FcChar8
*new; /* temp file name -- write data here */
274 FcChar8
*lck
; /* lockfile name (used for locking) */
275 FcChar8
*tmp
; /* tmpfile name (used for locking) */
286 * File names loaded from the configuration -- saved here as the
287 * cache file must be consulted before the directories are scanned,
288 * and those directives may occur in any order
290 FcStrSet
*configDirs
; /* directories to scan for fonts */
291 FcChar8
*cache
; /* name of per-user cache file */
293 * Set of allowed blank chars -- used to
294 * trim fonts of bogus glyphs
298 * List of directories containing fonts,
299 * built by recursively scanning the set
300 * of configured directories
304 * Names of all of the configuration files used
305 * to create this configuration
307 FcStrSet
*configFiles
; /* config files loaded */
309 * Substitution instructions for patterns and fonts;
310 * maxObjects is used to allocate appropriate intermediate storage
311 * while performing a whole set of substitutions
313 FcSubst
*substPattern
; /* substitutions for patterns */
314 FcSubst
*substFont
; /* substitutions for fonts */
315 int maxObjects
; /* maximum number of tests in all substs */
317 * The set of fonts loaded from the listed directories; the
318 * order within the set does not determine the font selection,
319 * except in the case of identical matches in which case earlier fonts
320 * match preferrentially
322 FcFontSet
*fonts
[FcSetApplication
+ 1];
324 * Fontconfig can periodically rescan the system configuration
325 * and font directories. This rescanning occurs when font
326 * listing requests are made, but no more often than rescanInterval
329 time_t rescanTime
; /* last time information was scanned */
330 int rescanInterval
; /* interval between scans */
333 extern FcConfig
*_fcConfig
;
335 typedef struct _FcCharMap FcCharMap
;
342 FcGlobalCacheCreate (void);
345 FcGlobalCacheDestroy (FcGlobalCache
*cache
);
348 FcGlobalCacheCheckTime (const FcChar8
*file
, FcGlobalCacheInfo
*info
);
351 FcGlobalCacheReferenced (FcGlobalCache
*cache
,
352 FcGlobalCacheInfo
*info
);
355 FcGlobalCacheReferenceSubdir (FcGlobalCache
*cache
,
359 FcGlobalCacheDirGet (FcGlobalCache
*cache
,
362 FcBool create_missing
);
365 FcGlobalCacheScanDir (FcFontSet
*set
,
367 FcGlobalCache
*cache
,
371 FcGlobalCacheFileGet (FcGlobalCache
*cache
,
378 FcGlobalCacheLoad (FcGlobalCache
*cache
,
379 const FcChar8
*cache_file
);
382 FcGlobalCacheUpdate (FcGlobalCache
*cache
,
385 const FcChar8
*name
);
388 FcGlobalCacheSave (FcGlobalCache
*cache
,
389 const FcChar8
*cache_file
);
392 FcDirCacheReadDir (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
395 FcDirCacheWriteDir (FcFontSet
*set
, FcStrSet
*dirs
, const FcChar8
*dir
);
400 FcConfigAddConfigDir (FcConfig
*config
,
404 FcConfigAddFontDir (FcConfig
*config
,
408 FcConfigAddDir (FcConfig
*config
,
412 FcConfigAddConfigFile (FcConfig
*config
,
416 FcConfigSetCache (FcConfig
*config
,
420 FcConfigAddBlank (FcConfig
*config
,
424 FcConfigAddEdit (FcConfig
*config
,
430 FcConfigSetFonts (FcConfig
*config
,
435 FcConfigCompareValue (const FcValue m
,
441 FcCharSetFreeze (FcCharSet
*cs
);
444 FcNameUnparseCharSet (FcStrBuf
*buf
, const FcCharSet
*c
);
447 FcNameParseCharSet (FcChar8
*string
);
450 FcCharSetFindLeafCreate (FcCharSet
*fcs
, FcChar32 ucs4
);
454 FcValueListPrint (const FcValueList
*l
);
457 FcLangSetPrint (const FcLangSet
*ls
);
463 FcTestPrint (const FcTest
*test
);
466 FcExprPrint (const FcExpr
*expr
);
469 FcEditPrint (const FcEdit
*edit
);
472 FcSubstPrint (const FcSubst
*subst
);
485 FcFreeTypeIsExclusiveLang (const FcChar8
*lang
);
488 FcFreeTypeHasLang (FcPattern
*pattern
, const FcChar8
*lang
);
491 FcFreeTypeUcs4ToPrivate (FcChar32 ucs4
, const FcCharMap
*map
);
494 FcFreeTypePrivateToUcs4 (FcChar32
private, const FcCharMap
*map
);
497 FcFreeTypeGetPrivateMap (FT_Encoding encoding
);
502 FcConfigparse (void);
508 FcConfigerror (char *fmt
, ...);
511 FcConfigSaveField (const char *field
);
514 FcTestCreate (FcMatchKind kind
,
516 const FcChar8
*field
,
521 FcTestDestroy (FcTest
*test
);
524 FcExprCreateInteger (int i
);
527 FcExprCreateDouble (double d
);
530 FcExprCreateString (const FcChar8
*s
);
533 FcExprCreateMatrix (const FcMatrix
*m
);
536 FcExprCreateBool (FcBool b
);
539 FcExprCreateNil (void);
542 FcExprCreateField (const char *field
);
545 FcExprCreateConst (const FcChar8
*constant
);
548 FcExprCreateOp (FcExpr
*left
, FcOp op
, FcExpr
*right
);
551 FcExprDestroy (FcExpr
*e
);
554 FcEditCreate (const char *field
, FcOp op
, FcExpr
*expr
, FcValueBinding binding
);
557 FcEditDestroy (FcEdit
*e
);
565 FcMemAlloc (int kind
, int size
);
568 FcMemFree (int kind
, int size
);
572 FcFreeTypeLangSet (const FcCharSet
*charset
,
573 const FcChar8
*exclusiveLang
);
576 FcLangCompare (const FcChar8
*s1
, const FcChar8
*s2
);
579 FcCharSetForLang (const FcChar8
*lang
);
582 FcLangSetPromote (const FcChar8
*lang
);
585 FcNameParseLangSet (const FcChar8
*string
);
588 FcNameUnparseLangSet (FcStrBuf
*buf
, const FcLangSet
*ls
);
597 FcNameBool (FcChar8
*v
, FcBool
*result
);
601 FcValueListDestroy (FcValueList
*l
);
604 FcPatternFindElt (const FcPattern
*p
, const char *object
);
607 FcPatternInsertElt (FcPattern
*p
, const char *object
);
610 FcPatternAddWithBinding (FcPattern
*p
,
613 FcValueBinding binding
,
617 FcPatternFreeze (FcPattern
*p
);
623 extern const FcMatrix FcIdentityMatrix
;
626 FcMatrixFree (FcMatrix
*mat
);
630 FcStrPlus (const FcChar8
*s1
, const FcChar8
*s2
);
633 FcStrFree (FcChar8
*s
);
636 FcStrBufInit (FcStrBuf
*buf
, FcChar8
*init
, int size
);
639 FcStrBufDestroy (FcStrBuf
*buf
);
642 FcStrBufDone (FcStrBuf
*buf
);
645 FcStrBufChar (FcStrBuf
*buf
, FcChar8 c
);
648 FcStrBufString (FcStrBuf
*buf
, const FcChar8
*s
);
651 FcStrBufData (FcStrBuf
*buf
, const FcChar8
*s
, int len
);
654 FcStrCmpIgnoreBlanksAndCase (const FcChar8
*s1
, const FcChar8
*s2
);
657 FcStrUsesHome (const FcChar8
*s
);
660 FcStrLastSlash (const FcChar8
*path
);
662 #endif /* _FC_INT_H_ */