3 * Wireshark - Network traffic analyzer
4 * By Gerald Combs <gerald@wireshark.org>
5 * Copyright 1998 Gerald Combs
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #ifndef __EXTCAP_PARSER_H__
23 #define __EXTCAP_PARSER_H__
30 EXTCAP_SENTENCE_UNKNOWN,
32 EXTCAP_SENTENCE_VALUE,
34 EXTCAP_SENTENCE_INTERFACE,
36 } extcap_sentence_type;
48 /* Complex GUI types which are populated with value sentences */
51 EXTCAP_ARG_MULTICHECK,
69 EXTCAP_PARAM_FILE_MUSTEXIST,
73 /* Values for a given sentence; values are all stored as a call
74 * and a value string, or a valid range, so we only need to store
75 * those and repeat them */
76 typedef struct _extcap_value {
86 /* Complex-ish struct for storing complex values */
87 typedef struct _extcap_complex {
88 extcap_arg_type complex_type;
91 unsigned int uint_value;
97 gboolean value_filled;
100 /* An argument sentence and accompanying options */
101 typedef struct _extcap_arg {
109 extcap_arg_type arg_type;
111 extcap_complex *range_start;
112 extcap_complex *range_end;
113 extcap_complex *default_complex;
118 typedef struct _extcap_if {
123 typedef struct _extcap_interface {
127 struct _extcap_interface *next_interface;
130 typedef struct _extcap_dlt {
135 struct _extcap_dlt *next_dlt;
138 /* Parser internals */
139 typedef struct _extcap_token_param {
143 extcap_param_type param_type;
145 struct _extcap_token_param *next_token;
146 } extcap_token_param;
148 typedef struct _extcap_token_sentence {
151 extcap_token_param *param_list;
153 struct _extcap_token_sentence *next_sentence;
154 } extcap_token_sentence;
160 extcap_interface *extcap_new_interface(void);
161 void extcap_free_interface(extcap_interface *interface);
163 extcap_dlt *extcap_new_dlt(void);
164 void extcap_free_dlt(extcap_dlt *dlt);
166 /* Parse a string into a complex type */
167 extcap_complex *extcap_parse_complex(extcap_arg_type complex_type,
171 void extcap_free_complex(extcap_complex *comp);
173 /* Print a complex value out for debug */
174 void extcap_printf_complex(extcap_complex *comp);
177 * Return a string representation of a complex type
178 * Caller is responsible for calling g_free on the returned string
180 gchar *extcap_get_complex_as_string(extcap_complex *comp);
182 int extcap_complex_get_int(extcap_complex *comp);
183 unsigned int extcap_complex_get_uint(extcap_complex *comp);
184 long extcap_complex_get_long(extcap_complex *comp);
185 double extcap_complex_get_double(extcap_complex *comp);
186 gboolean extcap_complex_get_bool(extcap_complex *comp);
187 gchar *extcap_complex_get_string(extcap_complex *comp);
189 /* compares the default value of an element with a given parameter */
190 gboolean extcap_compare_is_default(extcap_arg *element, extcap_complex *test);
192 void extcap_free_tokenized_param(extcap_token_param *v);
193 void extcap_free_tokenized_sentence(extcap_token_sentence *s);
194 void extcap_free_tokenized_sentence_list(extcap_token_sentence *f);
196 /* Turn a sentence into logical tokens, don't validate beyond basic syntax */
197 extcap_token_sentence *extcap_tokenize_sentence(const gchar *s);
199 /* Tokenize a set of sentences (such as the output of a g_spawn_sync) */
200 extcap_token_sentence *extcap_tokenize_sentences(const gchar *s);
202 /* Find an argument in the extcap_arg list which matches the given arg=X number */
203 extcap_arg *extcap_find_numbered_arg(extcap_arg *first, int number);
205 /* Find the first occurrence in a parameter list of a parameter of the given type */
206 extcap_token_param *extcap_find_param_by_type(extcap_token_param *first,
207 extcap_param_type t);
209 void extcap_free_value(extcap_value *v);
211 extcap_arg *extcap_new_arg(void);
213 /* Free a single argument */
214 void extcap_free_arg(extcap_arg *a);
216 /* Free an entire arg list */
217 void extcap_free_arg_list(GList *a);
220 * Parse a tokenized sentence and validate. If a new sentence is created, the result
221 * is returned in 'ra'. On error, < 0 is returned. Not all sentences will create a
222 * new returned sentence (VALUE sentences, for example)
224 extcap_arg * extcap_parse_arg_sentence(GList * args, extcap_token_sentence *s);
226 /* Parse all sentences for args and values */
227 GList * extcap_parse_args(extcap_token_sentence *first_s);
230 * Parse a tokenized set of sentences and validate, looking for interface definitions.
232 int extcap_parse_interface_sentence(extcap_token_sentence *s,
233 extcap_interface **ri);
235 /* Parse all sentences for interfaces */
236 int extcap_parse_interfaces(extcap_token_sentence *first_s,
237 extcap_interface **first_int);
239 /* Parse a tokenized set of sentences and validate, looking for DLT definitions */
240 int extcap_parse_dlt_sentence(extcap_token_sentence *s, extcap_dlt **ri);
242 /* Parse all sentences for DLTs */
243 int extcap_parse_dlts(extcap_token_sentence *first_s, extcap_dlt **first_dlt);
252 * Editor modelines - http://www.wireshark.org/tools/modelines.html
257 * indent-tabs-mode: nil
260 * vi: set shiftwidth=4 tabstop=8 expandtab:
261 * :indentSize=4:tabSize=8:noTabs=true: