prefs.h

Go to the documentation of this file.

#pragma once
#include <glib.h>
 
#include <epan/params.h>
#include <epan/range.h>
 
#include <wsutil/color.h>
 
#include "ws_symbol_export.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define DEF_WIDTH 750
#define DEF_HEIGHT 550
 
#define MAX_VAL_LEN  1024
 
#define TAP_UPDATE_DEFAULT_INTERVAL 3000
#define ST_DEF_BURSTRES 5
#define ST_DEF_BURSTLEN 100
#define ST_MAX_BURSTRES 600000 /* somewhat arbitrary limit of 10 minutes */
#define ST_MAX_BURSTBUCKETS 100 /* somewhat arbitrary limit - more buckets degrade performance */
#define DEF_GUI_DECIMAL_PLACES1 2
#define DEF_GUI_DECIMAL_PLACES2 4
#define DEF_GUI_DECIMAL_PLACES3 6
 
#define CONV_DEINT_KEY_CAPFILE    0x01 /* unused yet */
#define CONV_DEINT_KEY_INTERFACE  0x02
#define CONV_DEINT_KEY_MAC        0x04
#define CONV_DEINT_KEY_VLAN       0x08
 
/* Bitmask of flags for the effect of a preference in Wireshark */
#define PREF_EFFECT_DISSECTION        (1u << 0)
#define PREF_EFFECT_CAPTURE           (1u << 1)
#define PREF_EFFECT_GUI_LAYOUT        (1u << 2)
#define PREF_EFFECT_FIELDS            (1u << 3)
#define PREF_EFFECT_GUI               (1u << 4)
#define PREF_EFFECT_GUI_COLOR         (1u << 5)
#define PREF_EFFECT_AGGREGATION       (1u << 6)
 
/* Default update interval in milliseconds */
#define DEFAULT_UPDATE_INTERVAL 100
 
struct epan_uat;
struct _e_addr_resolve;

WS_DLL_PUBLIC
char string_to_name_resolve(const char *string, struct _e_addr_resolve *name_resolve);
 
/*
 * Modes for the starting directory in File Open dialogs.
 */
#define FO_STYLE_LAST_OPENED    0 /* start in last directory we looked at */
#define FO_STYLE_SPECIFIED      1 /* start in specified directory */
#define FO_STYLE_CWD            2 /* start in current working directory at startup */
 
/*
 * Toolbar styles.
 */
#define TB_STYLE_ICONS          0
#define TB_STYLE_TEXT           1
#define TB_STYLE_BOTH           2
 
#define COLOR_SCHEME_DEFAULT    0
#define COLOR_SCHEME_LIGHT      1
#define COLOR_SCHEME_DARK       2

typedef enum {
    layout_unused,    
    layout_type_5,    
    layout_type_2,    
    layout_type_1,    
    layout_type_4,    
    layout_type_3,    
    layout_type_6,    
    layout_type_max   
} layout_type_e;
 

typedef enum {
    layout_pane_content_none,     
    layout_pane_content_plist,    
    layout_pane_content_pdetails, 
    layout_pane_content_pbytes,   
    layout_pane_content_pdiagram, 
} layout_pane_content_e;
 

typedef enum {
    version_welcome_only, 
    version_title_only,   
    version_both,         
    version_neither       
} version_info_e;
 

typedef enum {
    layout_vertical,   
    layout_horizontal  
} splitter_layout_e;
 

typedef enum {
    pref_default, 
    pref_stashed, 
    pref_current  
} pref_source_t;
 

typedef enum {
    ELIDE_LEFT,   
    ELIDE_RIGHT,  
    ELIDE_MIDDLE, 
    ELIDE_NONE    
} elide_mode_e;
 

typedef enum {
    COPY_FORMAT_TEXT, 
    COPY_FORMAT_CSV,  
    COPY_FORMAT_YAML, 
    COPY_FORMAT_HTML  
} copy_format_e;
 

