prefs-int.h

Go to the documentation of this file.

/* prefs-int.h
 * Definitions for implementation of preference handling routines;
 * used by "friends" of the preferences type.
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
#pragma once
#include <stdio.h>
#include "ws_symbol_export.h"
#include <epan/wmem_scopes.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
struct pref_module {
    const char *name;           
    const char *title;          
    const char *description;    
    const char *help;           
    void (*apply_cb)(void);     
    wmem_allocator_t* scope;    
    GList *prefs;               
    struct pref_module *parent; 
    wmem_tree_t *submodules;    
    int numprefs;               
    unsigned int prefs_changed_flags;    
    bool obsolete;              
    bool use_gui;               
    unsigned int effect_flags;  
};
 
typedef struct {
    module_t* module; 
    FILE*     pf;     
} write_pref_arg_t;
 
 
typedef void (*pref_custom_free_cb)(pref_t* pref);
 
typedef void (*pref_custom_reset_cb)(pref_t* pref);
 
typedef prefs_set_pref_e (*pref_custom_set_cb)(pref_t* pref, const char* value, unsigned int* changed_flags);
 
/* typedef void (*pref_custom_write_cb) (pref_t* pref, write_pref_arg_t* arg); Deprecated. */
 
typedef const char* (*pref_custom_type_name_cb)(void);
 
typedef char* (*pref_custom_type_description_cb)(void);
 
typedef bool (*pref_custom_is_default_cb)(pref_t* pref);
 
typedef char* (*pref_custom_to_str_cb)(pref_t* pref, bool default_val);
 
struct pref_custom_cbs {
    pref_custom_free_cb             free_cb;             
    pref_custom_reset_cb            reset_cb;            
    pref_custom_set_cb              set_cb;              
    /* pref_custom_write_cb write_cb; Deprecated. */
    pref_custom_type_name_cb        type_name_cb;        
    pref_custom_type_description_cb type_description_cb; 
    pref_custom_is_default_cb       is_default_cb;       
    pref_custom_to_str_cb           to_str_cb;           
};
 
 
typedef enum {
    PREF_UINT,               
    PREF_BOOL,               
    PREF_ENUM,               
    PREF_STRING,             
    PREF_RANGE,              
    PREF_STATIC_TEXT,        
    PREF_UAT,                
    PREF_SAVE_FILENAME,      
    PREF_COLOR,              
    PREF_CUSTOM,             
    PREF_DIRNAME,            
    PREF_DECODE_AS_RANGE,    
    PREF_OPEN_FILENAME,      
    PREF_PASSWORD,           
    PREF_PROTO_TCP_SNDAMB_ENUM, 
    PREF_DISSECTOR,          
    PREF_INT,                
    PREF_FLOAT               
} pref_type_e;
 
/*
 * (1) These are only supported for "internal" (non-protocol) use
 *     and not as a generic protocol preference.
 * (2) Internal use only, not a generic protocol preference.
 * (3) Like string, but never saved to prefs file.
 * (4) Dedicated to TCP PROTOCOL for handling manual SEQ interpretation,
 *     and allow users manage the sender traffic ambiguities
 * (5) Like string, but with dissector name syntax check.
 */
 
/* read_prefs_file: read in a generic config file and do a callback to */
/* pref_set_pair_fct() for every key/value pair found */
typedef prefs_set_pref_e (*pref_set_pair_cb) (char *key, const char *value, void *private_data, bool return_range_errors);
 
WS_DLL_PUBLIC
const char* prefs_get_description(pref_t *pref);
 
WS_DLL_PUBLIC
const char* prefs_get_title(pref_t *pref);
 
WS_DLL_PUBLIC
const char* prefs_get_name(pref_t *pref);
 
WS_DLL_PUBLIC
int prefs_get_type(pref_t *pref);
 
WS_DLL_PUBLIC uint32_t prefs_get_max_value(pref_t *pref);
 
WS_DLL_PUBLIC
unsigned int prefs_get_effect_flags(pref_t *pref);
 
WS_DLL_PUBLIC
void prefs_set_effect_flags(pref_t *pref, unsigned int flags);
 
WS_DLL_PUBLIC
void prefs_set_effect_flags_by_name(module_t * module, const char *pref, unsigned int flags);
 
WS_DLL_PUBLIC
unsigned int prefs_get_module_effect_flags(module_t * module);
 
WS_DLL_PUBLIC
unsigned prefs_module_list_foreach(const wmem_tree_t* module_list, module_cb callback,
    void* user_data, bool skip_obsolete);
 
