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 #include <glib/gdataset.h>
31 #include <glib/ghash.h>
35 typedef struct _GScanner GScanner
;
36 typedef struct _GScannerConfig GScannerConfig
;
37 typedef union _GTokenValue GTokenValue
;
39 typedef void (*GScannerMsgFunc
) (GScanner
*scanner
,
43 /* GScanner: Flexible lexical scanner for general purpose.
47 #define G_CSET_A_2_Z "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
48 #define G_CSET_a_2_z "abcdefghijklmnopqrstuvwxyz"
49 #define G_CSET_DIGITS "0123456789"
50 #define G_CSET_LATINC "\300\301\302\303\304\305\306"\
51 "\307\310\311\312\313\314\315\316\317\320"\
52 "\321\322\323\324\325\326"\
53 "\330\331\332\333\334\335\336"
54 #define G_CSET_LATINS "\337\340\341\342\343\344\345\346"\
55 "\347\350\351\352\353\354\355\356\357\360"\
56 "\361\362\363\364\365\366"\
57 "\370\371\372\373\374\375\376\377"
64 G_ERR_UNEXP_EOF_IN_STRING
,
65 G_ERR_UNEXP_EOF_IN_COMMENT
,
66 G_ERR_NON_DIGIT_IN_CONST
,
77 G_TOKEN_LEFT_PAREN
= '(',
78 G_TOKEN_RIGHT_PAREN
= ')',
79 G_TOKEN_LEFT_CURLY
= '{',
80 G_TOKEN_RIGHT_CURLY
= '}',
81 G_TOKEN_LEFT_BRACE
= '[',
82 G_TOKEN_RIGHT_BRACE
= ']',
83 G_TOKEN_EQUAL_SIGN
= '=',
100 G_TOKEN_IDENTIFIER_NULL
,
102 G_TOKEN_COMMENT_SINGLE
,
103 G_TOKEN_COMMENT_MULTI
,
123 struct _GScannerConfig
127 gchar
*cset_skip_characters
; /* default: " \t\n" */
128 gchar
*cset_identifier_first
;
129 gchar
*cset_identifier_nth
;
130 gchar
*cpair_comment_single
; /* default: "#\n" */
132 /* Should symbol lookup work case sensitive?
134 guint case_sensitive
: 1;
136 /* Boolean values to be adjusted "on the fly"
137 * to configure scanning behaviour.
139 guint skip_comment_multi
: 1; /* C like comment */
140 guint skip_comment_single
: 1; /* single line comment */
141 guint scan_comment_multi
: 1; /* scan multi line comments? */
142 guint scan_identifier
: 1;
143 guint scan_identifier_1char
: 1;
144 guint scan_identifier_NULL
: 1;
145 guint scan_symbols
: 1;
146 guint scan_binary
: 1;
147 guint scan_octal
: 1;
148 guint scan_float
: 1;
149 guint scan_hex
: 1; /* `0x0ff0' */
150 guint scan_hex_dollar
: 1; /* `$0ff0' */
151 guint scan_string_sq
: 1; /* string: 'anything' */
152 guint scan_string_dq
: 1; /* string: "\\-escapes!\n" */
153 guint numbers_2_int
: 1; /* bin, octal, hex => int */
154 guint int_2_float
: 1; /* int => G_TOKEN_FLOAT? */
155 guint identifier_2_string
: 1;
156 guint char_2_token
: 1; /* return G_TOKEN_CHAR? */
157 guint symbol_2_token
: 1;
158 guint scope_0_fallback
: 1; /* try scope 0 on lookups? */
159 guint store_int64
: 1; /* use value.v_int64 rather than v_int */
167 guint max_parse_errors
;
169 /* g_scanner_error() increments this field */
172 /* name of input stream, featured by the default message handler */
173 const gchar
*input_name
;
178 /* link into the scanner configuration */
179 GScannerConfig
*config
;
181 /* fields filled in after g_scanner_get_next_token() */
187 /* fields filled in after g_scanner_peek_next_token() */
188 GTokenType next_token
;
189 GTokenValue next_value
;
193 /* to be considered private */
194 GHashTable
*symbol_table
;
197 const gchar
*text_end
;
201 /* handler function for _warn and _error */
202 GScannerMsgFunc msg_handler
;
205 GScanner
* g_scanner_new (const GScannerConfig
*config_templ
);
206 void g_scanner_destroy (GScanner
*scanner
);
207 void g_scanner_input_file (GScanner
*scanner
,
209 void g_scanner_sync_file_offset (GScanner
*scanner
);
210 void g_scanner_input_text (GScanner
*scanner
,
213 GTokenType
g_scanner_get_next_token (GScanner
*scanner
);
214 GTokenType
g_scanner_peek_next_token (GScanner
*scanner
);
215 GTokenType
g_scanner_cur_token (GScanner
*scanner
);
216 GTokenValue
g_scanner_cur_value (GScanner
*scanner
);
217 guint
g_scanner_cur_line (GScanner
*scanner
);
218 guint
g_scanner_cur_position (GScanner
*scanner
);
219 gboolean
g_scanner_eof (GScanner
*scanner
);
220 guint
g_scanner_set_scope (GScanner
*scanner
,
222 void g_scanner_scope_add_symbol (GScanner
*scanner
,
226 void g_scanner_scope_remove_symbol (GScanner
*scanner
,
228 const gchar
*symbol
);
229 gpointer
g_scanner_scope_lookup_symbol (GScanner
*scanner
,
231 const gchar
*symbol
);
232 void g_scanner_scope_foreach_symbol (GScanner
*scanner
,
236 gpointer
g_scanner_lookup_symbol (GScanner
*scanner
,
237 const gchar
*symbol
);
238 void g_scanner_unexp_token (GScanner
*scanner
,
239 GTokenType expected_token
,
240 const gchar
*identifier_spec
,
241 const gchar
*symbol_spec
,
242 const gchar
*symbol_name
,
243 const gchar
*message
,
245 void g_scanner_error (GScanner
*scanner
,
247 ...) G_GNUC_PRINTF (2,3);
248 void g_scanner_warn (GScanner
*scanner
,
250 ...) G_GNUC_PRINTF (2,3);
252 #ifndef G_DISABLE_DEPRECATED
254 /* keep downward source compatibility */
255 #define g_scanner_add_symbol( scanner, symbol, value ) G_STMT_START { \
256 g_scanner_scope_add_symbol ((scanner), 0, (symbol), (value)); \
258 #define g_scanner_remove_symbol( scanner, symbol ) G_STMT_START { \
259 g_scanner_scope_remove_symbol ((scanner), 0, (symbol)); \
261 #define g_scanner_foreach_symbol( scanner, func, data ) G_STMT_START { \
262 g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
265 /* The following two functions are deprecated and will be removed in
266 * the next major release. They do no good. */
267 #define g_scanner_freeze_symbol_table(scanner) ((void)0)
268 #define g_scanner_thaw_symbol_table(scanner) ((void)0)
270 #endif /* G_DISABLE_DEPRECATED */
274 #endif /* __G_SCANNER_H__ */