Imported Upstream version 3.4.0
[platform/upstream/harfbuzz.git] / util / options.hh
index 919e4f8..790650b 100644 (file)
 #ifndef OPTIONS_HH
 #define OPTIONS_HH
 
-
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
+#include "hb.hh"
 
 #include <stdlib.h>
 #include <stddef.h>
 #include <string.h>
 #include <stdio.h>
+#include <assert.h>
 #include <math.h>
 #include <locale.h>
 #include <errno.h>
 #endif
 
 #include <hb.h>
-#ifdef HAVE_OT
 #include <hb-ot.h>
-#endif
 #include <glib.h>
 #include <glib/gprintf.h>
 
-#if !GLIB_CHECK_VERSION (2, 22, 0)
-# define g_mapped_file_unref g_mapped_file_free
-#endif
-
-
-/* A few macros copied from hb-private.hh. */
-
-#if __GNUC__ >= 4
-#define HB_UNUSED      __attribute__((unused))
-#else
-#define HB_UNUSED
-#endif
-
-#undef MIN
-template <typename Type> static inline Type MIN (const Type &a, const Type &b) { return a < b ? a : b; }
-
-#undef MAX
-template <typename Type> static inline Type MAX (const Type &a, const Type &b) { return a > b ? a : b; }
-
-#undef  ARRAY_LENGTH
-template <typename Type, unsigned int n>
-static inline unsigned int ARRAY_LENGTH (const Type (&)[n]) { return n; }
-/* A const version, but does not detect erratically being called on pointers. */
-#define ARRAY_LENGTH_CONST(__array) ((signed int) (sizeof (__array) / sizeof (__array[0])))
-
-#define _ASSERT_STATIC1(_line, _cond)  HB_UNUSED typedef int _static_assert_on_line_##_line##_failed[(_cond)?1:-1]
-#define _ASSERT_STATIC0(_line, _cond)  _ASSERT_STATIC1 (_line, (_cond))
-#define ASSERT_STATIC(_cond)           _ASSERT_STATIC0 (__LINE__, (_cond))
-
 
-void fail (hb_bool_t suggest_help, const char *format, ...) G_GNUC_NORETURN G_GNUC_PRINTF (2, 3);
+static inline void fail (hb_bool_t suggest_help, const char *format, ...) G_GNUC_NORETURN G_GNUC_PRINTF (2, 3);
 
