1 /* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GLib Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GLib at ftp://ftp.gtk.org/pub/gtk/.
27 #ifndef __G_SCANNER_H__
28 #define __G_SCANNER_H__
30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
31 #error "Only <glib.h> can be included directly."
34 #include <glib/gdataset.h>
35 #include <glib/ghash.h>
39 typedef struct _GScanner GScanner
;
40 typedef struct _GScannerConfig GScannerConfig
;
41 typedef union _GTokenValue GTokenValue
;
43 typedef void (*GScannerMsgFunc
) (GScanner
*scanner
,
47 /* GScanner: Flexible lexical scanner for general purpose.
51 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
52 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
53 #define G_CSET_DIGITS "0123456789"
54 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
55 "\307\310\311\312\313\314\315\316\317\320"\
56 "\321\322\323\324\325\326"\
57 "\330\331\332\333\334\335\336"
58 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
59 "\347\350\351\352\353\354\355\356\357\360"\
60 "\361\362\363\364\365\366"\
61 "\370\371\372\373\374\375\376\377"
68 G_ERR_UNEXP_EOF_IN_STRING
,
69 G_ERR_UNEXP_EOF_IN_COMMENT
,
70 G_ERR_NON_DIGIT_IN_CONST
,
81 G_TOKEN_LEFT_PAREN
= '(',
82 G_TOKEN_RIGHT_PAREN
= ')',
83 G_TOKEN_LEFT_CURLY
= '{',
84 G_TOKEN_RIGHT_CURLY
= '}',
85 G_TOKEN_LEFT_BRACE
= '[',
86 G_TOKEN_RIGHT_BRACE
= ']',
87 G_TOKEN_EQUAL_SIGN
= '=',
104 G_TOKEN_IDENTIFIER_NULL
,
106 G_TOKEN_COMMENT_SINGLE
,
107 G_TOKEN_COMMENT_MULTI
,
129 struct _GScannerConfig
133 gchar
*cset_skip_characters
; /* default: " \t\n" */
134 gchar
*cset_identifier_first
;
135 gchar
*cset_identifier_nth
;
136 gchar
*cpair_comment_single
; /* default: "#\n" */
138 /* Should symbol lookup work case sensitive?
140 guint case_sensitive
: 1;
142 /* Boolean values to be adjusted "on the fly"
143 * to configure scanning behaviour.
145 guint skip_comment_multi
: 1; /* C like comment */
146 guint skip_comment_single
: 1; /* single line comment */
147 guint scan_comment_multi
: 1; /* scan multi line comments? */
148 guint scan_identifier
: 1;
149 guint scan_identifier_1char
: 1;
150 guint scan_identifier_NULL
: 1;
151 guint scan_symbols
: 1;
152 guint scan_binary
: 1;
153 guint scan_octal
: 1;
154 guint scan_float
: 1;
155 guint scan_hex
: 1; /* '0x0ff0' */
156 guint scan_hex_dollar
: 1; /* '$0ff0' */
157 guint scan_string_sq
: 1; /* string: 'anything' */
158 guint scan_string_dq
: 1; /* string: "\\-escapes!\n" */
159 guint numbers_2_int
: 1; /* bin, octal, hex => int */
160 guint int_2_float
: 1; /* int => G_TOKEN_FLOAT? */
161 guint identifier_2_string
: 1;
162 guint char_2_token
: 1; /* return G_TOKEN_CHAR? */
163 guint symbol_2_token
: 1;
164 guint scope_0_fallback
: 1; /* try scope 0 on lookups? */
165 guint store_int64
: 1; /* use value.v_int64 rather than v_int */
175 guint max_parse_errors
;
177 /* g_scanner_error() increments this field */
180 /* name of input stream, featured by the default message handler */
181 const gchar
*input_name
;
186 /* link into the scanner configuration */
187 GScannerConfig
*config
;
189 /* fields filled in after g_scanner_get_next_token() */
195 /* fields filled in after g_scanner_peek_next_token() */
196 GTokenType next_token
;
197 GTokenValue next_value
;
202 /* to be considered private */
203 GHashTable
*symbol_table
;
206 const gchar
*text_end
;
211 /* handler function for _warn and _error */
212 GScannerMsgFunc msg_handler
;
215 GLIB_AVAILABLE_IN_ALL
216 GScanner
* g_scanner_new (const GScannerConfig
*config_templ
);
217 GLIB_AVAILABLE_IN_ALL
218 void g_scanner_destroy (GScanner
*scanner
);
219 GLIB_AVAILABLE_IN_ALL
220 void g_scanner_input_file (GScanner
*scanner
,
222 GLIB_AVAILABLE_IN_ALL
223 void g_scanner_sync_file_offset (GScanner
*scanner
);
224 GLIB_AVAILABLE_IN_ALL
225 void g_scanner_input_text (GScanner
*scanner
,
228 GLIB_AVAILABLE_IN_ALL
229 GTokenType
g_scanner_get_next_token (GScanner
*scanner
);
230 GLIB_AVAILABLE_IN_ALL
231 GTokenType
g_scanner_peek_next_token (GScanner
*scanner
);
232 GLIB_AVAILABLE_IN_ALL
233 GTokenType
g_scanner_cur_token (GScanner
*scanner
);
234 GLIB_AVAILABLE_IN_ALL
235 GTokenValue
g_scanner_cur_value (GScanner
*scanner
);
236 GLIB_AVAILABLE_IN_ALL
237 guint
g_scanner_cur_line (GScanner
*scanner
);
238 GLIB_AVAILABLE_IN_ALL
239 guint
g_scanner_cur_position (GScanner
*scanner
);
240 GLIB_AVAILABLE_IN_ALL
241 gboolean
g_scanner_eof (GScanner
*scanner
);
242 GLIB_AVAILABLE_IN_ALL
243 guint
g_scanner_set_scope (GScanner
*scanner
,
245 GLIB_AVAILABLE_IN_ALL
246 void g_scanner_scope_add_symbol (GScanner
*scanner
,
250 GLIB_AVAILABLE_IN_ALL
251 void g_scanner_scope_remove_symbol (GScanner
*scanner
,
253 const gchar
*symbol
);
254 GLIB_AVAILABLE_IN_ALL
255 gpointer
g_scanner_scope_lookup_symbol (GScanner
*scanner
,
257 const gchar
*symbol
);
258 GLIB_AVAILABLE_IN_ALL
259 void g_scanner_scope_foreach_symbol (GScanner
*scanner
,
263 GLIB_AVAILABLE_IN_ALL
264 gpointer
g_scanner_lookup_symbol (GScanner
*scanner
,
265 const gchar
*symbol
);
266 GLIB_AVAILABLE_IN_ALL
267 void g_scanner_unexp_token (GScanner
*scanner
,
268 GTokenType expected_token
,
269 const gchar
*identifier_spec
,
270 const gchar
*symbol_spec
,
271 const gchar
*symbol_name
,
272 const gchar
*message
,
274 GLIB_AVAILABLE_IN_ALL
275 void g_scanner_error (GScanner
*scanner
,
277 ...) G_GNUC_PRINTF (2,3);
278 GLIB_AVAILABLE_IN_ALL
279 void g_scanner_warn (GScanner
*scanner
,
281 ...) G_GNUC_PRINTF (2,3);
283 #ifndef G_DISABLE_DEPRECATED
285 /* keep downward source compatibility */
286 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
287 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
289 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
290 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
292 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
293 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
296 /* The following two functions are deprecated and will be removed in
297 * the next major release. They do no good. */
298 #define g_scanner_freeze_symbol_table(scanner) ((void)0)
299 #define g_scanner_thaw_symbol_table(scanner) ((void)0)
301 #endif /* G_DISABLE_DEPRECATED */
305 #endif /* __G_SCANNER_H__ */