← Back to branch summary

~ubuntu-branches/debian/squeeze/glib2.0/squeeze

« back to all changes in this revision

Viewing changes to docs/reference/glib/xml/scanner.xml

  • Committer: Bazaar Package Importer
  • Author(s): Gustavo Noronha Silva
  • Date: 2009-02-15 13:00:43 UTC
  • mfrom: (1.3.1 upstream) (69.1.10 intrepid)
  • Revision ID: james.westby@ubuntu.com-20090215130043-q47fbt3owmt42m2f
Tags: 2.18.4-2
* Release to unstable
* debian/rules:
- bump SHVER, since we are already forcing a 2.18.0 dependecy on the
  symbols introduced in the development versions
* debian/control.in:
- added Homepage and Vcs-* control fields

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/glib/xml/scanner.xml
1
1
<refentry id="glib-Lexical-Scanner">
2
2
<refmeta>
3
 
<refentrytitle role="top_of_page">Lexical Scanner</refentrytitle>
 
3
<refentrytitle role="top_of_page" id="glib-Lexical-Scanner.top_of_page">Lexical Scanner</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>GLIB Library</refmiscinfo>
6
6
</refmeta>
8
8
<refnamediv>
9
9
<refname>Lexical Scanner</refname>
10
10
<refpurpose>a general purpose lexical scanner</refpurpose>
11
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
12
11
</refnamediv>
13
12
 
14
 
<refsynopsisdiv role="synopsis">
 
13
<refsynopsisdiv id="glib-Lexical-Scanner.synopsis" role="synopsis">
15
14
<title role="synopsis.title">Synopsis</title>
16
15
 
17
16
<synopsis>
18
17
 
19
18
#include &lt;glib.h&gt;
20
19
 
21
 
 
22
20
                    <link linkend="GScanner">GScanner</link>;
23
21
                    <link linkend="GScannerConfig">GScannerConfig</link>;
24
22
<link linkend="GScanner">GScanner</link>*           <link linkend="g-scanner-new">g_scanner_new</link>                       (const <link linkend="GScannerConfig">GScannerConfig</link> *config_templ);
82
80
                                                         <link linkend="gboolean">gboolean</link> error);
83
81
 
84
82
#define             <link linkend="G-CSET-a-2-z">G_CSET_a_2_z</link>
85
 
#define             <link linkend="G-CSET-A-2-Z:CAPS">G_CSET_A_2_Z</link>
86
 
#define             <link linkend="G-CSET-DIGITS:CAPS">G_CSET_DIGITS</link>
87
 
#define             <link linkend="G-CSET-LATINC:CAPS">G_CSET_LATINC</link>
88
 
#define             <link linkend="G-CSET-LATINS:CAPS">G_CSET_LATINS</link>
 
83
#define             <link linkend="G-CSET-A-2-Z--CAPS">G_CSET_A_2_Z</link>
 
84
#define             <link linkend="G-CSET-DIGITS--CAPS">G_CSET_DIGITS</link>
 
85
#define             <link linkend="G-CSET-LATINC--CAPS">G_CSET_LATINC</link>
 
86
#define             <link linkend="G-CSET-LATINS--CAPS">G_CSET_LATINS</link>
89
87
enum                <link linkend="GTokenType">GTokenType</link>;
90
88
union               <link linkend="GTokenValue">GTokenValue</link>;
91
89
enum                <link linkend="GErrorType">GErrorType</link>;
100
98
 
101
99
 
102
100
 
103
 
<refsect1 role="desc">
 
101
<refsect1 id="glib-Lexical-Scanner.description" role="desc">
104
102
<title role="desc.title">Description</title>
105
103
<para>
106
104
The <link linkend="GScanner"><type>GScanner</type></link> and its associated functions provide a general purpose
107
105
lexical scanner.
108
106
</para>
109
 
 
110
107
<!--
111
108
FIXME: really needs an example and more detail, but I don't completely
112
109
understand it myself. Look at gtkrc.c for some code using the scanner.
113
110
-->
114
111
</refsect1>
115
112
 
116
 
<refsect1 role="details">
 
113
<refsect1 id="glib-Lexical-Scanner.details" role="details">
117
114
<title role="details.title">Details</title>
118
 
<refsect2>
119
 
<title><anchor id="GScanner" role="struct"/>GScanner</title>
120
 