-
-extern hb_bool_t debug;
-
-struct option_group_t
+static inline void
+fail (hb_bool_t suggest_help, const char *format, ...)
 {
-  virtual void add_options (struct option_parser_t *parser) = 0;
-
-  virtual void pre_parse (GError **error G_GNUC_UNUSED) {};
-  virtual void post_parse (GError **error G_GNUC_UNUSED) {};
-};
-
+  const char *msg;
+
+  va_list vap;
+  va_start (vap, format);
+  msg = g_strdup_vprintf (format, vap);
+  va_end (vap);
+  const char *prgname = g_get_prgname ();
+  g_printerr ("%s: %s\n", prgname, msg);
+  if (suggest_help)
+    g_printerr ("Try `%s --help' for more information.\n", prgname);
+
+  exit (1);
+}
 
 struct option_parser_t
 {
-  option_parser_t (const char *usage) {
-    memset (this, 0, sizeof (*this));
-    usage_str = usage;
-    context = g_option_context_new (usage);
-    to_free = g_ptr_array_new ();
+  option_parser_t (const char *parameter_string = nullptr)
+  : context (g_option_context_new (parameter_string)),
+    to_free (g_ptr_array_new ())
+  {}
 
-    add_main_options ();
-  }
-  ~option_parser_t (void) {
+  static void _g_free_g_func (void *p, void * G_GNUC_UNUSED) { g_free (p); }
+
+  ~option_parser_t ()
+  {
     g_option_context_free (context);
-    g_ptr_array_foreach (to_free, (GFunc) g_free, NULL);
+    g_ptr_array_foreach (to_free, _g_free_g_func, nullptr);
     g_ptr_array_free (to_free, TRUE);
   }
 
-  void add_main_options (void);
+  void add_options ();
+
+  static void
+  post_parse_ (void *thiz, GError **error) {}
+  template <typename Type>
+  static auto
+  post_parse_ (Type *thiz, GError **error) -> decltype (thiz->post_parse (error))
+  { thiz->post_parse (error); }
+  template <typename Type>
+  static gboolean
+  post_parse (GOptionContext *context G_GNUC_UNUSED,
+             GOptionGroup *group G_GNUC_UNUSED,
+             gpointer data,
+             GError **error)
+  {
+    option_parser_t::post_parse_ (static_cast<Type *> (data), error);
+    return !*error;
+  }
 
+  template <typename Type>
   void add_group (GOptionEntry   *entries,
                  const gchar    *name,
                  const gchar    *description,
                  const gchar    *help_description,
-                 option_group_t *option_group);
-
-  void free_later (char *p) {
-    g_ptr_array_add (to_free, p);
-  }
-
-  void parse (int *argc, char ***argv);
-
-  G_GNUC_NORETURN void usage (void) {
-    g_printerr ("Usage: %s [OPTION...] %s\n", g_get_prgname (), usage_str);
-    exit (1);
-  }
-
-  private:
-  const char *usage_str;
-  GOptionContext *context;
-  GPtrArray *to_free;
-};
-
-
-#define DEFAULT_MARGIN 16
-#define DEFAULT_FORE "#000000"
-#define DEFAULT_BACK "#FFFFFF"
-#define FONT_SIZE_UPEM 0x7FFFFFFF
-#define FONT_SIZE_NONE 0
-
-struct view_options_t : option_group_t
-{
-  view_options_t (option_parser_t *parser) {
-    annotate = false;
-    fore = NULL;
-    back = NULL;
-    line_space = 0;
-    margin.t = margin.r = margin.b = margin.l = DEFAULT_MARGIN;
-
-    add_options (parser);
-  }
-  ~view_options_t (void)
+                 Type           *closure,
+                 bool            add_parse_hooks = true)
   {
-    g_free (fore);
-    g_free (back);
+    GOptionGroup *group = g_option_group_new (name, description, help_description,
+                                             static_cast<gpointer>(closure), nullptr);
+    g_option_group_add_entries (group, entries);
+    if (add_parse_hooks)
+      g_option_group_set_parse_hooks (group, nullptr, post_parse<Type>);
+    g_option_context_add_group (context, group);
   }
 
-  void add_options (option_parser_t *parser);
-
-  hb_bool_t annotate;
-  char *fore;
-  char *back;
-  double line_space;
-  struct margin_t {
-    double t, r, b, l;
-  } margin;
-};
-
-
-struct shape_options_t : option_group_t
-{
-  shape_options_t (option_parser_t *parser)
-  {
-    direction = language = script = NULL;
-    bot = eot = preserve_default_ignorables = false;
-    features = NULL;
-    num_features = 0;
-    shapers = NULL;
-    utf8_clusters = false;
-    cluster_level = HB_BUFFER_CLUSTER_LEVEL_DEFAULT;
-    normalize_glyphs = false;
-    num_iterations = 1;
-
-    add_options (parser);
-  }
-  ~shape_options_t (void)
+  template <typename Type>
+  void add_main_group (GOptionEntry   *entries,
+                      Type           *closure)
   {
-    g_free (direction);
-    g_free (language);
-    g_free (script);
-    free (features);
-    g_strfreev (shapers);
+    GOptionGroup *group = g_option_group_new (nullptr, nullptr, nullptr,
+                                             static_cast<gpointer>(closure), nullptr);
+    g_option_group_add_entries (group, entries);
+    /* https://gitlab.gnome.org/GNOME/glib/-/issues/2460 */
+    //g_option_group_set_parse_hooks (group, nullptr, post_parse<Type>);
+    g_option_context_set_main_group (context, group);
   }
 
-  void add_options (option_parser_t *parser);
-
-  void setup_buffer (hb_buffer_t *buffer)
+  void set_summary (const char *summary)
   {
-    hb_buffer_set_direction (buffer, hb_direction_from_string (direction, -1));
-    hb_buffer_set_script (buffer, hb_script_from_string (script, -1));
-    hb_buffer_set_language (buffer, hb_language_from_string (language, -1));
-    hb_buffer_set_flags (buffer, (hb_buffer_flags_t) (HB_BUFFER_FLAG_DEFAULT |
-                        (bot ? HB_BUFFER_FLAG_BOT : 0) |
-                        (eot ? HB_BUFFER_FLAG_EOT : 0) |
-                        (preserve_default_ignorables ? HB_BUFFER_FLAG_PRESERVE_DEFAULT_IGNORABLES : 0)));
-    hb_buffer_set_cluster_level (buffer, cluster_level);
-    hb_buffer_guess_segment_properties (buffer);
+    g_option_context_set_summary (context, summary);
   }
-
-  void populate_buffer (hb_buffer_t *buffer, const char *text, int text_len,
-                       const char *text_before, const char *text_after)
+  void set_description (const char *description)
   {
-    hb_buffer_clear_contents (buffer);
-    if (text_before) {
-      unsigned int len = strlen (text_before);
-      hb_buffer_add_utf8 (buffer, text_before, len, len, 0);
-    }
-    hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
-    if (text_after) {
-      hb_buffer_add_utf8 (buffer, text_after, -1, 0, 0);
-    }
-
-    if (!utf8_clusters) {
-      /* Reset cluster values to refer to Unicode character index
-       * instead of UTF-8 index. */
-      unsigned int num_glyphs = hb_buffer_get_length (buffer);
-      hb_glyph_info_t *info = hb_buffer_get_glyph_infos (buffer, NULL);
-      for (unsigned int i = 0; i < num_glyphs; i++)
-      {
-       info->cluster = i;
-       info++;
-      }
-    }
-
-    setup_buffer (buffer);
+    g_option_context_set_description (context, description);
   }
 
-  hb_bool_t shape (hb_font_t *font, hb_buffer_t *buffer)
-  {
-    hb_bool_t res = hb_shape_full (font, buffer, features, num_features, shapers);
-    if (normalize_glyphs)
-      hb_buffer_normalize_glyphs (buffer);
-    return res;
+  void free_later (char *p) {
+    g_ptr_array_add (to_free, p);
   }
 
-  void shape_closure (const char *text, int text_len,
-                     hb_font_t *font, hb_buffer_t *buffer,
-                     hb_set_t *glyphs)
-  {
-    hb_buffer_reset (buffer);
-    hb_buffer_add_utf8 (buffer, text, text_len, 0, text_len);
-    setup_buffer (buffer);
-    hb_ot_shape_glyphs_closure (font, buffer, features, num_features, glyphs);
-  }
+  bool parse (int *argc, char ***argv, bool ignore_error = false);
 
-  /* Buffer properties */
-  char *direction;
-  char *language;
-  char *script;
-
-  /* Buffer flags */
-  hb_bool_t bot;
-  hb_bool_t eot;
-  hb_bool_t preserve_default_ignorables;
-
-  hb_feature_t *features;
-  unsigned int num_features;
-  char **shapers;
-  hb_bool_t utf8_clusters;
-  hb_buffer_cluster_level_t cluster_level;
-  hb_bool_t normalize_glyphs;
-  unsigned int num_iterations;
+  GOptionContext *context;
+  protected:
+  GPtrArray *to_free;
 };
 
 
-struct font_options_t : option_group_t
+static inline gchar *
+shapers_to_string ()
 {
-  font_options_t (option_parser_t *parser,
-                 int default_font_size_,
-                 unsigned int subpixel_bits_) {
-    default_font_size = default_font_size_;
-    subpixel_bits = subpixel_bits_;
-    font_file = NULL;
-    face_index = 0;
-    font_size_x = font_size_y = default_font_size;
-    font_funcs = NULL;
-
-    font = NULL;
-
-    add_options (parser);
-  }
-  ~font_options_t (void) {
-    g_free (font_file);
-    g_free (font_funcs);
-    hb_font_destroy (font);
-  }
-
-  void add_options (option_parser_t *parser);
-
-  hb_font_t *get_font (void) const;
+  GString *shapers = g_string_new (nullptr);
+  const char **shaper_list = hb_shape_list_shapers ();
 
-  char *font_file;
-  int face_index;
-  int default_font_size;
-  unsigned int subpixel_bits;
-  mutable double font_size_x;
-  mutable double font_size_y;
-  char *font_funcs;
-
-  private:
-  mutable hb_font_t *font;
-};
+  for (; *shaper_list; shaper_list++) {
+    g_string_append (shapers, *shaper_list);
+    g_string_append_c (shapers, ',');
+  }
+  g_string_truncate (shapers, MAX (0, (gint)shapers->len - 1));
 
+  return g_string_free (shapers, false);
+}
 
