/builds/wireshark/wireshark/extcap_parser.h

Go to the documentation of this file.

 
#ifndef __EXTCAP_PARSER_H__
#define __EXTCAP_PARSER_H__
 
#include <stdio.h>
#include <glib.h>
#include <string.h>
 
#include "ui/iface_toolbar.h"

typedef enum {
    EXTCAP_SENTENCE_UNKNOWN,   
    EXTCAP_SENTENCE_ARG,       
    EXTCAP_SENTENCE_VALUE,     
    EXTCAP_SENTENCE_EXTCAP,    
    EXTCAP_SENTENCE_INTERFACE, 
    EXTCAP_SENTENCE_DLT,       
    EXTCAP_SENTENCE_CONTROL    
} extcap_sentence_type;

typedef enum {
    /* Simple types */
    EXTCAP_ARG_UNKNOWN,       
    EXTCAP_ARG_INTEGER,       
    EXTCAP_ARG_UNSIGNED,      
    EXTCAP_ARG_LONG,          
    EXTCAP_ARG_DOUBLE,        
    EXTCAP_ARG_BOOLEAN,       
    EXTCAP_ARG_BOOLFLAG,      
    EXTCAP_ARG_STRING,        
    EXTCAP_ARG_PASSWORD,      
    /* Complex GUI types which are populated with value sentences */
    EXTCAP_ARG_SELECTOR,      
    EXTCAP_ARG_EDIT_SELECTOR, 
    EXTCAP_ARG_RADIO,         
    EXTCAP_ARG_MULTICHECK,    
    EXTCAP_ARG_TABLE,         
    EXTCAP_ARG_FILESELECT,    
    EXTCAP_ARG_FOLDERSELECT,  
    EXTCAP_ARG_TIMESTAMP      
} extcap_arg_type;

typedef enum {
    EXTCAP_PARAM_UNKNOWN,         
    EXTCAP_PARAM_ARGNUM,          
    EXTCAP_PARAM_CALL,            
    EXTCAP_PARAM_DISPLAY,         
    EXTCAP_PARAM_TYPE,            
    EXTCAP_PARAM_ARG,             
    EXTCAP_PARAM_DEFAULT,         
    EXTCAP_PARAM_VALUE,           
    EXTCAP_PARAM_RANGE,           
    EXTCAP_PARAM_TOOLTIP,         
    EXTCAP_PARAM_PLACEHOLDER,     
    EXTCAP_PARAM_NAME,            
    EXTCAP_PARAM_ENABLED,         
    EXTCAP_PARAM_FILE_MUSTEXIST,  
    EXTCAP_PARAM_FILE_EXTENSION,  
    EXTCAP_PARAM_GROUP,           
    EXTCAP_PARAM_PARENT,          
    EXTCAP_PARAM_REQUIRED,        
    EXTCAP_PARAM_RELOAD,          
    EXTCAP_PARAM_CONFIGURABLE,    
    EXTCAP_PARAM_PREFIX,          
    EXTCAP_PARAM_SAVE,            
    EXTCAP_PARAM_VALIDATION,      
    EXTCAP_PARAM_VERSION,         
    EXTCAP_PARAM_HELP,            
    EXTCAP_PARAM_CONTROL,         
    EXTCAP_PARAM_ROLE             
} extcap_param_type;

#define ENUM_KEY(s) GUINT_TO_POINTER((unsigned)s)

typedef struct _extcap_value {
    int   arg_num;    
    char *call;       
    char *display;    
    bool  enabled;    
    bool  is_default; 
    char *parent;     
} extcap_value;

typedef struct _extcap_complex {
    extcap_arg_type  complex_type; 
    char            *_val;         
} extcap_complex;

#define EXTCAP_PARAM_REQUIRED_SUFFICIENT "sufficient"

typedef struct _extcap_arg {
    int   arg_num;      
    char *call;         
    char *display;      
    char *tooltip;      
    char *placeholder;  
 
    char *fileextension; 
    bool  fileexists;    
 
    bool  is_required;  
    bool  is_sufficient; 
    bool  save;         
    bool  reload;       
    bool  configurable; 
    char *prefix;       
    char *regexp;       
    char *group;        
 
    extcap_arg_type  arg_type;        
    extcap_complex  *range_start;     
    extcap_complex  *range_end;       
    extcap_complex  *default_complex; 
 
    char **pref_valptr;  
    char  *device_name;  
    /* XXX - device_name is not parsed or added by this file, but by the pref
     * callback in extcap.c, and is simply the same ifname that is given by
     * callers to extcap_get_if_configuration, the same for each extcap_arg
     * in a list of extcap_args. It should probably be removed from here. */
    GList *values;       
} extcap_arg;
 
#define EXTCAP_CONTROL_NONE 0
#define EXTCAP_CONTROL_TOOLBAR 1
#define EXTCAP_CONTROL_QUIT 2

typedef struct _extcap_interface {
    char *call;        
    char *display;     
    char *version;     
    char *help;        
    char *extcap_path; 
    unsigned control;  
    char *bookmark_name; 
    char *parent_call; 
 
    extcap_sentence_type if_type; 
} extcap_interface;

typedef struct _extcap_dlt {
    int   number;  
    char *name;    
    char *display; 
} extcap_dlt;

typedef struct _extcap_token_sentence {
    char       *sentence;    
    GHashTable *param_list;  
} extcap_token_sentence;
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Parse a string into a complex type */

extcap_complex *extcap_parse_complex(extcap_arg_type complex_type,
        const char *data);

/* Free a complex */
void extcap_free_complex(extcap_complex *comp);
 
/* Copy a complex */
extcap_complex *
extcap_copy_complex(const extcap_complex *comp);
 
/* Print a complex value out for debug */

char *extcap_get_complex_as_string(extcap_complex *comp);

int extcap_complex_get_int(extcap_complex *comp);

unsigned extcap_complex_get_uint(extcap_complex *comp);

int64_t extcap_complex_get_long(extcap_complex *comp);

double extcap_complex_get_double(extcap_complex *comp);

bool extcap_complex_get_bool(extcap_complex *comp);

char *extcap_complex_get_string(extcap_complex *comp);
 
/* compares the default value of an element with a given parameter */

bool extcap_compare_is_default(extcap_arg *element, extcap_complex *test);

void extcap_free_arg(extcap_arg *a);
 
extcap_arg*
extcap_copy_arg(const extcap_arg *a);

void extcap_free_toolbar_control(iface_toolbar_control *control);

void extcap_free_arg_list(GList *a);
 

 
/* Parse all sentences for args and values */

GList * extcap_parse_args(char *output);

GList * extcap_parse_values(char *output);

GList * extcap_parse_interfaces(char *output, GList **control_items);

GList * extcap_parse_dlts(char *output);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
/*
 * Editor modelines  -  https://www.wireshark.org/tools/modelines.html
 *
 * Local variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * vi: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */