91237b70850bc9750516c73aca7051228e5c22c1
[platform/upstream/harfbuzz.git] / src / hb-face.h
1 /*
2  * Copyright © 2009  Red Hat, Inc.
3  *
4  *  This is part of HarfBuzz, a text shaping library.
5  *
6  * Permission is hereby granted, without written agreement and without
7  * license or royalty fees, to use, copy, modify, and distribute this
8  * software and its documentation for any purpose, provided that the
9  * above copyright notice and the following two paragraphs appear in
10  * all copies of this software.
11  *
12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
16  * DAMAGE.
17  *
18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
23  *
24  * Red Hat Author(s): Behdad Esfahbod
25  */
26
27 #ifndef HB_H_IN
28 #error "Include <hb.h> instead."
29 #endif
30
31 #ifndef HB_FACE_H
32 #define HB_FACE_H
33
34 #include "hb-common.h"
35 #include "hb-blob.h"
36
37 HB_BEGIN_DECLS
38
39
40 /*
41  * hb_face_t
42  */
43
44 typedef struct hb_face_t hb_face_t;
45
46 HB_EXTERN hb_face_t *
47 hb_face_create (hb_blob_t    *blob,
48                 unsigned int  index);
49
50 typedef hb_blob_t * (*hb_reference_table_func_t)  (hb_face_t *face, hb_tag_t tag, void *user_data);
51
52 /* calls destroy() when not needing user_data anymore */
53 HB_EXTERN hb_face_t *
54 hb_face_create_for_tables (hb_reference_table_func_t  reference_table_func,
55                            void                      *user_data,
56                            hb_destroy_func_t          destroy);
57
58 HB_EXTERN hb_face_t *
59 hb_face_get_empty (void);
60
61 HB_EXTERN hb_face_t *
62 hb_face_reference (hb_face_t *face);
63
64 HB_EXTERN void
65 hb_face_destroy (hb_face_t *face);
66
67 HB_EXTERN hb_bool_t
68 hb_face_set_user_data (hb_face_t          *face,
69                        hb_user_data_key_t *key,
70                        void *              data,
71                        hb_destroy_func_t   destroy,
72                        hb_bool_t           replace);
73
74
75 HB_EXTERN void *
76 hb_face_get_user_data (hb_face_t          *face,
77                        hb_user_data_key_t *key);
78
79 HB_EXTERN void
80 hb_face_make_immutable (hb_face_t *face);
81
82 HB_EXTERN hb_bool_t
83 hb_face_is_immutable (hb_face_t *face);
84
85
86 HB_EXTERN hb_blob_t *
87 hb_face_reference_table (hb_face_t *face,
88                          hb_tag_t   tag);
89
90 HB_EXTERN hb_blob_t *
91 hb_face_reference_blob (hb_face_t *face);
92
93 HB_EXTERN void
94 hb_face_set_index (hb_face_t    *face,
95                    unsigned int  index);
96
97 HB_EXTERN unsigned int
98 hb_face_get_index (hb_face_t    *face);
99
100 HB_EXTERN void
101 hb_face_set_upem (hb_face_t    *face,
102                   unsigned int  upem);
103
104 HB_EXTERN unsigned int
105 hb_face_get_upem (hb_face_t *face);
106
107 HB_EXTERN void
108 hb_face_set_glyph_count (hb_face_t    *face,
109                          unsigned int  glyph_count);
110
111 HB_EXTERN unsigned int
112 hb_face_get_glyph_count (hb_face_t *face);
113
114
115 HB_END_DECLS
116
117 #endif /* HB_FACE_H */