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
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>visu_configFile</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="V_Sim API - Reference Manual">
<link rel="up" href="core.html" title="Part I. Core">
<link rel="prev" href="VisuRendering.html" title="VisuRendering">
<link rel="next" href="v-sim-visu-extension.html" title="visu_extension">
<meta name="generator" content="GTK-Doc V1.14 (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="VisuRendering.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="core.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">V_Sim API - Reference Manual</th>
<td><a accesskey="n" href="v-sim-visu-extension.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#v-sim-visu-configFile.synopsis" class="shortcut">Top</a>
|
<a href="#v-sim-visu-configFile.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry" title="visu_configFile">
<a name="v-sim-visu-configFile"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="v-sim-visu-configFile.top_of_page"></a>visu_configFile</span></h2>
<p>visu_configFile — Defines methods to access (read/write) to
config files and to create different entries.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="v-sim-visu-configFile.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"> <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry">VisuConfigFileEntry</a>;
#define <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-PARAMETER:CAPS" title="VISU_CONFIGFILE_PARAMETER">VISU_CONFIGFILE_PARAMETER</a>
#define <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-RESOURCE:CAPS" title="VISU_CONFIGFILE_RESOURCE">VISU_CONFIGFILE_RESOURCE</a>
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (<a class="link" href="v-sim-visu-configFile.html#VisuConfigFileReadFunc" title="VisuConfigFileReadFunc ()">*VisuConfigFileReadFunc</a>) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **lines</code></em>,
<em class="parameter"><code><span class="type">int</span> nbLines</code></em>,
<em class="parameter"><code><span class="type">int</span> position</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> (<a class="link" href="v-sim-visu-configFile.html#VisuConfigFileExportFunc" title="VisuConfigFileExportFunc ()">*VisuConfigFileExportFunc</a>) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="type">GString</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);
<a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="returnvalue">VisuConfigFileEntry</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-addEntry" title="visu_configFile_addEntry ()">visu_configFile_addEntry</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>,
<em class="parameter"><code><span class="type">int</span> nbLines</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileReadFunc" title="VisuConfigFileReadFunc ()"><span class="type">VisuConfigFileReadFunc</span></a> readFunc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-addExportFunction" title="visu_configFile_addExportFunction ()">visu_configFile_addExportFunction</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileExportFunc" title="VisuConfigFileExportFunc ()"><span class="type">VisuConfigFileExportFunc</span></a> writeFunc</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-entry-setTag" title="visu_configFile_entry_setTag ()">visu_configFile_entry_setTag</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-entry-setVersion" title="visu_configFile_entry_setVersion ()">visu_configFile_entry_setVersion</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code><span class="type">float</span> version</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-entry-setReplace" title="visu_configFile_entry_setReplace ()">visu_configFile_entry_setReplace</a> (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *newEntry</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *oldEntry</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-load" title="visu_configFile_load ()">visu_configFile_load</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fileName</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-save" title="visu_configFile_save ()">visu_configFile_save</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fileName</code></em>,
<em class="parameter"><code><span class="type">int</span> *lines</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<span class="returnvalue">void</span> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-addKnownTag" title="visu_configFile_addKnownTag ()">visu_configFile_addKnownTag</a> (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getValidPath" title="visu_configFile_getValidPath ()">visu_configFile_getValidPath</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><span class="type">int</span> mode</code></em>,
<em class="parameter"><code><span class="type">int</span> utf8</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getNextValidPath" title="visu_configFile_getNextValidPath ()">visu_configFile_getNextValidPath</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><span class="type">int</span> accessMode</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **list</code></em>,
<em class="parameter"><code><span class="type">int</span> utf8</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getDefaultFilename" title="visu_configFile_getDefaultFilename ()">visu_configFile_getDefaultFilename</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getPathList" title="visu_configFile_getPathList ()">visu_configFile_getPathList</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getEntries" title="visu_configFile_getEntries ()">visu_configFile_getEntries</a> (<em class="parameter"><code><span class="type">int</span> kind</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="v-sim-visu-configFile.html#visu-configFile-exportToXML" title="visu_configFile_exportToXML ()">visu_configFile_exportToXML</a> (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* <a class="link" href="v-sim-visu-configFile.html#visu-configFile-getPathToResources" title="visu_configFile_getPathToResources ()">visu_configFile_getPathToResources</a> ();
</pre>
</div>
<div class="refsect1" title="Description">
<a name="v-sim-visu-configFile.description"></a><h2>Description</h2>
<p>
</p>
<p>V_Sim uses two different configuration files. The first
stores the configuration of the program itself and is called
parameters file. The second stores differents values that control
the way files are rendered. It is called resources file. For
example, their is an entry in the parameters file that controls
your favorite rendering method ; and there is an entry in the
resources file that codes that vacancy elements are rendered by
cube in the atomic rendering method. Most methods of this part uses
a first argument usually called 'kind', that control if the method
will apply on the parameters file or on the resources
file. <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-PARAMETER:CAPS" title="VISU_CONFIGFILE_PARAMETER"><span class="type">VISU_CONFIGFILE_PARAMETER</span></a> and <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-RESOURCE:CAPS" title="VISU_CONFIGFILE_RESOURCE"><span class="type">VISU_CONFIGFILE_RESOURCE</span></a> are
the two flags that should be used for the 'kind' argument.</p>
<p>
</p>
<p>
</p>
<p>There are different paths where these files can be
stored. These paths are stored in V_Sim with an order : for example
parameters file are first looked for in the current working
directory, then in the $HOME/.v_sim directory and finally in the
installation directory. This is transparent for the user and
<a class="link" href="v-sim-visu-configFile.html#visu-configFile-getValidPath" title="visu_configFile_getValidPath ()"><code class="function">visu_configFile_getValidPath()</code></a> is the right method to access to the
best readable configuration file.</p>
<p>
</p>
<p>
</p>
<p>Different part of V_Sim can add entries in these files. The
method <a class="link" href="v-sim-visu-configFile.html#visu-configFile-addEntry" title="visu_configFile_addEntry ()"><code class="function">visu_configFile_addEntry()</code></a> is designed to this purpose. The
entries are defined by their name and they appear in the
configuration file as 'name:' followed by the data associated to
this entry. In the parameters file, the data are on the same
line. In the resources file, the data begin the line after and can
be longer that one line. When a configuration file is read, the
method associated to each entry (<a class="link" href="v-sim-visu-configFile.html#VisuConfigFileReadFunc" title="VisuConfigFileReadFunc ()"><code class="function">VisuConfigFileReadFunc()</code></a>) is
called with a copy of their data lines. The method
<a class="link" href="v-sim-visu-configFile.html#visu-configFile-addExportFunction" title="visu_configFile_addExportFunction ()"><code class="function">visu_configFile_addExportFunction()</code></a> should be used to add a callback
when the configurations files are written, then each part of V_Sim
that have entries can put some lines in the configuration
files.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="v-sim-visu-configFile.details"></a><h2>Details</h2>
<div class="refsect2" title="VisuConfigFileEntry">
<a name="VisuConfigFileEntry"></a><h3>VisuConfigFileEntry</h3>
<pre class="programlisting">typedef struct _VisuConfigFileEntry VisuConfigFileEntry;</pre>
<p>
This is the common name of the structure.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_CONFIGFILE_PARAMETER">
<a name="VISU-CONFIGFILE-PARAMETER:CAPS"></a><h3>VISU_CONFIGFILE_PARAMETER</h3>
<pre class="programlisting">#define VISU_CONFIGFILE_PARAMETER 0
</pre>
<p>
This defines a parameter entry in the config files.
</p>
</div>
<hr>
<div class="refsect2" title="VISU_CONFIGFILE_RESOURCE">
<a name="VISU-CONFIGFILE-RESOURCE:CAPS"></a><h3>VISU_CONFIGFILE_RESOURCE</h3>
<pre class="programlisting">#define VISU_CONFIGFILE_RESOURCE 1
</pre>
<p>
This defines a resource entry in the config files.
</p>
</div>
<hr>
<div class="refsect2" title="VisuConfigFileReadFunc ()">
<a name="VisuConfigFileReadFunc"></a><h3>VisuConfigFileReadFunc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> (*VisuConfigFileReadFunc) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **lines</code></em>,
<em class="parameter"><code><span class="type">int</span> nbLines</code></em>,
<em class="parameter"><code><span class="type">int</span> position</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
This prototype corresponds to methods called when an entry is
found. The <em class="parameter"><code>lines</code></em> argument is an array of lines read from the files.
These strings are copies and can be modified but not freed. There are
<em class="parameter"><code>nbLines</code></em> and this value correspond to the number of lines defined
for the entry. The <em class="parameter"><code>error</code></em> argument is used to store some text
messages and error ids. They should be in UTF8. The <em class="parameter"><code>error</code></em> argument
must be initialised with (GError*)0. The <em class="parameter"><code>position</code></em> argument give the number
of the first line given in <em class="parameter"><code>lines</code></em> argument. If the <em class="parameter"><code>dataObj</code></em> argument is not null,
some updates should be done with read values.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>lines</code></em> :</span></p></td>
<td>an array of strings ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nbLines</code></em> :</span></p></td>
<td>an integer ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>an integer ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a pointer to a GError pointer.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everything goes right, FALSE otherwise.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="VisuConfigFileExportFunc ()">
<a name="VisuConfigFileExportFunc"></a><h3>VisuConfigFileExportFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*VisuConfigFileExportFunc) (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Strings.html#GString"><span class="type">GString</span></a> *data</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>);</pre>
<p>
This prototype defines a method that is used to export some resources
or parameters. The <em class="parameter"><code>data</code></em> argument is an empty GString where the export has
to be written. If the argument <em class="parameter"><code>dataObj</code></em> is not null, only resources related
to the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object should be exported (for parameters files, <em class="parameter"><code>dataObj</code></em> is
always NULL).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>an empty GString to store the export ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_addEntry ()">
<a name="visu-configFile-addEntry"></a><h3>visu_configFile_addEntry ()</h3>
<pre class="programlisting"><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="returnvalue">VisuConfigFileEntry</span></a>* visu_configFile_addEntry (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *key</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *description</code></em>,
<em class="parameter"><code><span class="type">int</span> nbLines</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileReadFunc" title="VisuConfigFileReadFunc ()"><span class="type">VisuConfigFileReadFunc</span></a> readFunc</code></em>);</pre>
<p>
This creates a new <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> object with the given
values. The key and description arguments are copied.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>a string (should not be NULL) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td>a string (can be NULL) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>nbLines</code></em> :</span></p></td>
<td>an integer ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>readFunc</code></em> :</span></p></td>
<td>a VisuConfigFileReadFunc.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the newly created <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_addExportFunction ()">
<a name="visu-configFile-addExportFunction"></a><h3>visu_configFile_addExportFunction ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_configFile_addExportFunction (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileExportFunc" title="VisuConfigFileExportFunc ()"><span class="type">VisuConfigFileExportFunc</span></a> writeFunc</code></em>);</pre>
<p>
This stores the <em class="parameter"><code>writeFunc</code></em> given. It will be called when resources or parameters
will be exported to disk.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer to identify resources or parameters ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>writeFunc</code></em> :</span></p></td>
<td>a VisuConfigFileExportFunc method.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_entry_setTag ()">
<a name="visu-configFile-entry-setTag"></a><h3>visu_configFile_entry_setTag ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_configFile_entry_setTag (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);</pre>
<p>
This method is used to set a tag to the given entry. This tag is used
to ignore or not the entry when the file is read. The <em class="parameter"><code>tag</code></em> argument
is copied.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td>a string.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_entry_setVersion ()">
<a name="visu-configFile-entry-setVersion"></a><h3>visu_configFile_entry_setVersion ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_configFile_entry_setVersion (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *entry</code></em>,
<em class="parameter"><code><span class="type">float</span> version</code></em>);</pre>
<p>
Set the version number the entry appear in.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>entry</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>version</code></em> :</span></p></td>
<td>the version the entry appear in.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_entry_setReplace ()">
<a name="visu-configFile-entry-setReplace"></a><h3>visu_configFile_entry_setReplace ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_configFile_entry_setReplace (<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *newEntry</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> *oldEntry</code></em>);</pre>
<p>
Use this method to declare that <em class="parameter"><code>oldEntry</code></em> has become obsolete and
has been replaced by <em class="parameter"><code>newEntry</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>newEntry</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-configFile.html#VisuConfigFileEntry" title="VisuConfigFileEntry"><span class="type">VisuConfigFileEntry</span></a> object ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>oldEntry</code></em> :</span></p></td>
<td>idem.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_load ()">
<a name="visu-configFile-load"></a><h3>visu_configFile_load ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_configFile_load (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fileName</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Try to load the resources/parameters from the file name given in
parameter.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer to identify the kind of file ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fileName</code></em> :</span></p></td>
<td>the path to file to read ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object, sometime needed to update values (can
be NULL) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td> a pointer to a GError pointer.. <acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>. </td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everything goes right. If <em class="parameter"><code>error</code></em> is not NULL it
should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#g-error-free"><code class="function">g_error_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_save ()">
<a name="visu-configFile-save"></a><h3>visu_configFile_save ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_configFile_save (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *fileName</code></em>,
<em class="parameter"><code><span class="type">int</span> *lines</code></em>,
<em class="parameter"><code><a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> *dataObj</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Try to export the resources/parameters to the file name given in
parameter. If <em class="parameter"><code>lines</code></em> argument
is not NULL, and everything went right, it stores the number of written lines.
If the argument <em class="parameter"><code>dataObj</code></em> is not null, only resources related
to the <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object should be exported (for parameters files, <em class="parameter"><code>dataObj</code></em> is
always NULL).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer to identify the kind of file ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>fileName</code></em> :</span></p></td>
<td>the path to file to read ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>lines</code></em> :</span></p></td>
<td>a pointer to an integer (can be NULL) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>dataObj</code></em> :</span></p></td>
<td>a <a class="link" href="v-sim-visu-data.html#VisuData"><span class="type">VisuData</span></a> object (can be NULL) ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a location to store a possible error.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if everything goes right.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_addKnownTag ()">
<a name="visu-configFile-addKnownTag"></a><h3>visu_configFile_addKnownTag ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> visu_configFile_addKnownTag (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *tag</code></em>);</pre>
<p>
If parameter entries have a tag, they are ignored except if their tag
has been declared using this method.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>tag</code></em> :</span></p></td>
<td>a string (not nul or empty).
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getValidPath ()">
<a name="visu-configFile-getValidPath"></a><h3>visu_configFile_getValidPath ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_configFile_getValidPath (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><span class="type">int</span> mode</code></em>,
<em class="parameter"><code><span class="type">int</span> utf8</code></em>);</pre>
<p>
Test the entries of the hadoc list to find
a valid position to read or write a config file.
It tests access for the specified file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer identifier ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>a value from R_OK, W_OK and X_OK as described in unistd.h.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>utf8</code></em> :</span></p></td>
<td>if 1, the path is return in UTF-8 format, otherwise, the locale
of the file system is used.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the first valid path find in the list of known paths.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getNextValidPath ()">
<a name="visu-configFile-getNextValidPath"></a><h3>visu_configFile_getNextValidPath ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_configFile_getNextValidPath (<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><span class="type">int</span> accessMode</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **list</code></em>,
<em class="parameter"><code><span class="type">int</span> utf8</code></em>);</pre>
<p>
Test the entries of the given list to find
a valid position to read or write a config file.
It tests access for the specified file. After a call to this
method the <em class="parameter"><code>list</code></em> argument points to the next entry in the list, after
the one found.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer identifier ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>accessMode</code></em> :</span></p></td>
<td>a value from R_OK, W_OK and X_OK as described in unistd.h ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>list</code></em> :</span></p></td>
<td>a pointer to a valid *GList ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>utf8</code></em> :</span></p></td>
<td>if 1, the path is return in UTF-8 format, otherwise, the locale
of the file system is used.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the first valid path find in the given list of paths.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getDefaultFilename ()">
<a name="visu-configFile-getDefaultFilename"></a><h3>visu_configFile_getDefaultFilename ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_configFile_getDefaultFilename (<em class="parameter"><code><span class="type">int</span> kind</code></em>);</pre>
<p>
This methods is used to get the filename used for different
config files.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer identifier.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the filename of config file. The returned *gchar is
owned by V_Sim and should not be freed or modified.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getPathList ()">
<a name="visu-configFile-getPathList"></a><h3>visu_configFile_getPathList ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* visu_configFile_getPathList (<em class="parameter"><code><span class="type">int</span> kind</code></em>);</pre>
<p>
V_Sim stores a list of paths where to look for resources or parameters
files, this method is used to get these lists.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>an integer identifier.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the list of the parameters or resources paths. This list is read-only.. <acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getEntries ()">
<a name="visu-configFile-getEntries"></a><h3>visu_configFile_getEntries ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a>* visu_configFile_getEntries (<em class="parameter"><code><span class="type">int</span> kind</code></em>);</pre>
<p>
This routine should be used for introspections purpose, to know
what resources or parameters are available.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>either <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-PARAMETER:CAPS" title="VISU_CONFIGFILE_PARAMETER"><span class="type">VISU_CONFIGFILE_PARAMETER</span></a> or
<a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-RESOURCE:CAPS" title="VISU_CONFIGFILE_RESOURCE"><span class="type">VISU_CONFIGFILE_RESOURCE</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> own by V_Sim.. <acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8. </td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_exportToXML ()">
<a name="visu-configFile-exportToXML"></a><h3>visu_configFile_exportToXML ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> visu_configFile_exportToXML (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>,
<em class="parameter"><code><span class="type">int</span> kind</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Export all the registered entries for resources or parameters to an
XML file.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>
<td>a string in the encoding of the file system ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>kind</code></em> :</span></p></td>
<td>either <a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-PARAMETER:CAPS" title="VISU_CONFIGFILE_PARAMETER"><span class="type">VISU_CONFIGFILE_PARAMETER</span></a> or
<a class="link" href="v-sim-visu-configFile.html#VISU-CONFIGFILE-RESOURCE:CAPS" title="VISU_CONFIGFILE_RESOURCE"><span class="type">VISU_CONFIGFILE_RESOURCE</span></a> ;
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a location to store an error.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> TRUE if the file is written with success.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" title="visu_configFile_getPathToResources ()">
<a name="visu-configFile-getPathToResources"></a><h3>visu_configFile_getPathToResources ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a>* visu_configFile_getPathToResources ();</pre>
<p>
The resource file can be read from different places.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the path used to read the last resource file.
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