typedef enum {
    ABS_TIME_ASCII_NEVER,  
    ABS_TIME_ASCII_TREE,   
    ABS_TIME_ASCII_COLUMN, 
    ABS_TIME_ASCII_ALWAYS, 
} abs_time_format_e;
 

typedef enum {
    CAPTURE_PROCESS_INFO_NONE,  
    CAPTURE_PROCESS_INFO_BASIC, 
    CAPTURE_PROCESS_INFO_FULL   
} capture_process_info_e;

typedef enum {
    UPDATE_CHANNEL_DEVELOPMENT, 
    UPDATE_CHANNEL_STABLE       
} software_update_channel_e;
 

typedef enum {
    PACKET_LIST_MULTI_COLOR_MODE_OFF         = 0, 
    PACKET_LIST_MULTI_COLOR_MODE_SCROLLBAR_ONLY,  
    PACKET_LIST_MULTI_COLOR_MODE_FULL,            
    PACKET_LIST_MULTI_COLOR_MODE_SHIFT_RIGHT      
} gui_packet_list_multi_color_mode_e;
 

typedef enum {
    PACKET_LIST_MULTI_COLOR_SEPARATOR_VERTICAL  = 0, 
    PACKET_LIST_MULTI_COLOR_SEPARATOR_DIAGONAL,      
    PACKET_LIST_MULTI_COLOR_SEPARATOR_BUBBLE         
} gui_packet_list_multi_color_separator_e;
 

