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.
35 #include <sys/types.h>
38 #include <fontconfig/fontconfig.h>
39 #include <fontconfig/fcprivate.h>
40 #include <fontconfig/fcfreetype.h>
45 #ifndef FC_CONFIG_PATH
46 #define FC_CONFIG_PATH "fonts.conf"
49 #define FC_FONT_FILE_INVALID ((FcChar8 *) ".")
50 #define FC_FONT_FILE_DIR ((FcChar8 *) ".dir")
51 #define FC_GLOBAL_MAGIC_COOKIE "GLOBAL"
54 #define FC_SEARCH_PATH_SEPARATOR ';'
56 #define FC_SEARCH_PATH_SEPARATOR ':'
59 #define FC_DBG_MATCH 1
60 #define FC_DBG_MATCHV 2
62 #define FC_DBG_FONTSET 8
63 #define FC_DBG_CACHE 16
64 #define FC_DBG_CACHEV 32
65 #define FC_DBG_PARSE 64
66 #define FC_DBG_SCAN 128
67 #define FC_DBG_SCANV 256
68 #define FC_DBG_MEMORY 512
69 #define FC_DBG_CONFIG 1024
71 #define FC_MEM_CHARSET 0
72 #define FC_MEM_CHARLEAF 1
73 #define FC_MEM_FONTSET 2
74 #define FC_MEM_FONTPTR 3
75 #define FC_MEM_OBJECTSET 4
76 #define FC_MEM_OBJECTPTR 5
77 #define FC_MEM_MATRIX 6
78 #define FC_MEM_PATTERN 7
79 #define FC_MEM_PATELT 8
80 #define FC_MEM_VALLIST 9
81 #define FC_MEM_SUBSTATE 10
82 #define FC_MEM_STRING 11
83 #define FC_MEM_LISTBUCK 12
84 #define FC_MEM_STRSET 13
85 #define FC_MEM_STRLIST 14
86 #define FC_MEM_CONFIG 15
87 #define FC_MEM_LANGSET 16
88 #define FC_MEM_ATOMIC 17
89 #define FC_MEM_BLANKS 18
90 #define FC_MEM_CACHE 19
91 #define FC_MEM_STRBUF 20
92 #define FC_MEM_SUBST 21
93 #define FC_MEM_OBJECTTYPE 22
94 #define FC_MEM_CONSTANT 23
95 #define FC_MEM_TEST 24
96 #define FC_MEM_EXPR 25
97 #define FC_MEM_VSTACK 26
98 #define FC_MEM_ATTR 27
99 #define FC_MEM_PSTACK 28
100 #define FC_MEM_STATICSTR 29
102 #define FC_MEM_NUM 30
104 #define FC_BANK_DYNAMIC 0
105 #define FC_BANK_FIRST 1
106 #define FC_BANK_LANGS 0xfcfcfcfc
108 typedef enum _FcValueBinding
{
109 FcValueBindingWeak
, FcValueBindingStrong
, FcValueBindingSame
112 typedef struct _FcValueListPtr
{
116 struct _FcValueList
*dyn
;
120 typedef struct _FcValueList
{
124 FcValueBinding binding
;
127 typedef int FcObjectPtr
;
129 typedef struct _FcPatternEltPtr
{
133 struct _FcPatternElt
*dyn
;
137 typedef struct _FcPatternElt
{
139 FcValueListPtr values
;
145 FcPatternEltPtr elts
;
151 FcOpInteger
, FcOpDouble
, FcOpString
, FcOpMatrix
, FcOpBool
, FcOpCharSet
,
153 FcOpField
, FcOpConst
,
154 FcOpAssign
, FcOpAssignReplace
,
155 FcOpPrependFirst
, FcOpPrepend
, FcOpAppend
, FcOpAppendLast
,
157 FcOpOr
, FcOpAnd
, FcOpEqual
, FcOpNotEqual
,
158 FcOpContains
, FcOpListing
, FcOpNotContains
,
159 FcOpLess
, FcOpLessEqual
, FcOpMore
, FcOpMoreEqual
,
160 FcOpPlus
, FcOpMinus
, FcOpTimes
, FcOpDivide
,
161 FcOpNot
, FcOpComma
, FcOpFloor
, FcOpCeil
, FcOpRound
, FcOpTrunc
,
165 typedef struct _FcExpr
{
177 struct _FcExpr
*left
, *right
;
182 typedef enum _FcQual
{
183 FcQualAny
, FcQualAll
, FcQualFirst
, FcQualNotFirst
186 #define FcMatchDefault ((FcMatchKind) -1)
188 typedef struct _FcTest
{
189 struct _FcTest
*next
;
197 typedef struct _FcEdit
{
198 struct _FcEdit
*next
;
202 FcValueBinding binding
;
205 typedef struct _FcSubst
{
206 struct _FcSubst
*next
;
211 typedef struct _FcCharLeaf
{
212 FcChar32 map
[256/32];
215 #define FC_REF_CONSTANT -1
218 int ref
; /* reference count */
219 int num
; /* size of leaves and numbers arrays */
234 int ref
; /* reference count */
245 typedef struct _FcStrBuf
{
253 typedef struct _FcCache
{
254 int magic
; /* 0xFC02FC02 */
255 int count
; /* number of bytes of data in block */
256 int bank
; /* bank ID */
257 int pattern_count
; /* number of FcPatterns */
258 int patternelt_count
; /* number of FcPatternElts */
259 int valuelist_count
; /* number of FcValueLists */
260 int str_count
; /* size of strings appearing as FcValues */
261 int langset_count
; /* number of FcLangSets */
262 int charset_count
; /* number of FcCharSets */
263 int charset_numbers_count
;
264 int charset_leaf_count
;
265 int charset_leaf_idx_count
;
269 * To map adobe glyph names to unicode values, a precomputed hash
273 typedef struct _FcGlyphName
{
274 FcChar32 ucs
; /* unicode value */
275 FcChar8 name
[1]; /* name extends beyond struct */
279 * To perform case-insensitive string comparisons, a table
280 * is used which holds three different kinds of folding data.
282 * The first is a range of upper case values mapping to a range
283 * of their lower case equivalents. Within each range, the offset
284 * between upper and lower case is constant.
286 * The second is a range of upper case values which are interleaved
287 * with their lower case equivalents.
289 * The third is a set of raw unicode values mapping to a list
290 * of unicode values for comparison purposes. This allows conversion
291 * of ß to "ss" so that SS, ss and ß all match. A separate array
292 * holds the list of unicode values for each entry.
294 * These are packed into a single table. Using a binary search,
295 * the appropriate entry can be located.
298 #define FC_CASE_FOLD_RANGE 0
299 #define FC_CASE_FOLD_EVEN_ODD 1
300 #define FC_CASE_FOLD_FULL 2
302 typedef struct _FcCaseFold
{
306 short offset
; /* lower - upper for RANGE, table id for FULL */
309 #define FC_MAX_FILE_LEN 4096
311 #define FC_STORAGE_STATIC 0x80
312 #define fc_value_string(v) (((v)->type & FC_STORAGE_STATIC) ? ((FcChar8 *) v) + (v)->u.s_off : (v) -> u.s)
313 #define fc_value_charset(v) (((v)->type & FC_STORAGE_STATIC) ? (const FcCharSet *)(((char *) v) + (v)->u.c_off) : (v) -> u.c)
314 #define fc_value_langset(v) (((v)->type & FC_STORAGE_STATIC) ? (const FcLangSet *)(((char *) v) + (v)->u.l_off) : (v) -> u.l)
315 #define fc_storage_type(v) ((v)->type & ~FC_STORAGE_STATIC)
318 * The per-user ~/.fonts.cache-<version> file is loaded into
319 * this data structure. Each directory gets a substructure
320 * which is validated by comparing the directory timestamp with
321 * that saved in the cache. When valid, the entire directory cache
322 * can be immediately loaded without reading the directory. Otherwise,
323 * the files are checked individually; updated files are loaded into the
324 * cache which is then rewritten to the users home directory
327 #define FC_CACHE_MAGIC 0xFC02FC02
329 typedef struct _FcGlobalCacheDir FcGlobalCacheDir
;
332 FcGCDirDisabled
, FcGCDirFileRead
, FcGCDirConsumed
, FcGCDirUpdated
334 struct _FcGlobalCacheDir
{
335 struct _FcGlobalCacheDir
*next
;
341 enum FcGCDirState state
;
344 typedef struct _FcGlobalCache
{
345 FcGlobalCacheDir
*dirs
;
351 FcChar8
*file
; /* original file name */
352 FcChar8
*new; /* temp file name -- write data here */
353 FcChar8
*lck
; /* lockfile name (used for locking) */
354 FcChar8
*tmp
; /* tmpfile name (used for locking) */
365 * File names loaded from the configuration -- saved here as the
366 * cache file must be consulted before the directories are scanned,
367 * and those directives may occur in any order
369 FcStrSet
*configDirs
; /* directories to scan for fonts */
370 FcChar8
*cache
; /* name of per-user cache file */
372 * Set of allowed blank chars -- used to
373 * trim fonts of bogus glyphs
377 * List of directories containing fonts,
378 * built by recursively scanning the set
379 * of configured directories
383 * Names of all of the configuration files used
384 * to create this configuration
386 FcStrSet
*configFiles
; /* config files loaded */
388 * Substitution instructions for patterns and fonts;
389 * maxObjects is used to allocate appropriate intermediate storage
390 * while performing a whole set of substitutions
392 FcSubst
*substPattern
; /* substitutions for patterns */
393 FcSubst
*substFont
; /* substitutions for fonts */
394 int maxObjects
; /* maximum number of tests in all substs */
396 * List of patterns used to control font file selection
398 FcStrSet
*acceptGlobs
;
399 FcStrSet
*rejectGlobs
;
400 FcFontSet
*acceptPatterns
;
401 FcFontSet
*rejectPatterns
;
403 * The set of fonts loaded from the listed directories; the
404 * order within the set does not determine the font selection,
405 * except in the case of identical matches in which case earlier fonts
406 * match preferrentially
408 FcFontSet
*fonts
[FcSetApplication
+ 1];
410 * Fontconfig can periodically rescan the system configuration
411 * and font directories. This rescanning occurs when font
412 * listing requests are made, but no more often than rescanInterval
415 time_t rescanTime
; /* last time information was scanned */
416 int rescanInterval
; /* interval between scans */
419 extern FcConfig
*_fcConfig
;
421 typedef struct _FcFileTime
{
426 typedef struct _FcCharMap FcCharMap
;
428 #define ALIGN(v,type) ((__typeof__(v))(((uintptr_t)(v) + __alignof__(type) - 1) & ~(__alignof__(type) - 1)))
435 FcGlobalCacheCreate (void);
438 FcGlobalCacheDestroy (FcGlobalCache
*cache
);
441 FcGlobalCacheReadDir (FcFontSet
*set
,
443 FcGlobalCache
*cache
,
448 FcGlobalCacheLoad (FcGlobalCache
*cache
,
450 const FcChar8
*cache_file
,
454 FcGlobalCacheUpdate (FcGlobalCache
*cache
,
461 FcGlobalCacheSave (FcGlobalCache
*cache
,
462 const FcChar8
*cache_file
,
466 FcCacheRead (FcConfig
*config
, FcGlobalCache
* cache
);
469 FcDirCacheWrite (FcFontSet
*set
, FcStrSet
* dirs
, const FcChar8
*dir
);
472 FcDirCacheRead (FcFontSet
* set
, FcStrSet
* dirs
, const FcChar8
*dir
, FcConfig
*config
);
474 extern int *_fcBankId
, *_fcBankIdx
;
476 FcCacheBankToIndexMTF (int bank
);
478 static __inline__
int
479 FcCacheBankToIndex (int bank
)
481 return (_fcBankId
[*_fcBankIdx
] == bank
) ? *_fcBankIdx
: FcCacheBankToIndexMTF(bank
);
485 FcCacheFindBankDir (int bank
);
490 FcConfigAddConfigDir (FcConfig
*config
,
494 FcConfigAddFontDir (FcConfig
*config
,
498 FcConfigAddDir (FcConfig
*config
,
502 FcConfigAddConfigFile (FcConfig
*config
,
506 FcConfigSetCache (FcConfig
*config
,
510 FcConfigAddBlank (FcConfig
*config
,
514 FcConfigAddEdit (FcConfig
*config
,
520 FcConfigSetFonts (FcConfig
*config
,
525 FcConfigCompareValue (const FcValue
*m
,
530 FcConfigGlobAdd (FcConfig
*config
,
535 FcConfigAcceptFilename (FcConfig
*config
,
536 const FcChar8
*filename
);
539 FcConfigPatternsAdd (FcConfig
*config
,
544 FcConfigAcceptFont (FcConfig
*config
,
545 const FcPattern
*font
);
548 FcConfigModifiedTime (FcConfig
*config
);
552 FcLangCharSetPopulate (void);
555 FcCharSetFreeze (FcCharSet
*cs
);
558 FcCharSetThawAll (void);
561 FcNameUnparseCharSet (FcStrBuf
*buf
, const FcCharSet
*c
);
564 FcNameParseCharSet (FcChar8
*string
);
567 FcCharSetFindLeafCreate (FcCharSet
*fcs
, FcChar32 ucs4
);
570 FcCharSetNewBank (void);
573 FcCharSetNeededBytes (const FcCharSet
*c
);
576 FcCharSetNeededBytesAlign (void);
579 FcCharSetDistributeBytes (FcCache
* metadata
,
583 FcCharSetSerialize(int bank
, FcCharSet
*c
);
586 FcCharSetUnserialize (FcCache
* metadata
, void *block_ptr
);
589 FcCharSetGetLeaf(const FcCharSet
*c
, int i
);
592 FcCharSetGetNumbers(const FcCharSet
*c
);
596 FcValueListPrint (const FcValueListPtr l
);
599 FcLangSetPrint (const FcLangSet
*ls
);
605 FcTestPrint (const FcTest
*test
);
608 FcExprPrint (const FcExpr
*expr
);
611 FcEditPrint (const FcEdit
*edit
);
614 FcSubstPrint (const FcSubst
*subst
);
616 extern int FcDebugVal
;
618 static __inline__
int
619 FcDebug (void) { return FcDebugVal
; }
626 FcGetDefaultLang (void);
631 FcFileIsDir (const FcChar8
*file
);
634 FcFileScanConfig (FcFontSet
*set
,
643 FcDirScanConfig (FcFontSet
*set
,
657 FcFreeTypeIsExclusiveLang (const FcChar8
*lang
);
660 FcFreeTypeHasLang (FcPattern
*pattern
, const FcChar8
*lang
);
663 FcFreeTypeUcs4ToPrivate (FcChar32 ucs4
, const FcCharMap
*map
);
666 FcFreeTypePrivateToUcs4 (FcChar32
private, const FcCharMap
*map
);
669 FcFreeTypeGetPrivateMap (FT_Encoding encoding
);
674 FcFontSetNewBank (void);
677 FcFontSetNeededBytes (FcFontSet
*s
);
680 FcFontSetNeededBytesAlign (void);
683 FcFontSetDistributeBytes (FcCache
* metadata
, void * block_ptr
);
686 FcFontSetSerialize (int bank
, FcFontSet
* s
);
689 FcFontSetUnserialize(FcCache
* metadata
, FcFontSet
* s
, void * block_ptr
);
693 FcConfigparse (void);
699 FcConfigerror (char *fmt
, ...);
702 FcConfigSaveField (const char *field
);
705 FcTestDestroy (FcTest
*test
);
708 FcExprCreateInteger (int i
);
711 FcExprCreateDouble (double d
);
714 FcExprCreateString (const FcChar8
*s
);
717 FcExprCreateMatrix (const FcMatrix
*m
);
720 FcExprCreateBool (FcBool b
);
723 FcExprCreateNil (void);
726 FcExprCreateField (const char *field
);
729 FcExprCreateConst (const FcChar8
*constant
);
732 FcExprCreateOp (FcExpr
*left
, FcOp op
, FcExpr
*right
);
735 FcExprDestroy (FcExpr
*e
);
738 FcEditDestroy (FcEdit
*e
);
746 FcMemAlloc (int kind
, int size
);
749 FcMemFree (int kind
, int size
);
753 FcFreeTypeLangSet (const FcCharSet
*charset
,
754 const FcChar8
*exclusiveLang
);
757 FcLangCompare (const FcChar8
*s1
, const FcChar8
*s2
);
760 FcCharSetForLang (const FcChar8
*lang
);
763 FcLangSetPromote (const FcChar8
*lang
);
766 FcNameParseLangSet (const FcChar8
*string
);
769 FcNameUnparseLangSet (FcStrBuf
*buf
, const FcLangSet
*ls
);
772 FcLangSetNewBank (void);
775 FcLangSetNeededBytes (const FcLangSet
*l
);
778 FcLangSetNeededBytesAlign (void);
781 FcLangSetDistributeBytes (FcCache
* metadata
,
785 FcLangSetSerialize (int bank
, FcLangSet
*l
);
788 FcLangSetUnserialize (FcCache
* metadata
, void *block_ptr
);
793 FcListPatternMatchAny (const FcPattern
*p
,
794 const FcPattern
*font
);
801 FcNameBool (const FcChar8
*v
, FcBool
*result
);
804 FcObjectDistributeBytes (FcCache
* metadata
,
808 FcObjectToPtr (const char * si
);
811 FcObjectNeededBytes (void);
814 FcObjectNeededBytesAlign (void);
817 FcObjectUnserialize (FcCache
* metadata
, void *block_ptr
);
820 FcObjectSerialize (void);
823 FcObjectPtrU (FcObjectPtr p
);
825 static __inline__
int
826 FcObjectPtrCompare (const FcObjectPtr a
, const FcObjectPtr b
)
832 FcObjectStaticNameFini (void);
837 FcValueCanonicalize (const FcValue
*v
);
840 FcValueListDestroy (FcValueListPtr l
);
843 FcPatternFindElt (const FcPattern
*p
, const char *object
);
846 FcPatternInsertElt (FcPattern
*p
, const char *object
);
849 FcPatternAddWithBinding (FcPattern
*p
,
852 FcValueBinding binding
,
856 FcPatternFreeze (FcPattern
*p
);
859 FcPatternFini (void);
862 FcPatternAppend (FcPattern
*p
, FcPattern
*s
);
865 FcPatternAddFullFname (const FcPattern
*p
, const char *fname
);
868 FcPatternTransferFullFname (const FcPattern
*new, const FcPattern
*orig
);
871 FcStrStaticName (const FcChar8
*name
);
874 FcStringHash (const FcChar8
*s
);
877 FcPatternNewBank (void);
880 FcPatternNeededBytes (FcPattern
*p
);
883 FcPatternNeededBytesAlign (void);
886 FcPatternDistributeBytes (FcCache
* metadata
, void * block_ptr
);
888 /* please don't access these outside of fcpat.c! only visible so that
889 * *PtrU can be inlined. */
890 extern FcValueList
** _fcValueLists
;
891 extern FcPatternElt
** _fcPatternElts
;
893 static __inline__ FcValueList
*
894 FcValueListPtrU (FcValueListPtr pi
)
896 if (pi
.bank
== FC_BANK_DYNAMIC
)
899 return &_fcValueLists
[FcCacheBankToIndex(pi
.bank
)][pi
.u
.stat
];
902 static __inline__ FcPatternElt
*
903 FcPatternEltU (FcPatternEltPtr pei
)
905 if (pei
.bank
== FC_BANK_DYNAMIC
)
908 return &_fcPatternElts
[FcCacheBankToIndex(pei
.bank
)][pei
.u
.stat
];
912 FcPatternEltU (FcPatternEltPtr pei
);
915 FcValueListPtrCreateDynamic(FcValueList
* p
);
918 FcPatternSerialize (int bank
, FcPattern
* p
);
921 FcPatternUnserialize (FcCache
* metadata
, void *block_ptr
);
927 extern const FcMatrix FcIdentityMatrix
;
930 FcMatrixFree (FcMatrix
*mat
);
934 FcStrSetSort (FcStrSet
* set
);
937 FcStrPlus (const FcChar8
*s1
, const FcChar8
*s2
);
940 FcStrFree (FcChar8
*s
);
943 FcStrBufInit (FcStrBuf
*buf
, FcChar8
*init
, int size
);
946 FcStrBufDestroy (FcStrBuf
*buf
);
949 FcStrBufDone (FcStrBuf
*buf
);
952 FcStrBufChar (FcStrBuf
*buf
, FcChar8 c
);
955 FcStrBufString (FcStrBuf
*buf
, const FcChar8
*s
);
958 FcStrBufData (FcStrBuf
*buf
, const FcChar8
*s
, int len
);
961 FcStrCmpIgnoreBlanksAndCase (const FcChar8
*s1
, const FcChar8
*s2
);
964 FcStrContainsIgnoreBlanksAndCase (const FcChar8
*s1
, const FcChar8
*s2
);
967 FcStrContainsIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
970 FcStrUsesHome (const FcChar8
*s
);
973 FcStrLastSlash (const FcChar8
*path
);
976 FcStrHashIgnoreCase (const FcChar8
*s
);
978 #endif /* _FC_INT_H_ */