Deprecate module system, skip it for shaper modules

Now shaper is discovered via (previously unused!) font->find_shaper().
I'm keeping that just to allow clients override shaping.  Though,
even that I'm not sure we want to keep.

Wraps shaper in PangoEngineShape structs to keep PangoAnalysis API
intact.

Deprecated pango-modules.h and some pango-engine.h.  Language modules
are not moved yet.

Wired up PangoFc, PangoWin32, and PangoCoretext shapers.

1 files changed, 25 insertions, 414 deletions

diff --git a/pango/modules.c b/pango/modules.c
index 3d082760..299fa605 100644
--- a/pango/modules.c
+++ b/pango/modules.c
@@ -41,344 +41,24 @@
 #include "pango-impl-utils.h"
 #include "modules.h"
 
-typedef struct _PangoModule      PangoModule;
-typedef struct _PangoModuleClass PangoModuleClass;
-
-#define PANGO_TYPE_MODULE           (pango_module_get_type ())
-#define PANGO_MODULE(module) (G_TYPE_CHECK_INSTANCE_CAST ((module), PANGO_TYPE_MODULE, PangoModule))
-#define PANGO_IS_MODULE(module)  (G_TYPE_CHECK_INSTANCE_TYPE ((module), PANGO_TYPE_MODULE))
-
-typedef struct _PangoMapInfo PangoMapInfo;
-typedef struct _PangoEnginePair PangoEnginePair;
-typedef struct _PangoSubmap PangoSubmap;
-
-/**
- * PangoMap:
- *
- * A #PangoMap structure can be used to determine the engine to
- * use for each character.
- */
-struct _PangoMap
-{
-  GArray *entries;
-};
-
-/**
- * PangoMapEntry:
- *
- * A #PangoMapEntry contains information about the engine that should be used
- * for the codepoint to which this entry belongs and also whether the engine
- * matches the language tag for this entry's map exactly or just approximately.
- */
-struct _PangoMapEntry
-{
-  GSList *exact;
-  GSList *fallback;
-};
-
-struct _PangoMapInfo
-{
-  PangoLanguage *language;
-  guint engine_type_id;
-  guint render_type_id;
-  PangoMap *map;
-};
-
-struct _PangoEnginePair
-{
-  PangoEngineInfo info;
-  PangoModule *module;
-  PangoEngine *engine;
-};
-
-struct _PangoModule
-{
-  GTypeModule parent_instance;
-
-  void         (*list)   (PangoEngineInfo **engines, gint *n_engines);
-  void         (*init)   (GTypeModule *module);
-  void         (*exit)   (void);
-  PangoEngine *(*create) (const gchar *id);
-};
-
-struct _PangoModuleClass
-{
-  GTypeModuleClass parent_class;
-};
-
-G_LOCK_DEFINE_STATIC (maps);
-static GList *maps = NULL;
-/* the following are readonly after init_modules */
-static GSList *registered_engines = NULL;
-
-static void build_map    (PangoMapInfo *info);
-static void init_modules (void);
-
-static GType pango_module_get_type (void);
-
 /**
  * pango_find_map:
  * @language: the language tag for which to find the map
  * @engine_type_id: the engine type for the map to find
  * @render_type_id: the render type for the map to find
  *
- * Locate a #PangoMap for a particular engine type and render
- * type. The resulting map can be used to determine the engine
- * for each character.
+ * Do not use.  Does not do anything.
+ *
+ * Return value: %NULL.
  *
- * Return value: the suitable #PangoMap.
+ * Deprecated: 1.37
  **/
 PangoMap *