typedef struct _e_prefs {
    GList        *col_list;                  
    unsigned      num_cols;                  
 
    /* GUI appearance */
    int           gui_toolbar_main_style;    
    char         *gui_font_name;             
 
    /* Colorized column colors */
    char         *gui_colorized_fg;          
    char         *gui_colorized_bg;          
 
    /* Window geometry */
    bool          gui_geometry_save_position;   
    bool          gui_geometry_save_size;        
    bool          gui_geometry_save_maximized;   
 
    /* Recent entries */
    unsigned      gui_recent_df_entries_max;    
    unsigned      gui_recent_files_count_max;   
 
    /* File open dialog */
    unsigned      gui_fileopen_style;           
    char         *gui_fileopen_dir;             
    unsigned      gui_fileopen_preview;         
 
    char         *gui_tlskeylog_command;         
 
    /* Dialog behavior */
    bool          gui_ask_unsaved;              
    bool          gui_autocomplete_filter;      
    bool          gui_find_wrap;                
 
    /* Window title */
    char         *gui_window_title;             
    char         *gui_prepend_window_title;     
    char         *gui_start_title;              
    version_info_e gui_version_placement;       
 
    /* Export/tree limits */
    unsigned      gui_max_export_objects;       
    unsigned      gui_max_tree_items;           
    unsigned      gui_max_tree_depth;           
 
    bool          gui_welcome_page_show_recent; 
 
    /* Layout */
    layout_type_e         gui_layout_type;       
    layout_pane_content_e gui_layout_content_1;  
    layout_pane_content_e gui_layout_content_2;  
    layout_pane_content_e gui_layout_content_3;  
    splitter_layout_e     gui_packet_dialog_layout; 
 
    /* Interface filtering */
    char         *gui_interfaces_hide_types;     
    bool          gui_interfaces_show_hidden;    
    bool          gui_interfaces_remote_display; 
 
    /* I/O graph */
    bool          gui_io_graph_automatic_update; 
    bool          gui_io_graph_enable_legend;    
 
    /* Plot */
    bool          gui_plot_automatic_update;     
    bool          gui_plot_enable_legend;        
    bool          gui_plot_enable_auto_scroll;   
 
    bool          gui_packet_details_show_byteview; 
 
    bool          gui_appearance_mode_toolbar_button; 
 
    /* Capture device settings */
    char         *capture_device;               
    char         *capture_devices_linktypes;    
    char         *capture_devices_descr;        
    char         *capture_devices_hide;         
    char         *capture_devices_monitor_mode; 
    char         *capture_devices_buffersize;   
    char         *capture_devices_snaplen;      
    char         *capture_devices_pmode;        
    char         *capture_devices_filter;       
 
    /* Capture behavior */
    bool          capture_prom_mode;            
    bool          capture_monitor_mode;         
    bool          capture_pcap_ng;              
    int           capture_zstd_compression_level; 
    capture_process_info_e capture_process_info; 
    bool          capture_real_time;            
    unsigned      capture_update_interval;      
    char         *capture_temp_dir;             
 
    /* Aggregation */
    GList        *aggregation_fields;           
    int           aggregation_fields_num;       
 
    /* Capture startup */
    bool          capture_no_interface_load;    
    bool          capture_no_extcap;            
    bool          capture_show_info;            
 
    /* Update intervals */
    unsigned      tap_update_interval;          
 
    /* Dissection display options */
    bool          display_hidden_proto_items;          
    bool          display_byte_fields_with_spaces;     
    abs_time_format_e display_abs_time_ascii;          
 
    /* Dissector checking */
    bool          enable_incomplete_dissectors_check;  
    bool          incomplete_dissectors_check_debug;   
    bool          strict_conversation_tracking_heuristics; 
    int           conversation_deinterlacing_key;      
 
    /* Duplicate frame detection */
    bool          ignore_dup_frames;                   
    unsigned      ignore_dup_frames_cache_entries;     
 
    /* Migration flags */
    bool          filter_expressions_old;   
    bool          cols_hide_new;            
 
    /* Auto-update */
    bool          gui_update_enabled;                  
    software_update_channel_e gui_update_channel;      
    unsigned      gui_update_interval;                 
    unsigned      gui_debounce_timer;                  
 
    char         *saved_at_version;         
 
    /* Packet list display options */
    bool          gui_packet_list_separator;             
    bool          gui_packet_header_column_definition;   
    bool          gui_packet_list_hover_style;           
    bool          gui_show_selected_packet;              
    bool          gui_show_file_load_time;               
    elide_mode_e  gui_packet_list_elide_mode;            
    copy_format_e gui_packet_list_copy_format_options_for_keyboard_shortcut; 
    bool          gui_packet_list_copy_text_with_aligned_columns; 
    bool          gui_packet_list_show_related;          
    bool          gui_packet_list_show_minimap;          
    bool          gui_packet_list_sortable;              
    unsigned      gui_packet_list_cached_rows_max;       
 
    /* Multi-color stripe settings */
    gui_packet_list_multi_color_mode_e      gui_packet_list_multi_color_mode;            
    unsigned                                gui_packet_list_multi_color_shift_percent;   
    bool                                    gui_packet_list_multi_color_details;         
    bool                                    gui_coloring_rules_include_disabled;         
    gui_packet_list_multi_color_separator_e gui_packet_list_multi_color_separator;       
 
    /* Decimal places for statistics calculations */
    unsigned      gui_decimal_places1;      
    unsigned      gui_decimal_places2;      
    unsigned      gui_decimal_places3;      
 
    /* RTP player */
    bool          gui_rtp_player_use_disk1; 
    bool          gui_rtp_player_use_disk2; 
 
    /* Flow graph */
    unsigned      flow_graph_max_export_items; 
 
    /* Statistics burst detection */
    bool          st_enable_burstinfo;      
    bool          st_burst_showcount;       
    unsigned      st_burst_resolution;      
    unsigned      st_burst_windowlen;       
 
    /* Statistics sorting */
    bool          st_sort_casesensitve;     
    bool          st_sort_rng_fixorder;     
    bool          st_sort_rng_nameonly;     
    int           st_sort_defcolflag;       
    bool          st_sort_defdescending;    
    bool          st_sort_showfullname;     
    int           st_format;               
 
    bool          conv_machine_readable;   
    bool          extcap_save_on_start;    
} e_prefs;
 
WS_DLL_PUBLIC e_prefs prefs;
 
/*
 * Routines to let modules that have preference settings register
 * themselves by name, and to let them register preference settings
 * by name.
 */
struct pref_module;
 
