/usr/share/gtk-doc/html/libanjuta/AnjutaCModule.html is in libanjuta-dev 2:3.14.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnjutaCModule</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="libanjuta-internal-api.html" title="libanjuta internal API">
<link rel="prev" href="AnjutaCPluginFactory.html" title="AnjutaCPluginFactory">
<link rel="next" href="ESplash.html" title="ESplash">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AnjutaCPluginFactory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libanjuta-internal-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Anjuta Developers Reference Manual</th>
<td><a accesskey="n" href="ESplash.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AnjutaCModule.synopsis" class="shortcut">Top</a>
|
<a href="#AnjutaCModule.description" class="shortcut">Description</a>
|
<a href="#AnjutaCModule.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#AnjutaCModule.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="AnjutaCModule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AnjutaCModule.top_of_page"></a>AnjutaCModule</span></h2>
<p>AnjutaCModule — Anjuta C module</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AnjutaCModule.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libanjuta/anjuta-c-module.h>
<a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="returnvalue">AnjutaCModule</span></a> * <a class="link" href="AnjutaCModule.html#anjuta-c-module-new" title="anjuta_c_module_new ()">anjuta_c_module_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="AnjutaCModule.html#anjuta-c-module-get-last-error" title="anjuta_c_module_get_last_error ()">anjuta_c_module_get_last_error</a> (<em class="parameter"><code><a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="type">AnjutaCModule</span></a> *module</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);
<a class="link" href="AnjutaCModule.html#AnjutaCModule-struct" title="AnjutaCModule">AnjutaCModule</a>;
<a class="link" href="AnjutaCModule.html#AnjutaCModuleClass" title="AnjutaCModuleClass">AnjutaCModuleClass</a>;
</pre>
</div>
<div class="refsect1">
<a name="AnjutaCModule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html">GTypeModule</a>
+----AnjutaCModule
</pre>
</div>
<div class="refsect1">
<a name="AnjutaCModule.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
AnjutaCModule implements
<a href="http://library.gnome.org/devel/gobject/unstable/GTypePlugin.html">GTypePlugin</a>.</p>
</div>
<div class="refsect1">
<a name="AnjutaCModule.description"></a><h2>Description</h2>
<p>
A module is the part of the plugin containing the code. For machine code
compiled from C sources by example, it is a shared library and contained in
a .so file on Linux. GLib provides a portable way to load dynamically such
code with <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"><span class="type">GModule</span></a> objects.
</p>
<p>
In GLib you can register a dynamic type which means that you links a GLib
type with a module. When the type is used for the first time the module is
loaded. When the type is not used anymore, the module is unloaded. Most of
the code necessary to do this is already written in GLib <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> object
except the load and unload function.
</p>
<p>
<a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="type">AnjutaCModule</span></a> is used only by a <a class="link" href="AnjutaCPluginFactory.html" title="AnjutaCPluginFactory"><span class="type">AnjutaCPluginFactory</span></a>. It derives from
<a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> and implements the load and unload function using a <a href="http://library.gnome.org/devel/glib/unstable/glib-Dynamic-Loading-of-Modules.html#GModule"><span class="type">GModule</span></a>
object for a module written in C.
</p>
<p>
Anjuta plugin types are not registered before loading the module.
The loading of the module is done explicitly and types are registered just
after in a function included in the plugin. This function is named
anjuta_glue_register_components and has a <a href="http://library.gnome.org/devel/gobject/unstable/GTypeModule.html"><span class="type">GTypeModule</span></a> as argument.
The plugin must registers at the least the plugin type dynamically. It can
register other types, but this is currently not used.
</p>
<p>
After loading a module one or more plugin objects will be created using the
name of the plugin type which has just been registered. The module
will stay loaded while at least one plugin object is present. If all
plugins objects are destroyed the unload function will be called and the
module can be unloaded and removed from memory.
</p>
<p>
It could be useful that some modules stay in memory even if there is no
object using it. A typical example is if some plugin code or some code of
a library used by a plugin registers a GLib type statically. GLib types can
be registered statically at run time but cannot be unregistered later.
The code (or rather the data used in the registration) must stay in the
memory even if the type is not used. In order to avoid this, you must
register every type dynamically. You could have other situations where a
module cannot be unloaded. By default, Anjuta plugin modules are not
unloaded unless it is explicitly allowed.
</p>
</div>
<div class="refsect1">
<a name="AnjutaCModule.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="anjuta-c-module-new"></a><h3>anjuta_c_module_new ()</h3>
<pre class="programlisting"><a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="returnvalue">AnjutaCModule</span></a> * anjuta_c_module_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
<p>
Create a new <a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="type">AnjutaCModule</span></a> object.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>The full path of the module</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>The name of the module</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="type">AnjutaCModule</span></a> object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-c-module-get-last-error"></a><h3>anjuta_c_module_get_last_error ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> anjuta_c_module_get_last_error (<em class="parameter"><code><a class="link" href="AnjutaCModule.html" title="AnjutaCModule"><span class="type">AnjutaCModule</span></a> *module</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **err</code></em>);</pre>
<p>
Receives the error that occured when the module was loaded
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>module</code></em> :</span></p></td>
<td>AnjutaCModule object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>err</code></em> :</span></p></td>
<td>return location for a GError</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there was an Error, <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaCModule-struct"></a><h3>AnjutaCModule</h3>
<pre class="programlisting">typedef struct _AnjutaCModule AnjutaCModule;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaCModuleClass"></a><h3>AnjutaCModuleClass</h3>
<pre class="programlisting">typedef struct _AnjutaCModuleClass AnjutaCModuleClass;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="AnjutaCModule.see-also"></a><h2>See Also</h2>
<a class="link" href="AnjutaCPluginFactory.html" title="AnjutaCPluginFactory"><span class="type">AnjutaCPluginFactory</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|