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
44 #include <unistd.h> /* for isatty() */
46 #if defined(_WIN32) || defined(__CYGWIN__)
47 #include <io.h> /* for setmode() under Windows */
55 #include <glib/gprintf.h>
57 #if !GLIB_CHECK_VERSION (2, 22, 0)
58 # define g_mapped_file_unref g_mapped_file_free
62 /* A few macros copied from hb-private.hh. */
65 #define HB_UNUSED __attribute__((unused))
71 template <typename Type> static inline Type MIN (const Type &a, const Type &b) { return a < b ? a : b; }
74 template <typename Type> static inline Type MAX (const Type &a, const Type &b) { return a > b ? a : b; }
77 template <typename Type, unsigned int n>
78 static inline unsigned int ARRAY_LENGTH (const Type (&)[n]) { return n; }
79 /* A const version, but does not detect erratically being called on pointers. */
80 #define ARRAY_LENGTH_CONST(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
82 #define _ASSERT_STATIC1(_line, _cond) HB_UNUSED typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
83 #define _ASSERT_STATIC0(_line, _cond) _ASSERT_STATIC1 (_line, (_cond))
84 #define ASSERT_STATIC(_cond) _ASSERT_STATIC0 (__LINE__, (_cond))
87 void fail (hb_bool_t suggest_help, const char *format, ...) G_GNUC_NORETURN G_GNUC_PRINTF (2, 3);
90 extern hb_bool_t debug;
94 virtual void add_options (struct option_parser_t *parser) = 0;
96 virtual void pre_parse (GError **error G_GNUC_UNUSED) {};
97 virtual void post_parse (GError **error G_GNUC_UNUSED) {};
101 struct option_parser_t
103 option_parser_t (const char *usage) {
104 memset (this, 0, sizeof (*this));
106 context = g_option_context_new (usage);
107 to_free = g_ptr_array_new ();
111 ~option_parser_t (void) {
112 g_option_context_free (context);
113 g_ptr_array_foreach (to_free, (GFunc) g_free, NULL);
114 g_ptr_array_free (to_free, TRUE);
117 void add_main_options (void);
119 void add_group (GOptionEntry *entries,
121 const gchar *description,
122 const gchar *help_description,
123 option_group_t *option_group);
125 void free_later (char *p) {
126 g_ptr_array_add (to_free, p);
129 void parse (int *argc, char ***argv);
131 G_GNUC_NORETURN void usage (void) {
132 g_printerr ("Usage: %s [OPTION...] %s\n", g_get_prgname (), usage_str);
137 const char *usage_str;
138 GOptionContext *context;
143 #define DEFAULT_MARGIN 16
144 #define DEFAULT_FORE "#000000"
145 #define DEFAULT_BACK "#FFFFFF"
146 #define FONT_SIZE_UPEM 0x7FFFFFFF
147 #define FONT_SIZE_NONE 0
149 struct view_options_t : option_group_t
151 view_options_t (option_parser_t *parser) {
156 margin.t = margin.r = margin.b = margin.l = DEFAULT_MARGIN;
158 add_options (parser);
160 ~view_options_t (void)
166 void add_options (option_parser_t *parser);
178 struct shape_options_t : option_group_t
180 shape_options_t (option_parser_t *parser)
182 direction = language = script = NULL;
183 bot = eot = preserve_default_ignorables = false;
187 utf8_clusters = false;
188 cluster_level = HB_BUFFER_CLUSTER_LEVEL_DEFAULT;
189 normalize_glyphs = false;
192 add_options (parser);
194 ~shape_options_t (void)
200 g_strfreev (shapers);
203 void add_options (option_parser_t *parser);
205 void setup_buffer (hb_buffer_t *buffer)
207 hb_buffer_set_direction (buffer, hb_direction_from_string (direction, -1));
208 hb_buffer_set_script (buffer, hb_script_from_string (script, -1));
209 hb_buffer_set_language (buffer, hb_language_from_string (language, -1));
210 hb_buffer_set_flags (buffer, (hb_buffer_flags_t) (HB_BUFFER_FLAG_DEFAULT |
211 (bot ? HB_BUFFER_FLAG_BOT : 0) |
212 (eot ? HB_BUFFER_FLAG_EOT : 0) |
213 (preserve_default_ignorables ? HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES : 0)));
214 hb_buffer_set_cluster_level (buffer, cluster_level);
215 hb_buffer_guess_segment_properties (buffer);
218 void populate_buffer (hb_buffer_t *buffer, const char *text, int text_len,
219 const char *text_before, const char *text_after)
221 hb_buffer_clear_contents (buffer);
223 unsigned int len = strlen (text_before);
224 hb_buffer_add_utf8 (buffer, text_before, len, len, 0);
226 hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
228 hb_buffer_add_utf8 (buffer, text_after, -1, 0, 0);
231 if (!utf8_clusters) {
232 /* Reset cluster values to refer to Unicode character index
233 * instead of UTF-8 index. */
234 unsigned int num_glyphs = hb_buffer_get_length (buffer);
235 hb_glyph_info_t *info = hb_buffer_get_glyph_infos (buffer, NULL);
236 for (unsigned int i = 0; i < num_glyphs; i++)
243 setup_buffer (buffer);
246 hb_bool_t shape (hb_font_t *font, hb_buffer_t *buffer)
248 hb_bool_t res = hb_shape_full (font, buffer, features, num_features, shapers);
249 if (normalize_glyphs)
250 hb_buffer_normalize_glyphs (buffer);
254 void shape_closure (const char *text, int text_len,
255 hb_font_t *font, hb_buffer_t *buffer,
258 hb_buffer_reset (buffer);
259 hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
260 setup_buffer (buffer);
261 hb_ot_shape_glyphs_closure (font, buffer, features, num_features, glyphs);
264 /* Buffer properties */
272 hb_bool_t preserve_default_ignorables;
274 hb_feature_t *features;
275 unsigned int num_features;
277 hb_bool_t utf8_clusters;
278 hb_buffer_cluster_level_t cluster_level;
279 hb_bool_t normalize_glyphs;
280 unsigned int num_iterations;
284 struct font_options_t : option_group_t
286 font_options_t (option_parser_t *parser,
287 int default_font_size_,
288 unsigned int subpixel_bits_) {
289 default_font_size = default_font_size_;
290 subpixel_bits = subpixel_bits_;
293 font_size_x = font_size_y = default_font_size;
298 add_options (parser);
300 ~font_options_t (void) {
303 hb_font_destroy (font);
306 void add_options (option_parser_t *parser);
308 hb_font_t *get_font (void) const;
312 int default_font_size;
313 unsigned int subpixel_bits;
314 mutable double font_size_x;
315 mutable double font_size_y;
319 mutable hb_font_t *font;
323 struct text_options_t : option_group_t
325 text_options_t (option_parser_t *parser) {
335 line_len = (unsigned int) -1;
337 add_options (parser);
339 ~text_options_t (void) {
340 g_free (text_before);
345 g_string_free (gs, true);
350 void add_options (option_parser_t *parser);
352 void post_parse (GError **error G_GNUC_UNUSED) {
353 if (text && text_file)
355 G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
356 "Only one of text and text-file can be set");
359 const char *get_line (unsigned int *len);
371 unsigned int line_len;
374 struct output_options_t : option_group_t
376 output_options_t (option_parser_t *parser,
377 const char **supported_formats_ = NULL) {
379 output_format = NULL;
380 supported_formats = supported_formats_;
381 explicit_output_format = false;
385 add_options (parser);
387 ~output_options_t (void) {
388 g_free (output_file);
389 g_free (output_format);
394 void add_options (option_parser_t *parser);
396 void post_parse (GError **error G_GNUC_UNUSED)
399 explicit_output_format = true;
401 if (output_file && !output_format) {
402 output_format = strrchr (output_file, '.');
405 output_format++; /* skip the dot */
406 output_format = strdup (output_format);
410 if (output_file && 0 == strcmp (output_file, "-"))
411 output_file = NULL; /* STDOUT */
414 FILE *get_file_handle (void);
418 const char **supported_formats;
419 bool explicit_output_format;
424 struct format_options_t : option_group_t
426 format_options_t (option_parser_t *parser) {
427 show_glyph_names = true;
428 show_positions = true;
429 show_clusters = true;
431 show_unicode = false;
432 show_line_num = false;
433 show_extents = false;
435 add_options (parser);
438 void add_options (option_parser_t *parser);
440 void serialize_unicode (hb_buffer_t *buffer,
442 void serialize_glyphs (hb_buffer_t *buffer,
444 hb_buffer_serialize_format_t format,
445 hb_buffer_serialize_flags_t flags,
447 void serialize_line_no (unsigned int line_no,
449 void serialize_buffer_of_text (hb_buffer_t *buffer,
450 unsigned int line_no,
452 unsigned int text_len,
455 void serialize_message (unsigned int line_no,
458 void serialize_buffer_of_glyphs (hb_buffer_t *buffer,
459 unsigned int line_no,
461 unsigned int text_len,
463 hb_buffer_serialize_format_t output_format,
464 hb_buffer_serialize_flags_t format_flags,
468 hb_bool_t show_glyph_names;
469 hb_bool_t show_positions;
470 hb_bool_t show_clusters;
472 hb_bool_t show_unicode;
473 hb_bool_t show_line_num;
474 hb_bool_t show_extents;
477 /* fallback implementation for scalbn()/scalbnf() for pre-2013 MSVC */
478 #if defined (_MSC_VER) && (_MSC_VER < 1800)
484 __inline long double scalbn (long double x, int exp)
486 return x * (pow ((long double) FLT_RADIX, exp));
489 __inline float scalbnf (float x, int exp)
491 return x * (pow ((float) FLT_RADIX, exp));