-pango_find_map (PangoLanguage *language,
-		guint          engine_type_id,
-		guint          render_type_id)
-{
-  GList *tmp_list;
-  PangoMapInfo *map_info = NULL;
-  gboolean found_earlier = FALSE;
-
-  G_LOCK (maps);
-
-  tmp_list = maps;
-  while (tmp_list)
-    {
-      map_info = tmp_list->data;
-      if (map_info->engine_type_id == engine_type_id &&
-	  map_info->render_type_id == render_type_id)
-	{
-	  if (map_info->language == language)
-	    break;
-	  else
-	    found_earlier = TRUE;
-	}
-
-      tmp_list = tmp_list->next;
-    }
-
-  if (!tmp_list)
-    {
-      map_info = g_slice_new (PangoMapInfo);
-      map_info->language = language;
-      map_info->engine_type_id = engine_type_id;
-      map_info->render_type_id = render_type_id;
-
-      build_map (map_info);
-
-      maps = g_list_prepend (maps, map_info);
-    }
-  else if (found_earlier)
-    {
-      /* Move the found map to the beginning of the list
-       * for speed next time around if we had to do
-       * any failing comparison. (No longer so important,
-       * since we don't strcmp.)
-       */
-      maps = g_list_remove_link(maps, tmp_list);
-      maps = g_list_prepend(maps, tmp_list->data);
-      g_list_free_1(tmp_list);
-    }
-
-  G_UNLOCK (maps);
-
-  return map_info->map;
-}
-
-G_DEFINE_TYPE (PangoModule, pango_module, G_TYPE_TYPE_MODULE);
-
-static gboolean
-pango_module_load (GTypeModule *module)
-{
-  PangoModule *pango_module = PANGO_MODULE (module);
-
-  /* call the module's init function to let it */
-  /* setup anything it needs to set up. */
-  pango_module->init (module);
-
-  return TRUE;
-}
-
-static void
-pango_module_unload (GTypeModule *module)
-{
-  PangoModule *pango_module = PANGO_MODULE (module);
-
-  pango_module->exit();
-}
-
-/* This only will ever be called if an error occurs during
- * initialization
- */
-static void
-pango_module_finalize (GObject *object)
-{
-  G_OBJECT_CLASS (pango_module_parent_class)->finalize (object);
-}
-
-static void
-pango_module_init (PangoModule *self)
+pango_find_map (PangoLanguage *language G_GNUC_UNUSED,
+		guint          engine_type_id G_GNUC_UNUSED,
+		guint          render_type_id G_GNUC_UNUSED)
 {
-}
-
-static void
-pango_module_class_init (PangoModuleClass *class)
-{
-  GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
-  GObjectClass *gobject_class = G_OBJECT_CLASS (class);
-
-  module_class->load = pango_module_load;
-  module_class->unload = pango_module_unload;
-
-  gobject_class->finalize = pango_module_finalize;
-}
-
-G_LOCK_DEFINE_STATIC (engine);
-
-static PangoEngine *
-pango_engine_pair_get_engine (PangoEnginePair *pair)
-{
-  G_LOCK (engine);
-
-  if (!pair->engine)
-    {
-      if (g_type_module_use (G_TYPE_MODULE (pair->module)))
-	{
-	  pair->engine = pair->module->create (pair->info.id);
-	  g_type_module_unuse (G_TYPE_MODULE (pair->module));
-	}
-    }
-
-  G_UNLOCK (engine);
-
-  return pair->engine;
-}
-
-static void
-handle_included_module (PangoIncludedModule *included_module,
-			GSList             **engine_list)
-{
-  PangoModule *module = g_object_new (PANGO_TYPE_MODULE, NULL);
-  PangoEngineInfo *engine_info;
-  int n_engines;
-  int i;
-
-  module->list = included_module->list;
-  module->init = included_module->init;
-  module->exit = included_module->exit;
-  module->create = included_module->create;
-
-  module->list (&engine_info, &n_engines);
-
-  for (i = 0; i < n_engines; i++)
-    {
-      PangoEnginePair *pair = g_slice_new (PangoEnginePair);
-
-      pair->info = engine_info[i];
-      pair->module = module;
-      pair->engine = NULL;
-
-      *engine_list = g_slist_prepend (*engine_list, pair);
-    }
-}
-
-static void
-init_modules (void)
-{
-  static gsize init = 0;
-  int i;
-
-  if (g_once_init_enter (&init))
-    {
-#if !GLIB_CHECK_VERSION (2, 35, 3)
-      /* Make sure that the type system is initialized */
-      g_type_init ();
-#endif
-
-      for (i = 0; _pango_included_lang_modules[i].list; i++)
-        pango_module_register (&_pango_included_lang_modules[i]);
-
-      g_once_init_leave (&init, 1);
-    }
-}
-
-static void
-map_add_engine (PangoMapInfo    *info,
-		PangoEnginePair *pair)
-{
-  PangoMap *map = info->map;
-  int i;
-
-  for (i=0; i<pair->info.n_scripts; i++)
-    {
-      PangoScript script;
-      PangoMapEntry *entry;
-      gboolean is_exact = FALSE;
-
-      if (pair->info.scripts[i].langs)
-	{
-	  if (pango_language_matches (info->language, pair->info.scripts[i].langs))
-	    is_exact = TRUE;
-	}
-
-      script = pair->info.scripts[i].script;
-      if ((guint)script >= map->entries->len)
-	g_array_set_size (map->entries, script + 1);
-
-      entry = &g_array_index (map->entries, PangoMapEntry, script);
-
-      if (is_exact)
-	entry->exact = g_slist_prepend (entry->exact, pair);
-      else
-	entry->fallback = g_slist_prepend (entry->fallback, pair);
-    }
-}
-
-static void
-map_add_engine_list (PangoMapInfo *info,
-		     GSList       *engines,
-		     const char   *engine_type,
-		     const char   *render_type)
-{
-  GSList *tmp_list = engines;
-
-  while (tmp_list)
-    {
-      PangoEnginePair *pair = tmp_list->data;
-      tmp_list = tmp_list->next;
-
-      if (strcmp (pair->info.engine_type, engine_type) == 0 &&
-	  strcmp (pair->info.render_type, render_type) == 0)
-	{
-	  map_add_engine (info, pair);
-	}
-    }
-}
-
-static void
-build_map (PangoMapInfo *info)
-{
-  const char *engine_type = g_quark_to_string (info->engine_type_id);
-  const char *render_type = g_quark_to_string (info->render_type_id);
-
-  init_modules();
-
-  /* XXX: Can this even happen, now all modules are built statically? */
-  if (!registered_engines)
-    {
-      static gboolean no_module_warning = FALSE; /* MT-safe */
-      if (!no_module_warning)
-	{
-	  g_critical ("No modules found:\n"
-		      "No builtin or dynamically loaded modules were found.\n"
-		      "PangoFc will not work correctly.");
-
-	  no_module_warning = TRUE;
-	}
-    }
-
-  info->map = g_slice_new (PangoMap);
-  info->map->entries = g_array_new (FALSE, TRUE, sizeof (PangoMapEntry));
-
-  map_add_engine_list (info, registered_engines, engine_type, render_type);
+  return NULL;
 }
 
 /**
@@ -386,51 +66,17 @@ build_map (PangoMapInfo *info)
  * @map: a #PangoMap
  * @script: a #PangoScript
  *
- * Returns the best engine listed in the map for a given script
+ * Do not use.  Does not do anything.
+ *
+ * Return value: %NULL.
  *
- * Return value: (nullable): the best engine, if one is listed for the
- *    script, or %NULL. The lookup may cause the engine to be loaded;
- *    once an engine is loaded, it won't be unloaded. If multiple
- *    engines are exact for the script, the choice of which is
- *    returned is arbitrary.
+ * Deprecated: 1.37
  **/
 PangoEngine *
