Move tests/module-test.c to gmodules/tests/

Helps issue #1434

gmodule/tests/libmoduletestplugin_a.c

@@ -0,0 +1,71 @@
+/* libgplugin_a.c - test plugin for testgmodule
+ * Copyright (C) 1998 Tim Janik
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include	<gmodule.h>
+
+G_MODULE_EXPORT void gplugin_a_func (void);
+G_MODULE_EXPORT void gplugin_clash_func (void);
+G_MODULE_EXPORT void g_clash_func (void);
+G_MODULE_EXPORT void gplugin_say_boo_func (void);
+G_MODULE_EXPORT void gplugin_a_module_func (GModule *module);
+
+G_MODULE_EXPORT gchar* gplugin_a_state;
+
+G_MODULE_EXPORT void
+gplugin_a_func (void)
+{
+  gplugin_a_state = "Hello world";
+}
+
+G_MODULE_EXPORT void
+gplugin_clash_func (void)
+{
+  gplugin_a_state = "plugin clash";
+}
+
+G_MODULE_EXPORT void
+g_clash_func (void)
+{
+  gplugin_a_state = "global clash";
+}
+
+G_MODULE_EXPORT void
+gplugin_say_boo_func (void)
+{
+  gplugin_a_state = "BOOH";
+}
+
+G_MODULE_EXPORT void
+gplugin_a_module_func (GModule *module)
+{
+  void *f = NULL;
+
+  if (!g_module_symbol (module, "gplugin_say_boo_func", &f ))
+    {
+      g_print ("error: %s\n", g_module_error ());
+      exit (1);
+    }
+
+  ((void(*)(void)) f) ();
+}

gmodule/tests/libmoduletestplugin_b.c

@@ -0,0 +1,73 @@
+/* libgplugin_b.c - test plugin for testgmodule
+ * Copyright (C) 1998 Tim Janik
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include        <gmodule.h>
+
+G_MODULE_EXPORT gchar* gplugin_b_state;
+
+G_MODULE_EXPORT const gchar* g_module_check_init (GModule *module);
+G_MODULE_EXPORT void   g_module_unload (GModule *module);
+
+G_MODULE_EXPORT void gplugin_b_func (void);
+G_MODULE_EXPORT void gplugin_clash_func (void);
+G_MODULE_EXPORT void g_clash_func (void);
+G_MODULE_EXPORT void gplugin_say_boo_func (void);
+
+G_MODULE_EXPORT const gchar*
+g_module_check_init (GModule *module)
+{
+  gplugin_b_state = "check-init";
+
+  return NULL;
+}
+
+G_MODULE_EXPORT void
+g_module_unload (GModule *module)
+{
+  gplugin_b_state = "unloaded";
+}
+
+G_MODULE_EXPORT void
+gplugin_b_func (void)
+{
+  gplugin_b_state = "Hello world";
+}
+
+G_MODULE_EXPORT void
+gplugin_clash_func (void)
+{
+  gplugin_b_state = "plugin clash";
+}
+
+G_MODULE_EXPORT void
+g_clash_func (void)
+{
+  gplugin_b_state = "global clash";
+}
+
+G_MODULE_EXPORT void
+gplugin_say_boo_func (void)
+{
+  gplugin_b_state = "BOOH";
+}

gmodule/tests/meson.build

@@ -2,8 +2,40 @@ gmodule_tests = {
   'cxx' : {
     'source' : ['cxx.cpp'],
   },
+  'module-test-library' : {
+    'export_dynamic' : true,
+    'source': 'module-test.c',
+    'c_args': ['-DMODULE_TYPE="library"'],
+  },
+  'module-test-plugin' : {
+    'export_dynamic' : true,
+    'source': 'module-test.c',
+    'c_args': ['-DMODULE_TYPE="plugin"'],
+  },
 }
 
+module_suffix = []
+# Keep the autotools convention for shared module suffix because GModule
+# depends on it: https://gitlab.gnome.org/GNOME/glib/issues/520
+if ['darwin', 'ios'].contains(host_machine.system())
+  module_suffix = 'so'
+endif
+
+foreach module : ['moduletestplugin_a', 'moduletestplugin_b']
+  shared_module(module + '_plugin', 'lib@0@.c'.format(module),
+    dependencies : [libglib_dep, libgmodule_dep],
+    install_dir : installed_tests_execdir,
+    install : installed_tests_enabled,
+    name_suffix : module_suffix
+  )
+  shared_library(module + '_library', 'lib@0@.c'.format(module),
+    dependencies : [libglib_dep, libgmodule_dep],
+    install_dir : installed_tests_execdir,
+    install : installed_tests_enabled,
+    name_suffix : module_suffix
+  )
+endforeach
+
 test_env = environment()
 test_env.set('G_TEST_SRCDIR', meson.current_source_dir())
 test_env.set('G_TEST_BUILDDIR', meson.current_build_dir())
@@ -35,6 +67,7 @@ foreach test_name, extra_args : gmodule_tests
     c_args : test_cargs + extra_args.get('c_args', []),
     link_args : extra_args.get('link_args', []),
     dependencies : test_deps + extra_args.get('dependencies', []),
+    export_dynamic : extra_args.get('export_dynamic', false),
     install_dir: installed_tests_execdir,
     install: install,
   )

gmodule/tests/module-test.c

@@ -0,0 +1,214 @@
+/* module-test.c - test program for GMODULE
+ * Copyright (C) 1998 Tim Janik
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
+ */
+
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include <gmodule.h>
+
+#ifdef _MSC_VER
+# define MODULE_FILENAME_PREFIX ""
+#else
+# define MODULE_FILENAME_PREFIX "lib"
+#endif
+
+gchar *global_state = NULL;
+
+G_MODULE_EXPORT void g_clash_func (void);
+
+G_MODULE_EXPORT void
+g_clash_func (void)
+{
+  global_state = "global clash";
+}
+
+typedef	void (*SimpleFunc) (void);
+typedef	void (*GModuleFunc) (GModule *);
+
+static gchar **gplugin_a_state;
+static gchar **gplugin_b_state;
+
+static void
+compare (const gchar *desc, const gchar *expected, const gchar *found)
+{
+  if (!expected && !found)
+    return;
+
+  if (expected && found && strcmp (expected, found) == 0)
+    return;
+
+  g_error ("error: %s state should have been \"%s\", but is \"%s\"",
+	   desc, expected ? expected : "NULL", found ? found : "NULL");
+}
+
+static void
+test_states (const gchar *global, const gchar *gplugin_a, const gchar *gplugin_b)
+{
+  compare ("global", global, global_state);
+  compare ("Plugin A", gplugin_a, *gplugin_a_state);
+  compare ("Plugin B", gplugin_b, *gplugin_b_state);
+
+  global_state = *gplugin_a_state = *gplugin_b_state = NULL;
+}
+
+static SimpleFunc plugin_clash_func = NULL;
+
+static void
+test_module_basics (void)
+{
+  GModule *module_self, *module_a, *module_b;
+  gchar *plugin_a, *plugin_b;
+  SimpleFunc f_a, f_b, f_self;
+  GModuleFunc gmod_f;
+  GError *error = NULL;
+
+  if (!g_module_supported ())
+    g_error ("dynamic modules not supported");
+
+  plugin_a = g_test_build_filename (G_TEST_BUILT, MODULE_FILENAME_PREFIX "moduletestplugin_a_" MODULE_TYPE, NULL);
+  plugin_b = g_test_build_filename (G_TEST_BUILT, MODULE_FILENAME_PREFIX "moduletestplugin_b_" MODULE_TYPE, NULL);
+
+  /* module handles */
+
+  module_self = g_module_open_full (NULL, G_MODULE_BIND_LAZY, &error);
+  g_assert_no_error (error);
+  if (!module_self)
+    g_error ("error: %s", g_module_error ());
+
+    /* On Windows static compilation mode, glib API symbols are not
+     * exported dynamically by definition. */
+#if !defined(G_PLATFORM_WIN32) || !defined(GLIB_STATIC_COMPILATION)
+  if (!g_module_symbol (module_self, "g_module_close", (gpointer *) &f_self))
+    g_error ("error: %s", g_module_error ());
+#endif
+
+  module_a = g_module_open_full (plugin_a, G_MODULE_BIND_LAZY, &error);
+  g_assert_no_error (error);
+  if (!module_a)
+    g_error ("error: %s", g_module_error ());
+
+  module_b = g_module_open_full (plugin_b, G_MODULE_BIND_LAZY, &error);
+  g_assert_no_error (error);
+  if (!module_b)
+    g_error ("error: %s", g_module_error ());
+
+  /* get plugin state vars */
+
+  if (!g_module_symbol (module_a, "gplugin_a_state",
+                        (gpointer *) &gplugin_a_state))
+    g_error ("error: %s", g_module_error ());
+
+  if (!g_module_symbol (module_b, "gplugin_b_state",
+                        (gpointer *) &gplugin_b_state))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, "check-init");
+
+  /* get plugin specific symbols and call them */
+
+  if (!g_module_symbol (module_a, "gplugin_a_func", (gpointer *) &f_a))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  if (!g_module_symbol (module_b, "gplugin_b_func", (gpointer *) &f_b))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  f_a ();
+  test_states (NULL, "Hello world", NULL);
+
+  f_b ();
+  test_states (NULL, NULL, "Hello world");
+
+  /* get and call globally clashing functions */
+
+  if (!g_module_symbol (module_self, "g_clash_func", (gpointer *) &f_self))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  if (!g_module_symbol (module_a, "g_clash_func", (gpointer *) &f_a))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  if (!g_module_symbol (module_b, "g_clash_func", (gpointer *) &f_b))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  f_self ();
+  test_states ("global clash", NULL, NULL);
+
+  f_a ();
+  test_states (NULL, "global clash", NULL);
+
+  f_b ();
+  test_states (NULL, NULL, "global clash");
+
+  /* get and call clashing plugin functions  */
+
+  if (!g_module_symbol (module_a, "gplugin_clash_func", (gpointer *) &f_a))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  if (!g_module_symbol (module_b, "gplugin_clash_func", (gpointer *) &f_b))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  plugin_clash_func = f_a;
+  plugin_clash_func ();
+  test_states (NULL, "plugin clash", NULL);
+
+  plugin_clash_func = f_b;
+  plugin_clash_func ();
+  test_states (NULL, NULL, "plugin clash");
+
+  /* call gmodule function from A  */
+
+  if (!g_module_symbol (module_a, "gplugin_a_module_func", (gpointer *) &gmod_f))
+    g_error ("error: %s", g_module_error ());
+  test_states (NULL, NULL, NULL);
+
+  gmod_f (module_b);
+  test_states (NULL, NULL, "BOOH");
+
+  gmod_f (module_a);
+  test_states (NULL, "BOOH", NULL);
+
+  /* unload plugins  */
+
+  if (!g_module_close (module_a))
+    g_error ("error: %s", g_module_error ());
+
+  if (!g_module_close (module_b))
+    g_error ("error: %s", g_module_error ());
+
+  g_free (plugin_a);
+  g_free (plugin_b);
+  g_module_close (module_self);
+}
+
+int
+main (int argc, char *argv[])
+{
+  g_test_init (&argc, &argv, NULL);
+
+  g_test_add_func ("/module/basics", test_module_basics);
+
+  return g_test_run ();
+}