plugin_if.h

Go to the documentation of this file.

 
#ifndef EPAN_PLUGIN_IF_H
#define EPAN_PLUGIN_IF_H
 
#include "ws_symbol_export.h"
#include "ws_attributes.h"
 
#include <glib.h>
#include <epan/epan.h>
#include <epan/frame_data.h>
#include <epan/cfile.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef enum
{
    EXT_MENUBAR_GTK_GUI, 
    EXT_MENUBAR_QT_GUI   
} ext_menubar_gui_type;
 
 
typedef void (*ext_menubar_action_cb)(ext_menubar_gui_type gui_type, void *gui_object, void *user_data);
 
 
typedef enum
{
    EXT_MENUBAR_MENU,      
    EXT_MENUBAR_ITEM,      
    EXT_MENUBAR_SEPARATOR, 
    EXT_MENUBAR_URL        
} ext_menubar_entry_t;
 
 
typedef struct _ext_menubar_t ext_menubar_t;
typedef ext_menubar_t ext_menu_t; 
struct _ext_menubar_t
{
    ext_menubar_entry_t  type;         
    ext_menu_t          *parent;       
    int                  proto;        
    GList               *children;     
    unsigned             submenu_cnt;  
    unsigned             item_cnt;     
    char *name;       
    char *label;      
    char *tooltip;    
    bool  is_plugin;  
    void *user_data;  
    ext_menubar_action_cb callback;  
    char *parent_menu; 
};
 
typedef void (*ext_toolbar_action_cb)(void *toolbar_item, void *item_data, void *user_data);
 
typedef enum
{
    EXT_TOOLBAR_BAR,  
    EXT_TOOLBAR_ITEM  
} ext_toolbar_entry_t;
 
typedef enum
{
    EXT_TOOLBAR_BOOLEAN,  
    EXT_TOOLBAR_BUTTON,   
    EXT_TOOLBAR_STRING,   
    EXT_TOOLBAR_SELECTOR  
} ext_toolbar_item_t;
 
typedef struct _ext_toolbar_value_t
{
    char *value;      
    char *display;    
    bool  is_default; 
} ext_toolbar_value_t;
 
typedef struct _ext_toolbar_t
{
    ext_toolbar_entry_t type;        
    GList   *children;    
    unsigned submenu_cnt; 
    unsigned item_cnt;    
    char *name;      
    char *defvalue;  
    char *tooltip;   
    void *user_data; 
    bool               is_required;   
    bool               capture_only;  
    ext_toolbar_item_t item_type;     
    GList *values; 
    char  *regex;  
    ext_toolbar_action_cb callback; 
} ext_toolbar_t;
 
typedef enum
{
    EXT_TOOLBAR_UPDATE_VALUE,       
    EXT_TOOLBAR_UPDATE_DATA,        
    EXT_TOOLBAR_UPDATE_DATABYINDEX, 
    EXT_TOOLBAR_UPDATE_DATA_ADD,    
    EXT_TOOLBAR_UPDATE_DATA_REMOVE, 
    EXT_TOOLBAR_SET_ACTIVE          
} ext_toolbar_update_type_t;
 
 
typedef struct _ext_toolbar_update_t
{
    ext_toolbar_update_type_t type;       
    bool                      silent;     
    void                     *user_data;  
    void                     *data_index; 
} ext_toolbar_update_t;
 
WS_DLL_PUBLIC ext_menu_t * ext_menubar_register_menu(
        int proto_id, const char * menulabel, bool is_plugin);
 
WS_DLL_PUBLIC ext_menu_t * ext_menubar_set_parentmenu(
        ext_menu_t * menu, const char * parentmenu);
 
WS_DLL_PUBLIC ext_menu_t * ext_menubar_add_submenu(
        ext_menu_t * parent, const char *menulabel);
 
WS_DLL_PUBLIC void ext_menubar_add_entry(
        ext_menu_t * parent_menu,
        const char *label,
        const char *tooltip,
        ext_menubar_action_cb callback,
        void *user_data);
 
WS_DLL_PUBLIC void ext_menubar_add_separator(ext_menu_t *parent_menu);
 
WS_DLL_PUBLIC void ext_menubar_add_website(ext_menu_t * parent, const char *label,
        const char *tooltip, const char *url);
 
WS_DLL_PUBLIC ext_toolbar_t * ext_toolbar_register_toolbar(const char * toolbar_label);
 
WS_DLL_PUBLIC void ext_toolbar_unregister_toolbar(ext_toolbar_t * toolbar);
 
