From 6335c6ecf9be2a29cf3d074b21fc71cdae642b6a Mon Sep 17 00:00:00 2001
From: Colin Kiama <colinkiama@gmail.com>
Date: Sat, 1 Feb 2025 21:52:26 +0000
Subject: [PATCH 1/2] Add Type Modules Plugin info in developer guides

---
 source/developer-guides/plugins.rst           |   8 ++
 .../plugins/01-type-modules.rst               | 110 ++++++++++++++++++
 .../developer-guides/plugins/02-libpeas.rst   |   0
 3 files changed, 118 insertions(+)
 create mode 100644 source/developer-guides/plugins.rst
 create mode 100644 source/developer-guides/plugins/01-type-modules.rst
 create mode 100644 source/developer-guides/plugins/02-libpeas.rst

diff --git a/source/developer-guides/plugins.rst b/source/developer-guides/plugins.rst
new file mode 100644
index 00000000..746a5fe0
--- /dev/null
+++ b/source/developer-guides/plugins.rst
@@ -0,0 +1,8 @@
+Plugins
+=======
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   plugins/*
diff --git a/source/developer-guides/plugins/01-type-modules.rst b/source/developer-guides/plugins/01-type-modules.rst
new file mode 100644
index 00000000..66a688b5
--- /dev/null
+++ b/source/developer-guides/plugins/01-type-modules.rst
@@ -0,0 +1,110 @@
+Type Modules
+============
+
+This example shows you how to implement a GLib.TypeModule based plugin in Vala. It also shows the usage of static construct/destruct block. Plugin itself: plugin.vala
+
+.. code-block:: vala
+
+   // plugin.vala
+
+   public class MyClass : Object
+   {
+           static construct
+           {
+                   message("MyClass init");
+           }
+
+           static ~MyClass()
+           {
+                   message("MyClass deinit");
+           }
+   }
+
+   [ModuleInit]
+   Type plugin_init(GLib.TypeModule type_modul)
+   {
+           return typeof(MyClass);
+   }
+
+
+.. code-block:: vala
+
+   // loader.vala
+   class MyModule : TypeModule
+   {
+         [CCode (has_target = false)]
+         private delegate Type PluginInitFunc(TypeModule module);
+
+         private GLib.Module module = null;
+
+         private string name = null;
+
+         public MyModule(string name)
+         {
+                  this.name = name;
+         }
+
+         public override bool load()
+         {
+                  string path = Module.build_path(null, name);
+                  module = Module.open(path, GLib.ModuleFlags.BIND_LAZY);
+                  if(null == module) {
+                           error("Module not found");
+                  }
+
+                  void * plugin_init = null;
+                  if(! module.symbol("plugin_init", out plugin_init)) {
+                           error("No such symbol");
+                  }
+
+                  ((PluginInitFunc) plugin_init)(this);
+
+                  return true;
+         }
+
+         public override void unload()
+         {
+                  module = null;
+
+                  message("Library unloaded");
+         }
+   }
+
+   // Never unref instance of GTypeModule
+   // http://www.lanedo.com/~mitch/module-system-talk-guadec-2006/Module-System-Talk-Guadec-2006.pdf
+   static TypeModule module = null;
+
+   int main()
+   {
+         module = new MyModule("plugin");
+         module.load();
+
+         var o = GLib.Object.new(Type.from_name("MyClass"));
+
+         // free last instance, plugin unload
+         o = null;
+
+         return 0;
+   }
+
+**Build**:
+
+.. code-block:: console
+
+   $ valac -o loader loader.vala --pkg=gmodule-2.0
+   $ valac --ccode plugin.vala
+   $ gcc -fPIC -shared -o libplugin.so plugin.c $(pkg-config --libs --cflags gobject-2.0 gmodule-2.0)
+
+**Run**:
+
+.. code-block:: console
+
+   $ LD_LIBRARY_PATH=$PWD ./loader
+
+Which should output something like this:
+
+.. code-block:: output
+
+   ** Message: plugin.vala:5: MyClass init
+   ** Message: plugin.vala:10: MyClass deinit
+   ** Message: loader.vala:37: Library unloaded
diff --git a/source/developer-guides/plugins/02-libpeas.rst b/source/developer-guides/plugins/02-libpeas.rst
new file mode 100644
index 00000000..e69de29b

From 6893e5499192c9e8fa2317cf5f9ab1665aab9b10 Mon Sep 17 00:00:00 2001
From: Colin Kiama <colinkiama@gmail.com>
Date: Sat, 1 Feb 2025 22:04:57 +0000
Subject: [PATCH 2/2] Add Libpeas Plugin info in developer guides

---
 source/developer-guides/plugins/01-type-modules.rst |  3 +--
 source/developer-guides/plugins/02-libpeas.rst      | 12 ++++++++++++
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/source/developer-guides/plugins/01-type-modules.rst b/source/developer-guides/plugins/01-type-modules.rst
index 66a688b5..e65e8941 100644
--- a/source/developer-guides/plugins/01-type-modules.rst
+++ b/source/developer-guides/plugins/01-type-modules.rst
@@ -1,12 +1,11 @@
 Type Modules
 ============
 
-This example shows you how to implement a GLib.TypeModule based plugin in Vala. It also shows the usage of static construct/destruct block. Plugin itself: plugin.vala
+This example shows you how to implement a GLib.TypeModule based plugin in Vala. It also shows the usage of static construct/destruct block.
 
 .. code-block:: vala
 
    // plugin.vala
-
    public class MyClass : Object
    {
            static construct
diff --git a/source/developer-guides/plugins/02-libpeas.rst b/source/developer-guides/plugins/02-libpeas.rst
index e69de29b..549030d6 100644
--- a/source/developer-guides/plugins/02-libpeas.rst
+++ b/source/developer-guides/plugins/02-libpeas.rst
@@ -0,0 +1,12 @@
+Libpeas
+=======
+
+In advanced scenarios, you may need to create a plugin engine to manage plugins in your application.
+
+You can save time by using Libpeas, a library that handles that logic of making your application extensible with plugins.
+
+**Links**:
+
+* `Project Repository <https://gitlab.gnome.org/GNOME/libpeas>`_
+* `libpeas-2 - Valadoc Package page <https://valadoc.org/libpeas-2/index.htm>`_
+* `libpeas-2 - C Documentation <https://gnome.pages.gitlab.gnome.org/libpeas/libpeas-2/>`_