This file is indexed.

/usr/share/gtk-doc/html/libanjuta/AnjutaAutogen.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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnjutaAutogen</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-api.html" title="libanjuta API">
<link rel="prev" href="libanjuta-anjuta-convert.html" title="anjuta-convert">
<link rel="next" href="AnjutaCloseButton.html" title="AnjutaCloseButton">
<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="libanjuta-anjuta-convert.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libanjuta-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="AnjutaCloseButton.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#AnjutaAutogen.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#AnjutaAutogen.description" class="shortcut">Description</a>
                   | 
                  <a href="#AnjutaAutogen.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="AnjutaAutogen"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AnjutaAutogen.top_of_page"></a>AnjutaAutogen</span></h2>
<p>AnjutaAutogen — Template engine using GNU autogen program.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="AnjutaAutogen.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="AnjutaAutogen.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libanjuta/anjuta-autogen.h&gt;

<span class="returnvalue">void</span>                (<a class="link" href="AnjutaAutogen.html#AnjutaAutogenFunc" title="AnjutaAutogenFunc ()">*AnjutaAutogenFunc</a>)                (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *autogen</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<span class="returnvalue">void</span>                (<a class="link" href="AnjutaAutogen.html#AnjutaAutogenOutputFunc" title="AnjutaAutogenOutputFunc ()">*AnjutaAutogenOutputFunc</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> *output</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="returnvalue">AnjutaAutogen</span></a> *     <a class="link" href="AnjutaAutogen.html#anjuta-autogen-new" title="anjuta_autogen_new ()">anjuta_autogen_new</a>                  (<em class="parameter"><code><span class="type">void</span></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="AnjutaAutogen.html#anjuta-autogen-write-definition-file" title="anjuta_autogen_write_definition_file ()">anjuta_autogen_write_definition_file</a>
                                                        (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *values</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> **error</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="AnjutaAutogen.html#anjuta-autogen-set-library-path" title="anjuta_autogen_set_library_path ()">anjuta_autogen_set_library_path</a>     (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *directory</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="AnjutaAutogen.html#anjuta-autogen-clear-library-path" title="anjuta_autogen_clear_library_path ()">anjuta_autogen_clear_library_path</a>   (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             <a class="link" href="AnjutaAutogen.html#anjuta-autogen-get-library-paths" title="anjuta_autogen_get_library_paths ()">anjuta_autogen_get_library_paths</a>    (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</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="AnjutaAutogen.html#anjuta-autogen-set-input-file" title="anjuta_autogen_set_input_file ()">anjuta_autogen_set_input_file</a>       (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *filename</code></em>,
                                                         <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> *start_marker</code></em>,
                                                         <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> *end_marker</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="AnjutaAutogen.html#anjuta-autogen-set-output-file" title="anjuta_autogen_set_output_file ()">anjuta_autogen_set_output_file</a>      (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *filename</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="AnjutaAutogen.html#anjuta-autogen-set-output-callback" title="anjuta_autogen_set_output_callback ()">anjuta_autogen_set_output_callback</a>  (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a class="link" href="AnjutaAutogen.html#AnjutaAutogenOutputFunc" title="AnjutaAutogenOutputFunc ()"><span class="type">AnjutaAutogenOutputFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</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="AnjutaAutogen.html#anjuta-autogen-execute" title="anjuta_autogen_execute ()">anjuta_autogen_execute</a>              (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a class="link" href="AnjutaAutogen.html#AnjutaAutogenFunc" title="AnjutaAutogenFunc ()"><span class="type">AnjutaAutogenFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</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> **error</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="AnjutaAutogen.html#anjuta-check-autogen" title="anjuta_check_autogen ()">anjuta_check_autogen</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
                    <a class="link" href="AnjutaAutogen.html#AnjutaAutogen-struct" title="AnjutaAutogen">AnjutaAutogen</a>;
                    <a class="link" href="AnjutaAutogen.html#AnjutaAutogenClass" title="AnjutaAutogenClass">AnjutaAutogenClass</a>;
</pre>
</div>
<div class="refsect1">
<a name="AnjutaAutogen.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>
   +----AnjutaAutogen
</pre>
</div>
<div class="refsect1">
<a name="AnjutaAutogen.description"></a><h2>Description</h2>
<p>
GNU autogen is a program generating a text file from a template and a
definition file. The template contains fixed text and variables those will
be replaced under the control of the definition file.
</p>
<p>
By example from the following definition file
</p>
<pre class="programlisting">
AutoGen Definitions .;
list = { list_element = alpha;
         list_info    = "some alpha stuff"; };
list = { list_info    = "more beta stuff";
         list_element = beta; };
list = { list_element = omega;
         list_info    = "final omega stuff"; }
</pre>
<p>
And the following template
</p>
<pre class="programlisting">
[+ AutoGen5 template +]
typedef enum {[+
   FOR list "," +]
        IDX_[+ (string-upcase! (get "list_element")) +][+
   ENDFOR list +] }  list_enum;
</pre>
<p>
Autogen generates
</p>
<pre class="programlisting">
typedef enum {
        IDX_ALPHA,
        IDX_BETA,
        IDX_OMEGA }  list_enum;
</pre>
<p>
</p>
<p>
The template file can be quite complex, you can read autogen documentation
<a class="ulink" href="http://www.gnu.org/software/autogen" target="_top">here</a>.
</p>
<p>
The <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object takes care of writing the definition file from
a hash table and call autogen. The output can be written in a file or passed
to a callback function. Autogen is executed asynchronously, so there is
another callback function called when the processing is completed.
</p>
</div>
<div class="refsect1">
<a name="AnjutaAutogen.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AnjutaAutogenFunc"></a><h3>AnjutaAutogenFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*AnjutaAutogenFunc)                (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *autogen</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
This function is called when the autogen process is completed.
</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>autogen</code></em> :</span></p></td>
<td>
<a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data passed to the callback.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaAutogenOutputFunc"></a><h3>AnjutaAutogenOutputFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*AnjutaAutogenOutputFunc)          (<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> *output</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
This function is called each time there is new data from autogen.
</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>output</code></em> :</span></p></td>
<td>data generated by autogen.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>user data passed to the callback.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-new"></a><h3>anjuta_autogen_new ()</h3>
<pre class="programlisting"><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="returnvalue">AnjutaAutogen</span></a> *     anjuta_autogen_new                  (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Create a new autogen 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"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object. Free it using g_object_unref. <span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-write-definition-file"></a><h3>anjuta_autogen_write_definition_file ()</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_autogen_write_definition_file
                                                        (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *values</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> **error</code></em>);</pre>
<p>
Write the autogen definition file. The definition file defined variables
those will be used, typically replaced, in the template files.
</p>
<p>
The hash table keys are the names of the variables. The name can include an
index in square bracket, by example "members[0]". All values are strings but
but they could include children using braces, by example
"{count=2; list="aa bb"}".
</p>
<p>
The file is created in a temporary directory and removed when the object
is destroyed.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>values</code></em> :</span></p></td>
<td>A hash table containing all definitions. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> utf8 utf8]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Error propagation and reporting</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 the file has been written without error,</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-set-library-path"></a><h3>anjuta_autogen_set_library_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                anjuta_autogen_set_library_path     (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *directory</code></em>);</pre>
<p>
Add a new directory in the list of autogen libraries path.
</p>
<p>
Autogen can include files. These included file will be searched by default
in the same directory than the template file. This functions allows you to
add other directories.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>directory</code></em> :</span></p></td>
<td>A path containing autogen library.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-clear-library-path"></a><h3>anjuta_autogen_clear_library_path ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                anjuta_autogen_clear_library_path   (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>);</pre>
<p>
Remove all library pathes.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-get-library-paths"></a><h3>anjuta_autogen_get_library_paths ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *             anjuta_autogen_get_library_paths    (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>);</pre>
<p>
Get the list of all directories searched for files included in the autogen
templates.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A list of directories.
The content and the list itself are owned by the <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object and
should not be modified or freed. <span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> gchar*][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-set-input-file"></a><h3>anjuta_autogen_set_input_file ()</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_autogen_set_input_file       (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *filename</code></em>,
                                                         <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> *start_marker</code></em>,
                                                         <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> *end_marker</code></em>);</pre>
<p>
Read an autogen template file, optionally adding autogen markers.
</p>
<p>
To be recognized as an autogen template, the first line has to contain:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>the start marker</p></li>
<li class="listitem"><p>"autogen5 template"</p></li>
<li class="listitem"><p>the end marker</p></li>
</ul></div>
<p>
</p>
<p>
These markers are a custom sequence of up to 7 characters delimiting
the start and the end of autogen variables and macros.
</p>
<p>
This function can add this line using the value of <em class="parameter"><code>start_marker</code></em> and
<em class="parameter"><code>end_marker</code></em>. If this line is already present in the file,
<em class="parameter"><code>start_marker</code></em> and <em class="parameter"><code>end_marker</code></em> must be <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of the input template file</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_marker</code></em> :</span></p></td>
<td>start marker string. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_marker</code></em> :</span></p></td>
<td>end marker string. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</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 the file has been read without error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-set-output-file"></a><h3>anjuta_autogen_set_output_file ()</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_autogen_set_output_file      (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <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> *filename</code></em>);</pre>
<p>
Define the name of the generated file.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>name of the generated file</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 the file has been set without error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-set-output-callback"></a><h3>anjuta_autogen_set_output_callback ()</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_autogen_set_output_callback  (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a class="link" href="AnjutaAutogen.html#AnjutaAutogenOutputFunc" title="AnjutaAutogenOutputFunc ()"><span class="type">AnjutaAutogenOutputFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy</code></em>);</pre>
<p>
Define that autogen output should be send to a function as soon as it arrives.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>Function call each time we get new data from autogen</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data to pass to <em class="parameter"><code>func</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>destroy</code></em> :</span></p></td>
<td>Function call when the process is complete to free user data</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 is no error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-autogen-execute"></a><h3>anjuta_autogen_execute ()</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_autogen_execute              (<em class="parameter"><code><a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> *this</code></em>,
                                                         <em class="parameter"><code><a class="link" href="AnjutaAutogen.html#AnjutaAutogenFunc" title="AnjutaAutogenFunc ()"><span class="type">AnjutaAutogenFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</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> **error</code></em>);</pre>
<p>
Asynchronously execute autogen to generate the output, calling <em class="parameter"><code>func</code></em> when the
process is completed.
</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>this</code></em> :</span></p></td>
<td>A <a class="link" href="AnjutaAutogen.html" title="AnjutaAutogen"><span class="type">AnjutaAutogen</span></a> object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>A function called when autogen is terminated. <span class="annotation">[<a href="http://foldoc.org/scope%20async"><span class="acronym">scope async</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>User data to pass to <em class="parameter"><code>func</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Error propagation and reporting. <span class="annotation">[<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span>
</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 the file has been processed without error.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-check-autogen"></a><h3>anjuta_check_autogen ()</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_check_autogen                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Check if autogen version 5 is installed.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><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 autogen is installed.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaAutogen-struct"></a><h3>AnjutaAutogen</h3>
<pre class="programlisting">typedef struct _AnjutaAutogen AnjutaAutogen;</pre>
<p>
A GObject wrapper for running GNU autogen.
</p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaAutogenClass"></a><h3>AnjutaAutogenClass</h3>
<pre class="programlisting">typedef struct _AnjutaAutogenClass AnjutaAutogenClass;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="AnjutaAutogen.see-also"></a><h2>See Also</h2>
<a class="link" href="AnjutaLauncher.html" title="AnjutaLauncher"><span class="type">AnjutaLauncher</span></a>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>