decode_as.h

Go to the documentation of this file.

/* decode_as.h
 * Routines for dissector Decode As handlers
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <[email protected]>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include "ws_symbol_export.h"
 
#include "ftypes/ftypes.h"
#include "packet_info.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define MAX_DECODE_AS_PROMPT_LEN    200
#define DECODE_AS_ENTRY "decode_as_entry"
#define DECODE_AS_NONE "(none)"
 
/*
 * Filename of the "decode as" entry preferences
 */
#define DECODE_AS_ENTRIES_FILE_NAME "decode_as_entries"
 
 
typedef void (*build_label_func)(packet_info *pinfo, char* result);
 
typedef void * (*build_valid_func)(packet_info *pinfo);
 
typedef void (*decode_as_add_to_list_func)(const char *table_name, const char *proto_name, void *value, void *user_data);
typedef void (*decode_as_populate_list_func)(const char *table_name, decode_as_add_to_list_func add_to_list, void *ui_element);
typedef void (*decode_as_free_func)(void *value);
typedef void (*decode_as_add_changed_list_func)(void* data, void* user_data);
 
typedef bool (*decode_as_reset_func)(const char *name, const void *pattern);
typedef bool (*decode_as_change_func)(const char *name, const void *pattern, const void *handle, const char *list_name);
typedef void (*decode_as_reset_all_func)(void);
typedef void (*decode_as_build_changed_list_func)(decode_as_add_changed_list_func func, void* user_data);
 
typedef struct decode_as_value_s {
    build_label_func label_func;            
    unsigned num_values;                       
    build_valid_func* build_values;         
} decode_as_value_t;
 
typedef struct decode_as_s {
    const char *name;                               
    const char *table_name;                        
    unsigned num_items;                                
    unsigned default_index_value;                      
    decode_as_value_t* values;                      
    const char* pre_value_str;                      
    const char* post_value_str;                     
    decode_as_populate_list_func populate_list;     
    decode_as_reset_func reset_value;               
    decode_as_change_func change_value;             
    decode_as_free_func free_func;                  
    decode_as_reset_all_func reset_all;             
    decode_as_build_changed_list_func build_changed_list;    
} decode_as_t;
 
WS_DLL_PUBLIC void register_decode_as(decode_as_t* reg);
 
/* Forward declaration to prevent requiring packet.h */
struct dissector_table;
 
WS_DLL_PUBLIC struct dissector_table* register_decode_as_next_proto(int proto, const char *table_name, const char *ui_name, build_label_func label_func);
 
/* Walk though the dissector table and provide dissector_handle_t for each item in the table */
 
WS_DLL_PUBLIC void decode_as_default_populate_list(const char *table_name, decode_as_add_to_list_func add_to_list, void *ui_element);
/* Clear a FT_UINT32 value from dissector table list */
WS_DLL_PUBLIC bool decode_as_default_reset(const char *name, const void *pattern);
/* Add a FT_UINT32 value to dissector table list */
WS_DLL_PUBLIC bool decode_as_default_change(const char *name, const void *pattern, const void *handle, const char *list_name);
 
WS_DLL_PUBLIC GList *decode_as_list;
 
/* Some useful utilities for Decode As */
 
extern void load_decode_as_entries(const char* app_env_var_prefix);
 
WS_DLL_PUBLIC int save_decode_as_entries(const char* app_name, const char* app_env_var_prefix, char** err);
 
WS_DLL_PUBLIC void decode_clear_all(void);
 
WS_DLL_PUBLIC void decode_cleanup(void);
 
WS_DLL_PUBLIC void decode_build_reset_list (const char *table_name, ftenum_t selector_type,
                         void *key, void *value,
                         void *user_data);
 
 
#ifdef __cplusplus
}
#endif /* __cplusplus */