]> git.wh0rd.org - fontconfig.git/blob - fontconfig/fontconfig.h
Change charset enumeration functions to more sensible API
[fontconfig.git] / fontconfig / fontconfig.h
1 /*
2 * $XFree86: xc/lib/fontconfig/fontconfig/fontconfig.h,v 1.9 2002/05/22 04:37:07 keithp Exp $
3 *
4 * Copyright © 2001 Keith Packard, member of The XFree86 Project, Inc.
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 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.
15 *
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.
23 */
24
25 #ifndef _FONTCONFIG_H_
26 #define _FONTCONFIG_H_
27
28 #include <stdarg.h>
29
30 typedef unsigned char FcChar8;
31 typedef unsigned short FcChar16;
32 typedef unsigned int FcChar32;
33 typedef int FcBool;
34
35 /*
36 * Current Fontconfig version number
37 */
38 #define FC_MAJOR 1
39 #define FC_MINOR 0
40 #define FC_REVISION 1
41
42 #define FC_VERSION ((FC_MAJOR * 10000) + (FC_MINOR * 100) + (FC_REVISION))
43
44 #define FcTrue 1
45 #define FcFalse 0
46
47 #define FC_FAMILY "family" /* String */
48 #define FC_STYLE "style" /* String */
49 #define FC_SLANT "slant" /* Int */
50 #define FC_WEIGHT "weight" /* Int */
51 #define FC_SIZE "size" /* Double */
52 #define FC_PIXEL_SIZE "pixelsize" /* Double */
53 #define FC_SPACING "spacing" /* Int */
54 #define FC_FOUNDRY "foundry" /* String */
55 #define FC_ANTIALIAS "antialias" /* Bool (depends) */
56 #define FC_HINTING "hinting" /* Bool (true) */
57 #define FC_VERTICAL_LAYOUT "verticallayout" /* Bool (false) */
58 #define FC_AUTOHINT "autohint" /* Bool (false) */
59 #define FC_GLOBAL_ADVANCE "globaladvance" /* Bool (true) */
60 #define FC_FILE "file" /* String */
61 #define FC_INDEX "index" /* Int */
62 #define FC_RASTERIZER "rasterizer" /* String */
63 #define FC_OUTLINE "outline" /* Bool */
64 #define FC_SCALABLE "scalable" /* Bool */
65 #define FC_SCALE "scale" /* double */
66 #define FC_DPI "dpi" /* double */
67 #define FC_RGBA "rgba" /* Int */
68 #define FC_MINSPACE "minspace" /* Bool use minimum line spacing */
69 #define FC_SOURCE "source" /* String (X11, freetype) */
70 #define FC_CHARSET "charset" /* CharSet */
71 #define FC_LANG "lang" /* String OS/2 CodePageRange */
72
73 #define FC_DIR_CACHE_FILE "fonts.cache"
74 #define FC_USER_CACHE_FILE ".fonts.cache"
75
76 /* Adjust outline rasterizer */
77 #define FC_CHAR_WIDTH "charwidth" /* Int */
78 #define FC_CHAR_HEIGHT "charheight"/* Int */
79 #define FC_MATRIX "matrix" /* FcMatrix */
80
81 #define FC_WEIGHT_LIGHT 0
82 #define FC_WEIGHT_MEDIUM 100
83 #define FC_WEIGHT_DEMIBOLD 180
84 #define FC_WEIGHT_BOLD 200
85 #define FC_WEIGHT_BLACK 210
86
87 #define FC_SLANT_ROMAN 0
88 #define FC_SLANT_ITALIC 100
89 #define FC_SLANT_OBLIQUE 110
90
91 #define FC_PROPORTIONAL 0
92 #define FC_MONO 100
93 #define FC_CHARCELL 110
94
95 /* sub-pixel order */
96 #define FC_RGBA_NONE 0
97 #define FC_RGBA_RGB 1
98 #define FC_RGBA_BGR 2
99 #define FC_RGBA_VRGB 3
100 #define FC_RGBA_VBGR 4
101
102 /* language groups from the OS/2 CodePageRange bits */
103 #define FC_LANG_LATIN_1 "latin1" /* 0 */
104 #define FC_LANG_LATIN_2_EASTERN_EUROPE "latin2easterneurope" /* 1 */
105 #define FC_LANG_CYRILLIC "cyrillic" /* 2 */
106 #define FC_LANG_GREEK "greek" /* 3 */
107 #define FC_LANG_TURKISH "turkish" /* 4 */
108 #define FC_LANG_HEBREW "hebrew" /* 5 */
109 #define FC_LANG_ARABIC "arabic" /* 6 */
110 #define FC_LANG_WINDOWS_BALTIC "windowsbaltic" /* 7 */
111 #define FC_LANG_VIETNAMESE "vietnamese" /* 8 */
112 /* 9-15 reserved for Alternate ANSI */
113 #define FC_LANG_THAI "thai" /* 16 */
114 #define FC_LANG_JAPANESE "japanese" /* 17 */
115 #define FC_LANG_SIMPLIFIED_CHINESE "simplifiedchinese" /* 18 */
116 #define FC_LANG_KOREAN_WANSUNG "koreanwansung" /* 19 */
117 #define FC_LANG_TRADITIONAL_CHINESE "traditionalchinese" /* 20 */
118 #define FC_LANG_KOREAN_JOHAB "koreanjohab" /* 21 */
119 /* 22-28 reserved for Alternate ANSI & OEM */
120 #define FC_LANG_MACINTOSH "macintosh" /* 29 */
121 #define FC_LANG_OEM "oem" /* 30 */
122 #define FC_LANG_SYMBOL "symbol" /* 31 */
123 /* 32-47 reserved for OEM */
124 #define FC_LANG_IBM_GREEK "ibmgreek" /* 48 */
125 #define FC_LANG_MSDOS_RUSSIAN "msdosrussian" /* 49 */
126 #define FC_LANG_MSDOS_NORDIC "msdosnordic" /* 50 */
127 #define FC_LANG_ARABIC_864 "arabic864" /* 51 */
128 #define FC_LANG_MSDOS_CANADIAN_FRENCH "msdoscanadianfrench" /* 52 */
129 #define FC_LANG_HEBREW_862 "hebrew862" /* 53 */
130 #define FC_LANG_MSDOS_ICELANDIC "msdosicelandic" /* 54 */
131 #define FC_LANG_MSDOS_PORTUGUESE "msdosportuguese" /* 55 */
132 #define FC_LANG_IBM_TURKISH "ibmturkish" /* 56 */
133 #define FC_LANG_IBM_CYRILLIC "ibmcyrillic" /* 57 */
134 #define FC_LANG_LATIN_2 "latin2" /* 58 */
135 #define FC_LANG_MSDOS_BALTIC "msdosbaltic" /* 59 */
136 #define FC_LANG_GREEK_437_G "greek437g" /* 60 */
137 #define FC_LANG_ARABIC_ASMO_708 "arabicasmo708" /* 61 */
138 #define FC_LANG_WE_LATIN_1 "welatin1" /* 62 */
139 #define FC_LANG_US "us" /* 63 */
140
141 typedef enum _FcType {
142 FcTypeVoid,
143 FcTypeInteger,
144 FcTypeDouble,
145 FcTypeString,
146 FcTypeBool,
147 FcTypeMatrix,
148 FcTypeCharSet
149 } FcType;
150
151 typedef struct _FcMatrix {
152 double xx, xy, yx, yy;
153 } FcMatrix;
154
155 #define FcMatrixInit(m) ((m)->xx = (m)->yy = 1, \
156 (m)->xy = (m)->yx = 0)
157
158 /*
159 * A data structure to represent the available glyphs in a font.
160 * This is represented as a sparse boolean btree.
161 */
162
163 typedef struct _FcCharSet FcCharSet;
164
165 typedef struct _FcObjectType {
166 const char *object;
167 FcType type;
168 } FcObjectType;
169
170 typedef struct _FcConstant {
171 const FcChar8 *name;
172 const char *object;
173 int value;
174 } FcConstant;
175
176 typedef enum _FcResult {
177 FcResultMatch, FcResultNoMatch, FcResultTypeMismatch, FcResultNoId
178 } FcResult;
179
180 typedef struct _FcValue {
181 FcType type;
182 union {
183 const FcChar8 *s;
184 int i;
185 FcBool b;
186 double d;
187 const FcMatrix *m;
188 const FcCharSet *c;
189 } u;
190 } FcValue;
191
192 typedef struct _FcPattern FcPattern;
193
194 typedef struct _FcFontSet {
195 int nfont;
196 int sfont;
197 FcPattern **fonts;
198 } FcFontSet;
199
200 typedef struct _FcObjectSet {
201 int nobject;
202 int sobject;
203 const char **objects;
204 } FcObjectSet;
205
206 typedef enum _FcMatchKind {
207 FcMatchPattern, FcMatchFont
208 } FcMatchKind;
209
210 typedef enum _FcSetName {
211 FcSetSystem = 0,
212 FcSetApplication = 1
213 } FcSetName;
214
215 typedef struct _FcAtomic FcAtomic;
216
217 #if defined(__cplusplus) || defined(c_plusplus) /* for C++ V2.0 */
218 #define _FCFUNCPROTOBEGIN extern "C" { /* do not leave open across includes */
219 #define _FCFUNCPROTOEND }
220 #else
221 #define _FCFUNCPROTOBEGIN
222 #define _FCFUNCPROTOEND
223 #endif
224
225 typedef struct _FcConfig FcConfig;
226
227 typedef struct _FcFileCache FcFileCache;
228
229 typedef struct _FcBlanks FcBlanks;
230
231 typedef struct _FcStrList FcStrList;
232
233 typedef struct _FcStrSet FcStrSet;
234
235 _FCFUNCPROTOBEGIN
236
237 /* fcblanks.c */
238 FcBlanks *
239 FcBlanksCreate (void);
240
241 void
242 FcBlanksDestroy (FcBlanks *b);
243
244 FcBool
245 FcBlanksAdd (FcBlanks *b, FcChar32 ucs4);
246
247 FcBool
248 FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4);
249
250 /* fccfg.c */
251 FcChar8 *
252 FcConfigFilename (const FcChar8 *url);
253
254 FcConfig *
255 FcConfigCreate (void);
256
257 void
258 FcConfigDestroy (FcConfig *config);
259
260 FcBool
261 FcConfigSetCurrent (FcConfig *config);
262
263 FcConfig *
264 FcConfigGetCurrent (void);
265
266 FcBool
267 FcConfigUptoDate (FcConfig *config);
268
269 FcBool
270 FcConfigBuildFonts (FcConfig *config);
271
272 FcStrList *
273 FcConfigGetFontDirs (FcConfig *config);
274
275 FcStrList *
276 FcConfigGetConfigDirs (FcConfig *config);
277
278 FcStrList *
279 FcConfigGetConfigFiles (FcConfig *config);
280
281 FcChar8 *
282 FcConfigGetCache (FcConfig *config);
283
284 FcBlanks *
285 FcConfigGetBlanks (FcConfig *config);
286
287 int
288 FcConfigGetRescanInverval (FcConfig *config);
289
290 FcBool
291 FcConfigSetRescanInverval (FcConfig *config, int rescanInterval);
292
293 FcFontSet *
294 FcConfigGetFonts (FcConfig *config,
295 FcSetName set);
296
297 FcBool
298 FcConfigAppFontAddFile (FcConfig *config,
299 const FcChar8 *file);
300
301 FcBool
302 FcConfigAppFontAddDir (FcConfig *config,
303 const FcChar8 *dir);
304
305 void
306 FcConfigAppFontClear (FcConfig *config);
307
308 FcBool
309 FcConfigSubstitute (FcConfig *config,
310 FcPattern *p,
311 FcMatchKind kind);
312
313 /* fccharset.c */
314 FcCharSet *
315 FcCharSetCreate (void);
316
317 void
318 FcCharSetDestroy (FcCharSet *fcs);
319
320 FcBool
321 FcCharSetAddChar (FcCharSet *fcs, FcChar32 ucs4);
322
323 FcCharSet *
324 FcCharSetCopy (FcCharSet *src);
325
326 FcBool
327 FcCharSetEqual (const FcCharSet *a, const FcCharSet *b);
328
329 FcCharSet *
330 FcCharSetIntersect (const FcCharSet *a, const FcCharSet *b);
331
332 FcCharSet *
333 FcCharSetUnion (const FcCharSet *a, const FcCharSet *b);
334
335 FcCharSet *
336 FcCharSetSubtract (const FcCharSet *a, const FcCharSet *b);
337
338 FcBool
339 FcCharSetHasChar (const FcCharSet *fcs, FcChar32 ucs4);
340
341 FcChar32
342 FcCharSetCount (const FcCharSet *a);
343
344 FcChar32
345 FcCharSetIntersectCount (const FcCharSet *a, const FcCharSet *b);
346
347 FcChar32
348 FcCharSetSubtractCount (const FcCharSet *a, const FcCharSet *b);
349
350 #define FC_CHARSET_MAP_SIZE (256/32)
351 #define FC_CHARSET_DONE ((FcChar32) -1)
352
353 FcChar32
354 FcCharSetFirstPage (const FcCharSet *a,
355 FcChar32 map[FC_CHARSET_MAP_SIZE],
356 FcChar32 *next);
357
358 FcChar32
359 FcCharSetNextPage (const FcCharSet *a,
360 FcChar32 map[FC_CHARSET_MAP_SIZE],
361 FcChar32 *next);
362
363
364 /* fcdbg.c */
365 void
366 FcValuePrint (FcValue v);
367
368 void
369 FcPatternPrint (FcPattern *p);
370
371 void
372 FcFontSetPrint (FcFontSet *s);
373
374 /* fcdefault.c */
375 void
376 FcDefaultSubstitute (FcPattern *pattern);
377
378 /* fcdir.c */
379 FcBool
380 FcFileScan (FcFontSet *set,
381 FcStrSet *dirs,
382 FcFileCache *cache,
383 FcBlanks *blanks,
384 const FcChar8 *file,
385 FcBool force);
386
387 FcBool
388 FcDirScan (FcFontSet *set,
389 FcStrSet *dirs,
390 FcFileCache *cache,
391 FcBlanks *blanks,
392 const FcChar8 *dir,
393 FcBool force);
394
395 FcBool
396 FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);
397
398 FcBool
399 FcDirCacheValid (const FcChar8 *dir);
400
401 /* fcfreetype.c */
402 FcPattern *
403 FcFreeTypeQuery (const FcChar8 *file, int id, FcBlanks *blanks, int *count);
404
405 /* fcfs.c */
406
407 FcFontSet *
408 FcFontSetCreate (void);
409
410 void
411 FcFontSetDestroy (FcFontSet *s);
412
413 FcBool
414 FcFontSetAdd (FcFontSet *s, FcPattern *font);
415
416 /* fcinit.c */
417 FcConfig *
418 FcInitLoadConfig (void);
419
420 FcConfig *
421 FcInitLoadConfigAndFonts (void);
422
423 FcBool
424 FcInit (void);
425
426 int
427 FcGetVersion (void);
428
429 FcBool
430 FcInitReinitialize (void);
431
432 FcBool
433 FcInitBringUptoDate (void);
434
435 /* fclist.c */
436 FcObjectSet *
437 FcObjectSetCreate (void);
438
439 FcBool
440 FcObjectSetAdd (FcObjectSet *os, const char *object);
441
442 void
443 FcObjectSetDestroy (FcObjectSet *os);
444
445 FcObjectSet *
446 FcObjectSetVaBuild (const char *first, va_list va);
447
448 FcObjectSet *
449 FcObjectSetBuild (const char *first, ...);
450
451 FcFontSet *
452 FcFontSetList (FcConfig *config,
453 FcFontSet **sets,
454 int nsets,
455 FcPattern *p,
456 FcObjectSet *os);
457
458 FcFontSet *
459 FcFontList (FcConfig *config,
460 FcPattern *p,
461 FcObjectSet *os);
462
463 /* fcatomic.c */
464
465 FcAtomic *
466 FcAtomicCreate (const FcChar8 *file);
467
468 FcBool
469 FcAtomicLock (FcAtomic *atomic);
470
471 FcChar8 *
472 FcAtomicNewFile (FcAtomic *atomic);
473
474 FcChar8 *
475 FcAtomicOrigFile (FcAtomic *atomic);
476
477 FcBool
478 FcAtomicReplaceOrig (FcAtomic *atomic);
479
480 void
481 FcAtomicDeleteNew (FcAtomic *atomic);
482
483 void
484 FcAtomicUnlock (FcAtomic *atomic);
485
486 void
487 FcAtomicDestroy (FcAtomic *atomic);
488
489 /* fcmatch.c */
490 FcPattern *
491 FcFontSetMatch (FcConfig *config,
492 FcFontSet **sets,
493 int nsets,
494 FcPattern *p,
495 FcResult *result);
496
497 FcPattern *
498 FcFontMatch (FcConfig *config,
499 FcPattern *p,
500 FcResult *result);
501
502 FcPattern *
503 FcFontRenderPrepare (FcConfig *config,
504 FcPattern *pat,
505 FcPattern *font);
506
507 FcFontSet *
508 FcFontSetSort (FcConfig *config,
509 FcFontSet **sets,
510 int nsets,
511 FcPattern *p,
512 FcBool trim,
513 FcCharSet **csp,
514 FcResult *result);
515
516 /* fcmatrix.c */
517 FcMatrix *
518 FcMatrixCopy (const FcMatrix *mat);
519
520 FcBool
521 FcMatrixEqual (const FcMatrix *mat1, const FcMatrix *mat2);
522
523 void
524 FcMatrixMultiply (FcMatrix *result, const FcMatrix *a, const FcMatrix *b);
525
526 void
527 FcMatrixRotate (FcMatrix *m, double c, double s);
528
529 void
530 FcMatrixScale (FcMatrix *m, double sx, double sy);
531
532 void
533 FcMatrixShear (FcMatrix *m, double sh, double sv);
534
535 /* fcname.c */
536
537 FcBool
538 FcNameRegisterObjectTypes (const FcObjectType *types, int ntype);
539
540 FcBool
541 FcNameUnregisterObjectTypes (const FcObjectType *types, int ntype);
542
543 const FcObjectType *
544 FcNameGetObjectType (const char *object);
545
546 FcBool
547 FcNameRegisterConstants (const FcConstant *consts, int nconsts);
548
549 FcBool
550 FcNameUnregisterConstants (const FcConstant *consts, int nconsts);
551
552 const FcConstant *
553 FcNameGetConstant (FcChar8 *string);
554
555 FcBool
556 FcNameConstant (FcChar8 *string, int *result);
557
558 FcPattern *
559 FcNameParse (const FcChar8 *name);
560
561 FcChar8 *
562 FcNameUnparse (FcPattern *pat);
563
564 /* fcpat.c */
565 FcPattern *
566 FcPatternCreate (void);
567
568 FcPattern *
569 FcPatternDuplicate (FcPattern *p);
570
571 void
572 FcValueDestroy (FcValue v);
573
574 FcBool
575 FcValueEqual (FcValue va, FcValue vb);
576
577 FcValue
578 FcValueSave (FcValue v);
579
580 void
581 FcPatternDestroy (FcPattern *p);
582
583 FcBool
584 FcPatternEqual (FcPattern *pa, FcPattern *pb);
585
586 FcBool
587 FcPatternAdd (FcPattern *p, const char *object, FcValue value, FcBool append);
588
589 FcResult
590 FcPatternGet (FcPattern *p, const char *object, int id, FcValue *v);
591
592 FcBool
593 FcPatternDel (FcPattern *p, const char *object);
594
595 FcBool
596 FcPatternAddInteger (FcPattern *p, const char *object, int i);
597
598 FcBool
599 FcPatternAddDouble (FcPattern *p, const char *object, double d);
600
601 FcBool
602 FcPatternAddString (FcPattern *p, const char *object, const FcChar8 *s);
603
604 FcBool
605 FcPatternAddMatrix (FcPattern *p, const char *object, const FcMatrix *s);
606
607 FcBool
608 FcPatternAddCharSet (FcPattern *p, const char *object, const FcCharSet *c);
609
610 FcBool
611 FcPatternAddBool (FcPattern *p, const char *object, FcBool b);
612
613 FcResult
614 FcPatternGetInteger (FcPattern *p, const char *object, int n, int *i);
615
616 FcResult
617 FcPatternGetDouble (FcPattern *p, const char *object, int n, double *d);
618
619 FcResult
620 FcPatternGetString (FcPattern *p, const char *object, int n, FcChar8 ** s);
621
622 FcResult
623 FcPatternGetMatrix (FcPattern *p, const char *object, int n, FcMatrix **s);
624
625 FcResult
626 FcPatternGetCharSet (FcPattern *p, const char *object, int n, FcCharSet **c);
627
628 FcResult
629 FcPatternGetBool (FcPattern *p, const char *object, int n, FcBool *b);
630
631 FcPattern *
632 FcPatternVaBuild (FcPattern *orig, va_list va);
633
634 FcPattern *
635 FcPatternBuild (FcPattern *orig, ...);
636
637 /* fcstr.c */
638
639 FcChar8 *
640 FcStrCopy (const FcChar8 *s);
641
642 FcChar8 *
643 FcStrCopyFilename (const FcChar8 *s);
644
645 #define FcToLower(c) (('A' <= (c) && (c) <= 'Z') ? (c) - 'A' + 'a' : (c))
646
647 int
648 FcStrCmpIgnoreCase (const FcChar8 *s1, const FcChar8 *s2);
649
650 int
651 FcStrCmp (const FcChar8 *s1, const FcChar8 *s2);
652
653 int
654 FcUtf8ToUcs4 (FcChar8 *src_orig,
655 FcChar32 *dst,
656 int len);
657
658 FcBool
659 FcUtf8Len (FcChar8 *string,
660 int len,
661 int *nchar,
662 int *wchar);
663
664 FcChar8 *
665 FcStrDirname (const FcChar8 *file);
666
667 FcChar8 *
668 FcStrBasename (const FcChar8 *file);
669
670 FcStrSet *
671 FcStrSetCreate (void);
672
673 FcBool
674 FcStrSetMember (FcStrSet *set, const FcChar8 *s);
675
676 FcBool
677 FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
678
679 FcBool
680 FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
681
682 FcBool
683 FcStrSetDel (FcStrSet *set, const FcChar8 *s);
684
685 void
686 FcStrSetDestroy (FcStrSet *set);
687
688 FcStrList *
689 FcStrListCreate (FcStrSet *set);
690
691 FcChar8 *
692 FcStrListNext (FcStrList *list);
693
694 void
695 FcStrListDone (FcStrList *list);
696
697 /* fcxml.c */
698 FcBool
699 FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
700
701 _FCFUNCPROTOEND
702
703 #endif /* _FONTCONFIG_H_ */