Add TODO
[framework/uifw/harfbuzz.git] / src / hb-ft.c
1 /*
2  * Copyright (C) 2009  Red Hat, Inc.
3  * Copyright (C) 2009  Keith Stribley <devel@thanlwinsoft.org>
4  *
5  *  This is part of HarfBuzz, a text shaping library.
6  *
7  * Permission is hereby granted, without written agreement and without
8  * license or royalty fees, to use, copy, modify, and distribute this
9  * software and its documentation for any purpose, provided that the
10  * above copyright notice and the following two paragraphs appear in
11  * all copies of this software.
12  *
13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17  * DAMAGE.
18  *
19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24  *
25  * Red Hat Author(s): Behdad Esfahbod
26  */
27
28 #include "hb-private.h"
29
30 #include "hb-ft.h"
31
32 #include "hb-font-private.h"
33
34 #include FT_TRUETYPE_TABLES_H
35
36 static hb_codepoint_t
37 hb_ft_get_glyph (hb_font_t *font HB_GNUC_UNUSED,
38                  hb_face_t *face HB_GNUC_UNUSED,
39                  const void *user_data,
40                  hb_codepoint_t unicode,
41                  hb_codepoint_t variation_selector)
42 {
43   FT_Face ft_face = (FT_Face) user_data;
44
45 #ifdef HAVE_FT_FACE_GETCHARVARIANTINDEX
46   if (HB_UNLIKELY (variation_selector)) {
47     hb_codepoint_t glyph = FT_Face_GetCharVariantIndex (ft_face, unicode, variation_selector);
48     if (glyph)
49       return glyph;
50   }
51 #endif
52
53   return FT_Get_Char_Index (ft_face, unicode);
54 }
55
56 static hb_bool_t
57 hb_ft_get_contour_point (hb_font_t *font HB_GNUC_UNUSED,
58                          hb_face_t *face HB_GNUC_UNUSED,
59                          const void *user_data,
60                          unsigned int point_index,
61                          hb_codepoint_t glyph,
62                          hb_position_t *x,
63                          hb_position_t *y)
64 {
65   FT_Face ft_face = (FT_Face) user_data;
66   int load_flags = FT_LOAD_DEFAULT;
67
68   /* TODO: load_flags, embolden, etc */
69
70   if (HB_UNLIKELY (FT_Load_Glyph (ft_face, glyph, load_flags)))
71       return FALSE;
72
73   if (HB_UNLIKELY (ft_face->glyph->format != FT_GLYPH_FORMAT_OUTLINE))
74       return FALSE;
75
76   if (HB_UNLIKELY (point_index >= (unsigned int) ft_face->glyph->outline.n_points))
77       return FALSE;
78
79   *x = ft_face->glyph->outline.points[point_index].x;
80   *y = ft_face->glyph->outline.points[point_index].y;
81
82   return TRUE;
83 }
84
85 static void
86 hb_ft_get_glyph_metrics (hb_font_t *font HB_GNUC_UNUSED,
87                          hb_face_t *face HB_GNUC_UNUSED,
88                          const void *user_data,
89                          hb_codepoint_t glyph,
90                          hb_glyph_metrics_t *metrics)
91 {
92   FT_Face ft_face = (FT_Face) user_data;
93   int load_flags = FT_LOAD_DEFAULT;
94
95   /* TODO: load_flags, embolden, etc */
96
97   metrics->x_advance = metrics->y_advance = 0;
98   metrics->x_offset = metrics->y_offset = 0;
99   metrics->width = metrics->height = 0;
100   if (HB_LIKELY (!FT_Load_Glyph (ft_face, glyph, load_flags)))
101   {
102     /* TODO: A few negations should be in order here, not sure. */
103     metrics->x_advance = ft_face->glyph->advance.x;
104     metrics->y_advance = ft_face->glyph->advance.y;
105     metrics->x_offset = ft_face->glyph->metrics.horiBearingX;
106     metrics->y_offset = ft_face->glyph->metrics.horiBearingY;
107     metrics->width = ft_face->glyph->metrics.width;
108     metrics->height = ft_face->glyph->metrics.height;
109   }
110 }
111
112 static hb_position_t
113 hb_ft_get_kerning (hb_font_t *font HB_GNUC_UNUSED,
114                    hb_face_t *face HB_GNUC_UNUSED,
115                    const void *user_data,
116                    hb_codepoint_t first_glyph,
117                    hb_codepoint_t second_glyph)
118 {
119   FT_Face ft_face = (FT_Face) user_data;
120   FT_Vector kerning;
121
122   /* TODO: Kern type? */
123   if (FT_Get_Kerning (ft_face, first_glyph, second_glyph, FT_KERNING_DEFAULT, &kerning))
124       return 0;
125
126   return kerning.x;
127 }
128
129 static hb_font_funcs_t ft_ffuncs = {
130   HB_REFERENCE_COUNT_INVALID, /* ref_count */
131
132   TRUE, /* immutable */
133
134   hb_ft_get_glyph,
135   hb_ft_get_contour_point,
136   hb_ft_get_glyph_metrics,
137   hb_ft_get_kerning
138 };
139
140 hb_font_funcs_t *
141 hb_ft_get_font_funcs (void)
142 {
143   return &ft_ffuncs;
144 }
145
146
147 static hb_blob_t *
148 _get_table  (hb_tag_t tag, void *user_data)
149 {
150   FT_Face ft_face = (FT_Face) user_data;
151   FT_Byte *buffer;
152   FT_ULong  length = 0;
153   FT_Error error;
154
155   error = FT_Load_Sfnt_Table (ft_face, tag, 0, NULL, &length);
156   if (error)
157     return hb_blob_create_empty ();
158
159   /* TODO Use FT_Memory? */
160   buffer = malloc (length);
161   if (buffer == NULL)
162     return hb_blob_create_empty ();
163
164   error = FT_Load_Sfnt_Table (ft_face, tag, 0, buffer, &length);
165   if (error)
166     return hb_blob_create_empty ();
167
168   return hb_blob_create ((const char *) buffer, length,
169                          HB_MEMORY_MODE_WRITABLE,
170                          free, buffer);
171 }
172
173
174 hb_face_t *
175 hb_ft_face_create (FT_Face           ft_face,
176                    hb_destroy_func_t destroy)
177 {
178   hb_face_t *face;
179
180   if (ft_face->stream->read == NULL) {
181     hb_blob_t *blob;
182
183     blob = hb_blob_create ((const char *) ft_face->stream->base,
184                            (unsigned int) ft_face->stream->size,
185                            /* TODO: Check FT_FACE_FLAG_EXTERNAL_STREAM? */
186                            HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE,
187                            destroy, ft_face);
188     face = hb_face_create_for_data (blob, ft_face->face_index);
189     hb_blob_destroy (blob);
190   } else {
191     face = hb_face_create_for_tables (_get_table, destroy, ft_face);
192   }
193
194   return face;
195 }
196
197 static void
198 hb_ft_face_finalize (FT_Face ft_face)
199 {
200   hb_face_destroy (ft_face->generic.data);
201 }
202
203 hb_face_t *
204 hb_ft_face_create_cached (FT_Face ft_face)
205 {
206   if (HB_UNLIKELY (!ft_face->generic.data || ft_face->generic.finalizer != (FT_Generic_Finalizer) hb_ft_face_finalize))
207   {
208     if (ft_face->generic.finalizer)
209       ft_face->generic.finalizer (ft_face);
210
211     ft_face->generic.data = hb_ft_face_create (ft_face, NULL);
212     ft_face->generic.finalizer = (FT_Generic_Finalizer) hb_ft_face_finalize;
213   }
214
215   return hb_face_reference (ft_face->generic.data);
216 }
217
218
219 hb_font_t *
220 hb_ft_font_create (FT_Face           ft_face,
221                    hb_destroy_func_t destroy)
222 {
223   hb_font_t *font;
224
225   font = hb_font_create ();
226   hb_font_set_funcs (font,
227                      hb_ft_get_font_funcs (),
228                      destroy, ft_face);
229   hb_font_set_scale (font,
230                      ft_face->size->metrics.x_scale,
231                      ft_face->size->metrics.y_scale);
232   hb_font_set_ppem (font,
233                     ft_face->size->metrics.x_ppem,
234                     ft_face->size->metrics.y_ppem);
235
236   return font;
237 }