WS_DLL_PUBLIC void ext_toolbar_unregister_toolbar_by_name(const char * toolbar_name);
 
WS_DLL_PUBLIC ext_toolbar_t * ext_toolbar_add_entry(
        ext_toolbar_t * parent_bar,
        ext_toolbar_item_t type,
        const char *label,
        const char *defvalue,
        const char *tooltip,
        bool capture_only,
        GList * value_list,
        bool is_required,
        const char * valid_regex,
        ext_toolbar_action_cb callback,
        void *user_data);
 
WS_DLL_PUBLIC GList * ext_toolbar_add_val(GList * entries, char * value, char * display, bool is_default);
 
WS_DLL_PUBLIC void ext_toolbar_register_update_cb(ext_toolbar_t * entry, ext_toolbar_action_cb callback, void *item_data);
 
WS_DLL_PUBLIC void ext_toolbar_update_value(ext_toolbar_t * entry, void *data, bool silent);
 
WS_DLL_PUBLIC void ext_toolbar_update_data(ext_toolbar_t * entry, void *data, bool silent);
 
WS_DLL_PUBLIC void ext_toolbar_update_data_by_index(ext_toolbar_t * entry, void *data, void *idx, bool silent);
 
WS_DLL_PUBLIC void ext_toolbar_update_data_add_entry(ext_toolbar_t * entry, void *data, void *idx, bool silent);
 
WS_DLL_PUBLIC void ext_toolbar_update_data_remove_entry(ext_toolbar_t * entry, void *data, void *idx, bool silent);
 
WS_DLL_PUBLIC ext_toolbar_t * ext_toolbar_entry_by_label(const ext_toolbar_t * toolbar, const char * label);
 
WS_DLL_PUBLIC void ext_toolbar_update_data_set_active(ext_toolbar_t * entry, bool status);
 
/*
 * Structure definition for the plugin_if_get_ws_info function
 */
 
typedef struct _ws_info_t
{
    bool ws_info_supported;                 /* false if no libpcap */
    file_state cf_state;                        /* Current state of capture file */
    char *cf_filename;                         /* Name of capture file */
    uint32_t cf_count;                           /* Total number of frames */
    uint32_t cf_framenr;                         
    bool frame_passed_dfilter;              
} ws_info_t;
 
 
typedef enum
{
    PLUGIN_IF_FILTER_ACTION_APPLY,   
    PLUGIN_IF_FILTER_ACTION_PREPARE, 
    PLUGIN_IF_PREFERENCE_SAVE,       
    PLUGIN_IF_GOTO_FRAME,            
    PLUGIN_IF_GET_WS_INFO,           
    PLUGIN_IF_GET_FRAME_DATA,        
    PLUGIN_IF_GET_CAPTURE_FILE,      
    PLUGIN_IF_REMOVE_TOOLBAR         
} plugin_if_callback_t;
 
 
typedef void (*plugin_if_gui_cb)(GHashTable * data_set);
 
WS_DLL_PUBLIC void plugin_if_register_gui_cb(plugin_if_callback_t actionType, plugin_if_gui_cb callback);
 
WS_DLL_PUBLIC void plugin_if_apply_filter(const char * filter_string, bool force);
 
WS_DLL_PUBLIC void plugin_if_save_preference(const char * pref_module, const char * pref_key, const char * pref_value);
 
WS_DLL_PUBLIC void plugin_if_goto_frame(uint32_t framenr);
 
WS_DLL_PUBLIC void plugin_if_get_ws_info(ws_info_t ** ws_info);
 
typedef void* (*plugin_if_frame_data_cb)(frame_data*, void*);
 
WS_DLL_PUBLIC void* plugin_if_get_frame_data(plugin_if_frame_data_cb extract_cb, void *user_data);
 
typedef void* (*plugin_if_capture_file_cb)(capture_file*, void*);
 
WS_DLL_PUBLIC void* plugin_if_get_capture_file(plugin_if_capture_file_cb extract_cb, void* user_data);
 
WS_DLL_PUBLIC GList * ext_menubar_get_entries(void);
 
WS_DLL_PUBLIC GList * ext_toolbar_get_entries(void);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* EPAN_PLUGIN_IF_H */
 
/*
 * Editor modelines
 *
 * Local Variables:
 * c-basic-offset: 4
 * tab-width: 8
 * indent-tabs-mode: nil
 * End:
 *
 * ex: set shiftwidth=4 tabstop=8 expandtab:
 * :indentSize=4:tabSize=8:noTabs=true:
 */