Evas language: Added a character script querying function.
[framework/uifw/evas.git] / src / lib / engines / common / evas_font_ot.c
1 #include "evas_font_ot.h"
2
3 #ifdef USE_HARFBUZZ
4 # include <hb.h>
5 # include <hb-ft.h>
6 #endif
7
8 #include "evas_common.h"
9
10 #include <Eina.h>
11 #include "evas_font_private.h"
12
13 #ifdef USE_HARFBUZZ
14 static const hb_script_t
15 _evas_script_to_harfbuzz[] =
16 {
17   HB_SCRIPT_COMMON,
18   HB_SCRIPT_INHERITED,
19   HB_SCRIPT_ARABIC,
20   HB_SCRIPT_ARMENIAN,
21   HB_SCRIPT_BENGALI,
22   HB_SCRIPT_BOPOMOFO,
23   HB_SCRIPT_CHEROKEE,
24   HB_SCRIPT_COPTIC,
25   HB_SCRIPT_CYRILLIC,
26   HB_SCRIPT_DESERET,
27   HB_SCRIPT_DEVANAGARI,
28   HB_SCRIPT_ETHIOPIC,
29   HB_SCRIPT_GEORGIAN,
30   HB_SCRIPT_GOTHIC,
31   HB_SCRIPT_GREEK,
32   HB_SCRIPT_GUJARATI,
33   HB_SCRIPT_GURMUKHI,
34   HB_SCRIPT_HAN,
35   HB_SCRIPT_HANGUL,
36   HB_SCRIPT_HEBREW,
37   HB_SCRIPT_HIRAGANA,
38   HB_SCRIPT_KANNADA,
39   HB_SCRIPT_KATAKANA,
40   HB_SCRIPT_KHMER,
41   HB_SCRIPT_LAO,
42   HB_SCRIPT_LATIN,
43   HB_SCRIPT_MALAYALAM,
44   HB_SCRIPT_MONGOLIAN,
45   HB_SCRIPT_MYANMAR,
46   HB_SCRIPT_OGHAM,
47   HB_SCRIPT_OLD_ITALIC,
48   HB_SCRIPT_ORIYA,
49   HB_SCRIPT_RUNIC,
50   HB_SCRIPT_SINHALA,
51   HB_SCRIPT_SYRIAC,
52   HB_SCRIPT_TAMIL,
53   HB_SCRIPT_TELUGU,
54   HB_SCRIPT_THAANA,
55   HB_SCRIPT_THAI,
56   HB_SCRIPT_TIBETAN,
57   HB_SCRIPT_CANADIAN_ABORIGINAL,
58   HB_SCRIPT_YI,
59   HB_SCRIPT_TAGALOG,
60   HB_SCRIPT_HANUNOO,
61   HB_SCRIPT_BUHID,
62   HB_SCRIPT_TAGBANWA,
63
64   /* Unicode-4.0 additions */
65   HB_SCRIPT_BRAILLE,
66   HB_SCRIPT_CYPRIOT,
67   HB_SCRIPT_LIMBU,
68   HB_SCRIPT_OSMANYA,
69   HB_SCRIPT_SHAVIAN,
70   HB_SCRIPT_LINEAR_B,
71   HB_SCRIPT_TAI_LE,
72   HB_SCRIPT_UGARITIC,
73
74   /* Unicode-4.1 additions */
75   HB_SCRIPT_NEW_TAI_LUE,
76   HB_SCRIPT_BUGINESE,
77   HB_SCRIPT_GLAGOLITIC,
78   HB_SCRIPT_TIFINAGH,
79   HB_SCRIPT_SYLOTI_NAGRI,
80   HB_SCRIPT_OLD_PERSIAN,
81   HB_SCRIPT_KHAROSHTHI,
82
83   /* Unicode-5.0 additions */
84   HB_SCRIPT_UNKNOWN,
85   HB_SCRIPT_BALINESE,
86   HB_SCRIPT_CUNEIFORM,
87   HB_SCRIPT_PHOENICIAN,
88   HB_SCRIPT_PHAGS_PA,
89   HB_SCRIPT_NKO,
90
91   /* Unicode-5.1 additions */
92   HB_SCRIPT_KAYAH_LI,
93   HB_SCRIPT_LEPCHA,
94   HB_SCRIPT_REJANG,
95   HB_SCRIPT_SUNDANESE,
96   HB_SCRIPT_SAURASHTRA,
97   HB_SCRIPT_CHAM,
98   HB_SCRIPT_OL_CHIKI,
99   HB_SCRIPT_VAI,
100   HB_SCRIPT_CARIAN,
101   HB_SCRIPT_LYCIAN,
102   HB_SCRIPT_LYDIAN,
103
104   /* Unicode-5.2 additions */
105   HB_SCRIPT_AVESTAN,
106   HB_SCRIPT_BAMUM,
107   HB_SCRIPT_EGYPTIAN_HIEROGLYPHS,
108   HB_SCRIPT_IMPERIAL_ARAMAIC,
109   HB_SCRIPT_INSCRIPTIONAL_PAHLAVI,
110   HB_SCRIPT_INSCRIPTIONAL_PARTHIAN,
111   HB_SCRIPT_JAVANESE,
112   HB_SCRIPT_KAITHI,
113   HB_SCRIPT_TAI_THAM,
114   HB_SCRIPT_LISU,
115   HB_SCRIPT_MEETEI_MAYEK,
116   HB_SCRIPT_OLD_SOUTH_ARABIAN,
117   HB_SCRIPT_OLD_TURKIC,
118   HB_SCRIPT_SAMARITAN,
119   HB_SCRIPT_TAI_VIET,
120
121   /* Unicode-6.0 additions */
122   HB_SCRIPT_BATAK,
123   HB_SCRIPT_BRAHMI,
124   HB_SCRIPT_MANDAIC
125 };
126 #endif
127
128 #ifdef OT_SUPPORT
129 /* FIXME: doc. returns #items */
130 EAPI int
131 evas_common_font_ot_cluster_size_get(const Evas_Text_Props *props, size_t char_index)
132 {
133    int i;
134    int items;
135    int left_bound, right_bound;
136    size_t base_cluster;
137    char_index += props->start;
138    base_cluster = EVAS_FONT_OT_POS_GET(props->info->ot[char_index]);
139    for (i = (int) char_index ;
140          (i >= (int) props->start) &&
141          (EVAS_FONT_OT_POS_GET(props->info->ot[i]) == base_cluster) ;
142          i--)
143      ;
144    left_bound = i;
145    for (i = (int) char_index + 1;
146          (i < (int) (props->start + props->len)) &&
147          (EVAS_FONT_OT_POS_GET(props->info->ot[i]) == base_cluster) ;
148          i++)
149      ;
150    right_bound = i;
151
152    if (right_bound == left_bound)
153      {
154         items = 1;
155      }
156    else if (props->bidi.dir == EVAS_BIDI_DIRECTION_RTL)
157      {
158         if (left_bound < 0)
159           {
160              items = props->text_offset + props->text_len - base_cluster;
161           }
162         else
163           {
164              items = props->info->ot[left_bound].source_cluster - base_cluster;
165           }
166      }
167    else
168      {
169         if (right_bound >= (int) (props->text_offset + props->text_len))
170           {
171              items = props->text_offset + props->text_len - base_cluster;
172           }
173         else
174           {
175              items = props->info->ot[right_bound].source_cluster - base_cluster;
176           }
177      }
178    return (items > 0) ? items : 1;
179 }
180
181 EAPI void
182 evas_common_font_ot_load_face(void *_font)
183 {
184    RGBA_Font_Source *font = (RGBA_Font_Source *) _font;
185    /* Unload the face if by any chance it's already loaded */
186    evas_common_font_ot_unload_face(font);
187    font->hb.face = hb_ft_face_create(font->ft.face, NULL);
188 }
189
190 EAPI void
191 evas_common_font_ot_unload_face(void *_font)
192 {
193    RGBA_Font_Source *font = (RGBA_Font_Source *) _font;
194    if (!font->hb.face) return;
195    hb_face_destroy(font->hb.face);
196    font->hb.face = NULL;
197 }
198
199 /* Harfbuzz font functions */
200 static hb_font_funcs_t *_ft_font_funcs = NULL;
201
202 static hb_codepoint_t
203 _evas_common_font_ot_hb_get_glyph(hb_font_t *font, hb_face_t *face,
204     const void *user_data, hb_codepoint_t unicode,
205     hb_codepoint_t variation_selector)
206 {
207    RGBA_Font_Int *fi = (RGBA_Font_Int *) user_data;
208    return hb_font_funcs_get_glyph_func(_ft_font_funcs)(font, face,
209       fi->src->ft.face, unicode, variation_selector);
210 }
211
212 static void
213 _evas_common_font_ot_hb_get_glyph_advance(hb_font_t *font, hb_face_t *face,
214    const void *user_data, hb_codepoint_t glyph,
215    hb_position_t *x_advance, hb_position_t *y_advance)
216 {
217    /* Use our cache*/
218    RGBA_Font_Int *fi = (RGBA_Font_Int *) user_data;
219    RGBA_Font_Glyph *fg;
220    (void) font;
221    (void) face;
222    fg = evas_common_font_int_cache_glyph_get(fi, glyph);
223    if (fg)
224      {
225         *x_advance = fg->glyph->advance.x >> 10;
226         *y_advance = fg->glyph->advance.y >> 10;
227      }
228 }
229
230 static void
231 _evas_common_font_ot_hb_get_glyph_extents(hb_font_t *font, hb_face_t *face,
232    const void *user_data, hb_codepoint_t glyph, hb_glyph_extents_t *extents)
233 {
234    RGBA_Font_Int *fi = (RGBA_Font_Int *) user_data;
235    hb_font_funcs_get_glyph_extents_func(_ft_font_funcs)(font, face,
236       fi->src->ft.face, glyph, extents);
237 }
238
239 static hb_bool_t
240 _evas_common_font_ot_hb_get_contour_point(hb_font_t *font, hb_face_t *face,
241    const void *user_data, unsigned int point_index, hb_codepoint_t glyph,
242    hb_position_t *x, hb_position_t *y)
243 {
244    RGBA_Font_Int *fi = (RGBA_Font_Int *) user_data;
245    return hb_font_funcs_get_contour_point_func(_ft_font_funcs)(font, face,
246       fi->src->ft.face, point_index, glyph, x, y);
247 }
248
249 static hb_position_t
250 _evas_common_font_ot_hb_get_kerning(hb_font_t *font, hb_face_t *face,
251    const void *user_data, hb_codepoint_t first_glyph,
252    hb_codepoint_t second_glyph)
253 {
254    RGBA_Font_Int *fi = (RGBA_Font_Int *) user_data;
255    int kern;
256    (void) font;
257    (void) face;
258    if (evas_common_font_query_kerning(fi, first_glyph, second_glyph, &kern))
259       return kern;
260    else
261       return 0;
262 }
263
264 /* End of harfbuzz font funcs */
265
266 static hb_font_funcs_t *
267 _evas_common_font_ot_font_funcs_get(void)
268 {
269    static hb_font_funcs_t *font_funcs = NULL;
270    if (!font_funcs)
271      {
272         _ft_font_funcs = hb_ft_get_font_funcs();
273         font_funcs = hb_font_funcs_create();
274         hb_font_funcs_set_glyph_func(font_funcs,
275             _evas_common_font_ot_hb_get_glyph);
276         hb_font_funcs_set_glyph_advance_func(font_funcs,
277             _evas_common_font_ot_hb_get_glyph_advance);
278         hb_font_funcs_set_glyph_extents_func(font_funcs,
279             _evas_common_font_ot_hb_get_glyph_extents);
280         hb_font_funcs_set_contour_point_func(font_funcs,
281             _evas_common_font_ot_hb_get_contour_point);
282         hb_font_funcs_set_kerning_func(font_funcs,
283             _evas_common_font_ot_hb_get_kerning);
284      }
285
286    return font_funcs;
287 }
288
289 static void
290 _evas_common_font_ot_shape(hb_buffer_t *buffer, RGBA_Font_Int *fi)
291 {
292    hb_font_t   *hb_font;
293
294    hb_font = hb_ft_font_create(fi->src->ft.face, NULL);
295    hb_font_set_funcs(hb_font, _evas_common_font_ot_font_funcs_get(), fi, NULL);
296
297    hb_shape(hb_font, fi->src->hb.face, buffer, NULL, 0);
298    hb_font_destroy(hb_font);
299 }
300
301 EAPI Eina_Bool
302 evas_common_font_ot_populate_text_props(void *_fn, const Eina_Unicode *text,
303       Evas_Text_Props *props, int len)
304 {
305    RGBA_Font *fn = (RGBA_Font *) _fn;
306    RGBA_Font_Int *fi;
307    hb_buffer_t *buffer;
308    hb_glyph_position_t *positions;
309    hb_glyph_info_t *infos;
310    int slen;
311    unsigned int i;
312    Evas_Font_Glyph_Info *gl_itr;
313    Evas_Font_OT_Info *ot_itr;
314    Evas_Coord pen_x = 0;
315
316    fi = fn->fonts->data;
317    /* Load the font needed for this script */
318      {
319         /* Skip common chars */
320         const Eina_Unicode *tmp;
321         for (tmp = text ;
322               *tmp &&
323               evas_common_language_char_script_get(*tmp) == EVAS_SCRIPT_COMMON ;
324               tmp++)
325           ;
326         if (!*tmp && (tmp > text)) tmp--;
327         evas_common_font_glyph_search(fn, &fi, *tmp);
328      }
329    evas_common_font_int_reload(fi);
330    if (fi->src->current_size != fi->size)
331      {
332         FTLOCK();
333         FT_Activate_Size(fi->ft.size);
334         FTUNLOCK();
335         fi->src->current_size = fi->size;
336      }
337
338    if (len < 0)
339      {
340         slen = eina_unicode_strlen(text);
341      }
342    else
343      {
344         slen = len;
345      }
346
347    buffer = hb_buffer_create(slen);
348    hb_buffer_set_unicode_funcs(buffer, evas_common_language_unicode_funcs_get());
349    hb_buffer_set_language(buffer, hb_language_from_string(
350             evas_common_language_from_locale_get()));
351    hb_buffer_set_script(buffer, _evas_script_to_harfbuzz[props->script]);
352    hb_buffer_set_direction(buffer,
353          (props->bidi.dir == EVAS_BIDI_DIRECTION_RTL) ?
354          HB_DIRECTION_RTL : HB_DIRECTION_LTR);
355    /* FIXME: add run-time conversions if needed, which is very unlikely */
356    hb_buffer_add_utf32(buffer, (const uint32_t *) text, slen, 0, slen);
357
358    _evas_common_font_ot_shape(buffer, fi);
359
360    props->len = hb_buffer_get_length(buffer);
361    props->info->ot = calloc(props->len,
362          sizeof(Evas_Font_OT_Info));
363    props->info->glyph = calloc(props->len,
364               sizeof(Evas_Font_Glyph_Info));
365    positions = hb_buffer_get_glyph_positions(buffer, NULL);
366    infos = hb_buffer_get_glyph_infos(buffer, NULL);
367    gl_itr = props->info->glyph;
368    ot_itr = props->info->ot;
369    for (i = 0 ; i < props->len ; i++)
370      {
371         Evas_Coord adv;
372         ot_itr->source_cluster = infos->cluster;
373         ot_itr->x_offset = positions->x_offset;
374         ot_itr->y_offset = positions->y_offset;
375         gl_itr->index = infos->codepoint;
376         adv = positions->x_advance;
377
378         pen_x += adv;
379         gl_itr->pen_after = EVAS_FONT_ROUND_26_6_TO_INT(pen_x);
380
381         ot_itr++;
382         gl_itr++;
383         infos++;
384         positions++;
385      }
386
387    hb_buffer_destroy(buffer);
388    evas_common_font_int_use_trim();
389
390    return EINA_FALSE;
391 }
392
393 #endif
394