Debian Codegraph @

docs/api/html/libprelude-prelude-plugin.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>prelude-plugin: libprelude Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="index.html" title="libprelude Reference Manual">
8 <link rel="up" href="ch01.html" title="[Insert title here]">
9 <link rel="prev" href="libprelude-prelude-client-profile.html" title="prelude-client-profile">
10 <link rel="next" href="libprelude-prelude-hash.html" title="prelude-hash">
11 <meta name="generator" content="GTK-Doc V1.28 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#libprelude-prelude-plugin.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="libprelude-prelude-client-profile.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="libprelude-prelude-hash.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="libprelude-prelude-plugin"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="libprelude-prelude-plugin.top_of_page"></a>prelude-plugin</span></h2>
30 <p>prelude-plugin</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="libprelude-prelude-plugin.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="define_keyword">#define</td>
44 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#PRELUDE-PLUGIN-SET-PRELOADED-SYMBOLS:CAPS" title="PRELUDE_PLUGIN_SET_PRELOADED_SYMBOLS">PRELUDE_PLUGIN_SET_PRELOADED_SYMBOLS</a></td>
45 </tr>
46 <tr>
47 <td class="define_keyword">#define</td>
48 <td class="function_name">
49 <a class="link" href="libprelude-prelude-plugin.html#PRELUDE-PLUGIN-OPTION-DECLARE-STRING-CB:CAPS" title="PRELUDE_PLUGIN_OPTION_DECLARE_STRING_CB()">PRELUDE_PLUGIN_OPTION_DECLARE_STRING_CB</a><span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="define_keyword">#define</td>
54 <td class="function_name">
55 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-get-name" title="prelude_plugin_get_name()">prelude_plugin_get_name</a><span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="define_keyword">#define</td>
60 <td class="function_name">
61 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-set-name" title="prelude_plugin_set_name()">prelude_plugin_set_name</a><span class="c_punctuation">()</span>
62 </td>
63 </tr>
64 <tr>
65 <td class="define_keyword">#define</td>
66 <td class="function_name">
67 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-set-destroy-func" title="prelude_plugin_set_destroy_func()">prelude_plugin_set_destroy_func</a><span class="c_punctuation">()</span>
68 </td>
69 </tr>
70 <tr>
71 <td class="function_type">
72 <span class="returnvalue">void</span>
73 </td>
74 <td class="function_name">
75 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-entry-set-plugin" title="prelude_plugin_entry_set_plugin ()">prelude_plugin_entry_set_plugin</a> <span class="c_punctuation">()</span>
76 </td>
77 </tr>
78 <tr>
79 <td class="function_type">
80 <span class="returnvalue">int</span>
81 </td>
82 <td class="function_name">
83 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-set-activation-option" title="prelude_plugin_set_activation_option ()">prelude_plugin_set_activation_option</a> <span class="c_punctuation">()</span>
84 </td>
85 </tr>
86 <tr>
87 <td class="function_type">
88 <span class="returnvalue">int</span>
89 </td>
90 <td class="function_name">
91 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-subscribe" title="prelude_plugin_instance_subscribe ()">prelude_plugin_instance_subscribe</a> <span class="c_punctuation">()</span>
92 </td>
93 </tr>
94 <tr>
95 <td class="function_type">
96 <span class="returnvalue">int</span>
97 </td>
98 <td class="function_name">
99 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-unsubscribe" title="prelude_plugin_instance_unsubscribe ()">prelude_plugin_instance_unsubscribe</a> <span class="c_punctuation">()</span>
100 </td>
101 </tr>
102 <tr>
103 <td class="function_type">
104 <span class="returnvalue">int</span>
105 </td>
106 <td class="function_name">
107 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-new-instance" title="prelude_plugin_new_instance ()">prelude_plugin_new_instance</a> <span class="c_punctuation">()</span>
108 </td>
109 </tr>
110 <tr>
111 <td class="function_type">
112 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
113 </td>
114 <td class="function_name">
115 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-search-by-name" title="prelude_plugin_search_by_name ()">prelude_plugin_search_by_name</a> <span class="c_punctuation">()</span>
116 </td>
117 </tr>
118 <tr>
119 <td class="function_type">
120 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="returnvalue">prelude_plugin_instance_t</span></a> *
121 </td>
122 <td class="function_name">
123 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-search-instance-by-name" title="prelude_plugin_search_instance_by_name ()">prelude_plugin_search_instance_by_name</a> <span class="c_punctuation">()</span>
124 </td>
125 </tr>
126 <tr>
127 <td class="function_type">
128 <span class="returnvalue">void</span>
129 </td>
130 <td class="function_name">
131 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-set-data" title="prelude_plugin_instance_set_data ()">prelude_plugin_instance_set_data</a> <span class="c_punctuation">()</span>
132 </td>
133 </tr>
134 <tr>
135 <td class="function_type">
136 <span class="returnvalue">void</span> *
137 </td>
138 <td class="function_name">
139 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-get-data" title="prelude_plugin_instance_get_data ()">prelude_plugin_instance_get_data</a> <span class="c_punctuation">()</span>
140 </td>
141 </tr>
142 <tr>
143 <td class="function_type">
144 <span class="returnvalue">void</span>
145 </td>
146 <td class="function_name">
147 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-set-plugin-data" title="prelude_plugin_instance_set_plugin_data ()">prelude_plugin_instance_set_plugin_data</a> <span class="c_punctuation">()</span>
148 </td>
149 </tr>
150 <tr>
151 <td class="function_type">
152 <span class="returnvalue">void</span> *
153 </td>
154 <td class="function_name">
155 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-get-plugin-data" title="prelude_plugin_instance_get_plugin_data ()">prelude_plugin_instance_get_plugin_data</a> <span class="c_punctuation">()</span>
156 </td>
157 </tr>
158 <tr>
159 <td class="function_type">const <span class="returnvalue">char</span> *
160 </td>
161 <td class="function_name">
162 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-get-name" title="prelude_plugin_instance_get_name ()">prelude_plugin_instance_get_name</a> <span class="c_punctuation">()</span>
163 </td>
164 </tr>
165 <tr>
166 <td class="function_type">
167 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
168 </td>
169 <td class="function_name">
170 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-get-plugin" title="prelude_plugin_instance_get_plugin ()">prelude_plugin_instance_get_plugin</a> <span class="c_punctuation">()</span>
171 </td>
172 </tr>
173 <tr>
174 <td class="function_type">
175 <span class="returnvalue">int</span>
176 </td>
177 <td class="function_name">
178 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-load-from-dir" title="prelude_plugin_load_from_dir ()">prelude_plugin_load_from_dir</a> <span class="c_punctuation">()</span>
179 </td>
180 </tr>
181 <tr>
182 <td class="function_type">
183 <span class="returnvalue">int</span>
184 </td>
185 <td class="function_name">
186 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-add" title="prelude_plugin_instance_add ()">prelude_plugin_instance_add</a> <span class="c_punctuation">()</span>
187 </td>
188 </tr>
189 <tr>
190 <td class="function_type">
191 <span class="returnvalue">void</span>
192 </td>
193 <td class="function_name">
194 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-del" title="prelude_plugin_instance_del ()">prelude_plugin_instance_del</a> <span class="c_punctuation">()</span>
195 </td>
196 </tr>
197 <tr>
198 <td class="function_type">
199 <span class="returnvalue">void</span>
200 </td>
201 <td class="function_name">
202 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-compute-time" title="prelude_plugin_instance_compute_time ()">prelude_plugin_instance_compute_time</a> <span class="c_punctuation">()</span>
203 </td>
204 </tr>
205 <tr>
206 <td class="function_type">
207 <span class="returnvalue">int</span>
208 </td>
209 <td class="function_name">
210 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-call-commit-func" title="prelude_plugin_instance_call_commit_func ()">prelude_plugin_instance_call_commit_func</a> <span class="c_punctuation">()</span>
211 </td>
212 </tr>
213 <tr>
214 <td class="function_type">
215 <a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
216 </td>
217 <td class="function_name">
218 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-has-commit-func" title="prelude_plugin_instance_has_commit_func ()">prelude_plugin_instance_has_commit_func</a> <span class="c_punctuation">()</span>
219 </td>
220 </tr>
221 <tr>
222 <td class="function_type">
223 <span class="returnvalue">void</span>
224 </td>
225 <td class="function_name">
226 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-set-preloaded-symbols" title="prelude_plugin_set_preloaded_symbols ()">prelude_plugin_set_preloaded_symbols</a> <span class="c_punctuation">()</span>
227 </td>
228 </tr>
229 <tr>
230 <td class="function_type">
231 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
232 </td>
233 <td class="function_name">
234 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-get-next" title="prelude_plugin_get_next ()">prelude_plugin_get_next</a> <span class="c_punctuation">()</span>
235 </td>
236 </tr>
237 <tr>
238 <td class="function_type">
239 <span class="returnvalue">void</span>
240 </td>
241 <td class="function_name">
242 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-unload" title="prelude_plugin_unload ()">prelude_plugin_unload</a> <span class="c_punctuation">()</span>
243 </td>
244 </tr>
245 <tr>
246 <td class="define_keyword">#define</td>
247 <td class="function_name">
248 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-compute-stats" title="prelude_plugin_compute_stats()">prelude_plugin_compute_stats</a><span class="c_punctuation">()</span>
249 </td>
250 </tr>
251 <tr>
252 <td class="define_keyword">#define</td>
253 <td class="function_name">
254 <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-run" title="prelude_plugin_run()">prelude_plugin_run</a><span class="c_punctuation">()</span>
255 </td>
256 </tr>
257 </tbody>
258 </table></div>
259 </div>
260 <div class="refsect1">
261 <a name="libprelude-prelude-plugin.other"></a><h2>Types and Values</h2>
262 <div class="informaltable"><table width="100%" border="0">
263 <colgroup>
264 <col width="150px" class="name">
265 <col class="description">
266 </colgroup>
267 <tbody>
268 <tr>
269 <td class="define_keyword">#define</td>
270 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#lt-preloaded-symbols" title="lt_preloaded_symbols">lt_preloaded_symbols</a></td>
271 </tr>
272 <tr>
273 <td class="define_keyword">#define</td>
274 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#PRELUDE-PLUGIN-API-VERSION:CAPS" title="PRELUDE_PLUGIN_API_VERSION">PRELUDE_PLUGIN_API_VERSION</a></td>
275 </tr>
276 <tr>
277 <td class="typedef_keyword">typedef</td>
278 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-entry-t" title="prelude_plugin_entry_t">prelude_plugin_entry_t</a></td>
279 </tr>
280 <tr>
281 <td class="typedef_keyword">typedef</td>
282 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t">prelude_plugin_instance_t</a></td>
283 </tr>
284 <tr>
285 <td class="define_keyword">#define</td>
286 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#PRELUDE-PLUGIN-GENERIC:CAPS" title="PRELUDE_PLUGIN_GENERIC">PRELUDE_PLUGIN_GENERIC</a></td>
287 </tr>
288 <tr>
289 <td class="datatype_keyword"> </td>
290 <td class="function_name"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t">prelude_plugin_generic_t</a></td>
291 </tr>
292 </tbody>
293 </table></div>
294 </div>
295 <div class="refsect1">
296 <a name="libprelude-prelude-plugin.description"></a><h2>Description</h2>
297 </div>
298 <div class="refsect1">
299 <a name="libprelude-prelude-plugin.functions_details"></a><h2>Functions</h2>
300 <div class="refsect2">
301 <a name="PRELUDE-PLUGIN-SET-PRELOADED-SYMBOLS:CAPS"></a><h3>PRELUDE_PLUGIN_SET_PRELOADED_SYMBOLS</h3>
302 <pre class="programlisting">#define PRELUDE_PLUGIN_SET_PRELOADED_SYMBOLS()</pre>
303 </div>
304 <hr>
305 <div class="refsect2">
306 <a name="PRELUDE-PLUGIN-OPTION-DECLARE-STRING-CB:CAPS"></a><h3>PRELUDE_PLUGIN_OPTION_DECLARE_STRING_CB()</h3>
307 <pre class="programlisting">#define PRELUDE_PLUGIN_OPTION_DECLARE_STRING_CB(prefix, type, name)</pre>
308 </div>
309 <hr>
310 <div class="refsect2">
311 <a name="prelude-plugin-get-name"></a><h3>prelude_plugin_get_name()</h3>
312 <pre class="programlisting">#define prelude_plugin_get_name(p) (p)-&gt;name
313 </pre>
314 </div>
315 <hr>
316 <div class="refsect2">
317 <a name="prelude-plugin-set-name"></a><h3>prelude_plugin_set_name()</h3>
318 <pre class="programlisting">#define prelude_plugin_set_name(p, str) (p)-&gt;name = (str)
319 </pre>
320 </div>
321 <hr>
322 <div class="refsect2">
323 <a name="prelude-plugin-set-destroy-func"></a><h3>prelude_plugin_set_destroy_func()</h3>
324 <pre class="programlisting">#define prelude_plugin_set_destroy_func(p, func) (p)-&gt;destroy = func
325 </pre>
326 </div>
327 <hr>
328 <div class="refsect2">
329 <a name="prelude-plugin-entry-set-plugin"></a><h3>prelude_plugin_entry_set_plugin ()</h3>
330 <pre class="programlisting"><span class="returnvalue">void</span>
331 prelude_plugin_entry_set_plugin (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-entry-t" title="prelude_plugin_entry_t"><span class="type">prelude_plugin_entry_t</span></a> *pe</code></em>,
332 <em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="type">prelude_plugin_generic_t</span></a> *pl</code></em>);</pre>
333 </div>
334 <hr>
335 <div class="refsect2">
336 <a name="prelude-plugin-set-activation-option"></a><h3>prelude_plugin_set_activation_option ()</h3>
337 <pre class="programlisting"><span class="returnvalue">int</span>
338 prelude_plugin_set_activation_option (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-entry-t" title="prelude_plugin_entry_t"><span class="type">prelude_plugin_entry_t</span></a> *pe</code></em>,
339 <em class="parameter"><code><a class="link" href="libprelude-prelude-option.html#prelude-option-t" title="prelude_option_t"><span class="type">prelude_option_t</span></a> *opt</code></em>,
340 <em class="parameter"><code><span class="type">int</span> (*commit) (prelude_plugin_instance_t *pi, prelude_string_t *err)</code></em>);</pre>
341 </div>
342 <hr>
343 <div class="refsect2">
344 <a name="prelude-plugin-instance-subscribe"></a><h3>prelude_plugin_instance_subscribe ()</h3>
345 <pre class="programlisting"><span class="returnvalue">int</span>
346 prelude_plugin_instance_subscribe (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
347 </div>
348 <hr>
349 <div class="refsect2">
350 <a name="prelude-plugin-instance-unsubscribe"></a><h3>prelude_plugin_instance_unsubscribe ()</h3>
351 <pre class="programlisting"><span class="returnvalue">int</span>
352 prelude_plugin_instance_unsubscribe (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
353 <p>Set <em class="parameter"><code>pi</code></em>
354 to be inactive.</p>
355 <p>The unsubscribe function specified in <code class="function">plugin_load_from_dir()</code>
356 is called for plugin un-registration and the instance for this
357 plugin is freed.</p>
358 <div class="refsect3">
359 <a name="prelude-plugin-instance-unsubscribe.parameters"></a><h4>Parameters</h4>
360 <div class="informaltable"><table width="100%" border="0">
361 <colgroup>
362 <col width="150px" class="parameters_name">
363 <col class="parameters_description">
364 <col width="200px" class="parameters_annotations">
365 </colgroup>
366 <tbody><tr>
367 <td class="parameter_name"><p>pi</p></td>
368 <td class="parameter_description"><p>Pointer to a plugin instance.</p></td>
369 <td class="parameter_annotations"> </td>
370 </tr></tbody>
371 </table></div>
372 </div>
373 <div class="refsect3">
374 <a name="prelude-plugin-instance-unsubscribe.returns"></a><h4>Returns</h4>
375 <p> 0 on success, -1 if an error occured.</p>
376 </div>
377 </div>
378 <hr>
379 <div class="refsect2">
380 <a name="prelude-plugin-new-instance"></a><h3>prelude_plugin_new_instance ()</h3>
381 <pre class="programlisting"><span class="returnvalue">int</span>
382 prelude_plugin_new_instance (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> **pi</code></em>,
383 <em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="type">prelude_plugin_generic_t</span></a> *plugin</code></em>,
384 <em class="parameter"><code>const <span class="type">char</span> *name</code></em>,
385 <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
386 </div>
387 <hr>
388 <div class="refsect2">
389 <a name="prelude-plugin-search-by-name"></a><h3>prelude_plugin_search_by_name ()</h3>
390 <pre class="programlisting"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
391 prelude_plugin_search_by_name (<em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> *head</code></em>,
392 <em class="parameter"><code>const <span class="type">char</span> *name</code></em>);</pre>
393 <p>Search <em class="parameter"><code>head</code></em>
394 list of plugin for a plugin with name <em class="parameter"><code>name</code></em>
395 .</p>
396 <div class="refsect3">
397 <a name="prelude-plugin-search-by-name.parameters"></a><h4>Parameters</h4>
398 <div class="informaltable"><table width="100%" border="0">
399 <colgroup>
400 <col width="150px" class="parameters_name">
401 <col class="parameters_description">
402 <col width="200px" class="parameters_annotations">
403 </colgroup>
404 <tbody>
405 <tr>
406 <td class="parameter_name"><p>head</p></td>
407 <td class="parameter_description"><p>List where to search the plugin from.</p></td>
408 <td class="parameter_annotations"> </td>
409 </tr>
410 <tr>
411 <td class="parameter_name"><p>name</p></td>
412 <td class="parameter_description"><p>Name of the plugin to search.</p></td>
413 <td class="parameter_annotations"> </td>
414 </tr>
415 </tbody>
416 </table></div>
417 </div>
418 <div class="refsect3">
419 <a name="prelude-plugin-search-by-name.returns"></a><h4>Returns</h4>
420 <p> the a <span class="type">prelude_plugin_t</span> on success, or NULL if the plugin does not exist.</p>
421 </div>
422 </div>
423 <hr>
424 <div class="refsect2">
425 <a name="prelude-plugin-search-instance-by-name"></a><h3>prelude_plugin_search_instance_by_name ()</h3>
426 <pre class="programlisting"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="returnvalue">prelude_plugin_instance_t</span></a> *
427 prelude_plugin_search_instance_by_name
428 (<em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> *head</code></em>,
429 <em class="parameter"><code>const <span class="type">char</span> *pname</code></em>,
430 <em class="parameter"><code>const <span class="type">char</span> *iname</code></em>);</pre>
431 </div>
432 <hr>
433 <div class="refsect2">
434 <a name="prelude-plugin-instance-set-data"></a><h3>prelude_plugin_instance_set_data ()</h3>
435 <pre class="programlisting"><span class="returnvalue">void</span>
436 prelude_plugin_instance_set_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>,
437 <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
438 </div>
439 <hr>
440 <div class="refsect2">
441 <a name="prelude-plugin-instance-get-data"></a><h3>prelude_plugin_instance_get_data ()</h3>
442 <pre class="programlisting"><span class="returnvalue">void</span> *
443 prelude_plugin_instance_get_data (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
444 </div>
445 <hr>
446 <div class="refsect2">
447 <a name="prelude-plugin-instance-set-plugin-data"></a><h3>prelude_plugin_instance_set_plugin_data ()</h3>
448 <pre class="programlisting"><span class="returnvalue">void</span>
449 prelude_plugin_instance_set_plugin_data
450 (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>,
451 <em class="parameter"><code><span class="type">void</span> *data</code></em>);</pre>
452 </div>
453 <hr>
454 <div class="refsect2">
455 <a name="prelude-plugin-instance-get-plugin-data"></a><h3>prelude_plugin_instance_get_plugin_data ()</h3>
456 <pre class="programlisting"><span class="returnvalue">void</span> *
457 prelude_plugin_instance_get_plugin_data
458 (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
459 </div>
460 <hr>
461 <div class="refsect2">
462 <a name="prelude-plugin-instance-get-name"></a><h3>prelude_plugin_instance_get_name ()</h3>
463 <pre class="programlisting">const <span class="returnvalue">char</span> *
464 prelude_plugin_instance_get_name (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
465 </div>
466 <hr>
467 <div class="refsect2">
468 <a name="prelude-plugin-instance-get-plugin"></a><h3>prelude_plugin_instance_get_plugin ()</h3>
469 <pre class="programlisting"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
470 prelude_plugin_instance_get_plugin (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
471 </div>
472 <hr>
473 <div class="refsect2">
474 <a name="prelude-plugin-load-from-dir"></a><h3>prelude_plugin_load_from_dir ()</h3>
475 <pre class="programlisting"><span class="returnvalue">int</span>
476 prelude_plugin_load_from_dir (<em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> *head</code></em>,
477 <em class="parameter"><code>const <span class="type">char</span> *dirname</code></em>,
478 <em class="parameter"><code>const <span class="type">char</span> *symbol</code></em>,
479 <em class="parameter"><code><span class="type">void</span> *ptr</code></em>,
480 <em class="parameter"><code><span class="type">int</span> (*subscribe) (prelude_plugin_instance_t *p)</code></em>,
481 <em class="parameter"><code><span class="type">void</span> (*unsubscribe) (prelude_plugin_instance_t *pi)</code></em>);</pre>
482 <p>Load all plugins in directory 'dirname', using <em class="parameter"><code>symbol</code></em>
483 entry point.
484 Each plugin have a <em class="parameter"><code>subscribe</code></em>
485 and <em class="parameter"><code>unsubscribe</code></em>
486 callback associated with it.</p>
487 <p>The plugins are loaded, but not active, until someone call <code class="function">prelude_plugin_subscribe()</code>
488 on one of the plugin. Which'll call <em class="parameter"><code>subscribe</code></em>
489 in order to register it.</p>
490 <p><em class="parameter"><code>ptr</code></em>
491 is an extra argument provided to the plugin at initialization time.</p>
492 <div class="refsect3">
493 <a name="prelude-plugin-load-from-dir.parameters"></a><h4>Parameters</h4>
494 <div class="informaltable"><table width="100%" border="0">
495 <colgroup>
496 <col width="150px" class="parameters_name">
497 <col class="parameters_description">
498 <col width="200px" class="parameters_annotations">
499 </colgroup>
500 <tbody>
501 <tr>
502 <td class="parameter_name"><p>head</p></td>
503 <td class="parameter_description"><p>List where the loaded plugin should be added.</p></td>
504 <td class="parameter_annotations"> </td>
505 </tr>
506 <tr>
507 <td class="parameter_name"><p>dirname</p></td>
508 <td class="parameter_description"><p>The directory to load the plugin from.</p></td>
509 <td class="parameter_annotations"> </td>
510 </tr>
511 <tr>
512 <td class="parameter_name"><p>symbol</p></td>
513 <td class="parameter_description"><p>Symbol to lookup within loaded plugin.</p></td>
514 <td class="parameter_annotations"> </td>
515 </tr>
516 <tr>
517 <td class="parameter_name"><p>ptr</p></td>
518 <td class="parameter_description"><p>Extra pointer to provide to the plugin initialization function.</p></td>
519 <td class="parameter_annotations"> </td>
520 </tr>
521 <tr>
522 <td class="parameter_name"><p>subscribe</p></td>
523 <td class="parameter_description"><p>Pointer to a callback function for plugin subscribtion.</p></td>
524 <td class="parameter_annotations"> </td>
525 </tr>
526 <tr>
527 <td class="parameter_name"><p>unsubscribe</p></td>
528 <td class="parameter_description"><p>Pointer to a callback function for plugin un-subscribtion.</p></td>
529 <td class="parameter_annotations"> </td>
530 </tr>
531 </tbody>
532 </table></div>
533 </div>
534 <div class="refsect3">
535 <a name="prelude-plugin-load-from-dir.returns"></a><h4>Returns</h4>
536 <p> The number of loaded plugins on success, -1 on error.</p>
537 </div>
538 </div>
539 <hr>
540 <div class="refsect2">
541 <a name="prelude-plugin-instance-add"></a><h3>prelude_plugin_instance_add ()</h3>
542 <pre class="programlisting"><span class="returnvalue">int</span>
543 prelude_plugin_instance_add (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>,
544 <em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> *h</code></em>);</pre>
545 <p>This function add the plugin instance associated with <em class="parameter"><code>pi</code></em>
546 to the linked list
547 specified by <em class="parameter"><code>h</code></em>
548 . If this instance is already used somewhere else, a copy is
549 made, since instance does not share information).</p>
550 <div class="refsect3">
551 <a name="prelude-plugin-instance-add.parameters"></a><h4>Parameters</h4>
552 <div class="informaltable"><table width="100%" border="0">
553 <colgroup>
554 <col width="150px" class="parameters_name">
555 <col class="parameters_description">
556 <col width="200px" class="parameters_annotations">
557 </colgroup>
558 <tbody>
559 <tr>
560 <td class="parameter_name"><p>pi</p></td>
561 <td class="parameter_description"><p>Pointer to a plugin instance</p></td>
562 <td class="parameter_annotations"> </td>
563 </tr>
564 <tr>
565 <td class="parameter_name"><p>h</p></td>
566 <td class="parameter_description"><p>Pointer to a linked list</p></td>
567 <td class="parameter_annotations"> </td>
568 </tr>
569 </tbody>
570 </table></div>
571 </div>
572 <div class="refsect3">
573 <a name="prelude-plugin-instance-add.returns"></a><h4>Returns</h4>
574 <p> 0 on success or -1 if an error occured.</p>
575 </div>
576 </div>
577 <hr>
578 <div class="refsect2">
579 <a name="prelude-plugin-instance-del"></a><h3>prelude_plugin_instance_del ()</h3>
580 <pre class="programlisting"><span class="returnvalue">void</span>
581 prelude_plugin_instance_del (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
582 <p>Delete <em class="parameter"><code>pi</code></em>
583 from the list specified at <a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-add" title="prelude_plugin_instance_add ()"><code class="function">prelude_plugin_instance_add()</code></a> time.</p>
584 <div class="refsect3">
585 <a name="prelude-plugin-instance-del.parameters"></a><h4>Parameters</h4>
586 <div class="informaltable"><table width="100%" border="0">
587 <colgroup>
588 <col width="150px" class="parameters_name">
589 <col class="parameters_description">
590 <col width="200px" class="parameters_annotations">
591 </colgroup>
592 <tbody><tr>
593 <td class="parameter_name"><p>pi</p></td>
594 <td class="parameter_description"><p>Pointer to a plugin instance.</p></td>
595 <td class="parameter_annotations"> </td>
596 </tr></tbody>
597 </table></div>
598 </div>
599 </div>
600 <hr>
601 <div class="refsect2">
602 <a name="prelude-plugin-instance-compute-time"></a><h3>prelude_plugin_instance_compute_time ()</h3>
603 <pre class="programlisting"><span class="returnvalue">void</span>
604 prelude_plugin_instance_compute_time (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>,
605 <em class="parameter"><code><span class="type">struct timeval</span> *start</code></em>,
606 <em class="parameter"><code><span class="type">struct timeval</span> *end</code></em>);</pre>
607 </div>
608 <hr>
609 <div class="refsect2">
610 <a name="prelude-plugin-instance-call-commit-func"></a><h3>prelude_plugin_instance_call_commit_func ()</h3>
611 <pre class="programlisting"><span class="returnvalue">int</span>
612 prelude_plugin_instance_call_commit_func
613 (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>,
614 <em class="parameter"><code><a class="link" href="libprelude-prelude-string.html#prelude-string-t" title="prelude_string_t"><span class="type">prelude_string_t</span></a> *err</code></em>);</pre>
615 </div>
616 <hr>
617 <div class="refsect2">
618 <a name="prelude-plugin-instance-has-commit-func"></a><h3>prelude_plugin_instance_has_commit_func ()</h3>
619 <pre class="programlisting"><a class="link" href="libprelude-prelude-inttypes.html#prelude-bool-t" title="enum prelude_bool_t"><span class="returnvalue">prelude_bool_t</span></a>
620 prelude_plugin_instance_has_commit_func
621 (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-instance-t" title="prelude_plugin_instance_t"><span class="type">prelude_plugin_instance_t</span></a> *pi</code></em>);</pre>
622 </div>
623 <hr>
624 <div class="refsect2">
625 <a name="prelude-plugin-set-preloaded-symbols"></a><h3>prelude_plugin_set_preloaded_symbols ()</h3>
626 <pre class="programlisting"><span class="returnvalue">void</span>
627 prelude_plugin_set_preloaded_symbols (<em class="parameter"><code><span class="type">void</span> *symlist</code></em>);</pre>
628 </div>
629 <hr>
630 <div class="refsect2">
631 <a name="prelude-plugin-get-next"></a><h3>prelude_plugin_get_next ()</h3>
632 <pre class="programlisting"><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="returnvalue">prelude_plugin_generic_t</span></a> *
633 prelude_plugin_get_next (<em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> *head</code></em>,
634 <em class="parameter"><code><a class="link" href="libprelude-prelude-list.html#prelude-list-t" title="prelude_list_t"><span class="type">prelude_list_t</span></a> **iter</code></em>);</pre>
635 </div>
636 <hr>
637 <div class="refsect2">
638 <a name="prelude-plugin-unload"></a><h3>prelude_plugin_unload ()</h3>
639 <pre class="programlisting"><span class="returnvalue">void</span>
640 prelude_plugin_unload (<em class="parameter"><code><a class="link" href="libprelude-prelude-plugin.html#prelude-plugin-generic-t" title="prelude_plugin_generic_t"><span class="type">prelude_plugin_generic_t</span></a> *plugin</code></em>);</pre>
641 </div>
642 <hr>
643 <div class="refsect2">
644 <a name="prelude-plugin-compute-stats"></a><h3>prelude_plugin_compute_stats()</h3>
645 <pre class="programlisting">#define prelude_plugin_compute_stats(pi, func)</pre>
646 </div>
647 <hr>
648 <div class="refsect2">
649 <a name="prelude-plugin-run"></a><h3>prelude_plugin_run()</h3>
650 <pre class="programlisting">#define prelude_plugin_run(pi, type, member, ...)</pre>
651 </div>
652 </div>
653 <div class="refsect1">
654 <a name="libprelude-prelude-plugin.other_details"></a><h2>Types and Values</h2>
655 <div class="refsect2">
656 <a name="lt-preloaded-symbols"></a><h3>lt_preloaded_symbols</h3>
657 <pre class="programlisting"># define lt_preloaded_symbols lt__PROGRAM__LTX_preloaded_symbols
658 </pre>
659 </div>
660 <hr>
661 <div class="refsect2">
662 <a name="PRELUDE-PLUGIN-API-VERSION:CAPS"></a><h3>PRELUDE_PLUGIN_API_VERSION</h3>
663 <pre class="programlisting">#define PRELUDE_PLUGIN_API_VERSION 1
664 </pre>
665 </div>
666 <hr>
667 <div class="refsect2">
668 <a name="prelude-plugin-entry-t"></a><h3>prelude_plugin_entry_t</h3>
669 <pre class="programlisting">typedef struct prelude_plugin_entry prelude_plugin_entry_t;
670 </pre>
671 </div>
672 <hr>
673 <div class="refsect2">
674 <a name="prelude-plugin-instance-t"></a><h3>prelude_plugin_instance_t</h3>
675 <pre class="programlisting">typedef struct prelude_plugin_instance prelude_plugin_instance_t;
676 </pre>
677 </div>
678 <hr>
679 <div class="refsect2">
680 <a name="PRELUDE-PLUGIN-GENERIC:CAPS"></a><h3>PRELUDE_PLUGIN_GENERIC</h3>
681 <pre class="programlisting">#define PRELUDE_PLUGIN_GENERIC</pre>
682 </div>
683 <hr>
684 <div class="refsect2">
685 <a name="prelude-plugin-generic-t"></a><h3>prelude_plugin_generic_t</h3>
686 <pre class="programlisting">typedef struct {
687 PRELUDE_PLUGIN_GENERIC;
688 } prelude_plugin_generic_t;
689 </pre>
690 </div>
691 </div>
692 </div>
693 <div class="footer">
694 <hr>Generated by GTK-Doc V1.28</div>
695 </body>
696 </html>