WS_DLL_PUBLIC
void prefs_set_module_effect_flags(module_t * module, unsigned int flags);
 
 
WS_DLL_PUBLIC
bool prefs_set_range_value_work(pref_t *pref, const char *value,
                           bool return_range_errors, unsigned int *changed_flags);
 
WS_DLL_PUBLIC
unsigned int
prefs_set_stashed_range_value(pref_t *pref, const char *value);
 
WS_DLL_PUBLIC
void
prefs_range_add_value(pref_t *pref, uint32_t val);
 
WS_DLL_PUBLIC
void
prefs_range_remove_value(pref_t *pref, uint32_t val);
 
WS_DLL_PUBLIC unsigned int prefs_set_bool_value(pref_t *pref, bool value, pref_source_t source);
 
WS_DLL_PUBLIC bool prefs_get_bool_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC void prefs_invert_bool_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_uint_value(pref_t *pref, unsigned value, pref_source_t source);
 
WS_DLL_PUBLIC unsigned prefs_get_uint_base(pref_t *pref);
 
WS_DLL_PUBLIC unsigned prefs_get_uint_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_int_value(pref_t* pref, int value, pref_source_t source);
 
WS_DLL_PUBLIC int prefs_get_int_value(pref_t* pref, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_float_value(pref_t* pref, double value, pref_source_t source);
 
WS_DLL_PUBLIC double prefs_get_float_value(pref_t* pref, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_enum_value(pref_t *pref, int value, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_enum_string_value(pref_t *pref, const char *value, pref_source_t source);
 
WS_DLL_PUBLIC int prefs_get_enum_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC const enum_val_t* prefs_get_enumvals(pref_t *pref);
 
WS_DLL_PUBLIC bool prefs_get_enum_radiobuttons(pref_t *pref);
 
WS_DLL_PUBLIC bool prefs_set_color_value(pref_t *pref, color_t value, pref_source_t source);
 
WS_DLL_PUBLIC color_t* prefs_get_color_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_custom_value(pref_t *pref, const char *value, pref_source_t source);
 
WS_DLL_PUBLIC unsigned int prefs_set_string_value(pref_t *pref, const char* value, pref_source_t source);
 
WS_DLL_PUBLIC const char *prefs_get_string_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC struct epan_uat* prefs_get_uat_value(pref_t *pref);
 
WS_DLL_PUBLIC bool prefs_set_range_value(pref_t *pref, range_t *value, pref_source_t source);
 
WS_DLL_PUBLIC range_t* prefs_get_range_value_real(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC bool prefs_add_decode_as_value(pref_t *pref, unsigned value, bool replace);
 
WS_DLL_PUBLIC bool prefs_remove_decode_as_value(pref_t *pref, unsigned value, bool set_default);
 
WS_DLL_PUBLIC unsigned int prefs_set_password_value(pref_t *pref, const char* value, pref_source_t source);
 
WS_DLL_PUBLIC const char *prefs_get_password_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC bool prefs_add_list_value(pref_t *pref, void *value, pref_source_t source);
 
WS_DLL_PUBLIC GList* prefs_get_list_value(pref_t *pref, pref_source_t source);
 
WS_DLL_PUBLIC void reset_pref(pref_t *pref);
 
WS_DLL_PUBLIC const wmem_tree_t* prefs_get_module_tree(void);
 
WS_DLL_PUBLIC
int
read_prefs_file(const char *pf_path, FILE *pf, pref_set_pair_cb pref_set_pair_fct, void *private_data);
 
WS_DLL_PUBLIC
void
prefs_read_module(const char *name, const char* app_env_var_prefix);
 
WS_DLL_PUBLIC
bool
prefs_pref_is_default(pref_t *pref);
 
WS_DLL_PUBLIC
unsigned pref_stash(pref_t *pref, void *unused);
 
typedef struct pref_unstash_data
{
    module_t* module;          
    bool      handle_decode_as; 
} pref_unstash_data_t;
 
WS_DLL_PUBLIC
unsigned pref_unstash(pref_t *pref, void *unstash_data_p);
 
WS_DLL_PUBLIC
unsigned pref_clean_stash(pref_t *pref, void *unused);
 
WS_DLL_PUBLIC
void reset_stashed_pref(pref_t *pref);
 
WS_DLL_PUBLIC
char *
join_string_list(GList *sl);
 
WS_DLL_PUBLIC
char *
prefs_sanitize_string(const char* str);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */