Bug 59456 - Adding a --sysroot like option to fc-cache
[platform/upstream/fontconfig.git] / fontconfig / fontconfig.h
1 /*
2  * fontconfig/fontconfig/fontconfig.h
3  *
4  * Copyright © 2001 Keith Packard
5  *
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 the author(s) not be used in
11  * advertising or publicity pertaining to distribution of the software without
12  * specific, written prior permission.  The authors make no
13  * representations about the suitability of this software for any purpose.  It
14  * is provided "as is" without express or implied warranty.
15  *
16  * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18  * EVENT SHALL THE AUTHOR(S) 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.
23  */
24
25 #ifndef _FONTCONFIG_H_
26 #define _FONTCONFIG_H_
27
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #include <stdarg.h>
31
32 #if defined(__GNUC__) && (__GNUC__ >= 4)
33 #define FC_ATTRIBUTE_SENTINEL(x) __attribute__((__sentinel__(0)))
34 #else
35 #define FC_ATTRIBUTE_SENTINEL(x)
36 #endif
37
38 #ifndef FcPublic
39 #define FcPublic
40 #endif
41
42 typedef unsigned char   FcChar8;
43 typedef unsigned short  FcChar16;
44 typedef unsigned int    FcChar32;
45 typedef int             FcBool;
46
47 /*
48  * Current Fontconfig version number.  This same number
49  * must appear in the fontconfig configure.in file. Yes,
50  * it'a a pain to synchronize version numbers like this.
51  */
52
53 #define FC_MAJOR        2
54 #define FC_MINOR        10
55 #define FC_REVISION     91
56
57 #define FC_VERSION      ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
58
59 /*
60  * Current font cache file format version
61  * This is appended to the cache files so that multiple
62  * versions of the library will peacefully coexist
63  *
64  * Change this value whenever the disk format for the cache file
65  * changes in any non-compatible way.  Try to avoid such changes as
66  * it means multiple copies of the font information.
67  */
68
69 #define FC_CACHE_VERSION    "4"
70
71 #define FcTrue          1
72 #define FcFalse         0
73
74 #define FC_FAMILY           "family"            /* String */
75 #define FC_STYLE            "style"             /* String */
76 #define FC_SLANT            "slant"             /* Int */
77 #define FC_WEIGHT           "weight"            /* Int */
78 #define FC_SIZE             "size"              /* Double */
79 #define FC_ASPECT           "aspect"            /* Double */
80 #define FC_PIXEL_SIZE       "pixelsize"         /* Double */
81 #define FC_SPACING          "spacing"           /* Int */
82 #define FC_FOUNDRY          "foundry"           /* String */
83 #define FC_ANTIALIAS        "antialias"         /* Bool (depends) */
84 #define FC_HINTING          "hinting"           /* Bool (true) */
85 #define FC_HINT_STYLE       "hintstyle"         /* Int */
86 #define FC_VERTICAL_LAYOUT  "verticallayout"    /* Bool (false) */
87 #define FC_AUTOHINT         "autohint"          /* Bool (false) */
88 /* FC_GLOBAL_ADVANCE is deprecated. this is simply ignored on freetype 2.4.5 or later */
89 #define FC_GLOBAL_ADVANCE   "globaladvance"     /* Bool (true) */
90 #define FC_WIDTH            "width"             /* Int */
91 #define FC_FILE             "file"              /* String */
92 #define FC_INDEX            "index"             /* Int */
93 #define FC_FT_FACE          "ftface"            /* FT_Face */
94 #define FC_RASTERIZER       "rasterizer"        /* String */
95 #define FC_OUTLINE          "outline"           /* Bool */
96 #define FC_SCALABLE         "scalable"          /* Bool */
97 #define FC_SCALE            "scale"             /* double */
98 #define FC_DPI              "dpi"               /* double */
99 #define FC_RGBA             "rgba"              /* Int */
100 #define FC_MINSPACE         "minspace"          /* Bool use minimum line spacing */
101 #define FC_SOURCE           "source"            /* String (deprecated) */
102 #define FC_CHARSET          "charset"           /* CharSet */
103 #define FC_LANG             "lang"              /* String RFC 3066 langs */
104 #define FC_FONTVERSION      "fontversion"       /* Int from 'head' table */
105 #define FC_FULLNAME         "fullname"          /* String */
106 #define FC_FAMILYLANG       "familylang"        /* String RFC 3066 langs */
107 #define FC_STYLELANG        "stylelang"         /* String RFC 3066 langs */
108 #define FC_FULLNAMELANG     "fullnamelang"      /* String RFC 3066 langs */
109 #define FC_CAPABILITY       "capability"        /* String */
110 #define FC_FONTFORMAT       "fontformat"        /* String */
111 #define FC_EMBOLDEN         "embolden"          /* Bool - true if emboldening needed*/
112 #define FC_EMBEDDED_BITMAP  "embeddedbitmap"    /* Bool - true to enable embedded bitmaps */
113 #define FC_DECORATIVE       "decorative"        /* Bool - true if style is a decorative variant */
114 #define FC_LCD_FILTER       "lcdfilter"         /* Int */
115 #define FC_FONT_FEATURES    "fontfeatures"      /* String */
116 #define FC_NAMELANG         "namelang"          /* String RFC 3866 langs */
117 #define FC_PRGNAME          "prgname"           /* String */
118 #define FC_HASH             "hash"              /* String */
119
120 #define FC_CACHE_SUFFIX             ".cache-" FC_CACHE_VERSION
121 #define FC_DIR_CACHE_FILE           "fonts.cache-" FC_CACHE_VERSION
122 #define FC_USER_CACHE_FILE          ".fonts.cache-" FC_CACHE_VERSION
123
124 /* Adjust outline rasterizer */
125 #define FC_CHAR_WIDTH       "charwidth" /* Int */
126 #define FC_CHAR_HEIGHT      "charheight"/* Int */
127 #define FC_MATRIX           "matrix"    /* FcMatrix */
128
129 #define FC_WEIGHT_THIN              0
130 #define FC_WEIGHT_EXTRALIGHT        40
131 #define FC_WEIGHT_ULTRALIGHT        FC_WEIGHT_EXTRALIGHT
132 #define FC_WEIGHT_LIGHT             50
133 #define FC_WEIGHT_BOOK              75
134 #define FC_WEIGHT_REGULAR           80
135 #define FC_WEIGHT_NORMAL            FC_WEIGHT_REGULAR
136 #define FC_WEIGHT_MEDIUM            100
137 #define FC_WEIGHT_DEMIBOLD          180
138 #define FC_WEIGHT_SEMIBOLD          FC_WEIGHT_DEMIBOLD
139 #define FC_WEIGHT_BOLD              200
140 #define FC_WEIGHT_EXTRABOLD         205
141 #define FC_WEIGHT_ULTRABOLD         FC_WEIGHT_EXTRABOLD
142 #define FC_WEIGHT_BLACK             210
143 #define FC_WEIGHT_HEAVY             FC_WEIGHT_BLACK
144 #define FC_WEIGHT_EXTRABLACK        215
145 #define FC_WEIGHT_ULTRABLACK        FC_WEIGHT_EXTRABLACK
146
147 #define FC_SLANT_ROMAN              0
148 #define FC_SLANT_ITALIC             100
149 #define FC_SLANT_OBLIQUE            110
150
151 #define FC_WIDTH_ULTRACONDENSED     50
152 #define FC_WIDTH_EXTRACONDENSED     63
153 #define FC_WIDTH_CONDENSED          75
154 #define FC_WIDTH_SEMICONDENSED      87
155 #define FC_WIDTH_NORMAL             100
156 #define FC_WIDTH_SEMIEXPANDED       113
157 #define FC_WIDTH_EXPANDED           125
158 #define FC_WIDTH_EXTRAEXPANDED      150
159 #define FC_WIDTH_ULTRAEXPANDED      200
160
161 #define FC_PROPORTIONAL             0
162 #define FC_DUAL                     90
163 #define FC_MONO                     100
164 #define FC_CHARCELL                 110
165
166 /* sub-pixel order */
167 #define FC_RGBA_UNKNOWN     0
168 #define FC_RGBA_RGB         1
169 #define FC_RGBA_BGR         2
170 #define FC_RGBA_VRGB        3
171 #define FC_RGBA_VBGR        4
172 #define FC_RGBA_NONE        5
173
174 /* hinting style */
175 #define FC_HINT_NONE        0
176 #define FC_HINT_SLIGHT      1
177 #define FC_HINT_MEDIUM      2
178 #define FC_HINT_FULL        3
179
180 /* LCD filter */
181 #define FC_LCD_NONE         0
182 #define FC_LCD_DEFAULT      1
183 #define FC_LCD_LIGHT        2
184 #define FC_LCD_LEGACY       3
185
186 typedef enum _FcType {
187     FcTypeVoid,
188     FcTypeInteger,
189     FcTypeDouble,
190     FcTypeString,
191     FcTypeBool,
192     FcTypeMatrix,
193     FcTypeCharSet,
194     FcTypeFTFace,
195     FcTypeLangSet
196 } FcType;
197
198 typedef struct _FcMatrix {
199     double xx, xy, yx, yy;
200 } FcMatrix;
201
202 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
203                          (m)->xy = (m)->yx = 0)
204
205 /*
206  * A data structure to represent the available glyphs in a font.
207  * This is represented as a sparse boolean btree.
208  */
209
210 typedef struct _FcCharSet FcCharSet;
211
212 typedef struct _FcObjectType {
213     const char  *object;
214     FcType      type;
215 } FcObjectType;
216
217 typedef struct _FcConstant {
218     const FcChar8  *name;
219     const char  *object;
220     int         value;
221 } FcConstant;
222
223 typedef enum _FcResult {
224     FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId,
225     FcResultOutOfMemory
226 } FcResult;
227
228 typedef struct _FcPattern   FcPattern;
229
230 typedef struct _FcLangSet   FcLangSet;
231
232 typedef struct _FcValue {
233     FcType      type;
234     union {
235         const FcChar8   *s;
236         int             i;
237         FcBool          b;
238         double          d;
239         const FcMatrix  *m;
240         const FcCharSet *c;
241         void            *f;
242         const FcLangSet *l;
243     } u;
244 } FcValue;
245
246 typedef struct _FcFontSet {
247     int         nfont;
248     int         sfont;
249     FcPattern   **fonts;
250 } FcFontSet;
251
252 typedef struct _FcObjectSet {
253     int         nobject;
254     int         sobject;
255     const char  **objects;
256 } FcObjectSet;
257     
258 typedef enum _FcMatchKind {
259     FcMatchPattern, FcMatchFont, FcMatchScan
260 } FcMatchKind;
261
262 typedef enum _FcLangResult {
263     FcLangEqual = 0,
264     FcLangDifferentCountry = 1,
265     FcLangDifferentTerritory = 1,
266     FcLangDifferentLang = 2
267 } FcLangResult;
268
269 typedef enum _FcSetName {
270     FcSetSystem = 0,
271     FcSetApplication = 1
272 } FcSetName;
273
274 typedef struct _FcAtomic FcAtomic;
275
276 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
277 #define _FCFUNCPROTOBEGIN extern "C" {  /* do not leave open across includes */
278 #define _FCFUNCPROTOEND }
279 #else
280 #define _FCFUNCPROTOBEGIN
281 #define _FCFUNCPROTOEND
282 #endif
283
284 typedef enum { FcEndianBig, FcEndianLittle } FcEndian;
285
286 typedef struct _FcConfig    FcConfig;
287
288 typedef struct _FcGlobalCache   FcFileCache;
289
290 typedef struct _FcBlanks    FcBlanks;
291
292 typedef struct _FcStrList   FcStrList;
293
294 typedef struct _FcStrSet    FcStrSet;
295
296 typedef struct _FcCache     FcCache;
297
298 _FCFUNCPROTOBEGIN
299
300 /* fcblanks.c */
301 FcPublic FcBlanks *
302 FcBlanksCreate (void);
303
304 FcPublic void
305 FcBlanksDestroy (FcBlanks *b);
306
307 FcPublic FcBool
308 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
309
310 FcPublic FcBool
311 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
312
313 /* fccache.c */
314
315 FcPublic const FcChar8 *
316 FcCacheDir(const FcCache *c);
317
318 FcPublic FcFontSet *
319 FcCacheCopySet(const FcCache *c);
320
321 FcPublic const FcChar8 *
322 FcCacheSubdir (const FcCache *c, int i);
323
324 FcPublic int
325 FcCacheNumSubdir (const FcCache *c);
326
327 FcPublic int
328 FcCacheNumFont (const FcCache *c);
329
330 FcPublic FcBool
331 FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config);
332
333 FcPublic FcBool
334 FcDirCacheValid (const FcChar8 *cache_file);
335
336 FcPublic FcBool
337 FcDirCacheClean (const FcChar8 *cache_dir, FcBool verbose);
338
339 FcPublic void
340 FcCacheCreateTagFile (const FcConfig *config);
341
342 /* fccfg.c */
343 FcPublic FcChar8 *
344 FcConfigHome (void);
345
346 FcPublic FcBool
347 FcConfigEnableHome (FcBool enable);
348
349 FcPublic FcChar8 *
350 FcConfigFilename (const FcChar8 *url);
351     
352 FcPublic FcConfig *
353 FcConfigCreate (void);
354
355 FcPublic FcConfig *
356 FcConfigReference (FcConfig *config);
357
358 FcPublic void
359 FcConfigDestroy (FcConfig *config);
360
361 FcPublic FcBool
362 FcConfigSetCurrent (FcConfig *config);
363
364 FcPublic FcConfig *
365 FcConfigGetCurrent (void);
366
367 FcPublic FcBool
368 FcConfigUptoDate (FcConfig *config);
369     
370 FcPublic FcBool
371 FcConfigBuildFonts (FcConfig *config);
372
373 FcPublic FcStrList *
374 FcConfigGetFontDirs (FcConfig   *config);
375
376 FcPublic FcStrList *
377 FcConfigGetConfigDirs (FcConfig   *config);
378
379 FcPublic FcStrList *
380 FcConfigGetConfigFiles (FcConfig    *config);
381
382 FcPublic FcChar8 *
383 FcConfigGetCache (FcConfig  *config);
384
385 FcPublic FcBlanks *
386 FcConfigGetBlanks (FcConfig *config);
387
388 FcPublic FcStrList *
389 FcConfigGetCacheDirs (const FcConfig    *config);
390
391 FcPublic int
392 FcConfigGetRescanInterval (FcConfig *config);
393
394 FcPublic FcBool
395 FcConfigSetRescanInterval (FcConfig *config, int rescanInterval);
396
397 FcPublic FcFontSet *
398 FcConfigGetFonts (FcConfig      *config,
399                   FcSetName     set);
400
401 FcPublic FcBool
402 FcConfigAppFontAddFile (FcConfig    *config,
403                         const FcChar8  *file);
404
405 FcPublic FcBool
406 FcConfigAppFontAddDir (FcConfig     *config,
407                        const FcChar8   *dir);
408
409 FcPublic void
410 FcConfigAppFontClear (FcConfig      *config);
411
412 FcPublic FcBool
413 FcConfigSubstituteWithPat (FcConfig     *config,
414                            FcPattern    *p,
415                            FcPattern    *p_pat,
416                            FcMatchKind  kind);
417
418 FcPublic FcBool
419 FcConfigSubstitute (FcConfig    *config,
420                     FcPattern   *p,
421                     FcMatchKind kind);
422
423 FcPublic const FcChar8 *
424 FcConfigGetSysRoot (const FcConfig *config);
425
426 FcPublic void
427 FcConfigSetSysRoot (FcConfig      *config,
428                     const FcChar8 *sysroot);
429
430 /* fccharset.c */
431 FcPublic FcCharSet*
432 FcCharSetCreate (void);
433
434 /* deprecated alias for FcCharSetCreate */
435 FcPublic FcCharSet *
436 FcCharSetNew (void);
437
438 FcPublic void
439 FcCharSetDestroy (FcCharSet *fcs);
440
441 FcPublic FcBool
442 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
443
444 FcPublic FcBool
445 FcCharSetDelChar (FcCharSet *fcs, FcChar32 ucs4);
446
447 FcPublic FcCharSet*
448 FcCharSetCopy (FcCharSet *src);
449
450 FcPublic FcBool
451 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
452
453 FcPublic FcCharSet*
454 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
455
456 FcPublic FcCharSet*
457 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
458
459 FcPublic FcCharSet*
460 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
461
462 FcPublic FcBool
463 FcCharSetMerge (FcCharSet *a, const FcCharSet *b, FcBool *changed);
464
465 FcPublic FcBool
466 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
467
468 FcPublic FcChar32
469 FcCharSetCount (const FcCharSet *a);
470
471 FcPublic FcChar32
472 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
473
474 FcPublic FcChar32
475 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
476
477 FcPublic FcBool
478 FcCharSetIsSubset (const FcCharSet *a, const FcCharSet *b);
479
480 #define FC_CHARSET_MAP_SIZE (256/32)
481 #define FC_CHARSET_DONE ((FcChar32) -1)
482
483 FcPublic FcChar32
484 FcCharSetFirstPage (const FcCharSet *a, 
485                     FcChar32        map[FC_CHARSET_MAP_SIZE],
486                     FcChar32        *next);
487
488 FcPublic FcChar32
489 FcCharSetNextPage (const FcCharSet  *a, 
490                    FcChar32         map[FC_CHARSET_MAP_SIZE],
491                    FcChar32         *next);
492
493 /*
494  * old coverage API, rather hard to use correctly
495  */
496
497 FcPublic FcChar32
498 FcCharSetCoverage (const FcCharSet *a, FcChar32 page, FcChar32 *result);
499
500 /* fcdbg.c */
501 FcPublic void
502 FcValuePrint (const FcValue v);
503
504 FcPublic void
505 FcPatternPrint (const FcPattern *p);
506
507 FcPublic void
508 FcFontSetPrint (const FcFontSet *s);
509
510 /* fcdefault.c */
511 FcPublic FcStrSet *
512 FcGetDefaultLangs (void);
513
514 FcPublic void
515 FcDefaultSubstitute (FcPattern *pattern);
516
517 /* fcdir.c */
518 FcPublic FcBool
519 FcFileIsDir (const FcChar8 *file);
520
521 FcPublic FcBool
522 FcFileScan (FcFontSet       *set,
523             FcStrSet        *dirs,
524             FcFileCache     *cache,
525             FcBlanks        *blanks,
526             const FcChar8   *file,
527             FcBool          force);
528
529 FcPublic FcBool
530 FcDirScan (FcFontSet        *set,
531            FcStrSet         *dirs,
532            FcFileCache      *cache,
533            FcBlanks         *blanks,
534            const FcChar8    *dir,
535            FcBool           force);
536
537 FcPublic FcBool
538 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
539
540 FcPublic FcCache *
541 FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file);
542     
543 FcPublic FcCache *
544 FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config);
545
546 FcPublic FcCache *
547 FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat);
548
549 FcPublic void
550 FcDirCacheUnload (FcCache *cache);
551
552 /* fcfreetype.c */
553 FcPublic FcPattern *
554 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
555
556 /* fcfs.c */
557
558 FcPublic FcFontSet *
559 FcFontSetCreate (void);
560
561 FcPublic void
562 FcFontSetDestroy (FcFontSet *s);
563
564 FcPublic FcBool
565 FcFontSetAdd (FcFontSet *s, FcPattern *font);
566
567 /* fcinit.c */
568 FcPublic FcConfig *
569 FcInitLoadConfig (void);
570
571 FcPublic FcConfig *
572 FcInitLoadConfigAndFonts (void);
573
574 FcPublic FcBool
575 FcInit (void);
576
577 FcPublic void
578 FcFini (void);
579
580 FcPublic int
581 FcGetVersion (void);
582
583 FcPublic FcBool
584 FcInitReinitialize (void);
585
586 FcPublic FcBool
587 FcInitBringUptoDate (void);
588
589 /* fclang.c */
590 FcPublic FcStrSet *
591 FcGetLangs (void);
592
593 FcPublic FcChar8 *
594 FcLangNormalize (const FcChar8 *lang);
595
596 FcPublic const FcCharSet *
597 FcLangGetCharSet (const FcChar8 *lang);
598
599 FcPublic FcLangSet*
600 FcLangSetCreate (void);
601
602 FcPublic void
603 FcLangSetDestroy (FcLangSet *ls);
604
605 FcPublic FcLangSet*
606 FcLangSetCopy (const FcLangSet *ls);
607
608 FcPublic FcBool
609 FcLangSetAdd (FcLangSet *ls, const FcChar8 *lang);
610
611 FcPublic FcBool
612 FcLangSetDel (FcLangSet *ls, const FcChar8 *lang);
613
614 FcPublic FcLangResult
615 FcLangSetHasLang (const FcLangSet *ls, const FcChar8 *lang);
616
617 FcPublic FcLangResult
618 FcLangSetCompare (const FcLangSet *lsa, const FcLangSet *lsb);
619
620 FcPublic FcBool
621 FcLangSetContains (const FcLangSet *lsa, const FcLangSet *lsb);
622
623 FcPublic FcBool
624 FcLangSetEqual (const FcLangSet *lsa, const FcLangSet *lsb);
625
626 FcPublic FcChar32
627 FcLangSetHash (const FcLangSet *ls);
628
629 FcPublic FcStrSet *
630 FcLangSetGetLangs (const FcLangSet *ls);
631
632 FcPublic FcLangSet *
633 FcLangSetUnion (const FcLangSet *a, const FcLangSet *b);
634
635 FcPublic FcLangSet *
636 FcLangSetSubtract (const FcLangSet *a, const FcLangSet *b);
637
638 /* fclist.c */
639 FcPublic FcObjectSet *
640 FcObjectSetCreate (void);
641
642 FcPublic FcBool
643 FcObjectSetAdd (FcObjectSet *os, const char *object);
644
645 FcPublic void
646 FcObjectSetDestroy (FcObjectSet *os);
647
648 FcPublic FcObjectSet *
649 FcObjectSetVaBuild (const char *first, va_list va);
650
651 FcPublic FcObjectSet *
652 FcObjectSetBuild (const char *first, ...) FC_ATTRIBUTE_SENTINEL(0);
653
654 FcPublic FcFontSet *
655 FcFontSetList (FcConfig     *config,
656                FcFontSet    **sets,
657                int          nsets,
658                FcPattern    *p,
659                FcObjectSet  *os);
660
661 FcPublic FcFontSet *
662 FcFontList (FcConfig    *config,
663             FcPattern   *p,
664             FcObjectSet *os);
665
666 /* fcatomic.c */
667
668 FcPublic FcAtomic *
669 FcAtomicCreate (const FcChar8   *file);
670
671 FcPublic FcBool
672 FcAtomicLock (FcAtomic *atomic);
673
674 FcPublic FcChar8 *
675 FcAtomicNewFile (FcAtomic *atomic);
676
677 FcPublic FcChar8 *
678 FcAtomicOrigFile (FcAtomic *atomic);
679
680 FcPublic FcBool
681 FcAtomicReplaceOrig (FcAtomic *atomic);
682
683 FcPublic void
684 FcAtomicDeleteNew (FcAtomic *atomic);
685
686 FcPublic void
687 FcAtomicUnlock (FcAtomic *atomic);
688
689 FcPublic void
690 FcAtomicDestroy (FcAtomic *atomic);
691
692 /* fcmatch.c */
693 FcPublic FcPattern *
694 FcFontSetMatch (FcConfig    *config,
695                 FcFontSet   **sets,
696                 int         nsets,
697                 FcPattern   *p,
698                 FcResult    *result);
699
700 FcPublic FcPattern *
701 FcFontMatch (FcConfig   *config,
702              FcPattern  *p, 
703              FcResult   *result);
704
705 FcPublic FcPattern *
706 FcFontRenderPrepare (FcConfig       *config,
707                      FcPattern      *pat,
708                      FcPattern      *font);
709
710 FcPublic FcFontSet *
711 FcFontSetSort (FcConfig     *config,
712                FcFontSet    **sets,
713                int          nsets,
714                FcPattern    *p,
715                FcBool       trim,
716                FcCharSet    **csp,
717                FcResult     *result);
718
719 FcPublic FcFontSet *
720 FcFontSort (FcConfig     *config,
721             FcPattern    *p,
722             FcBool       trim,
723             FcCharSet    **csp,
724             FcResult     *result);
725
726 FcPublic void
727 FcFontSetSortDestroy (FcFontSet *fs);
728
729 /* fcmatrix.c */
730 FcPublic FcMatrix *
731 FcMatrixCopy (const FcMatrix *mat);
732
733 FcPublic FcBool
734 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
735
736 FcPublic void
737 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
738
739 FcPublic void
740 FcMatrixRotate (FcMatrix *m, double c, double s);
741
742 FcPublic void
743 FcMatrixScale (FcMatrix *m, double sx, double sy);
744
745 FcPublic void
746 FcMatrixShear (FcMatrix *m, double sh, double sv);
747
748 /* fcname.c */
749
750 /* Deprecated.  Does nothing.  Returns FcFalse. */
751 FcPublic FcBool
752 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
753
754 /* Deprecated.  Does nothing.  Returns FcFalse. */
755 FcPublic FcBool
756 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
757
758 FcPublic const FcObjectType *
759 FcNameGetObjectType (const char *object);
760
761 /* Deprecated.  Does nothing.  Returns FcFalse. */
762 FcPublic FcBool
763 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
764
765 /* Deprecated.  Does nothing.  Returns FcFalse. */
766 FcPublic FcBool
767 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
768
769 FcPublic const FcConstant *
770 FcNameGetConstant (const FcChar8 *string);
771
772 FcPublic FcBool
773 FcNameConstant (const FcChar8 *string, int *result);
774
775 FcPublic FcPattern *
776 FcNameParse (const FcChar8 *name);
777
778 FcPublic FcChar8 *
779 FcNameUnparse (FcPattern *pat);
780
781 /* fcpat.c */
782 FcPublic FcPattern *
783 FcPatternCreate (void);
784
785 FcPublic FcPattern *
786 FcPatternDuplicate (const FcPattern *p);
787
788 FcPublic void
789 FcPatternReference (FcPattern *p);
790
791 FcPublic FcPattern *
792 FcPatternFilter (FcPattern *p, const FcObjectSet *os);
793
794 FcPublic void
795 FcValueDestroy (FcValue v);
796
797 FcPublic FcBool
798 FcValueEqual (FcValue va, FcValue vb);
799
800 FcPublic FcValue
801 FcValueSave (FcValue v);
802
803 FcPublic void
804 FcPatternDestroy (FcPattern *p);
805
806 FcPublic FcBool
807 FcPatternEqual (const FcPattern *pa, const FcPattern *pb);
808
809 FcPublic FcBool
810 FcPatternEqualSubset (const FcPattern *pa, const FcPattern *pb, const FcObjectSet *os);
811
812 FcPublic FcChar32
813 FcPatternHash (const FcPattern *p);
814
815 FcPublic FcBool
816 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
817     
818 FcPublic FcBool
819 FcPatternAddWeak (FcPattern *p, const char *object, FcValue value, FcBool append);
820     
821 FcPublic FcResult
822 FcPatternGet (const FcPattern *p, const char *object, int id, FcValue *v);
823     
824 FcPublic FcBool
825 FcPatternDel (FcPattern *p, const char *object);
826
827 FcPublic FcBool
828 FcPatternRemove (FcPattern *p, const char *object, int id);
829
830 FcPublic FcBool
831 FcPatternAddInteger (FcPattern *p, const char *object, int i);
832
833 FcPublic FcBool
834 FcPatternAddDouble (FcPattern *p, const char *object, double d);
835
836 FcPublic FcBool
837 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
838
839 FcPublic FcBool
840 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
841
842 FcPublic FcBool
843 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
844
845 FcPublic FcBool
846 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
847
848 FcPublic FcBool
849 FcPatternAddLangSet (FcPattern *p, const char *object, const FcLangSet *ls);
850
851 FcPublic FcResult
852 FcPatternGetInteger (const FcPattern *p, const char *object, int n, int *i);
853
854 FcPublic FcResult
855 FcPatternGetDouble (const FcPattern *p, const char *object, int n, double *d);
856
857 FcPublic FcResult
858 FcPatternGetString (const FcPattern *p, const char *object, int n, FcChar8 ** s);
859
860 FcPublic FcResult
861 FcPatternGetMatrix (const FcPattern *p, const char *object, int n, FcMatrix **s);
862
863 FcPublic FcResult
864 FcPatternGetCharSet (const FcPattern *p, const char *object, int n, FcCharSet **c);
865
866 FcPublic FcResult
867 FcPatternGetBool (const FcPattern *p, const char *object, int n, FcBool *b);
868
869 FcPublic FcResult
870 FcPatternGetLangSet (const FcPattern *p, const char *object, int n, FcLangSet **ls);
871
872 FcPublic FcPattern *
873 FcPatternVaBuild (FcPattern *p, va_list va);
874     
875 FcPublic FcPattern *
876 FcPatternBuild (FcPattern *p, ...) FC_ATTRIBUTE_SENTINEL(0);
877
878 FcPublic FcChar8 *
879 FcPatternFormat (FcPattern *pat, const FcChar8 *format);
880
881 /* fcstr.c */
882
883 FcPublic FcChar8 *
884 FcStrCopy (const FcChar8 *s);
885
886 FcPublic FcChar8 *
887 FcStrCopyFilename (const FcChar8 *s);
888     
889 FcPublic FcChar8 *
890 FcStrPlus (const FcChar8 *s1, const FcChar8 *s2);
891     
892 FcPublic void
893 FcStrFree (FcChar8 *s);
894
895 /* These are ASCII only, suitable only for pattern element names */
896 #define FcIsUpper(c)    ((0101 <= (c) && (c) <= 0132))
897 #define FcIsLower(c)    ((0141 <= (c) && (c) <= 0172))
898 #define FcToLower(c)    (FcIsUpper(c) ? (c) - 0101 + 0141 : (c))
899
900 FcPublic FcChar8 *
901 FcStrDowncase (const FcChar8 *s);
902
903 FcPublic int
904 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
905
906 FcPublic int
907 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
908
909 FcPublic const FcChar8 *
910 FcStrStrIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
911
912 FcPublic const FcChar8 *
913 FcStrStr (const FcChar8 *s1, const FcChar8 *s2);
914
915 FcPublic int
916 FcUtf8ToUcs4 (const FcChar8 *src_orig,
917               FcChar32      *dst,
918               int           len);
919
920 FcPublic FcBool
921 FcUtf8Len (const FcChar8    *string,
922            int              len,
923            int              *nchar,
924            int              *wchar);
925
926 #define FC_UTF8_MAX_LEN 6
927
928 FcPublic int
929 FcUcs4ToUtf8 (FcChar32  ucs4,
930               FcChar8   dest[FC_UTF8_MAX_LEN]);
931
932 FcPublic int
933 FcUtf16ToUcs4 (const FcChar8    *src_orig,
934                FcEndian         endian,
935                FcChar32         *dst,
936                int              len);       /* in bytes */
937
938 FcPublic FcBool
939 FcUtf16Len (const FcChar8   *string,
940             FcEndian        endian,
941             int             len,            /* in bytes */
942             int             *nchar,
943             int             *wchar);
944
945 FcPublic FcChar8 *
946 FcStrDirname (const FcChar8 *file);
947
948 FcPublic FcChar8 *
949 FcStrBasename (const FcChar8 *file);
950
951 FcPublic FcStrSet *
952 FcStrSetCreate (void);
953
954 FcPublic FcBool
955 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
956
957 FcPublic FcBool
958 FcStrSetEqual (FcStrSet *sa, FcStrSet *sb);
959
960 FcPublic FcBool
961 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
962
963 FcPublic FcBool
964 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
965
966 FcPublic FcBool
967 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
968
969 FcPublic void
970 FcStrSetDestroy (FcStrSet *set);
971
972 FcPublic FcStrList *
973 FcStrListCreate (FcStrSet *set);
974
975 FcPublic FcChar8 *
976 FcStrListNext (FcStrList *list);
977
978 FcPublic void
979 FcStrListDone (FcStrList *list);
980
981 /* fcxml.c */
982 FcPublic FcBool
983 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
984
985 _FCFUNCPROTOEND
986
987 #undef FC_ATTRIBUTE_SENTINEL
988
989
990 #ifndef _FCINT_H_
991
992 /*
993  * Deprecated functions are placed here to help users fix their code without
994  * digging through documentation
995  */
996  
997 #define FcConfigGetRescanInverval   FcConfigGetRescanInverval_REPLACE_BY_FcConfigGetRescanInterval
998 #define FcConfigSetRescanInverval   FcConfigSetRescanInverval_REPLACE_BY_FcConfigSetRescanInterval
999
1000 #endif
1001
1002 #endif /* _FONTCONFIG_H_ */