struct pref_custom_cbs;
 
typedef struct pref_module module_t;


void prefs_init(const char** col_fmt, int num_cols);


WS_DLL_PUBLIC void prefs_reset(const char* app_env_var_prefix, const char** col_fmt, int num_cols);


void prefs_cleanup(void);

WS_DLL_PUBLIC module_t *prefs_register_protocol(int id, void (*apply_cb)(void));

WS_DLL_PUBLIC void prefs_register_module_alias(const char *name, module_t *module);

void prefs_deregister_protocol(int id);

WS_DLL_PUBLIC module_t *prefs_register_stat(const char *name, const char *title,
    const char *description, void (*apply_cb)(void));

WS_DLL_PUBLIC module_t *prefs_register_codec(const char *name, const char *title,
    const char *description, void (*apply_cb)(void));

WS_DLL_PUBLIC module_t *prefs_register_protocol_subtree(const char *subtree, int id,
    void (*apply_cb)(void));

WS_DLL_PUBLIC module_t *prefs_register_protocol_obsolete(int id);

WS_DLL_PUBLIC module_t*
prefs_register_module(wmem_tree_t* pref_tree, wmem_tree_t* master_pref_tree, const char* name, const char* title,
    const char* description, const char* help, void (*apply_cb)(void),
    const bool use_gui);

typedef unsigned (*module_cb)(module_t *module, void *user_data);

WS_DLL_PUBLIC bool prefs_module_has_submodules(module_t *module);

WS_DLL_PUBLIC unsigned prefs_modules_foreach(const wmem_tree_t* module, module_cb callback, void *user_data);

WS_DLL_PUBLIC unsigned prefs_modules_foreach_submodules(const wmem_tree_t* module, module_cb callback, void *user_data);

WS_DLL_PUBLIC unsigned prefs_modules_for_all_modules(module_cb callback, void* user_data);

WS_DLL_PUBLIC void prefs_apply_all(void);

WS_DLL_PUBLIC void prefs_apply(module_t *module);
 
 
struct preference;
 
typedef struct preference pref_t;

WS_DLL_PUBLIC bool prefs_is_registered_protocol(const char *name);

WS_DLL_PUBLIC const char *prefs_get_title_by_name(const char *name);

WS_DLL_PUBLIC module_t *prefs_find_module(const char *name);

WS_DLL_PUBLIC pref_t *prefs_find_preference(module_t * module, const char *pref);

WS_DLL_PUBLIC void prefs_register_uint_preference(module_t *module, const char *name,
    const char *title, const char *description, unsigned base, unsigned *var);

WS_DLL_PUBLIC void prefs_register_int_preference(module_t* module, const char* name,
    const char* title, const char* description, int* var);

WS_DLL_PUBLIC void prefs_register_float_preference(module_t* module, const char* name,
    const char* title, const char* description, unsigned num_decimal, double* var);
 
/*
 * prefs_register_ callers must conform to the following:
 *
 * Names must be in lowercase letters only (underscore allowed).
 * Titles and descriptions must be valid UTF-8 or NULL.
 * Titles must be short (less than 80 characters)
 * Titles must not contain newlines.
 */

WS_DLL_PUBLIC void prefs_register_bool_preference(module_t *module, const char *name,
    const char *title, const char *description, bool *var);

WS_DLL_PUBLIC void prefs_register_enum_preference(module_t *module, const char *name,
    const char *title, const char *description, int *var,
    const enum_val_t *enumvals, bool radio_buttons);

WS_DLL_PUBLIC void prefs_register_string_preference(module_t *module, const char *name,
    const char *title, const char *description, const char **var);

WS_DLL_PUBLIC void prefs_register_filename_preference(module_t *module, const char *name,
    const char *title, const char *description, const char **var, bool for_writing);

WS_DLL_PUBLIC void prefs_register_directory_preference(module_t *module, const char *name,
    const char *title, const char *description, const char **var);

