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")
53 #define FC_SEARCH_PATH_SEPARATOR ';'
55 #define FC_SEARCH_PATH_SEPARATOR ':'
58 #define FC_DBG_MATCH 1
59 #define FC_DBG_MATCHV 2
61 #define FC_DBG_FONTSET 8
62 #define FC_DBG_CACHE 16
63 #define FC_DBG_CACHEV 32
64 #define FC_DBG_PARSE 64
65 #define FC_DBG_SCAN 128
66 #define FC_DBG_SCANV 256
67 #define FC_DBG_MEMORY 512
68 #define FC_DBG_CONFIG 1024
70 #define FC_MEM_CHARSET 0
71 #define FC_MEM_CHARLEAF 1
72 #define FC_MEM_FONTSET 2
73 #define FC_MEM_FONTPTR 3
74 #define FC_MEM_OBJECTSET 4
75 #define FC_MEM_OBJECTPTR 5
76 #define FC_MEM_MATRIX 6
77 #define FC_MEM_PATTERN 7
78 #define FC_MEM_PATELT 8
79 #define FC_MEM_VALLIST 9
80 #define FC_MEM_SUBSTATE 10
81 #define FC_MEM_STRING 11
82 #define FC_MEM_LISTBUCK 12
83 #define FC_MEM_STRSET 13
84 #define FC_MEM_STRLIST 14
85 #define FC_MEM_CONFIG 15
86 #define FC_MEM_LANGSET 16
87 #define FC_MEM_ATOMIC 17
88 #define FC_MEM_BLANKS 18
89 #define FC_MEM_CACHE 19
90 #define FC_MEM_STRBUF 20
91 #define FC_MEM_SUBST 21
92 #define FC_MEM_OBJECTTYPE 22
93 #define FC_MEM_CONSTANT 23
94 #define FC_MEM_TEST 24
95 #define FC_MEM_EXPR 25
96 #define FC_MEM_VSTACK 26
97 #define FC_MEM_ATTR 27
98 #define FC_MEM_PSTACK 28
99 #define FC_MEM_STATICSTR 29
101 #define FC_MEM_NUM 30
103 #define FC_BANK_LANGS 0xfcfcfcfc
105 typedef enum _FcValueBinding
{
106 FcValueBindingWeak
, FcValueBindingStrong
, FcValueBindingSame
109 typedef struct _FcValueListPtr
{
113 struct _FcValueList
*dyn
;
117 typedef struct _FcValueList
{
121 FcValueBinding binding
;
124 typedef int FcObjectPtr
;
126 typedef struct _FcPatternEltPtr
{
130 struct _FcPatternElt
*dyn
;
134 typedef struct _FcPatternElt
{
136 FcValueListPtr values
;
142 FcPatternEltPtr elts
;
148 FcOpInteger
, FcOpDouble
, FcOpString
, FcOpMatrix
, FcOpBool
, FcOpCharSet
,
150 FcOpField
, FcOpConst
,
151 FcOpAssign
, FcOpAssignReplace
,
152 FcOpPrependFirst
, FcOpPrepend
, FcOpAppend
, FcOpAppendLast
,
154 FcOpOr
, FcOpAnd
, FcOpEqual
, FcOpNotEqual
,
155 FcOpContains
, FcOpListing
, FcOpNotContains
,
156 FcOpLess
, FcOpLessEqual
, FcOpMore
, FcOpMoreEqual
,
157 FcOpPlus
, FcOpMinus
, FcOpTimes
, FcOpDivide
,
158 FcOpNot
, FcOpComma
, FcOpFloor
, FcOpCeil
, FcOpRound
, FcOpTrunc
,
162 typedef struct _FcExpr
{
174 struct _FcExpr
*left
, *right
;
179 typedef enum _FcQual
{
180 FcQualAny
, FcQualAll
, FcQualFirst
, FcQualNotFirst
183 #define FcMatchDefault ((FcMatchKind) -1)
185 typedef struct _FcTest
{
186 struct _FcTest
*next
;
194 typedef struct _FcEdit
{
195 struct _FcEdit
*next
;
199 FcValueBinding binding
;
202 typedef struct _FcSubst
{
203 struct _FcSubst
*next
;
208 typedef struct _FcCharLeaf
{
209 FcChar32 map
[256/32];
212 #define FC_REF_CONSTANT -1
215 int ref
; /* reference count */
216 int num
; /* size of leaves and numbers arrays */
231 int ref
; /* reference count */
242 typedef struct _FcStrBuf
{
250 typedef struct _FcCache
{
251 int magic
; /* 0xFC02FC02 */
252 int count
; /* number of bytes of data in block */
253 int bank
; /* bank ID */
254 int pattern_count
; /* number of FcPatterns */
255 int patternelt_count
; /* number of FcPatternElts */
256 int valuelist_count
; /* number of FcValueLists */
257 int str_count
; /* size of strings appearing as FcValues */
258 int langset_count
; /* number of FcLangSets */
259 int charset_count
; /* number of FcCharSets */
260 int charset_numbers_count
;
261 int charset_leaf_count
;
262 int charset_leaf_idx_count
;
266 * To map adobe glyph names to unicode values, a precomputed hash
270 typedef struct _FcGlyphName
{
271 FcChar32 ucs
; /* unicode value */
272 FcChar8 name
[1]; /* name extends beyond struct */
276 * To perform case-insensitive string comparisons, a table
277 * is used which holds three different kinds of folding data.
279 * The first is a range of upper case values mapping to a range
280 * of their lower case equivalents. Within each range, the offset
281 * between upper and lower case is constant.
283 * The second is a range of upper case values which are interleaved
284 * with their lower case equivalents.
286 * The third is a set of raw unicode values mapping to a list
287 * of unicode values for comparison purposes. This allows conversion
288 * of ß to "ss" so that SS, ss and ß all match. A separate array
289 * holds the list of unicode values for each entry.
291 * These are packed into a single table. Using a binary search,
292 * the appropriate entry can be located.
295 #define FC_CASE_FOLD_RANGE 0
296 #define FC_CASE_FOLD_EVEN_ODD 1
297 #define FC_CASE_FOLD_FULL 2
299 typedef struct _FcCaseFold
{
303 short offset
; /* lower - upper for RANGE, table id for FULL */
306 #define FC_MAX_FILE_LEN 4096
308 #define FC_STORAGE_STATIC 0x80
309 #define fc_value_string(v) (((v)->type & FC_STORAGE_STATIC) ? ((FcChar8 *) v) + (v)->u.s_off : (v) -> u.s)
310 #define fc_value_charset(v) (((v)->type & FC_STORAGE_STATIC) ? (const FcCharSet *)(((char *) v) + (v)->u.c_off) : (v) -> u.c)
311 #define fc_value_langset(v) (((v)->type & FC_STORAGE_STATIC) ? (const FcLangSet *)(((char *) v) + (v)->u.l_off) : (v) -> u.l)
314 * The per-user ~/.fonts.cache-<version> file is loaded into
315 * this data structure. Each directory gets a substructure
316 * which is validated by comparing the directory timestamp with
317 * that saved in the cache. When valid, the entire directory cache
318 * can be immediately loaded without reading the directory. Otherwise,
319 * the files are checked individually; updated files are loaded into the
320 * cache which is then rewritten to the users home directory
323 #define FC_CACHE_MAGIC 0xFC02FC02
325 typedef struct _FcGlobalCacheDir FcGlobalCacheDir
;
327 struct _FcGlobalCacheDir
{
328 struct _FcGlobalCacheDir
*next
;
335 typedef struct _FcGlobalCache
{
336 FcGlobalCacheDir
*dirs
;
342 FcChar8
*file
; /* original file name */
343 FcChar8
*new; /* temp file name -- write data here */
344 FcChar8
*lck
; /* lockfile name (used for locking) */
345 FcChar8
*tmp
; /* tmpfile name (used for locking) */
356 * File names loaded from the configuration -- saved here as the
357 * cache file must be consulted before the directories are scanned,
358 * and those directives may occur in any order
360 FcStrSet
*configDirs
; /* directories to scan for fonts */
361 FcChar8
*cache
; /* name of per-user cache file */
363 * Set of allowed blank chars -- used to
364 * trim fonts of bogus glyphs
368 * List of directories containing fonts,
369 * built by recursively scanning the set
370 * of configured directories
374 * Names of all of the configuration files used
375 * to create this configuration
377 FcStrSet
*configFiles
; /* config files loaded */
379 * Substitution instructions for patterns and fonts;
380 * maxObjects is used to allocate appropriate intermediate storage
381 * while performing a whole set of substitutions
383 FcSubst
*substPattern
; /* substitutions for patterns */
384 FcSubst
*substFont
; /* substitutions for fonts */
385 int maxObjects
; /* maximum number of tests in all substs */
387 * List of patterns used to control font file selection
389 FcStrSet
*acceptGlobs
;
390 FcStrSet
*rejectGlobs
;
391 FcFontSet
*acceptPatterns
;
392 FcFontSet
*rejectPatterns
;
394 * The set of fonts loaded from the listed directories; the
395 * order within the set does not determine the font selection,
396 * except in the case of identical matches in which case earlier fonts
397 * match preferrentially
399 FcFontSet
*fonts
[FcSetApplication
+ 1];
401 * Fontconfig can periodically rescan the system configuration
402 * and font directories. This rescanning occurs when font
403 * listing requests are made, but no more often than rescanInterval
406 time_t rescanTime
; /* last time information was scanned */
407 int rescanInterval
; /* interval between scans */
410 extern FcConfig
*_fcConfig
;
412 typedef struct _FcFileTime
{
417 typedef struct _FcCharMap FcCharMap
;
419 #define ALIGN(v,type) ((__typeof__(v))(((uintptr_t)(v) + __alignof__(type) - 1) & ~(__alignof__(type) - 1)))
426 FcGlobalCacheCreate (void);
429 FcGlobalCacheDestroy (FcGlobalCache
*cache
);
432 FcGlobalCacheReadDir (FcFontSet
*set
,
434 FcGlobalCache
*cache
,
439 FcGlobalCacheLoad (FcGlobalCache
*cache
,
441 const FcChar8
*cache_file
,
445 FcGlobalCacheUpdate (FcGlobalCache
*cache
,
450 FcGlobalCacheSave (FcGlobalCache
*cache
,
451 const FcChar8
*cache_file
);
454 FcCacheRead (FcConfig
*config
, FcGlobalCache
* cache
);
457 FcDirCacheWrite (FcFontSet
*set
, FcStrSet
* dirs
, const FcChar8
*dir
);
460 FcDirCacheRead (FcFontSet
* set
, FcStrSet
* dirs
, const FcChar8
*dir
);
463 FcCacheBankToIndex (int bank
);
466 FcCacheFindBankDir (int bank
);
471 FcConfigAddConfigDir (FcConfig
*config
,
475 FcConfigAddFontDir (FcConfig
*config
,
479 FcConfigAddDir (FcConfig
*config
,
483 FcConfigAddConfigFile (FcConfig
*config
,
487 FcConfigSetCache (FcConfig
*config
,
491 FcConfigAddBlank (FcConfig
*config
,
495 FcConfigAddEdit (FcConfig
*config
,
501 FcConfigSetFonts (FcConfig
*config
,
506 FcConfigCompareValue (const FcValue
*m
,
511 FcConfigGlobAdd (FcConfig
*config
,
516 FcConfigAcceptFilename (FcConfig
*config
,
517 const FcChar8
*filename
);
520 FcConfigPatternsAdd (FcConfig
*config
,
525 FcConfigAcceptFont (FcConfig
*config
,
526 const FcPattern
*font
);
529 FcConfigModifiedTime (FcConfig
*config
);
533 FcLangCharSetPopulate (void);
536 FcCharSetFreeze (FcCharSet
*cs
);
539 FcCharSetThawAll (void);
542 FcNameUnparseCharSet (FcStrBuf
*buf
, const FcCharSet
*c
);
545 FcNameParseCharSet (FcChar8
*string
);
548 FcCharSetFindLeafCreate (FcCharSet
*fcs
, FcChar32 ucs4
);
551 FcCharSetNewBank (void);
554 FcCharSetNeededBytes (const FcCharSet
*c
);
557 FcCharSetNeededBytesAlign (void);
560 FcCharSetDistributeBytes (FcCache
* metadata
,
564 FcCharSetSerialize(int bank
, FcCharSet
*c
);
567 FcCharSetUnserialize (FcCache metadata
, void *block_ptr
);
570 FcCharSetGetLeaf(const FcCharSet
*c
, int i
);
573 FcCharSetGetNumbers(const FcCharSet
*c
);
577 FcValueListPrint (const FcValueListPtr l
);
580 FcLangSetPrint (const FcLangSet
*ls
);
586 FcTestPrint (const FcTest
*test
);
589 FcExprPrint (const FcExpr
*expr
);
592 FcEditPrint (const FcEdit
*edit
);
595 FcSubstPrint (const FcSubst
*subst
);
597 extern int FcDebugVal
;
599 static __inline__
int
600 FcDebug (void) { return FcDebugVal
; }
607 FcGetDefaultLang (void);
612 FcFileIsDir (const FcChar8
*file
);
615 FcFileScanConfig (FcFontSet
*set
,
624 FcDirScanConfig (FcFontSet
*set
,
638 FcFreeTypeIsExclusiveLang (const FcChar8
*lang
);
641 FcFreeTypeHasLang (FcPattern
*pattern
, const FcChar8
*lang
);
644 FcFreeTypeUcs4ToPrivate (FcChar32 ucs4
, const FcCharMap
*map
);
647 FcFreeTypePrivateToUcs4 (FcChar32
private, const FcCharMap
*map
);
650 FcFreeTypeGetPrivateMap (FT_Encoding encoding
);
655 FcFontSetNewBank (void);
658 FcFontSetNeededBytes (FcFontSet
*s
);
661 FcFontSetNeededBytesAlign (void);
664 FcFontSetDistributeBytes (FcCache
* metadata
, void * block_ptr
);
667 FcFontSetSerialize (int bank
, FcFontSet
* s
);
670 FcFontSetUnserialize(FcCache metadata
, FcFontSet
* s
, void * block_ptr
);
674 FcConfigparse (void);
680 FcConfigerror (char *fmt
, ...);
683 FcConfigSaveField (const char *field
);
686 FcTestDestroy (FcTest
*test
);
689 FcExprCreateInteger (int i
);
692 FcExprCreateDouble (double d
);
695 FcExprCreateString (const FcChar8
*s
);
698 FcExprCreateMatrix (const FcMatrix
*m
);
701 FcExprCreateBool (FcBool b
);
704 FcExprCreateNil (void);
707 FcExprCreateField (const char *field
);
710 FcExprCreateConst (const FcChar8
*constant
);
713 FcExprCreateOp (FcExpr
*left
, FcOp op
, FcExpr
*right
);
716 FcExprDestroy (FcExpr
*e
);
719 FcEditDestroy (FcEdit
*e
);
727 FcMemAlloc (int kind
, int size
);
730 FcMemFree (int kind
, int size
);
734 FcFreeTypeLangSet (const FcCharSet
*charset
,
735 const FcChar8
*exclusiveLang
);
738 FcLangCompare (const FcChar8
*s1
, const FcChar8
*s2
);
741 FcCharSetForLang (const FcChar8
*lang
);
744 FcLangSetPromote (const FcChar8
*lang
);
747 FcNameParseLangSet (const FcChar8
*string
);
750 FcNameUnparseLangSet (FcStrBuf
*buf
, const FcLangSet
*ls
);
753 FcLangSetNewBank (void);
756 FcLangSetNeededBytes (const FcLangSet
*l
);
759 FcLangSetNeededBytesAlign (void);
762 FcLangSetDistributeBytes (FcCache
* metadata
,
766 FcLangSetSerialize (int bank
, FcLangSet
*l
);
769 FcLangSetUnserialize (FcCache metadata
, void *block_ptr
);
774 FcListPatternMatchAny (const FcPattern
*p
,
775 const FcPattern
*font
);
782 FcNameBool (const FcChar8
*v
, FcBool
*result
);
785 FcObjectDistributeBytes (FcCache
* metadata
,
789 FcObjectToPtr (const char * si
);
792 FcObjectNeededBytes (void);
795 FcObjectNeededBytesAlign (void);
798 FcObjectUnserialize (FcCache metadata
, void *block_ptr
);
801 FcObjectSerialize (void);
804 FcObjectPtrU (FcObjectPtr p
);
807 FcObjectPtrCompare (FcObjectPtr a
, FcObjectPtr b
);
810 FcObjectStaticNameFini (void);
815 FcValueCanonicalize (const FcValue
*v
);
818 FcValueListDestroy (FcValueListPtr l
);
821 FcPatternFindElt (const FcPattern
*p
, const char *object
);
824 FcPatternInsertElt (FcPattern
*p
, const char *object
);
827 FcPatternAddWithBinding (FcPattern
*p
,
830 FcValueBinding binding
,
834 FcPatternFreeze (FcPattern
*p
);
837 FcPatternFini (void);
840 FcPatternAppend (FcPattern
*p
, FcPattern
*s
);
843 FcPatternAddFullFname (const FcPattern
*p
, const char *fname
);
846 FcPatternTransferFullFname (const FcPattern
*new, const FcPattern
*orig
);
849 FcStrStaticName (const FcChar8
*name
);
852 FcStringHash (const FcChar8
*s
);
855 FcPatternNewBank (void);
858 FcPatternNeededBytes (FcPattern
*p
);
861 FcPatternNeededBytesAlign (void);
864 FcPatternDistributeBytes (FcCache
* metadata
, void * block_ptr
);
867 FcValueListPtrU(FcValueListPtr p
);
870 FcPatternEltU (FcPatternEltPtr pei
);
873 FcValueListPtrCreateDynamic(FcValueList
* p
);
876 FcPatternSerialize (int bank
, FcPattern
* p
);
879 FcPatternUnserialize (FcCache metadata
, void *block_ptr
);
885 extern const FcMatrix FcIdentityMatrix
;
888 FcMatrixFree (FcMatrix
*mat
);
892 FcStrSetSort (FcStrSet
* set
);
895 FcStrPlus (const FcChar8
*s1
, const FcChar8
*s2
);
898 FcStrFree (FcChar8
*s
);
901 FcStrBufInit (FcStrBuf
*buf
, FcChar8
*init
, int size
);
904 FcStrBufDestroy (FcStrBuf
*buf
);
907 FcStrBufDone (FcStrBuf
*buf
);
910 FcStrBufChar (FcStrBuf
*buf
, FcChar8 c
);
913 FcStrBufString (FcStrBuf
*buf
, const FcChar8
*s
);
916 FcStrBufData (FcStrBuf
*buf
, const FcChar8
*s
, int len
);
919 FcStrCmpIgnoreBlanksAndCase (const FcChar8
*s1
, const FcChar8
*s2
);
922 FcStrContainsIgnoreBlanksAndCase (const FcChar8
*s1
, const FcChar8
*s2
);
925 FcStrContainsIgnoreCase (const FcChar8
*s1
, const FcChar8
*s2
);
928 FcStrUsesHome (const FcChar8
*s
);
931 FcStrLastSlash (const FcChar8
*path
);
934 FcStrHashIgnoreCase (const FcChar8
*s
);
936 #endif /* _FC_INT_H_ */