-struct text_options_t : option_group_t
+static G_GNUC_NORETURN gboolean
+show_version (const char *name G_GNUC_UNUSED,
+             const char *arg G_GNUC_UNUSED,
+             gpointer    data G_GNUC_UNUSED,
+             GError    **error G_GNUC_UNUSED)
 {
-  text_options_t (option_parser_t *parser) {
-    text_before = NULL;
-    text_after = NULL;
-
-    text = NULL;
-    text_file = NULL;
-
-    fp = NULL;
-    gs = NULL;
-    line = NULL;
-    line_len = (unsigned int) -1;
+  g_printf ("%s (%s) %s\n", g_get_prgname (), PACKAGE_NAME, PACKAGE_VERSION);
 
-    add_options (parser);
-  }
-  ~text_options_t (void) {
-    g_free (text_before);
-    g_free (text_after);
-    g_free (text);
-    g_free (text_file);
-    if (gs)
-      g_string_free (gs, true);
-    if (fp)
-      fclose (fp);
-  }
+  char *shapers = shapers_to_string ();
+  g_printf ("Available shapers: %s\n", shapers);
+  g_free (shapers);
+  if (strcmp (HB_VERSION_STRING, hb_version_string ()))
+    g_printf ("Linked HarfBuzz library has a different version: %s\n", hb_version_string ());
 
-  void add_options (option_parser_t *parser);
+  exit(0);
+}
 