-pango_map_get_engine (PangoMap   *map,
-		      PangoScript script)
+pango_map_get_engine (PangoMap   *map G_GNUC_UNUSED,
+		      PangoScript script G_GNUC_UNUSED)
 {
-  PangoMapEntry *entry = NULL;
-  PangoMapEntry *common_entry = NULL;
-
-  if ((guint)script < map->entries->len)
-    entry = &g_array_index (map->entries, PangoMapEntry, script);
-
-  if (PANGO_SCRIPT_COMMON < map->entries->len)
-    common_entry = &g_array_index (map->entries, PangoMapEntry, PANGO_SCRIPT_COMMON);
-
-  if (entry && entry->exact)
-    return pango_engine_pair_get_engine (entry->exact->data);
-  else if (common_entry && common_entry->exact)
-    return pango_engine_pair_get_engine (common_entry->exact->data);
-  else if (entry && entry->fallback)
-    return pango_engine_pair_get_engine (entry->fallback->data);
-  else if (common_entry && common_entry->fallback)
-    return pango_engine_pair_get_engine (common_entry->fallback->data);
-  else
-    return NULL;
-}
-
-static void
-append_engines (GSList **engine_list,
-		GSList  *pair_list)
-{
-  GSList *l;
-
-  for (l = pair_list; l; l = l->next)
-    {
-      PangoEngine *engine = pango_engine_pair_get_engine (l->data);
-      if (engine)
-	*engine_list = g_slist_append (*engine_list, engine);
-    }
+  return NULL;
 }
 
 /**
@@ -442,63 +88,28 @@ append_engines (GSList **engine_list,
  * @fallback_engines: location to store list of engines that approximately
  *  handle this script.
  *
- * Finds engines in the map that handle the given script. The returned
- * lists should be freed with g_slist_free, but the engines in the
- * lists are owned by GLib and will be kept around permanently, so
- * they should not be unref'ed.
+ * Do not use.  Does not do anything.
  *
  * Since: 1.4
+ * Deprecated: 1.37
  **/
 void
