extcap_parser.h

   1 /* extcap_parser.h
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 #ifndef __EXTCAP_PARSER_H__
  23 #define __EXTCAP_PARSER_H__
  24
  25 #include <stdio.h>
  26 #include <glib.h>
  27 #include <string.h>
  28
  29 typedef enum {
  30     EXTCAP_SENTENCE_UNKNOWN,
  31     EXTCAP_SENTENCE_ARG,
  32     EXTCAP_SENTENCE_VALUE,
  33     EXTCAP_SENTENCE_FLAG,
  34     EXTCAP_SENTENCE_INTERFACE,
  35     EXTCAP_SENTENCE_DLT
  36 } extcap_sentence_type;
  37
  38 typedef enum {
  39     /* Simple types */
  40     EXTCAP_ARG_UNKNOWN,
  41     EXTCAP_ARG_INTEGER,
  42     EXTCAP_ARG_UNSIGNED,
  43     EXTCAP_ARG_LONG,
  44     EXTCAP_ARG_DOUBLE,
  45     EXTCAP_ARG_BOOLEAN,
  46     EXTCAP_ARG_BOOLFLAG,
  47     EXTCAP_ARG_STRING,
  48     /* Complex GUI types which are populated with value sentences */
  49     EXTCAP_ARG_SELECTOR,
  50     EXTCAP_ARG_RADIO,
  51     EXTCAP_ARG_MULTICHECK,
  52     EXTCAP_ARG_FILESELECT
  53 } extcap_arg_type;
  54
  55 typedef enum {
  56     /* value types */
  57     EXTCAP_PARAM_UNKNOWN,
  58     EXTCAP_PARAM_ARGNUM,
  59     EXTCAP_PARAM_CALL,
  60     EXTCAP_PARAM_DISPLAY,
  61     EXTCAP_PARAM_TYPE,
  62     EXTCAP_PARAM_ARG,
  63     EXTCAP_PARAM_DEFAULT,
  64     EXTCAP_PARAM_VALUE,
  65     EXTCAP_PARAM_RANGE,
  66     EXTCAP_PARAM_TOOLTIP,
  67     EXTCAP_PARAM_NAME,
  68     EXTCAP_PARAM_ENABLED,
  69     EXTCAP_PARAM_FILE_MUSTEXIST,
  70     EXTCAP_PARAM_PARENT
  71 } extcap_param_type;
  72
  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 {
  77     int arg_num;
  78
  79     gchar *call;
  80     gchar *display;
  81     gboolean enabled;
  82     gboolean is_default;
  83     gchar *parent;
  84 } extcap_value;
  85
  86 /* Complex-ish struct for storing complex values */
  87 typedef struct _extcap_complex {
  88     extcap_arg_type complex_type;
  89     union {
  90         int int_value;
  91         unsigned int uint_value;
  92         long long_value;
  93         double double_value;
  94         gboolean bool_value;
  95         gchar *string_value;
  96     } complex_value;
  97     gboolean value_filled;
  98 } extcap_complex;
  99
 100 /* An argument sentence and accompanying options */
 101 typedef struct _extcap_arg {
 102     int arg_num;
 103
 104     gchar *call;
 105     gchar *display;
 106     gchar *tooltip;
 107     gboolean fileexists;
 108
 109     extcap_arg_type arg_type;
 110
 111     extcap_complex *range_start;
 112     extcap_complex *range_end;
 113     extcap_complex *default_complex;
 114
 115     GList * values;
 116 } extcap_arg;
 117
 118 typedef struct _extcap_if {
 119     gchar * extcap_path;
 120     GList * interfaces;
 121 } extcap_if;
 122
 123 typedef struct _extcap_interface {
 124     gchar *call;
 125     gchar *display;
 126
 127     struct _extcap_interface *next_interface;
 128 } extcap_interface;
 129
 130 typedef struct _extcap_dlt {
 131     gint number;
 132     gchar *name;
 133     gchar *display;
 134
 135     struct _extcap_dlt *next_dlt;
 136 } extcap_dlt;
 137
 138 /* Parser internals */
 139 typedef struct _extcap_token_param {
 140     gchar *arg;
 141     gchar *value;
 142
 143     extcap_param_type param_type;
 144
 145     struct _extcap_token_param *next_token;
 146 } extcap_token_param;
 147
 148 typedef struct _extcap_token_sentence {
 149     gchar *sentence;
 150
 151     extcap_token_param *param_list;
 152
 153     struct _extcap_token_sentence *next_sentence;
 154 } extcap_token_sentence;
 155
 156 #ifdef __cplusplus
 157 extern "C" {
 158 #endif
 159
 160 extcap_interface *extcap_new_interface(void);
 161 void extcap_free_interface(extcap_interface *interface);
 162
 163 extcap_dlt *extcap_new_dlt(void);
 164 void extcap_free_dlt(extcap_dlt *dlt);
 165
 166 /* Parse a string into a complex type */
 167 extcap_complex *extcap_parse_complex(extcap_arg_type complex_type,
 168         const gchar *data);
 169
 170 /* Free a complex */
 171 void extcap_free_complex(extcap_complex *comp);
 172
 173 /* Print a complex value out for debug */
 174 void extcap_printf_complex(extcap_complex *comp);
 175
 176 /*
 177  * Return a string representation of a complex type
 178  * Caller is responsible for calling g_free on the returned string
 179  */
 180 gchar *extcap_get_complex_as_string(extcap_complex *comp);
 181
 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);
 188
 189 /* compares the default value of an element with a given parameter */
 190 gboolean extcap_compare_is_default(extcap_arg *element, extcap_complex *test);
 191
 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);
 195
 196 /* Turn a sentence into logical tokens, don't validate beyond basic syntax */
 197 extcap_token_sentence *extcap_tokenize_sentence(const gchar *s);
 198
 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);
 201
 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);
 204
 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);
 208
 209 void extcap_free_value(extcap_value *v);
 210
 211 extcap_arg *extcap_new_arg(void);
 212
 213 /* Free a single argument */
 214 void extcap_free_arg(extcap_arg *a);
 215
 216 /* Free an entire arg list */
 217 void extcap_free_arg_list(GList *a);
 218
 219 /*
 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)
 223  */
 224 extcap_arg * extcap_parse_arg_sentence(GList * args, extcap_token_sentence *s);
 225
 226 /* Parse all sentences for args and values */
 227 GList * extcap_parse_args(extcap_token_sentence *first_s);
 228
 229 /*
 230  * Parse a tokenized set of sentences and validate, looking for interface definitions.
 231  */
 232 int extcap_parse_interface_sentence(extcap_token_sentence *s,
 233         extcap_interface **ri);
 234
 235 /* Parse all sentences for interfaces */
 236 int extcap_parse_interfaces(extcap_token_sentence *first_s,
 237         extcap_interface **first_int);
 238
 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);
 241
 242 /* Parse all sentences for DLTs */
 243 int extcap_parse_dlts(extcap_token_sentence *first_s, extcap_dlt **first_dlt);
 244
 245 #ifdef __cplusplus
 246 }
 247 #endif
 248
 249 #endif
 250
 251 /*
 252  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
 253  *
 254  * Local variables:
 255  * c-basic-offset: 4
 256  * tab-width: 8
 257  * indent-tabs-mode: nil
 258  * End:
 259  *
 260  * vi: set shiftwidth=4 tabstop=8 expandtab:
 261  * :indentSize=4:tabSize=8:noTabs=true:
 262  */