-  void post_parse (GError **error G_GNUC_UNUSED) {
-    if (text && text_file)
-      g_set_error (error,
-                  G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE,
-                  "Only one of text and text-file can be set");
+inline void
+option_parser_t::add_options ()
+{
+  GOptionEntry entries[] =
+  {
+    {"version",                0, G_OPTION_FLAG_NO_ARG,
+                             G_OPTION_ARG_CALLBACK,    (gpointer) &show_version,       "Show version numbers",                 nullptr},
+    {nullptr}
   };
+  g_option_context_add_main_entries (context, entries, nullptr);
+}
 
-  const char *get_line (unsigned int *len);
-
-  char *text_before;
-  char *text_after;
-
-  char *text;
-  char *text_file;
-
-  private:
-  FILE *fp;
-  GString *gs;
-  char *line;
-  unsigned int line_len;
-};
-
-struct output_options_t : option_group_t
+inline bool
+option_parser_t::parse (int *argc, char ***argv, bool ignore_error)
 {
-  output_options_t (option_parser_t *parser,
-                   const char **supported_formats_ = NULL) {
-    output_file = NULL;
-    output_format = NULL;
-    supported_formats = supported_formats_;
-    explicit_output_format = false;
-
-    fp = NULL;
-
-    add_options (parser);
-  }
-  ~output_options_t (void) {
-    g_free (output_file);
-    g_free (output_format);
-    if (fp)
-      fclose (fp);
-  }
+  setlocale (LC_ALL, "");
 
-  void add_options (option_parser_t *parser);
-
-  void post_parse (GError **error G_GNUC_UNUSED)
+  GError *parse_error = nullptr;
+  if (!g_option_context_parse (context, argc, argv, &parse_error))
   {
-    if (output_format)
-      explicit_output_format = true;
-
-    if (output_file && !output_format) {
-      output_format = strrchr (output_file, '.');
-      if (output_format)
-      {
-         output_format++; /* skip the dot */
-         output_format = strdup (output_format);
-      }
+    if (parse_error)
+    {
+      if (!ignore_error)
+       fail (true, "%s", parse_error->message);
+      g_error_free (parse_error);
     }
-
-    if (output_file && 0 == strcmp (output_file, "-"))
-      output_file = NULL; /* STDOUT */
-  }
-
-  FILE *get_file_handle (void);
-
-  char *output_file;
-  char *output_format;
-  const char **supported_formats;
-  bool explicit_output_format;
-
-  mutable FILE *fp;
-};
-
-struct format_options_t : option_group_t
-{
-  format_options_t (option_parser_t *parser) {
-    show_glyph_names = true;
-    show_positions = true;
-    show_clusters = true;
-    show_text = false;
-    show_unicode = false;
-    show_line_num = false;
-    show_extents = false;
-
-    add_options (parser);
+    else
+    {
+      if (!ignore_error)
+       fail (true, "Option parse error");
+    }
+    return false;
   }
+  return true;
+}
 
-  void add_options (option_parser_t *parser);
-
-  void serialize_unicode (hb_buffer_t  *buffer,
-                         GString      *gs);
-  void serialize_glyphs (hb_buffer_t  *buffer,
-                        hb_font_t    *font,
-                        hb_buffer_serialize_format_t format,
-                        hb_buffer_serialize_flags_t flags,
-                        GString      *gs);
-  void serialize_line_no (unsigned int  line_no,
-                         GString      *gs);
-  void serialize_buffer_of_text (hb_buffer_t  *buffer,
-                                unsigned int  line_no,
-                                const char   *text,
-                                unsigned int  text_len,
-                                hb_font_t    *font,
-                                GString      *gs);
-  void serialize_message (unsigned int  line_no,
-                         const char   *msg,
-                         GString      *gs);
-  void serialize_buffer_of_glyphs (hb_buffer_t  *buffer,
-                                  unsigned int  line_no,
-                                  const char   *text,
-                                  unsigned int  text_len,
-                                  hb_font_t    *font,
-                                  hb_buffer_serialize_format_t output_format,
-                                  hb_buffer_serialize_flags_t format_flags,
-                                  GString      *gs);
-
-
-  hb_bool_t show_glyph_names;
-  hb_bool_t show_positions;
-  hb_bool_t show_clusters;
-  hb_bool_t show_text;
-  hb_bool_t show_unicode;
-  hb_bool_t show_line_num;
-  hb_bool_t show_extents;
-};
 
 /* fallback implementation for scalbn()/scalbnf() for pre-2013 MSVC */
 #if defined (_MSC_VER) && (_MSC_VER < 1800)