2 * Copyright © 2011 Google, Inc.
4 * This is part of HarfBuzz, a text shaping library.
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.
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
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.
24 * Google Author(s): Behdad Esfahbod
42 #include <unistd.h> /* for isatty() */
44 #if defined(_WIN32) || defined(__CYGWIN__)
45 #include <io.h> /* for setmode() under Windows */
51 #include <glib/gprintf.h>
53 void fail (hb_bool_t suggest_help, const char *format, ...) G_GNUC_NORETURN G_GNUC_PRINTF (2, 3);
57 virtual ~option_group_t () {}
59 virtual void add_options (struct option_parser_t *parser) = 0;
61 virtual void pre_parse (GError **error G_GNUC_UNUSED) {}
62 virtual void post_parse (GError **error G_GNUC_UNUSED) {}
66 struct option_parser_t
68 option_parser_t (const char *usage)
70 memset (this, 0, sizeof (*this));
72 context = g_option_context_new (usage);
73 to_free = g_ptr_array_new ();
78 static void _g_free_g_func (void *p, void * G_GNUC_UNUSED) { g_free (p); }
82 g_option_context_free (context);
83 g_ptr_array_foreach (to_free, _g_free_g_func, nullptr);
84 g_ptr_array_free (to_free, TRUE);
87 void add_main_options ();
89 void add_group (GOptionEntry *entries,
91 const gchar *description,
92 const gchar *help_description,
93 option_group_t *option_group);
95 void free_later (char *p) {
96 g_ptr_array_add (to_free, p);
99 void parse (int *argc, char ***argv);
101 G_GNUC_NORETURN void usage () {
102 g_printerr ("Usage: %s [OPTION...] %s\n", g_get_prgname (), usage_str);
107 const char *usage_str;
108 GOptionContext *context;
113 #define DEFAULT_MARGIN 16
114 #define DEFAULT_FORE "#000000"
115 #define DEFAULT_BACK "#FFFFFF"
116 #define FONT_SIZE_UPEM 0x7FFFFFFF
117 #define FONT_SIZE_NONE 0
119 struct view_options_t : option_group_t
121 view_options_t (option_parser_t *parser)
127 margin.t = margin.r = margin.b = margin.l = DEFAULT_MARGIN;
129 add_options (parser);
131 virtual ~view_options_t ()
137 void add_options (option_parser_t *parser);
149 struct shape_options_t : option_group_t
151 shape_options_t (option_parser_t *parser)
153 direction = language = script = nullptr;
154 bot = eot = preserve_default_ignorables = remove_default_ignorables = false;
158 utf8_clusters = false;
160 cluster_level = HB_BUFFER_CLUSTER_LEVEL_DEFAULT;
161 normalize_glyphs = false;
165 add_options (parser);
167 virtual ~shape_options_t ()
173 g_strfreev (shapers);
176 void add_options (option_parser_t *parser);
178 void setup_buffer (hb_buffer_t *buffer)
180 hb_buffer_set_direction (buffer, hb_direction_from_string (direction, -1));
181 hb_buffer_set_script (buffer, hb_script_from_string (script, -1));
182 hb_buffer_set_language (buffer, hb_language_from_string (language, -1));
183 hb_buffer_set_flags (buffer, (hb_buffer_flags_t)
184 (HB_BUFFER_FLAG_DEFAULT |
185 (bot ? HB_BUFFER_FLAG_BOT : 0) |
186 (eot ? HB_BUFFER_FLAG_EOT : 0) |
187 (preserve_default_ignorables ? HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES : 0) |
188 (remove_default_ignorables ? HB_BUFFER_FLAG_REMOVE_DEFAULT_IGNORABLES : 0) |
190 hb_buffer_set_invisible_glyph (buffer, invisible_glyph);
191 hb_buffer_set_cluster_level (buffer, cluster_level);
192 hb_buffer_guess_segment_properties (buffer);
195 static void copy_buffer_properties (hb_buffer_t *dst, hb_buffer_t *src)
197 hb_segment_properties_t props;
198 hb_buffer_get_segment_properties (src, &props);
199 hb_buffer_set_segment_properties (dst, &props);
200 hb_buffer_set_flags (dst, hb_buffer_get_flags (src));
201 hb_buffer_set_cluster_level (dst, hb_buffer_get_cluster_level (src));
204 void populate_buffer (hb_buffer_t *buffer, const char *text, int text_len,
205 const char *text_before, const char *text_after)
207 hb_buffer_clear_contents (buffer);
209 unsigned int len = strlen (text_before);
210 hb_buffer_add_utf8 (buffer, text_before, len, len, 0);
212 hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
214 hb_buffer_add_utf8 (buffer, text_after, -1, 0, 0);
217 if (!utf8_clusters) {
218 /* Reset cluster values to refer to Unicode character index
219 * instead of UTF-8 index. */
220 unsigned int num_glyphs = hb_buffer_get_length (buffer);
221 hb_glyph_info_t *info = hb_buffer_get_glyph_infos (buffer, nullptr);
222 for (unsigned int i = 0; i < num_glyphs; i++)
229 setup_buffer (buffer);
232 hb_bool_t shape (hb_font_t *font, hb_buffer_t *buffer, const char **error=nullptr)
234 hb_buffer_t *text_buffer = nullptr;
237 text_buffer = hb_buffer_create ();
238 hb_buffer_append (text_buffer, buffer, 0, -1);
241 if (!hb_shape_full (font, buffer, features, num_features, shapers))
244 *error = "all shapers failed.";
248 if (normalize_glyphs)
249 hb_buffer_normalize_glyphs (buffer);
251 if (verify && !verify_buffer (buffer, text_buffer, font, error))
255 hb_buffer_destroy (text_buffer);
261 hb_buffer_destroy (text_buffer);
266 bool verify_buffer (hb_buffer_t *buffer,
267 hb_buffer_t *text_buffer,
269 const char **error=nullptr)
271 if (!verify_buffer_monotone (buffer, error))
273 if (!verify_buffer_safe_to_break (buffer, text_buffer, font, error))
278 bool verify_buffer_monotone (hb_buffer_t *buffer, const char **error=nullptr)
280 /* Check that clusters are monotone. */
281 if (cluster_level == HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES ||
282 cluster_level == HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS)
284 bool is_forward = HB_DIRECTION_IS_FORWARD (hb_buffer_get_direction (buffer));
286 unsigned int num_glyphs;
287 hb_glyph_info_t *info = hb_buffer_get_glyph_infos (buffer, &num_glyphs);
289 for (unsigned int i = 1; i < num_glyphs; i++)
290 if (info[i-1].cluster != info[i].cluster &&
291 (info[i-1].cluster < info[i].cluster) != is_forward)
294 *error = "clusters are not monotone.";
302 bool verify_buffer_safe_to_break (hb_buffer_t *buffer,
303 hb_buffer_t *text_buffer,
305 const char **error=nullptr)
307 if (cluster_level != HB_BUFFER_CLUSTER_LEVEL_MONOTONE_GRAPHEMES &&
308 cluster_level != HB_BUFFER_CLUSTER_LEVEL_MONOTONE_CHARACTERS)
310 /* Cannot perform this check without monotone clusters.
311 * Then again, unsafe-to-break flag is much harder to use without
312 * monotone clusters. */
316 /* Check that breaking up shaping at safe-to-break is indeed safe. */
318 hb_buffer_t *fragment = hb_buffer_create ();
319 hb_buffer_t *reconstruction = hb_buffer_create ();
320 copy_buffer_properties (reconstruction, buffer);
322 unsigned int num_glyphs;
323 hb_glyph_info_t *info = hb_buffer_get_glyph_infos (buffer, &num_glyphs);
325 unsigned int num_chars;
326 hb_glyph_info_t *text = hb_buffer_get_glyph_infos (text_buffer, &num_chars);
328 /* Chop text and shape fragments. */
329 bool forward = HB_DIRECTION_IS_FORWARD (hb_buffer_get_direction (buffer));
330 unsigned int start = 0;
331 unsigned int text_start = forward ? 0 : num_chars;
332 unsigned int text_end = text_start;
333 for (unsigned int end = 1; end < num_glyphs + 1; end++)
335 if (end < num_glyphs &&
336 (info[end].cluster == info[end-1].cluster ||
337 info[end-(forward?0:1)].mask & HB_GLYPH_FLAG_UNSAFE_TO_BREAK))
340 /* Shape segment corresponding to glyphs start..end. */
341 if (end == num_glyphs)
344 text_end = num_chars;
352 unsigned int cluster = info[end].cluster;
353 while (text_end < num_chars && text[text_end].cluster < cluster)
358 unsigned int cluster = info[end - 1].cluster;
359 while (text_start && text[text_start - 1].cluster >= cluster)
363 assert (text_start < text_end);
366 printf("start %d end %d text start %d end %d\n", start, end, text_start, text_end);
368 hb_buffer_clear_contents (fragment);
369 copy_buffer_properties (fragment, buffer);
371 /* TODO: Add pre/post context text. */
372 hb_buffer_flags_t flags = hb_buffer_get_flags (fragment);
374 flags = (hb_buffer_flags_t) (flags & ~HB_BUFFER_FLAG_BOT);
375 if (text_end < num_chars)
376 flags = (hb_buffer_flags_t) (flags & ~HB_BUFFER_FLAG_EOT);
377 hb_buffer_set_flags (fragment, flags);
379 hb_buffer_append (fragment, text_buffer, text_start, text_end);
380 if (!hb_shape_full (font, fragment, features, num_features, shapers))
383 *error = "all shapers failed while shaping fragment.";
384 hb_buffer_destroy (reconstruction);
385 hb_buffer_destroy (fragment);
388 hb_buffer_append (reconstruction, fragment, 0, -1);
392 text_start = text_end;
394 text_end = text_start;
398 hb_buffer_diff_flags_t diff = hb_buffer_diff (reconstruction, buffer, (hb_codepoint_t) -1, 0);
402 *error = "Safe-to-break test failed.";
405 /* Return the reconstructed result instead so it can be inspected. */
406 hb_buffer_set_length (buffer, 0);
407 hb_buffer_append (buffer, reconstruction, 0, -1);
410 hb_buffer_destroy (reconstruction);
411 hb_buffer_destroy (fragment);
416 void shape_closure (const char *text, int text_len,
417 hb_font_t *font, hb_buffer_t *buffer,
420 hb_buffer_reset (buffer);
421 hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
422 setup_buffer (buffer);
423 hb_ot_shape_glyphs_closure (font, buffer, features, num_features, glyphs);
426 /* Buffer properties */
434 hb_bool_t preserve_default_ignorables;
435 hb_bool_t remove_default_ignorables;
437 hb_feature_t *features;
438 unsigned int num_features;
440 hb_bool_t utf8_clusters;
441 hb_codepoint_t invisible_glyph;
442 hb_buffer_cluster_level_t cluster_level;
443 hb_bool_t normalize_glyphs;
445 unsigned int num_iterations;
449 struct font_options_t : option_group_t
451 font_options_t (option_parser_t *parser,
452 int default_font_size_,
453 unsigned int subpixel_bits_)
455 variations = nullptr;
457 default_font_size = default_font_size_;
461 subpixel_bits = subpixel_bits_;
464 font_size_x = font_size_y = default_font_size;
465 font_funcs = nullptr;
471 add_options (parser);
473 virtual ~font_options_t ()
478 hb_font_destroy (font);
481 void add_options (option_parser_t *parser);
483 hb_font_t *get_font () const;
486 mutable hb_blob_t *blob;
488 hb_variation_t *variations;
489 unsigned int num_variations;
490 int default_font_size;
494 unsigned int subpixel_bits;
495 mutable double font_size_x;
496 mutable double font_size_y;
501 mutable hb_font_t *font;
505 struct text_options_t : option_group_t
507 text_options_t (option_parser_t *parser)
509 text_before = nullptr;
510 text_after = nullptr;
519 line_len = (unsigned int) -1;
521 add_options (parser);
523 virtual ~text_options_t ()
525 g_free (text_before);
530 g_string_free (gs, true);
531 if (fp && fp != stdin)
535 void add_options (option_parser_t *parser);
537 void post_parse (GError **error G_GNUC_UNUSED) {
538 if (text && text_file)
540 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
541 "Only one of text and text-file can be set");
544 const char *get_line (unsigned int *len);
557 unsigned int line_len;
560 struct output_options_t : option_group_t
562 output_options_t (option_parser_t *parser,
563 const char **supported_formats_ = nullptr)
565 output_file = nullptr;
566 output_format = nullptr;
567 supported_formats = supported_formats_;
568 explicit_output_format = false;
572 add_options (parser);
574 virtual ~output_options_t ()
576 g_free (output_file);
577 g_free (output_format);
578 if (fp && fp != stdout)
582 void add_options (option_parser_t *parser);
584 void post_parse (GError **error G_GNUC_UNUSED)
587 explicit_output_format = true;
589 if (output_file && !output_format) {
590 output_format = strrchr (output_file, '.');
593 output_format++; /* skip the dot */
594 output_format = g_strdup (output_format);
598 if (output_file && 0 == strcmp (output_file, "-"))
599 output_file = nullptr; /* STDOUT */
602 FILE *get_file_handle ();
606 const char **supported_formats;
607 bool explicit_output_format;
612 struct format_options_t : option_group_t
614 format_options_t (option_parser_t *parser) {
615 show_glyph_names = true;
616 show_positions = true;
617 show_advances = true;
618 show_clusters = true;
620 show_unicode = false;
621 show_line_num = false;
622 show_extents = false;
626 add_options (parser);
629 void add_options (option_parser_t *parser);
631 void serialize_unicode (hb_buffer_t *buffer,
633 void serialize_glyphs (hb_buffer_t *buffer,
635 hb_buffer_serialize_format_t format,
636 hb_buffer_serialize_flags_t flags,
638 void serialize_line_no (unsigned int line_no,
640 void serialize_buffer_of_text (hb_buffer_t *buffer,
641 unsigned int line_no,
643 unsigned int text_len,
646 void serialize_message (unsigned int line_no,
650 void serialize_buffer_of_glyphs (hb_buffer_t *buffer,
651 unsigned int line_no,
653 unsigned int text_len,
655 hb_buffer_serialize_format_t output_format,
656 hb_buffer_serialize_flags_t format_flags,
660 hb_bool_t show_glyph_names;
661 hb_bool_t show_positions;
662 hb_bool_t show_advances;
663 hb_bool_t show_clusters;
665 hb_bool_t show_unicode;
666 hb_bool_t show_line_num;
667 hb_bool_t show_extents;
668 hb_bool_t show_flags;
672 struct subset_options_t : option_group_t
674 subset_options_t (option_parser_t *parser)
679 desubroutinize = false;
681 add_options (parser);
684 void add_options (option_parser_t *parser);
686 hb_bool_t keep_layout;
687 hb_bool_t drop_hints;
688 hb_bool_t retain_gids;
689 hb_bool_t desubroutinize;
692 /* fallback implementation for scalbn()/scalbnf() for pre-2013 MSVC */
693 #if defined (_MSC_VER) && (_MSC_VER < 1800)
699 __inline long double scalbn (long double x, int exp)
701 return x * (pow ((long double) FLT_RADIX, exp));
704 __inline float scalbnf (float x, int exp)
706 return x * (pow ((float) FLT_RADIX, exp));