-pango_map_get_engines (PangoMap     *map,
-		       PangoScript   script,
-		       GSList      **exact_engines,
-		       GSList      **fallback_engines)
+pango_map_get_engines (PangoMap     *map G_GNUC_UNUSED,
+		       PangoScript   script G_GNUC_UNUSED,
+		       GSList      **exact_engines G_GNUC_UNUSED,
+		       GSList      **fallback_engines G_GNUC_UNUSED)
 {
-  PangoMapEntry *entry = NULL;
-  PangoMapEntry *common_entry = NULL;
-
-  if ((guint)script < map->entries->len)
-    entry = &g_array_index (map->entries, PangoMapEntry, script);
-
-  if (PANGO_SCRIPT_COMMON < map->entries->len)
-    common_entry = &g_array_index (map->entries, PangoMapEntry, PANGO_SCRIPT_COMMON);
-
-  if (exact_engines)
-    {
-      *exact_engines = NULL;
-      if (entry && entry->exact)
-	append_engines (exact_engines, entry->exact);
-      else if (common_entry && common_entry->exact)
-	append_engines (exact_engines, common_entry->exact);
-    }
-
-  if (fallback_engines)
-    {
-      *fallback_engines = NULL;
-      if (entry && entry->fallback)
-	append_engines (fallback_engines, entry->fallback);
-      else if (common_entry && common_entry->fallback)
-	append_engines (fallback_engines, common_entry->fallback);
-    }
 }
 
 /**
  * pango_module_register:
  * @module: a #PangoIncludedModule
  *
- * Registers a statically linked module with Pango. The
- * #PangoIncludedModule structure that is passed in contains the
- * functions that would otherwise be loaded from a dynamically loaded
- * module.
+ * Do not use.  Does not do anything.
+ *
+ * Deprecated: 1.37
  **/
 void
-pango_module_register (PangoIncludedModule *module)
+pango_module_register (PangoIncludedModule *module G_GNUC_UNUSED)
 {
-  GSList *tmp_list = NULL;
-
-  handle_included_module (module, &tmp_list);
-
-  registered_engines = g_slist_concat (registered_engines,
-				       g_slist_reverse (tmp_list));
 }