<indexterm><primary>GScanner</primary></indexterm><programlisting>typedef struct {
 
115
<refsect2 id="GScanner" role="struct">
 
116
<title>GScanner</title>
 
117
<indexterm zone="GScanner"><primary sortas="GScanner">GScanner</primary></indexterm><programlisting>typedef struct {
121
118
  /* unused fields */
122
119
  gpointer              user_data;
123
120
  guint                 max_parse_errors;
162
159
The data structure representing a lexical scanner.
163
160
</para>
164
161
<para>
165
 
You should set <structfield>input_name</structfield> after creating 
166
 
the scanner, since it is used by the default message handler when 
167
 
displaying warnings and errors. If you are scanning a file, the file 
 
162
You should set <structfield>input_name</structfield> after creating
 
163
the scanner, since it is used by the default message handler when
 
164
displaying warnings and errors. If you are scanning a file, the file
168
165
name would be a good choice.
169
166
</para>
170
167
<para>
178
175
handler function is declared by <link linkend="GScannerMsgFunc"><type>GScannerMsgFunc</type></link>.
179
176
</para><variablelist role="struct">
180
177
<varlistentry>
181
 
<term><link linkend="gpointer">gpointer</link>&nbsp;<structfield>user_data</structfield>;</term>
182
 
<listitem><simpara>
183
 
</simpara></listitem>
184
 
</varlistentry>
185
 
<varlistentry>
186
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>max_parse_errors</structfield>;</term>
187
 
<listitem><simpara>
188
 
</simpara></listitem>
189
 
</varlistentry>
190
 
<varlistentry>
191
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>parse_errors</structfield>;</term>
192
 
<listitem><simpara>
193
 
</simpara></listitem>
194
 
</varlistentry>
195
 
<varlistentry>
196
 
<term>const&nbsp;<link linkend="gchar">gchar</link>&nbsp;*<structfield>input_name</structfield>;</term>
197
 
<listitem><simpara>
198
 
</simpara></listitem>
199
 
</varlistentry>
200
 
<varlistentry>
201
 
<term><link linkend="GData">GData</link>&nbsp;*<structfield>qdata</structfield>;</term>
202
 
<listitem><simpara>
203
 
</simpara></listitem>
204
 
</varlistentry>
205
 
<varlistentry>
206
 
<term><link linkend="GScannerConfig">GScannerConfig</link>&nbsp;*<structfield>config</structfield>;</term>
207
 
<listitem><simpara>
208
 
</simpara></listitem>
209
 
</varlistentry>
210
 
<varlistentry>
211
 
<term><link linkend="GTokenType">GTokenType</link>&nbsp;<structfield>token</structfield>;</term>
 
178
<term><link linkend="gpointer">gpointer</link>&#160;<structfield>user_data</structfield>;</term>
 
179
<listitem><simpara>
 
180
</simpara></listitem>
 
181
</varlistentry>
 
182
<varlistentry>
 
183
<term><link linkend="guint">guint</link>&#160;<structfield>max_parse_errors</structfield>;</term>
 
184
<listitem><simpara>
 
185
</simpara></listitem>
 
186
</varlistentry>
 
187
<varlistentry>
 
188
<term><link linkend="guint">guint</link>&#160;<structfield>parse_errors</structfield>;</term>
 
189
<listitem><simpara>
 
190
</simpara></listitem>
 
191
</varlistentry>
 
192
<varlistentry>
 
193
<term>const&#160;<link linkend="gchar">gchar</link>&#160;*<structfield>input_name</structfield>;</term>
 
194
<listitem><simpara>
 
195
</simpara></listitem>
 
196
</varlistentry>
 
197
<varlistentry>
 
198
<term><link linkend="GData">GData</link>&#160;*<structfield>qdata</structfield>;</term>
 
199
<listitem><simpara>
 
200
</simpara></listitem>
 
201
</varlistentry>
 
202
<varlistentry>
 
203
<term><link linkend="GScannerConfig">GScannerConfig</link>&#160;*<structfield>config</structfield>;</term>
 
204
<listitem><simpara>
 
205
</simpara></listitem>
 
206
</varlistentry>
 
207
<varlistentry>
 
208
<term><link linkend="GTokenType">GTokenType</link>&#160;<structfield>token</structfield>;</term>
212
209
<listitem><simpara>      token parsed by the last <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>
213
210
</simpara></listitem>
214
211
</varlistentry>
215
212
<varlistentry>
216
 
<term><link linkend="GTokenValue">GTokenValue</link>&nbsp;<structfield>value</structfield>;</term>
 
213
<term><link linkend="GTokenValue">GTokenValue</link>&#160;<structfield>value</structfield>;</term>
217
214
<listitem><simpara>      value of the last token from <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>
218
215
</simpara></listitem>
219
216
</varlistentry>
220
217
<varlistentry>
221
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>line</structfield>;</term>
 
218
<term><link linkend="guint">guint</link>&#160;<structfield>line</structfield>;</term>
222
219
<listitem><simpara>       line number of the last token from <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>
223
220
</simpara></listitem>
224
221
</varlistentry>
225
222
<varlistentry>
226
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>position</structfield>;</term>
 
223
<term><link linkend="guint">guint</link>&#160;<structfield>position</structfield>;</term>
227
224
<listitem><simpara>   char number of the last token from <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>
228
225
</simpara></listitem>
229
226
</varlistentry>
230
227
<varlistentry>
231
 
<term><link linkend="GTokenType">GTokenType</link>&nbsp;<structfield>next_token</structfield>;</term>
 
228
<term><link linkend="GTokenType">GTokenType</link>&#160;<structfield>next_token</structfield>;</term>
232
229
<listitem><simpara>   token parsed by the last <link linkend="g-scanner-peek-next-token"><function>g_scanner_peek_next_token()</function></link>
233
230
</simpara></listitem>
234
231
</varlistentry>
235
232
<varlistentry>
236
 
<term><link linkend="GTokenValue">GTokenValue</link>&nbsp;<structfield>next_value</structfield>;</term>
 
233
<term><link linkend="GTokenValue">GTokenValue</link>&#160;<structfield>next_value</structfield>;</term>
237
234
<listitem><simpara>   value of the last token from <link linkend="g-scanner-peek-next-token"><function>g_scanner_peek_next_token()</function></link>
238
235
</simpara></listitem>
239
236
</varlistentry>
240
237
<varlistentry>
241
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>next_line</structfield>;</term>
 
238
<term><link linkend="guint">guint</link>&#160;<structfield>next_line</structfield>;</term>
242
239
<listitem><simpara>    line number of the last token from <link linkend="g-scanner-peek-next-token"><function>g_scanner_peek_next_token()</function></link>
243
240
</simpara></listitem>
244
241
</varlistentry>
245
242
<varlistentry>
246
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>next_position</structfield>;</term>
 
243
<term><link linkend="guint">guint</link>&#160;<structfield>next_position</structfield>;</term>
247
244
<listitem><simpara>char number of the last token from <link linkend="g-scanner-peek-next-token"><function>g_scanner_peek_next_token()</function></link>
248
245
</simpara></listitem>
249
246
</varlistentry>
250
247
<varlistentry>
251
 
<term><link linkend="GHashTable">GHashTable</link>&nbsp;*<structfield>symbol_table</structfield>;</term>
252
 
<listitem><simpara>
253
 
</simpara></listitem>
254
 
</varlistentry>
255
 
<varlistentry>
256
 
<term><link linkend="gint">gint</link>&nbsp;<structfield>input_fd</structfield>;</term>
257
 
<listitem><simpara>
258
 
</simpara></listitem>
259
 
</varlistentry>
260
 
<varlistentry>
261
 
<term>const&nbsp;<link linkend="gchar">gchar</link>&nbsp;*<structfield>text</structfield>;</term>
262
 
<listitem><simpara>
263
 
</simpara></listitem>
264
 
</varlistentry>
265
 
<varlistentry>
266
 
<term>const&nbsp;<link linkend="gchar">gchar</link>&nbsp;*<structfield>text_end</structfield>;</term>
267
 
<listitem><simpara>
268
 
</simpara></listitem>
269
 
</varlistentry>
270
 
<varlistentry>
271
 
<term><link linkend="gchar">gchar</link>&nbsp;*<structfield>buffer</structfield>;</term>
272
 
<listitem><simpara>
273
 
</simpara></listitem>
274
 
</varlistentry>
275
 
<varlistentry>
276
 
<term><link linkend="guint">guint</link>&nbsp;<structfield>scope_id</structfield>;</term>
277
 
<listitem><simpara>
278
 
</simpara></listitem>
279
 
</varlistentry>
280
 
<varlistentry>
281
 
<term><link linkend="GScannerMsgFunc">GScannerMsgFunc</link>&nbsp;<structfield>msg_handler</structfield>;</term>
 
248
<term><link linkend="GHashTable">GHashTable</link>&#160;*<structfield>symbol_table</structfield>;</term>
 
249
<listitem><simpara>
 
250
</simpara></listitem>
 
251
</varlistentry>
 
252
<varlistentry>
 
253
<term><link linkend="gint">gint</link>&#160;<structfield>input_fd</structfield>;</term>
 
254
<listitem><simpara>
 
255
</simpara></listitem>
 
256
</varlistentry>
 
257
<varlistentry>
 
258
<term>const&#160;<link linkend="gchar">gchar</link>&#160;*<structfield>text</structfield>;</term>
 
259
<listitem><simpara>
 
260
</simpara></listitem>
 
261
</varlistentry>
 
262
<varlistentry>
 
263
<term>const&#160;<link linkend="gchar">gchar</link>&#160;*<structfield>text_end</structfield>;</term>
 
264
<listitem><simpara>
 
265
</simpara></listitem>
 
266
</varlistentry>
 
267
<varlistentry>
 
268
<term><link linkend="gchar">gchar</link>&#160;*<structfield>buffer</structfield>;</term>
 
269
<listitem><simpara>
 
270
</simpara></listitem>
 
271
</varlistentry>
 
272
<varlistentry>
 
273
<term><link linkend="guint">guint</link>&#160;<structfield>scope_id</structfield>;</term>
 
274
<listitem><simpara>
 
275
</simpara></listitem>
 
276
</varlistentry>
 
277
<varlistentry>
 
278
<term><link linkend="GScannerMsgFunc">GScannerMsgFunc</link>&#160;<structfield>msg_handler</structfield>;</term>
282
279
<listitem><simpara>function to handle GScanner message output
283
 
 
284
280
</simpara></listitem>
285
281
</varlistentry>
286
282
</variablelist></refsect2>
287
 
<refsect2>
288
 
<title><anchor id="GScannerConfig" role="struct"/>GScannerConfig</title>
289
 
<indexterm><primary>GScannerConfig</primary></indexterm><programlisting>typedef struct {
 
283
<refsect2 id="GScannerConfig" role="struct">
 
284
<title>GScannerConfig</title>
 
285
<indexterm zone="GScannerConfig"><primary sortas="GScannerConfig">GScannerConfig</primary></indexterm><programlisting>typedef struct {
290
286
  /* Character sets
291
287
   */
292
288
  gchar         *cset_skip_characters;          /* default: " \t\n" */
336
332
</para>
337
333
<para>
338
334
<structfield>cset_identifier_first</structfield> specifies the characters
339
 
which can start identifiers (the default is <link linkend="G-CSET-a-2-z"><type>G_CSET_a_2_z</type></link>, "_", and 
340
 
<link linkend="G-CSET-A-2-Z:CAPS"><type>G_CSET_A_2_Z</type></link>).
 
335
which can start identifiers (the default is <link linkend="G-CSET-a-2-z"><type>G_CSET_a_2_z</type></link>, "_", and
 
336
<link linkend="G-CSET-A-2-Z--CAPS"><type>G_CSET_A_2_Z</type></link>).
341
337
</para>
342
338
<para>
343
339
<structfield>cset_identifier_nth</structfield> specifies the characters
344
 
which can be used in identifiers, after the first character (the default 
345
 
is <link linkend="G-CSET-a-2-z"><type>G_CSET_a_2_z</type></link>, "_0123456789", <link linkend="G-CSET-A-2-Z:CAPS"><type>G_CSET_A_2_Z</type></link>, <link linkend="G-CSET-LATINS:CAPS"><type>G_CSET_LATINS</type></link>,
346
 
<link linkend="G-CSET-LATINC:CAPS"><type>G_CSET_LATINC</type></link>).
 
340
which can be used in identifiers, after the first character (the default
 
341
is <link linkend="G-CSET-a-2-z"><type>G_CSET_a_2_z</type></link>, "_0123456789", <link linkend="G-CSET-A-2-Z--CAPS"><type>G_CSET_A_2_Z</type></link>, <link linkend="G-CSET-LATINS--CAPS"><type>G_CSET_LATINS</type></link>,
 
342
<link linkend="G-CSET-LATINC--CAPS"><type>G_CSET_LATINC</type></link>).
347
343
</para>
348
344
<para>
349
345
<structfield>cpair_comment_single</structfield> specifies the characters
353
349
</para>
354
350
<para>
355
351
<structfield>case_sensitive</structfield> specifies if symbols are
356
 
case sensitive (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
352
case sensitive (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
357
353
</para>
358
354
<para>
359
355
<structfield>skip_comment_multi</structfield> specifies if multi-line
360
 
comments are skipped and not returned as tokens (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
356
comments are skipped and not returned as tokens (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
361
357
</para>
362
358
<para>
363
359
<structfield>skip_comment_single</structfield> specifies if single-line
364
 
comments are skipped and not returned as tokens (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
360
comments are skipped and not returned as tokens (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
365
361
</para>
366
362
<para>
367
363
<structfield>scan_comment_multi</structfield> specifies if multi-line
368
 
comments are recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
364
comments are recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
369
365
</para>
370
366
<para>
371
367
<structfield>scan_identifier</structfield> specifies if identifiers
372
 
are recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
368
are recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
373
369
</para>
374
370
<para>
375
371
<structfield>scan_identifier_1char</structfield> specifies if single-character
376
 
identifiers are recognized (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
372
identifiers are recognized (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
377
373
</para>
378
374
<para>
379
 
<structfield>scan_identifier_NULL</structfield> specifies if 
380
 
<literal>NULL</literal> is reported as <link linkend="G-TOKEN-IDENTIFIER-NULL:CAPS"><type>G_TOKEN_IDENTIFIER_NULL</type></link>.
381
 
(the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
375
<structfield>scan_identifier_NULL</structfield> specifies if
 
376
<literal>NULL</literal> is reported as <link linkend="G-TOKEN-IDENTIFIER-NULL--CAPS"><type>G_TOKEN_IDENTIFIER_NULL</type></link>.
 
377
(the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
382
378
</para>
383
379
<para>
384
380
<structfield>scan_symbols</structfield> specifies if symbols are
385
 
recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
381
recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
386
382
</para>
387
383
<para>
388
384
<structfield>scan_binary</structfield> specifies if binary numbers
389
 
are recognized (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
385
are recognized (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
390
386
</para>
391
387
<para>
392
388
<structfield>scan_octal</structfield> specifies if octal numbers
393
 
are recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
389
are recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
394
390
</para>
395
391
<para>
396
392
<structfield>scan_float</structfield> specifies if floating point numbers
397
 
are recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
393
are recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
398
394
</para>
399
395
<para>
400
396
<structfield>scan_hex</structfield> specifies if hexadecimal numbers
401
 
are recognized (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
397
are recognized (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
402
398
</para>
403
399
<para>
404
400
<structfield>scan_hex_dollar</structfield> specifies if '$' is recognized
405
 
as a prefix for hexadecimal numbers (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
401
as a prefix for hexadecimal numbers (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
406
402
</para>
407
403
<para>
408
404
<structfield>scan_string_sq</structfield> specifies if strings can be
409
 
enclosed in single quotes (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
405
enclosed in single quotes (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
410
406
</para>
411
407
<para>
412
408
<structfield>scan_string_dq</structfield> specifies if strings can be
413
 
enclosed in double quotes (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
409
enclosed in double quotes (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
414
410
</para>
415
411
<para>
416
412
<structfield>numbers_2_int</structfield> specifies if binary, octal and
417
 
hexadecimal numbers are reported as <link linkend="G-TOKEN-INT:CAPS"><type>G_TOKEN_INT</type></link> (the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
413
hexadecimal numbers are reported as <link linkend="G-TOKEN-INT--CAPS"><type>G_TOKEN_INT</type></link> (the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
418
414
</para>
419
415
<para>
420
 
<structfield>int_2_float</structfield> specifies if all numbers are 
421
 
reported as <link linkend="G-TOKEN-FLOAT:CAPS"><type>G_TOKEN_FLOAT</type></link> (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
416
<structfield>int_2_float</structfield> specifies if all numbers are
 
417
reported as <link linkend="G-TOKEN-FLOAT--CAPS"><type>G_TOKEN_FLOAT</type></link> (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
422
418
</para>
423
419
<para>
424
420
<structfield>identifier_2_string</structfield> specifies if identifiers
425
 
are reported as strings (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
421
are reported as strings (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
426
422
</para>
427
423
<para>
428
424
<structfield>char_2_token</structfield> specifies if characters
429
 
are reported by setting <literal>token = ch</literal> or as <link linkend="G-TOKEN-CHAR:CAPS"><type>G_TOKEN_CHAR</type></link> 
430
 
(the default is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>).
 
425
are reported by setting <literal>token = ch</literal> or as <link linkend="G-TOKEN-CHAR--CAPS"><type>G_TOKEN_CHAR</type></link>
 
426
(the default is <link linkend="TRUE--CAPS"><literal>TRUE</literal></link>).
431
427
</para>
432
428
<para>
433
 
<structfield>symbol_2_token</structfield> specifies if symbols 
 
429
<structfield>symbol_2_token</structfield> specifies if symbols
434
430
are reported by setting <literal>token = v_symbol</literal> or as
435
 
<link linkend="G-TOKEN-SYMBOL:CAPS"><type>G_TOKEN_SYMBOL</type></link> (the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
431
<link linkend="G-TOKEN-SYMBOL--CAPS"><type>G_TOKEN_SYMBOL</type></link> (the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
436
432
</para>
437
433
<para>
438
 
<structfield>scope_0_fallback</structfield> specifies if a symbol 
 
434
<structfield>scope_0_fallback</structfield> specifies if a symbol
439
435
is searched for in the default scope in addition to the current scope
440
 
(the default is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>).
 
436
(the default is <link linkend="FALSE--CAPS"><literal>FALSE</literal></link>).
441
437
</para></refsect2>
442
 
<refsect2>
443
 
<title><anchor id="g-scanner-new" role="function"/>g_scanner_new ()</title>
444
 
<indexterm><primary>g_scanner_new</primary></indexterm><programlisting><link linkend="GScanner">GScanner</link>*           g_scanner_new                       (const <link linkend="GScannerConfig">GScannerConfig</link> *config_templ);</programlisting>
 
438
<refsect2 id="g-scanner-new" role="function">
 
439
<title>g_scanner_new ()</title>
 
440
<indexterm zone="g-scanner-new"><primary sortas="g_scanner_new">g_scanner_new</primary></indexterm><programlisting><link linkend="GScanner">GScanner</link>*           g_scanner_new                       (const <link linkend="GScannerConfig">GScannerConfig</link> *config_templ);</programlisting>
445
441
<para>
446
442
Creates a new <link linkend="GScanner"><type>GScanner</type></link>.
447
443
The <parameter>config_templ</parameter> structure specifies the initial settings of the scanner,
448
444
which are copied into the <link linkend="GScanner"><type>GScanner</type></link> <structfield>config</structfield> field.
449
 
If you pass <link linkend="NULL:CAPS"><literal>NULL</literal></link> then the default settings are used.
 
445
If you pass <link linkend="NULL--CAPS"><literal>NULL</literal></link> then the default settings are used.
450
446
</para><variablelist role="params">
451
 
<varlistentry><term><parameter>config_templ</parameter>&nbsp;:</term>
 
447
<varlistentry><term><parameter>config_templ</parameter>&#160;:</term>
452
448
<listitem><simpara>the initial scanner settings.
453
449
</simpara></listitem></varlistentry>
454
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the new <link linkend="GScanner"><type>GScanner</type></link>.
455
 
 
456
 
 
 
450
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the new <link linkend="GScanner"><type>GScanner</type></link>.
457
451
</simpara></listitem></varlistentry>
458
452
</variablelist></refsect2>
459
 
<refsect2>
460
 
<title><anchor id="g-scanner-destroy" role="function"/>g_scanner_destroy ()</title>
461
 
<indexterm><primary>g_scanner_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_destroy                   (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
453
<refsect2 id="g-scanner-destroy" role="function">
 
454
<title>g_scanner_destroy ()</title>
 
455
<indexterm zone="g-scanner-destroy"><primary sortas="g_scanner_destroy">g_scanner_destroy</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_destroy                   (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
462
456
<para>
463
457
Frees all memory used by the <link linkend="GScanner"><type>GScanner</type></link>.
464
458
</para><variablelist role="params">
465
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
459
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
466
460
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
467
 
 
468
 
 
469
461
</simpara></listitem></varlistentry>
470
462
</variablelist></refsect2>
471
 
<refsect2>
472
 
<title><anchor id="g-scanner-input-file" role="function"/>g_scanner_input_file ()</title>
473
 
<indexterm><primary>g_scanner_input_file</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_input_file                (<link linkend="GScanner">GScanner</link> *scanner,
 
463
<refsect2 id="g-scanner-input-file" role="function">
 
464
<title>g_scanner_input_file ()</title>
 
465
<indexterm zone="g-scanner-input-file"><primary sortas="g_scanner_input_file">g_scanner_input_file</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_input_file                (<link linkend="GScanner">GScanner</link> *scanner,
474
466
                                                         <link linkend="gint">gint</link> input_fd);</programlisting>
475
467
<para>
476
468
Prepares to scan a file.
477
469
</para><variablelist role="params">
478
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
470
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
479
471
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
480
472
</simpara></listitem></varlistentry>
481
 
<varlistentry><term><parameter>input_fd</parameter>&nbsp;:</term>
 
473
<varlistentry><term><parameter>input_fd</parameter>&#160;:</term>
482
474
<listitem><simpara>a file descriptor.
483
 
 
484
 
 
485
475
</simpara></listitem></varlistentry>
486
476
</variablelist></refsect2>
487
 
<refsect2>
488
 
<title><anchor id="g-scanner-sync-file-offset" role="function"/>g_scanner_sync_file_offset ()</title>
489
 
<indexterm><primary>g_scanner_sync_file_offset</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_sync_file_offset          (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
477
<refsect2 id="g-scanner-sync-file-offset" role="function">
 
478
<title>g_scanner_sync_file_offset ()</title>
 
479
<indexterm zone="g-scanner-sync-file-offset"><primary sortas="g_scanner_sync_file_offset">g_scanner_sync_file_offset</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_sync_file_offset          (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
490
480
<para>
491
 
Rewinds the filedescriptor to the current buffer position and blows 
 
481
Rewinds the filedescriptor to the current buffer position and blows
492
482
the file read ahead buffer. This is useful for third party uses of
493
 
the scanners filedescriptor, which hooks onto the current scanning 
 
483
the scanners filedescriptor, which hooks onto the current scanning
494
484
position.
495
485
</para><variablelist role="params">
496
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
486
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
497
487
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
498
 
 
499
 
 
500
488
</simpara></listitem></varlistentry>
501
489
</variablelist></refsect2>
502
 
<refsect2>
503
 
<title><anchor id="g-scanner-input-text" role="function"/>g_scanner_input_text ()</title>
504
 
<indexterm><primary>g_scanner_input_text</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_input_text                (<link linkend="GScanner">GScanner</link> *scanner,
 
490
<refsect2 id="g-scanner-input-text" role="function">
 
491
<title>g_scanner_input_text ()</title>
 
492
<indexterm zone="g-scanner-input-text"><primary sortas="g_scanner_input_text">g_scanner_input_text</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_input_text                (<link linkend="GScanner">GScanner</link> *scanner,
505
493
                                                         const <link linkend="gchar">gchar</link> *text,
506
494
                                                         <link linkend="guint">guint</link> text_len);</programlisting>
507
495
<para>
508
496
Prepares to scan a text buffer.
509
497
</para><variablelist role="params">
510
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
498
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
511
499
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
512
500
</simpara></listitem></varlistentry>
513
 
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
 
501
<varlistentry><term><parameter>text</parameter>&#160;:</term>
514
502
<listitem><simpara>the text buffer to scan.
515
503
</simpara></listitem></varlistentry>
516
 
<varlistentry><term><parameter>text_len</parameter>&nbsp;:</term>
 
504
<varlistentry><term><parameter>text_len</parameter>&#160;:</term>
517
505
<listitem><simpara>the length of the text buffer.
518
 
 
519
 
 
520
506
</simpara></listitem></varlistentry>
521
507
</variablelist></refsect2>
522
 
<refsect2>
523
 
<title><anchor id="g-scanner-peek-next-token" role="function"/>g_scanner_peek_next_token ()</title>
524
 
<indexterm><primary>g_scanner_peek_next_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_peek_next_token           (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
508
<refsect2 id="g-scanner-peek-next-token" role="function">
 
509
<title>g_scanner_peek_next_token ()</title>
 
510
<indexterm zone="g-scanner-peek-next-token"><primary sortas="g_scanner_peek_next_token">g_scanner_peek_next_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_peek_next_token           (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
525
511
<para>
526
512
Parses the next token, without removing it from the input stream.
527
513
The token data is placed in the
537
523
changing scope or the scanner configuration after peeking the next token.
538
524
Getting the next token after switching the scope or configuration will
539
525
return whatever was peeked before, regardless of any symbols that may
540
 
have been added or removed in the new scope. 
 
526
have been added or removed in the new scope.
541
527
</para><variablelist role="params">
542
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
528
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
543
529
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
544
530
</simpara></listitem></varlistentry>
545
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the type of the token.
546
 
 
547
 
 
 
531
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the type of the token.
548
532
</simpara></listitem></varlistentry>
549
533
</variablelist></refsect2>
550
 
<refsect2>
551
 
<title><anchor id="g-scanner-get-next-token" role="function"/>g_scanner_get_next_token ()</title>
552
 
<indexterm><primary>g_scanner_get_next_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_get_next_token            (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
534
<refsect2 id="g-scanner-get-next-token" role="function">
 
535
<title>g_scanner_get_next_token ()</title>
 
536
<indexterm zone="g-scanner-get-next-token"><primary sortas="g_scanner_get_next_token">g_scanner_get_next_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_get_next_token            (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
553
537
<para>
554
538
Parses the next token just like <link linkend="g-scanner-peek-next-token"><function>g_scanner_peek_next_token()</function></link> and also
555
539
removes it from the input stream.
559
543
<structfield>line</structfield>, and
560
544
<structfield>position</structfield> fields of the <link linkend="GScanner"><type>GScanner</type></link> structure.
561
545
</para><variablelist role="params">
562
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
546
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
563
547
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
564
548
</simpara></listitem></varlistentry>
565
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the type of the token.
566
 
 
567
 
 
 
549
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the type of the token.
568
550
</simpara></listitem></varlistentry>
569
551
</variablelist></refsect2>
570
 
<refsect2>
571
 
<title><anchor id="g-scanner-eof" role="function"/>g_scanner_eof ()</title>
572
 
<indexterm><primary>g_scanner_eof</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_scanner_eof                       (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
552
<refsect2 id="g-scanner-eof" role="function">
 
553
<title>g_scanner_eof ()</title>
 
554
<indexterm zone="g-scanner-eof"><primary sortas="g_scanner_eof">g_scanner_eof</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            g_scanner_eof                       (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
573
555
<para>
574
 
Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the scanner has reached the end of the file or text buffer.
 
556
Returns <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> if the scanner has reached the end of the file or text buffer.
575
557
</para><variablelist role="params">
576
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
558
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
577
559
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
578
560
</simpara></listitem></varlistentry>
579
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the scanner has reached the end of the file or text buffer.
580
 
 
581
 
 
 
561
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>%TRUE if the scanner has reached the end of the file or text buffer.
582
562
</simpara></listitem></varlistentry>
583
563
</variablelist></refsect2>
584
 
<refsect2>
585
 
<title><anchor id="g-scanner-cur-line" role="function"/>g_scanner_cur_line ()</title>
586
 
<indexterm><primary>g_scanner_cur_line</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_cur_line                  (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
564
<refsect2 id="g-scanner-cur-line" role="function">
 
565
<title>g_scanner_cur_line ()</title>
 
566
<indexterm zone="g-scanner-cur-line"><primary sortas="g_scanner_cur_line">g_scanner_cur_line</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_cur_line                  (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
587
567
<para>
588
568
Returns the current line in the input stream (counting from 1).
589
569
This is the line of the last token parsed via <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>.
590
570
</para><variablelist role="params">
591
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
571
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
592
572
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
593
573
</simpara></listitem></varlistentry>
594
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the current line.
595
 
 
596
 
 
 
574
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the current line.
597
575
</simpara></listitem></varlistentry>
598
576
</variablelist></refsect2>
599
 
<refsect2>
600
 
<title><anchor id="g-scanner-cur-position" role="function"/>g_scanner_cur_position ()</title>
601
 
<indexterm><primary>g_scanner_cur_position</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_cur_position              (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
577
<refsect2 id="g-scanner-cur-position" role="function">
 
578
<title>g_scanner_cur_position ()</title>
 
579
<indexterm zone="g-scanner-cur-position"><primary sortas="g_scanner_cur_position">g_scanner_cur_position</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_cur_position              (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
602
580
<para>
603
581
Returns the current position in the current line (counting from 0).
604
582
This is the position of the last token parsed via <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link>.
605
583
</para><variablelist role="params">
606
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
584
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
607
585
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
608
586
</simpara></listitem></varlistentry>
609
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the current position on the line.
610
 
 
611
 
 
 
587
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the current position on the line.
612
588
</simpara></listitem></varlistentry>
613
589
</variablelist></refsect2>
614
 
<refsect2>
615
 
<title><anchor id="g-scanner-cur-token" role="function"/>g_scanner_cur_token ()</title>
616
 
<indexterm><primary>g_scanner_cur_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_cur_token                 (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
590
<refsect2 id="g-scanner-cur-token" role="function">
 
591
<title>g_scanner_cur_token ()</title>
 
592
<indexterm zone="g-scanner-cur-token"><primary sortas="g_scanner_cur_token">g_scanner_cur_token</primary></indexterm><programlisting><link linkend="GTokenType">GTokenType</link>          g_scanner_cur_token                 (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
617
593
<para>
618
594
Gets the current token type.
619
595
This is simply the <structfield>token</structfield> field in the <link linkend="GScanner"><type>GScanner</type></link>
620
596
structure.
621
597
</para><variablelist role="params">
622
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
598
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
623
599
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
624
600
</simpara></listitem></varlistentry>
625
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the current token type.
626
 
 
627
 
 
 
601
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the current token type.
628
602
</simpara></listitem></varlistentry>
629
603
</variablelist></refsect2>
630
 
<refsect2>
631
 
<title><anchor id="g-scanner-cur-value" role="function"/>g_scanner_cur_value ()</title>
632
 
<indexterm><primary>g_scanner_cur_value</primary></indexterm><programlisting><link linkend="GTokenValue">GTokenValue</link>         g_scanner_cur_value                 (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
 
604
<refsect2 id="g-scanner-cur-value" role="function">
 
605
<title>g_scanner_cur_value ()</title>
 
606
<indexterm zone="g-scanner-cur-value"><primary sortas="g_scanner_cur_value">g_scanner_cur_value</primary></indexterm><programlisting><link linkend="GTokenValue">GTokenValue</link>         g_scanner_cur_value                 (<link linkend="GScanner">GScanner</link> *scanner);</programlisting>
633
607
<para>
634
608
Gets the current token value.
635
609
This is simply the <structfield>value</structfield> field in the <link linkend="GScanner"><type>GScanner</type></link>
636
610
structure.
637
611
</para><variablelist role="params">
638
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
612
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
639
613
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
640
614
</simpara></listitem></varlistentry>
641
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the current token value.
642
 
 
643
 
 
 
615
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the current token value.
644
616
</simpara></listitem></varlistentry>
645
617
</variablelist></refsect2>
646
 
<refsect2>
647
 
<title><anchor id="g-scanner-set-scope" role="function"/>g_scanner_set_scope ()</title>
648
 
<indexterm><primary>g_scanner_set_scope</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_set_scope                 (<link linkend="GScanner">GScanner</link> *scanner,
 
618
<refsect2 id="g-scanner-set-scope" role="function">
 
619
<title>g_scanner_set_scope ()</title>
 
620
<indexterm zone="g-scanner-set-scope"><primary sortas="g_scanner_set_scope">g_scanner_set_scope</primary></indexterm><programlisting><link linkend="guint">guint</link>               g_scanner_set_scope                 (<link linkend="GScanner">GScanner</link> *scanner,
649
621
                                                         <link linkend="guint">guint</link> scope_id);</programlisting>
650
622
<para>
651
623
Sets the current scope.
652
624
</para><variablelist role="params">
653
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
625
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
654
626
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
655
627
</simpara></listitem></varlistentry>
656
 
<varlistentry><term><parameter>scope_id</parameter>&nbsp;:</term>
 
628
<varlistentry><term><parameter>scope_id</parameter>&#160;:</term>
657
629
<listitem><simpara>the new scope id.
658
630
</simpara></listitem></varlistentry>
659
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the old scope id.
660
 
 
661
 
 
 
631
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the old scope id.
662
632
</simpara></listitem></varlistentry>
663
633
</variablelist></refsect2>
664
 
<refsect2>
665
 
<title><anchor id="g-scanner-scope-add-symbol" role="function"/>g_scanner_scope_add_symbol ()</title>
666
 
<indexterm><primary>g_scanner_scope_add_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_add_symbol          (<link linkend="GScanner">GScanner</link> *scanner,
 
634
<refsect2 id="g-scanner-scope-add-symbol" role="function">
 
635
<title>g_scanner_scope_add_symbol ()</title>
 
636
<indexterm zone="g-scanner-scope-add-symbol"><primary sortas="g_scanner_scope_add_symbol">g_scanner_scope_add_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_add_symbol          (<link linkend="GScanner">GScanner</link> *scanner,
667
637
                                                         <link linkend="guint">guint</link> scope_id,
668
638
                                                         const <link linkend="gchar">gchar</link> *symbol,
669
639
                                                         <link linkend="gpointer">gpointer</link> value);</programlisting>
670
640
<para>
671
641
Adds a symbol to the given scope.
672
642
</para><variablelist role="params">
673
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
643
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
674
644
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
675
645
</simpara></listitem></varlistentry>
676
 
<varlistentry><term><parameter>scope_id</parameter>&nbsp;:</term>
 
646
<varlistentry><term><parameter>scope_id</parameter>&#160;:</term>
677
647
<listitem><simpara>the scope id.
678
648
</simpara></listitem></varlistentry>
679
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
649
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
680
650
<listitem><simpara>the symbol to add.
681
651
</simpara></listitem></varlistentry>
682
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
652
<varlistentry><term><parameter>value</parameter>&#160;:</term>
683
653
<listitem><simpara>the value of the symbol.
684
 
 
685
 
 
686
654
</simpara></listitem></varlistentry>
687
655
</variablelist></refsect2>
688
 
<refsect2>
689
 
<title><anchor id="g-scanner-scope-foreach-symbol" role="function"/>g_scanner_scope_foreach_symbol ()</title>
690
 
<indexterm><primary>g_scanner_scope_foreach_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_foreach_symbol      (<link linkend="GScanner">GScanner</link> *scanner,
 
656
<refsect2 id="g-scanner-scope-foreach-symbol" role="function">
 
657
<title>g_scanner_scope_foreach_symbol ()</title>
 
658
<indexterm zone="g-scanner-scope-foreach-symbol"><primary sortas="g_scanner_scope_foreach_symbol">g_scanner_scope_foreach_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_foreach_symbol      (<link linkend="GScanner">GScanner</link> *scanner,
691
659
                                                         <link linkend="guint">guint</link> scope_id,
692
660
                                                         <link linkend="GHFunc">GHFunc</link> func,
693
661
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
694
662
<para>
695
 
Calls the given function for each of the symbol/value pairs in the 
696
 
given scope of the <link linkend="GScanner"><type>GScanner</type></link>. The function is passed the symbol and 
 
663
Calls the given function for each of the symbol/value pairs in the
 
664
given scope of the <link linkend="GScanner"><type>GScanner</type></link>. The function is passed the symbol and
697
665
value of each pair, and the given <parameter>user_data</parameter> parameter.
698
666
</para><variablelist role="params">
699
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
667
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
700
668
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
701
669
</simpara></listitem></varlistentry>
702
 
<varlistentry><term><parameter>scope_id</parameter>&nbsp;:</term>
 
670
<varlistentry><term><parameter>scope_id</parameter>&#160;:</term>
703
671
<listitem><simpara>the scope id.
704
672
</simpara></listitem></varlistentry>
705
 
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 
673
<varlistentry><term><parameter>func</parameter>&#160;:</term>
706
674
<listitem><simpara>the function to call for each symbol/value pair.
707
675
</simpara></listitem></varlistentry>
708
 
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
 
676
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
709
677
<listitem><simpara>user data to pass to the function.
710
 
 
711
 
 
712
678
</simpara></listitem></varlistentry>
713
679
</variablelist></refsect2>
714
 
<refsect2>
715
 
<title><anchor id="g-scanner-scope-lookup-symbol" role="function"/>g_scanner_scope_lookup_symbol ()</title>
716
 
<indexterm><primary>g_scanner_scope_lookup_symbol</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_scanner_scope_lookup_symbol       (<link linkend="GScanner">GScanner</link> *scanner,
 
680
<refsect2 id="g-scanner-scope-lookup-symbol" role="function">
 
681
<title>g_scanner_scope_lookup_symbol ()</title>
 
682
<indexterm zone="g-scanner-scope-lookup-symbol"><primary sortas="g_scanner_scope_lookup_symbol">g_scanner_scope_lookup_symbol</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_scanner_scope_lookup_symbol       (<link linkend="GScanner">GScanner</link> *scanner,
717
683
                                                         <link linkend="guint">guint</link> scope_id,
718
684
                                                         const <link linkend="gchar">gchar</link> *symbol);</programlisting>
719
685
<para>
720
686
Looks up a symbol in a scope and return its value. If the
721
 
symbol is not bound in the scope, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.
 
687
symbol is not bound in the scope, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned.
722
688
</para><variablelist role="params">
723
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
689
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
724
690
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
725
691
</simpara></listitem></varlistentry>
726
 
<varlistentry><term><parameter>scope_id</parameter>&nbsp;:</term>
 
692
<varlistentry><term><parameter>scope_id</parameter>&#160;:</term>
727
693
<listitem><simpara>the scope id.
728
694
</simpara></listitem></varlistentry>
729
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
695
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
730
696
<listitem><simpara>the symbol to look up.
731
697
</simpara></listitem></varlistentry>
732
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the value of <parameter>symbol</parameter> in the given scope, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
698
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the value of <parameter>symbol</parameter> in the given scope, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
733
699
if <parameter>symbol</parameter> is not bound in the given scope.
734
 
 
735
 
 
736
700
</simpara></listitem></varlistentry>
737
701
</variablelist></refsect2>
738
 
<refsect2>
739
 
<title><anchor id="g-scanner-scope-remove-symbol" role="function"/>g_scanner_scope_remove_symbol ()</title>
740
 
<indexterm><primary>g_scanner_scope_remove_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_remove_symbol       (<link linkend="GScanner">GScanner</link> *scanner,
 
702
<refsect2 id="g-scanner-scope-remove-symbol" role="function">
 
703
<title>g_scanner_scope_remove_symbol ()</title>
 
704
<indexterm zone="g-scanner-scope-remove-symbol"><primary sortas="g_scanner_scope_remove_symbol">g_scanner_scope_remove_symbol</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_scope_remove_symbol       (<link linkend="GScanner">GScanner</link> *scanner,
741
705
                                                         <link linkend="guint">guint</link> scope_id,
742
706
                                                         const <link linkend="gchar">gchar</link> *symbol);</programlisting>
743
707
<para>
744
708
Removes a symbol from a scope.
745
709
</para><variablelist role="params">
746
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
710
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
747
711
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
748
712
</simpara></listitem></varlistentry>
749
 
<varlistentry><term><parameter>scope_id</parameter>&nbsp;:</term>
 
713
<varlistentry><term><parameter>scope_id</parameter>&#160;:</term>
750
714
<listitem><simpara>the scope id.
751
715
</simpara></listitem></varlistentry>
752
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
716
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
753
717
<listitem><simpara>the symbol to remove.
754
 
 
755
 
 
756
718
</simpara></listitem></varlistentry>
757
719
</variablelist></refsect2>
758
 
<refsect2>
759
 
<title><anchor id="g-scanner-add-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_add_symbol() instead."/>g_scanner_add_symbol()</title>
760
 
<indexterm role="deprecated"><primary>g_scanner_add_symbol</primary></indexterm><programlisting>#define             g_scanner_add_symbol( scanner, symbol, value )</programlisting>
 
720
<refsect2 id="g-scanner-add-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_add_symbol() instead.">
 
721
<title>g_scanner_add_symbol()</title>
 
722
<indexterm zone="g-scanner-add-symbol" role="deprecated"><primary sortas="g_scanner_add_symbol">g_scanner_add_symbol</primary></indexterm><programlisting>#define             g_scanner_add_symbol( scanner, symbol, value )</programlisting>
761
723
<warning><para><literal>g_scanner_add_symbol</literal> has been deprecated since version 2.2 and should not be used in newly-written code. Use <link linkend="g-scanner-scope-add-symbol"><function>g_scanner_scope_add_symbol()</function></link> instead.</para></warning>
762
724
<para>
763
725
Adds a symbol to the default scope.
764
726
</para><variablelist role="params">
765
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
727
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
766
728
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
767
729
</simpara></listitem></varlistentry>
768
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
730
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
769
731
<listitem><simpara>the symbol to add.
770
732
</simpara></listitem></varlistentry>
771
 
<varlistentry><term><parameter>value</parameter>&nbsp;:</term>
 
733
<varlistentry><term><parameter>value</parameter>&#160;:</term>
772
734
<listitem><simpara>the value of the symbol.
773
735
</simpara></listitem></varlistentry>
774
736
</variablelist></refsect2>
775
 
<refsect2>
776
 
<title><anchor id="g-scanner-remove-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_remove_symbol() instead."/>g_scanner_remove_symbol()</title>
777
 
<indexterm role="deprecated"><primary>g_scanner_remove_symbol</primary></indexterm><programlisting>#define             g_scanner_remove_symbol( scanner, symbol )</programlisting>
 
737
<refsect2 id="g-scanner-remove-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_remove_symbol() instead.">
 
738
<title>g_scanner_remove_symbol()</title>
 
739
<indexterm zone="g-scanner-remove-symbol" role="deprecated"><primary sortas="g_scanner_remove_symbol">g_scanner_remove_symbol</primary></indexterm><programlisting>#define             g_scanner_remove_symbol( scanner, symbol )</programlisting>
778
740
<warning><para><literal>g_scanner_remove_symbol</literal> has been deprecated since version 2.2 and should not be used in newly-written code. Use <link linkend="g-scanner-scope-remove-symbol"><function>g_scanner_scope_remove_symbol()</function></link> instead.</para></warning>
779
741
<para>
780
742
Removes a symbol from the default scope.
781
743
</para><variablelist role="params">
782
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
744
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
783
745
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
784
746
</simpara></listitem></varlistentry>
785
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
747
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
786
748
<listitem><simpara>the symbol to remove.
787
749
</simpara></listitem></varlistentry>
788
750
</variablelist></refsect2>
789
 
<refsect2>
790
 
<title><anchor id="g-scanner-foreach-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead."/>g_scanner_foreach_symbol()</title>
791
 
<indexterm role="deprecated"><primary>g_scanner_foreach_symbol</primary></indexterm><programlisting>#define             g_scanner_foreach_symbol( scanner, func, data )</programlisting>
 
751
<refsect2 id="g-scanner-foreach-symbol" role="macro" condition="deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead.">
 
752
<title>g_scanner_foreach_symbol()</title>
 
753
<indexterm zone="g-scanner-foreach-symbol" role="deprecated"><primary sortas="g_scanner_foreach_symbol">g_scanner_foreach_symbol</primary></indexterm><programlisting>#define             g_scanner_foreach_symbol( scanner, func, data )</programlisting>
792
754
<warning><para><literal>g_scanner_foreach_symbol</literal> has been deprecated since version 2.2 and should not be used in newly-written code. Use <link linkend="g-scanner-scope-foreach-symbol"><function>g_scanner_scope_foreach_symbol()</function></link> instead.</para></warning>
793
755
<para>
794
756
Calls a function for each symbol in the default scope.
795
757
</para><variablelist role="params">
796
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
758
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
797
759
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
798
760
</simpara></listitem></varlistentry>
799
 
<varlistentry><term><parameter>func</parameter>&nbsp;:</term>
 
761
<varlistentry><term><parameter>func</parameter>&#160;:</term>
800
762
<listitem><simpara>the function to call with each symbol.
801
763
</simpara></listitem></varlistentry>
802
 
<varlistentry><term><parameter>data</parameter>&nbsp;:</term>
 
764
<varlistentry><term><parameter>data</parameter>&#160;:</term>
803
765
<listitem><simpara>data to pass to the function.
804
766
</simpara></listitem></varlistentry>
805
767
</variablelist></refsect2>
806
 
<refsect2>
807
 
<title><anchor id="g-scanner-freeze-symbol-table" role="macro" condition="deprecated:2.2: This macro does nothing."/>g_scanner_freeze_symbol_table()</title>
808
 
<indexterm role="deprecated"><primary>g_scanner_freeze_symbol_table</primary></indexterm><programlisting>#define             g_scanner_freeze_symbol_table(scanner)</programlisting>
 
768
<refsect2 id="g-scanner-freeze-symbol-table" role="macro" condition="deprecated:2.2: This macro does nothing.">
 
769
<title>g_scanner_freeze_symbol_table()</title>
 
770
<indexterm zone="g-scanner-freeze-symbol-table" role="deprecated"><primary sortas="g_scanner_freeze_symbol_table">g_scanner_freeze_symbol_table</primary></indexterm><programlisting>#define             g_scanner_freeze_symbol_table(scanner)</programlisting>
809
771
<warning><para><literal>g_scanner_freeze_symbol_table</literal> has been deprecated since version 2.2 and should not be used in newly-written code. This macro does nothing.</para></warning>
810
772
<para>
811
773
There is no reason to use this macro, since it does nothing.
812
774
</para><variablelist role="params">
813
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
775
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
814
776
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
815
777
</simpara></listitem></varlistentry>
816
778
</variablelist></refsect2>
817
 
<refsect2>
818
 
<title><anchor id="g-scanner-thaw-symbol-table" role="macro" condition="deprecated:2.2: This macro does nothing."/>g_scanner_thaw_symbol_table()</title>
819
 
<indexterm role="deprecated"><primary>g_scanner_thaw_symbol_table</primary></indexterm><programlisting>#define             g_scanner_thaw_symbol_table(scanner)</programlisting>
 
779
<refsect2 id="g-scanner-thaw-symbol-table" role="macro" condition="deprecated:2.2: This macro does nothing.">
 
780
<title>g_scanner_thaw_symbol_table()</title>
 
781
<indexterm zone="g-scanner-thaw-symbol-table" role="deprecated"><primary sortas="g_scanner_thaw_symbol_table">g_scanner_thaw_symbol_table</primary></indexterm><programlisting>#define             g_scanner_thaw_symbol_table(scanner)</programlisting>
820
782
<warning><para><literal>g_scanner_thaw_symbol_table</literal> has been deprecated since version 2.2 and should not be used in newly-written code. This macro does nothing.</para></warning>
821
783
<para>
822
784
There is no reason to use this macro, since it does nothing.
823
785
</para><variablelist role="params">
824
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
786
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
825
787
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
826
788
</simpara></listitem></varlistentry>
827
789
</variablelist></refsect2>
828
 
<refsect2>
829
 
<title><anchor id="g-scanner-lookup-symbol" role="function"/>g_scanner_lookup_symbol ()</title>
830
 
<indexterm><primary>g_scanner_lookup_symbol</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_scanner_lookup_symbol             (<link linkend="GScanner">GScanner</link> *scanner,
 
790
<refsect2 id="g-scanner-lookup-symbol" role="function">
 
791
<title>g_scanner_lookup_symbol ()</title>
 
792
<indexterm zone="g-scanner-lookup-symbol"><primary sortas="g_scanner_lookup_symbol">g_scanner_lookup_symbol</primary></indexterm><programlisting><link linkend="gpointer">gpointer</link>            g_scanner_lookup_symbol             (<link linkend="GScanner">GScanner</link> *scanner,
831
793
                                                         const <link linkend="gchar">gchar</link> *symbol);</programlisting>
832
794
<para>
833
795
Looks up a symbol in the current scope and return its value. If the
834
 
symbol is not bound in the current scope, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.
 
796
symbol is not bound in the current scope, <link linkend="NULL--CAPS"><literal>NULL</literal></link> is returned.
835
797
</para><variablelist role="params">
836
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
798
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
837
799
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
838
800
</simpara></listitem></varlistentry>
839
 
<varlistentry><term><parameter>symbol</parameter>&nbsp;:</term>
 
801
<varlistentry><term><parameter>symbol</parameter>&#160;:</term>
840
802
<listitem><simpara>the symbol to look up.
841
803
</simpara></listitem></varlistentry>
842
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>the value of <parameter>symbol</parameter> in the current scope, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
 
804
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>the value of <parameter>symbol</parameter> in the current scope, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>
843
805
if <parameter>symbol</parameter> is not bound in the current scope.
844
 
 
845
 
 
846
806
</simpara></listitem></varlistentry>
847
807
</variablelist></refsect2>
848
 
<refsect2>
849
 
<title><anchor id="g-scanner-warn" role="function"/>g_scanner_warn ()</title>
850
 
<indexterm><primary>g_scanner_warn</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_warn                      (<link linkend="GScanner">GScanner</link> *scanner,
 
808
<refsect2 id="g-scanner-warn" role="function">
 
809
<title>g_scanner_warn ()</title>
 
810
<indexterm zone="g-scanner-warn"><primary sortas="g_scanner_warn">g_scanner_warn</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_warn                      (<link linkend="GScanner">GScanner</link> *scanner,
851
811
                                                         const <link linkend="gchar">gchar</link> *format,
852
812
                                                         ...);</programlisting>
853
813
<para>
854
814
Outputs a warning message, via the <link linkend="GScanner"><type>GScanner</type></link> message handler.
855
815
</para><variablelist role="params">
856
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
816
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
857
817
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
858
818
</simpara></listitem></varlistentry>
859
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
819
<varlistentry><term><parameter>format</parameter>&#160;:</term>
860
820
<listitem><simpara>the message format. See the <function><link linkend="printf"><function>printf()</function></link></function>
861
821
documentation.
862
822
</simpara></listitem></varlistentry>
863
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
823
<varlistentry><term><parameter>...</parameter>&#160;:</term>
864
824
<listitem><simpara>the parameters to insert into the format string.
865
 
 
866
 
 
867
825
</simpara></listitem></varlistentry>
868
826
</variablelist></refsect2>
869
 
<refsect2>
870
 
<title><anchor id="g-scanner-error" role="function"/>g_scanner_error ()</title>
871
 
<indexterm><primary>g_scanner_error</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_error                     (<link linkend="GScanner">GScanner</link> *scanner,
 
827
<refsect2 id="g-scanner-error" role="function">
 
828
<title>g_scanner_error ()</title>
 
829
<indexterm zone="g-scanner-error"><primary sortas="g_scanner_error">g_scanner_error</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_error                     (<link linkend="GScanner">GScanner</link> *scanner,
872
830
                                                         const <link linkend="gchar">gchar</link> *format,
873
831
                                                         ...);</programlisting>
874
832
<para>
875
833
Outputs an error message, via the <link linkend="GScanner"><type>GScanner</type></link> message handler.
876
834
</para><variablelist role="params">
877
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
835
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
878
836
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
879
837
</simpara></listitem></varlistentry>
880
 
<varlistentry><term><parameter>format</parameter>&nbsp;:</term>
 
838
<varlistentry><term><parameter>format</parameter>&#160;:</term>
881
839
<listitem><simpara>the message format. See the <function><link linkend="printf"><function>printf()</function></link></function>
882
840
documentation.
883
841
</simpara></listitem></varlistentry>
884
 
<varlistentry><term><parameter>...</parameter>&nbsp;:</term>
 
842
<varlistentry><term><parameter>...</parameter>&#160;:</term>
885
843
<listitem><simpara>the parameters to insert into the format string.
886
 
 
887
 
 
888
844
</simpara></listitem></varlistentry>
889
845
</variablelist></refsect2>
890
 
<refsect2>
891
 
<title><anchor id="g-scanner-unexp-token" role="function"/>g_scanner_unexp_token ()</title>
892
 
<indexterm><primary>g_scanner_unexp_token</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_unexp_token               (<link linkend="GScanner">GScanner</link> *scanner,
 
846
<refsect2 id="g-scanner-unexp-token" role="function">
 
847
<title>g_scanner_unexp_token ()</title>
 
848
<indexterm zone="g-scanner-unexp-token"><primary sortas="g_scanner_unexp_token">g_scanner_unexp_token</primary></indexterm><programlisting><link linkend="void">void</link>                g_scanner_unexp_token               (<link linkend="GScanner">GScanner</link> *scanner,
893
849
                                                         <link linkend="GTokenType">GTokenType</link> expected_token,
894
850
                                                         const <link linkend="gchar">gchar</link> *identifier_spec,
895
851
                                                         const <link linkend="gchar">gchar</link> *symbol_spec,
905
861
scanner's current token (not the peeked token) to construct part
906
862
of the message.
907
863
</para><variablelist role="params">
908
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
864
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
909
865
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
910
866
</simpara></listitem></varlistentry>
911
 
<varlistentry><term><parameter>expected_token</parameter>&nbsp;:</term>
 
867
<varlistentry><term><parameter>expected_token</parameter>&#160;:</term>
912
868
<listitem><simpara>the expected token.
913
869
</simpara></listitem></varlistentry>
914
 
<varlistentry><term><parameter>identifier_spec</parameter>&nbsp;:</term>
915
 
<listitem><simpara>a string describing how the scanner's user refers to
916
 
                  identifiers (<link linkend="NULL:CAPS"><literal>NULL</literal></link> defaults to "identifier").
917
 
                  This is used if <parameter>expected_token</parameter> is <link linkend="G-TOKEN-IDENTIFIER:CAPS"><type>G_TOKEN_IDENTIFIER</type></link>
918
 
                  or <link linkend="G-TOKEN-IDENTIFIER-NULL:CAPS"><type>G_TOKEN_IDENTIFIER_NULL</type></link>.
919
 
</simpara></listitem></varlistentry>
920
 
<varlistentry><term><parameter>symbol_spec</parameter>&nbsp;:</term>
921
 
<listitem><simpara>a string describing how the scanner's user refers to
922
 
              symbols (<link linkend="NULL:CAPS"><literal>NULL</literal></link> defaults to "symbol").
923
 
              This is used if <parameter>expected_token</parameter> is <link linkend="G-TOKEN-SYMBOL:CAPS"><type>G_TOKEN_SYMBOL</type></link> or
924
 
              any token value greater than <link linkend="G-TOKEN-LAST:CAPS"><type>G_TOKEN_LAST</type></link>.
925
 
</simpara></listitem></varlistentry>
926
 
<varlistentry><term><parameter>symbol_name</parameter>&nbsp;:</term>
 
870
<varlistentry><term><parameter>identifier_spec</parameter>&#160;:</term>
 
871
<listitem><simpara>a string describing how the scanner's user refers to
 
872
                  identifiers (<link linkend="NULL--CAPS"><literal>NULL</literal></link> defaults to "identifier").
 
873
                  This is used if <parameter>expected_token</parameter> is <link linkend="G-TOKEN-IDENTIFIER--CAPS"><type>G_TOKEN_IDENTIFIER</type></link>
 
874
                  or <link linkend="G-TOKEN-IDENTIFIER-NULL--CAPS"><type>G_TOKEN_IDENTIFIER_NULL</type></link>.
 
875
</simpara></listitem></varlistentry>
 
876
<varlistentry><term><parameter>symbol_spec</parameter>&#160;:</term>
 
877
<listitem><simpara>a string describing how the scanner's user refers to
 
878
              symbols (<link linkend="NULL--CAPS"><literal>NULL</literal></link> defaults to "symbol").
 
879
              This is used if <parameter>expected_token</parameter> is <link linkend="G-TOKEN-SYMBOL--CAPS"><type>G_TOKEN_SYMBOL</type></link> or
 
880
              any token value greater than <link linkend="G-TOKEN-LAST--CAPS"><type>G_TOKEN_LAST</type></link>.
 
881
</simpara></listitem></varlistentry>
 
882
<varlistentry><term><parameter>symbol_name</parameter>&#160;:</term>
927
883
<listitem><simpara>the name of the symbol, if the scanner's current token
928
884
              is a symbol.
929
885
</simpara></listitem></varlistentry>
930
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
931
 
<listitem><simpara>a message string to output at the end of the warning/error, or <link linkend="NULL:CAPS"><literal>NULL</literal></link>.
 
886
<varlistentry><term><parameter>message</parameter>&#160;:</term>
 
887
<listitem><simpara>a message string to output at the end of the warning/error, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>.
932
888
</simpara></listitem></varlistentry>
933
 
<varlistentry><term><parameter>is_error</parameter>&nbsp;:</term>
934
 
<listitem><simpara>if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> it is output as an error. If <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> it is output as a
 
889
<varlistentry><term><parameter>is_error</parameter>&#160;:</term>
 
890
<listitem><simpara>if <link linkend="TRUE--CAPS"><literal>TRUE</literal></link> it is output as an error. If <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> it is output as a
935
891
           warning.
936
 
 
937
 
 
938
892
</simpara></listitem></varlistentry>
939
893
</variablelist></refsect2>
940
 
<refsect2>
941
 
<title><anchor id="GScannerMsgFunc" role="function"/>GScannerMsgFunc ()</title>
942
 
<indexterm><primary>GScannerMsgFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*GScannerMsgFunc)                  (<link linkend="GScanner">GScanner</link> *scanner,
 
894
<refsect2 id="GScannerMsgFunc" role="function">
 
895
<title>GScannerMsgFunc ()</title>
 
896
<indexterm zone="GScannerMsgFunc"><primary sortas="GScannerMsgFunc">GScannerMsgFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*GScannerMsgFunc)                  (<link linkend="GScanner">GScanner</link> *scanner,
943
897
                                                         <link linkend="gchar">gchar</link> *message,
944
898
                                                         <link linkend="gboolean">gboolean</link> error);</programlisting>
945
899
<para>
946
900
Specifies the type of the message handler function.
947
901
</para><variablelist role="params">
948
 
<varlistentry><term><parameter>scanner</parameter>&nbsp;:</term>
 
902
<varlistentry><term><parameter>scanner</parameter>&#160;:</term>
949
903
<listitem><simpara>a <link linkend="GScanner"><type>GScanner</type></link>.
950
904
</simpara></listitem></varlistentry>
951
 
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
 
905
<varlistentry><term><parameter>message</parameter>&#160;:</term>
952
906
<listitem><simpara>the message.
953
907
</simpara></listitem></varlistentry>
954
 
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
955
 
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the message signals an error, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it 
 
908
<varlistentry><term><parameter>error</parameter>&#160;:</term>
 
909
<listitem><simpara>%TRUE if the message signals an error, <link linkend="FALSE--CAPS"><literal>FALSE</literal></link> if it 
956
910
  signals a warning.
957
 
 
958
 
 
959
911
</simpara></listitem></varlistentry>
960
912
</variablelist></refsect2>
961
 
<refsect2>
962
 
<title><anchor id="G-CSET-a-2-z" role="macro"/>G_CSET_a_2_z</title>
963
 
<indexterm><primary>G_CSET_a_2_z</primary></indexterm><programlisting>#define G_CSET_a_2_z      "abcdefghijklmnopqrstuvwxyz"
 
913
<refsect2 id="G-CSET-a-2-z" role="macro">
 
914
<title>G_CSET_a_2_z</title>
 
915
<indexterm zone="G-CSET-a-2-z"><primary sortas="G_CSET_a_2_z">G_CSET_a_2_z</primary></indexterm><programlisting>#define G_CSET_a_2_z    "abcdefghijklmnopqrstuvwxyz"
964
916
</programlisting>
965
917
<para>
966
918
The set of lowercase ASCII alphabet characters.
967
919
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
968
920
</para></refsect2>
969
 
<refsect2>
970
 
<title><anchor id="G-CSET-A-2-Z:CAPS" role="macro"/>G_CSET_A_2_Z</title>
971
 
<indexterm><primary>G_CSET_A_2_Z</primary></indexterm><programlisting>#define G_CSET_A_2_Z      "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 
921
<refsect2 id="G-CSET-A-2-Z--CAPS" role="macro">
 
922
<title>G_CSET_A_2_Z</title>
 
923
<indexterm zone="G-CSET-A-2-Z--CAPS"><primary sortas="G_CSET_A_2_Z">G_CSET_A_2_Z</primary></indexterm><programlisting>#define G_CSET_A_2_Z      "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
972
924
</programlisting>
973
925
<para>
974
926
The set of uppercase ASCII alphabet characters.
975
927
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
976
928
</para></refsect2>
977
 
<refsect2>
978
 
<title><anchor id="G-CSET-DIGITS:CAPS" role="macro"/>G_CSET_DIGITS</title>
979
 
<indexterm><primary>G_CSET_DIGITS</primary></indexterm><programlisting>#define G_CSET_DIGITS    "0123456789"
 
929
<refsect2 id="G-CSET-DIGITS--CAPS" role="macro">
 
930
<title>G_CSET_DIGITS</title>
 
931
<indexterm zone="G-CSET-DIGITS--CAPS"><primary sortas="G_CSET_DIGITS">G_CSET_DIGITS</primary></indexterm><programlisting>#define G_CSET_DIGITS  "0123456789"
980
932
</programlisting>
981
933
<para>
982
934
The set of digits.
983
935
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
984
936
</para></refsect2>
985
 
<refsect2>
986
 
<title><anchor id="G-CSET-LATINC:CAPS" role="macro"/>G_CSET_LATINC</title>
987
 
<indexterm><primary>G_CSET_LATINC</primary></indexterm><programlisting>#define             G_CSET_LATINC</programlisting>
988
 
<para>
989
 
The set of uppercase ISO 8859-1 alphabet characters which are 
990
 
not ASCII characters. 
991
 
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
992
 
</para></refsect2>
993
 
<refsect2>
994
 
<title><anchor id="G-CSET-LATINS:CAPS" role="macro"/>G_CSET_LATINS</title>
995
 
<indexterm><primary>G_CSET_LATINS</primary></indexterm><programlisting>#define             G_CSET_LATINS</programlisting>
996
 
<para>
997
 
The set of lowercase ISO 8859-1 alphabet characters which are 
998
 
not ASCII characters. 
999
 
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
1000
 
</para></refsect2>
1001
 
<refsect2>
1002
 
<title><anchor id="GTokenType" role="enum"/>enum GTokenType</title>
1003
 
<indexterm><primary>GTokenType</primary></indexterm><programlisting>typedef enum
 
937
<refsect2 id="G-CSET-LATINC--CAPS" role="macro">
 
938
<title>G_CSET_LATINC</title>
 
939
<indexterm zone="G-CSET-LATINC--CAPS"><primary sortas="G_CSET_LATINC">G_CSET_LATINC</primary></indexterm><programlisting>#define             G_CSET_LATINC</programlisting>
 
940
<para>
 
941
The set of uppercase ISO 8859-1 alphabet characters which are
 
942
not ASCII characters.
 
943
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
 
944
</para></refsect2>
 
945
<refsect2 id="G-CSET-LATINS--CAPS" role="macro">
 
946
<title>G_CSET_LATINS</title>
 
947
<indexterm zone="G-CSET-LATINS--CAPS"><primary sortas="G_CSET_LATINS">G_CSET_LATINS</primary></indexterm><programlisting>#define             G_CSET_LATINS</programlisting>
 
948
<para>
 
949
The set of lowercase ISO 8859-1 alphabet characters which are
 
950
not ASCII characters.
 
951
Used for specifying valid identifier characters in <link linkend="GScannerConfig"><type>GScannerConfig</type></link>.
 
952
</para></refsect2>
 
953
<refsect2 id="GTokenType" role="enum">
 
954
<title>enum GTokenType</title>
 
955
<indexterm zone="GTokenType"><primary sortas="GTokenType">GTokenType</primary></indexterm><programlisting>typedef enum
1004
956
{
1005
957
  G_TOKEN_EOF                   =   0,
1006
958
  
1037
989
<para>
1038
990
The possible types of token returned from each <link linkend="g-scanner-get-next-token"><function>g_scanner_get_next_token()</function></link> call.
1039
991
</para><variablelist role="enum">
1040
 
<varlistentry>
1041
 
<term><anchor id="G-TOKEN-EOF:CAPS" role="constant"/><literal>G_TOKEN_EOF</literal></term>
 
992
<varlistentry id="G-TOKEN-EOF--CAPS" role="constant">
 
993
<term><literal>G_TOKEN_EOF</literal></term>
1042
994
<listitem><simpara>the end of the file.
1043
995
</simpara></listitem>
1044
996
</varlistentry>
1045
 
<varlistentry>
1046
 
<term><anchor id="G-TOKEN-LEFT-PAREN:CAPS" role="constant"/><literal>G_TOKEN_LEFT_PAREN</literal></term>
 
997
<varlistentry id="G-TOKEN-LEFT-PAREN--CAPS" role="constant">
 
998
<term><literal>G_TOKEN_LEFT_PAREN</literal></term>
1047
999
<listitem><simpara>a '(' character.
1048
1000
</simpara></listitem>
1049
1001
</varlistentry>
1050
 
<varlistentry>
1051
 
<term><anchor id="G-TOKEN-LEFT-CURLY:CAPS" role="constant"/><literal>G_TOKEN_LEFT_CURLY</literal></term>
 
1002
<varlistentry id="G-TOKEN-LEFT-CURLY--CAPS" role="constant">
 
1003
<term><literal>G_TOKEN_LEFT_CURLY</literal></term>
1052
1004
<listitem><simpara>a '{' character.
1053
1005
</simpara></listitem>
1054
1006
</varlistentry>
1055
 
<varlistentry>
1056
 
<term><anchor id="G-TOKEN-RIGHT-CURLY:CAPS" role="constant"/><literal>G_TOKEN_RIGHT_CURLY</literal></term>
 
1007
<varlistentry id="G-TOKEN-RIGHT-CURLY--CAPS" role="constant">
 
1008
<term><literal>G_TOKEN_RIGHT_CURLY</literal></term>
1057
1009
<listitem><simpara>a '}' character.
1058
 
 
1059
1010
</simpara></listitem>
1060
1011
</varlistentry>
1061
1012
</variablelist></refsect2>
1062
 
<refsect2>
1063
 
<title><anchor id="GTokenValue" role="union"/>union GTokenValue</title>
1064
 
<indexterm><primary>GTokenValue</primary></indexterm><programlisting>union GTokenValue
 
1013
<refsect2 id="GTokenValue" role="union">
 
1014
<title>union GTokenValue</title>
 
1015
<indexterm zone="GTokenValue"><primary sortas="GTokenValue">GTokenValue</primary></indexterm><programlisting>union GTokenValue
1065
1016
{
1066
1017
  gpointer      v_symbol;
1067
1018
  gchar         *v_identifier;
1080
1031
<para>
1081
1032
A union holding the value of the token.
1082
1033
</para></refsect2>
1083
 
<refsect2>
1084
 
<title><anchor id="GErrorType" role="enum"/>enum GErrorType</title>
1085
 
<indexterm><primary>GErrorType</primary></indexterm><programlisting>typedef enum
 
1034
<refsect2 id="GErrorType" role="enum">
 
1035
<title>enum GErrorType</title>
 
1036
<indexterm zone="GErrorType"><primary sortas="GErrorType">GErrorType</primary></indexterm><programlisting>typedef enum
1086
1037
{
1087
1038
  G_ERR_UNKNOWN,
1088
1039
  G_ERR_UNEXP_EOF,
1096
1047
</programlisting>
1097
1048
<para>
1098
1049
The possible errors, used in the <structfield>v_error</structfield> field
1099
 
of <link linkend="GTokenValue"><type>GTokenValue</type></link>, when the token is a <link linkend="G-TOKEN-ERROR:CAPS"><type>G_TOKEN_ERROR</type></link>.
 
1050
of <link linkend="GTokenValue"><type>GTokenValue</type></link>, when the token is a <link linkend="G-TOKEN-ERROR--CAPS"><type>G_TOKEN_ERROR</type></link>.
1100
1051
</para><variablelist role="enum">
1101
 
<varlistentry>
1102
 
<term><anchor id="G-ERR-UNKNOWN:CAPS" role="constant"/><literal>G_ERR_UNKNOWN</literal></term>
 
1052
<varlistentry id="G-ERR-UNKNOWN--CAPS" role="constant">
 
1053
<term><literal>G_ERR_UNKNOWN</literal></term>
1103
1054
<listitem><simpara>unknown error.
1104
1055
</simpara></listitem>
1105
1056
</varlistentry>
1106
 
<varlistentry>
1107
 
<term><anchor id="G-ERR-UNEXP-EOF:CAPS" role="constant"/><literal>G_ERR_UNEXP_EOF</literal></term>
 
1057
<varlistentry id="G-ERR-UNEXP-EOF--CAPS" role="constant">
 
1058
<term><literal>G_ERR_UNEXP_EOF</literal></term>
1108
1059
<listitem><simpara>unexpected end of file.
1109
1060
</simpara></listitem>
1110
1061
</varlistentry>
1111
 
<varlistentry>
1112
 
<term><anchor id="G-ERR-UNEXP-EOF-IN-STRING:CAPS" role="constant"/><literal>G_ERR_UNEXP_EOF_IN_STRING</literal></term>
 
1062
<varlistentry id="G-ERR-UNEXP-EOF-IN-STRING--CAPS" role="constant">
 
1063
<term><literal>G_ERR_UNEXP_EOF_IN_STRING</literal></term>
1113
1064
<listitem><simpara>unterminated string constant.
1114
1065
</simpara></listitem>
1115
1066
</varlistentry>
1116
 
<varlistentry>
1117
 
<term><anchor id="G-ERR-UNEXP-EOF-IN-COMMENT:CAPS" role="constant"/><literal>G_ERR_UNEXP_EOF_IN_COMMENT</literal></term>
 
1067
<varlistentry id="G-ERR-UNEXP-EOF-IN-COMMENT--CAPS" role="constant">
 
1068
<term><literal>G_ERR_UNEXP_EOF_IN_COMMENT</literal></term>
1118
1069
<listitem><simpara>unterminated comment.
1119
1070
</simpara></listitem>
1120
1071
</varlistentry>
1121
 
<varlistentry>
1122
 
<term><anchor id="G-ERR-NON-DIGIT-IN-CONST:CAPS" role="constant"/><literal>G_ERR_NON_DIGIT_IN_CONST</literal></term>
 
1072
<varlistentry id="G-ERR-NON-DIGIT-IN-CONST--CAPS" role="constant">
 
1073
<term><literal>G_ERR_NON_DIGIT_IN_CONST</literal></term>
1123
1074
<listitem><simpara>non-digit character in a number.
1124
1075
</simpara></listitem>
1125
1076
</varlistentry>
1126
 
<varlistentry>
1127
 
<term><anchor id="G-ERR-DIGIT-RADIX:CAPS" role="constant"/><literal>G_ERR_DIGIT_RADIX</literal></term>
 
1077
<varlistentry id="G-ERR-DIGIT-RADIX--CAPS" role="constant">
 
1078
<term><literal>G_ERR_DIGIT_RADIX</literal></term>
1128
1079
<listitem><simpara>digit beyond radix in a number.
1129
1080
</simpara></listitem>
1130
1081
</varlistentry>
1131
 
<varlistentry>
1132
 
<term><anchor id="G-ERR-FLOAT-RADIX:CAPS" role="constant"/><literal>G_ERR_FLOAT_RADIX</literal></term>
 
1082
<varlistentry id="G-ERR-FLOAT-RADIX--CAPS" role="constant">
 
1083
<term><literal>G_ERR_FLOAT_RADIX</literal></term>
1133
1084
<listitem><simpara>non-decimal floating point number.
1134
1085
</simpara></listitem>
1135
1086
</varlistentry>
1136
 
<varlistentry>
1137
 
<term><anchor id="G-ERR-FLOAT-MALFORMED:CAPS" role="constant"/><literal>G_ERR_FLOAT_MALFORMED</literal></term>
 
1087
<varlistentry id="G-ERR-FLOAT-MALFORMED--CAPS" role="constant">
 
1088
<term><literal>G_ERR_FLOAT_MALFORMED</literal></term>
1138
1089
<listitem><simpara>malformed floating point number.
1139
 
 
1140
1090
</simpara></listitem>
1141
1091
</varlistentry>
1142
1092
</variablelist></refsect2>
1146
1096
 
1147
1097
 
1148
1098
 
1149
 
 
1150
 
<refsect1><refsect2 /><refsect2 /></refsect1>
1151
1099
</refentry>