WS_DLL_PUBLIC void prefs_register_list_string_preference(module_t* module, const char* name,
    const char* title, const char* description, wmem_list_t** var);

WS_DLL_PUBLIC void prefs_register_multiple_string_preference(module_t* module, const char* name,
    const char* title, const char* description, wmem_list_t** var);

WS_DLL_PUBLIC void prefs_register_range_preference(module_t *module, const char *name,
    const char *title, const char *description, range_t **var,
    uint32_t max_value);

WS_DLL_PUBLIC void prefs_register_static_text_preference(module_t *module, const char *name,
    const char *title, const char *description);

WS_DLL_PUBLIC void prefs_register_uat_preference(module_t *module,
    const char *name, const char* title, const char *description,  struct epan_uat* uat);

void prefs_register_color_preference(module_t *module, const char *name,
    const char *title, const char *description, color_t *color);

void prefs_register_custom_preference(module_t *module, const char *name,
    const char *title, const char *description, struct pref_custom_cbs* custom_cbs,
    void** custom_data);

void prefs_register_decode_as_range_preference(module_t *module, const char *name,
    const char *title, const char *description, range_t **var,
    uint32_t max_value, const char *dissector_table, const char *dissector_description);

WS_DLL_PUBLIC void prefs_register_password_preference(module_t *module, const char *name,
    const char *title, const char *description, const char **var);

WS_DLL_PUBLIC void prefs_register_dissector_preference(module_t *module, const char *name,
    const char *title, const char *description, const char **var);

WS_DLL_PUBLIC void prefs_register_obsolete_preference(module_t *module,
    const char *name);

WS_DLL_PUBLIC void prefs_register_custom_preference_TCP_Analysis(module_t *module, const char *name,
    const char *title, const char *description, int *var,
    const enum_val_t *enumvals, bool radio_buttons);

WS_DLL_PUBLIC void prefs_set_preference_effect_fields(module_t *module,
    const char *name);

WS_DLL_PUBLIC void prefs_set_preference_effect(module_t* module,
    const char* name, unsigned flags);
 
typedef unsigned (*pref_cb)(pref_t *pref, void *user_data);

WS_DLL_PUBLIC unsigned prefs_pref_foreach(module_t *module, pref_cb callback,
    void *user_data);

WS_DLL_PUBLIC GList *prefs_get_string_list(const char *str);

WS_DLL_PUBLIC void prefs_clear_string_list(GList *sl);

WS_DLL_PUBLIC
const char *prefs_pref_type_name(pref_t *pref);

WS_DLL_PUBLIC
char *prefs_pref_type_description(pref_t *pref);

WS_DLL_PUBLIC
char *prefs_pref_to_str(pref_t *pref, pref_source_t source);

WS_DLL_PUBLIC
int prefs_num_non_uat(module_t* module);
 

WS_DLL_PUBLIC
bool prefs_is_preference_obsolete(pref_t *pref);

extern e_prefs *read_prefs(const char* app_env_var_prefix);

WS_DLL_PUBLIC int write_prefs(const char* app_env_var_prefix, char **pf_path_return);

WS_DLL_PUBLIC void pref_write_individual(void* data, void* user_data);

WS_DLL_PUBLIC void pref_free_individual(void* data, void* user_data);

typedef enum {
    PREFS_SET_OK,               
    PREFS_SET_SYNTAX_ERR,       
    PREFS_SET_NO_SUCH_PREF,     
    PREFS_SET_OBSOLETE          
} prefs_set_pref_e;

WS_DLL_PUBLIC prefs_set_pref_e prefs_set_pref(char *prefarg, char **errmsg);

WS_DLL_PUBLIC range_t* prefs_get_range_value(const char *module_name, const char* pref_name);

WS_DLL_PUBLIC bool prefs_is_capture_device_hidden(const char *name);

WS_DLL_PUBLIC bool prefs_capture_device_monitor_mode(const char *name);

WS_DLL_PUBLIC bool prefs_has_layout_pane_content (layout_pane_content_e layout_pane_content);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
/*
 * 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:
 */