|
Wireshark 4.5.0
The Wireshark network protocol analyzer
|
Go to the source code of this file.
Classes | |
| struct | pref_module |
| struct | write_pref_arg_t |
| struct | pref_custom_cbs |
| struct | pref_unstash_data |
Macros | |
| #define | PREF_UINT (1u << 0) |
| #define | PREF_BOOL (1u << 1) |
| #define | PREF_ENUM (1u << 2) |
| #define | PREF_STRING (1u << 3) |
| #define | PREF_RANGE (1u << 4) |
| #define | PREF_STATIC_TEXT (1u << 5) |
| #define | PREF_UAT (1u << 6) |
| #define | PREF_SAVE_FILENAME (1u << 7) |
| #define | PREF_COLOR (1u << 8) /* XXX - These are only supported for "internal" (non-protocol) */ |
| #define | PREF_CUSTOM (1u << 9) /* use and not as a generic protocol preference */ |
| #define | PREF_OBSOLETE (1u << 10) |
| #define | PREF_DIRNAME (1u << 11) |
| #define | PREF_DECODE_AS_RANGE (1u << 13) /* XXX - Internal use only, not a generic protocol preference */ |
| #define | PREF_OPEN_FILENAME (1u << 14) |
| #define | PREF_PASSWORD (1u << 15) /* like string, but never saved to prefs file */ |
| #define | PREF_PROTO_TCP_SNDAMB_ENUM (1u << 16) |
| #define | PREF_DISSECTOR (1u << 17) /* like string, but with dissector name syntax check */ |
| #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) |
Typedefs | |
| 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 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) |
| typedef prefs_set_pref_e(* | pref_set_pair_cb) (char *key, const char *value, void *private_data, bool return_range_errors) |
| typedef struct pref_unstash_data | pref_unstash_data_t |
Functions | |
| 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 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_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 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 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 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) |
| WS_DLL_PUBLIC bool | prefs_pref_is_default (pref_t *pref) |
| WS_DLL_PUBLIC unsigned | pref_stash (pref_t *pref, void *unused) |
| 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) |
Variables | |
| WS_DLL_PUBLIC module_t * | protocols_module |
| #define PREF_PROTO_TCP_SNDAMB_ENUM (1u << 16) |
Dedicated to TCP PROTOCOL for handling manual SEQ interpretation, and allow users manage the sender traffic ambiguities
| #define PREF_UINT (1u << 0) |
PREF_OBSOLETE is used for preferences that a module used to support but no longer supports; we give different error messages for them.
| typedef prefs_set_pref_e(* pref_set_pair_cb) (char *key, const char *value, void *private_data, bool return_range_errors) |
Given a string of the form "<pref name>:<pref value>", as might appear as an argument to a "-o" option, parse it and set the preference in question.
| WS_DLL_PUBLIC char * join_string_list | ( | GList * | sl | ) |
Convert a string list preference to a preference string.
Given a GList of char pointers, create a quoted, comma-separated string. Should be used with prefs_get_string_list() and prefs_clear_string_list().
| sl | String list. |
| WS_DLL_PUBLIC unsigned pref_clean_stash | ( | pref_t * | pref, |
| void * | unused | ||
| ) |
Clean up a stashed preference. Can be called from prefs_pref_foreach().
| pref | A preference. |
| unused | unused |
| WS_DLL_PUBLIC unsigned pref_stash | ( | pref_t * | pref, |
| void * | unused | ||
| ) |
"Stash" a preference. Copy a preference to its stashed value. Can be called from prefs_pref_foreach().
| pref | A preference. |
| unused | unused |
| WS_DLL_PUBLIC unsigned pref_unstash | ( | pref_t * | pref, |
| void * | unstash_data_p | ||
| ) |
"Unstash" a preference. Set a preference to its stashed value. Can be called from prefs_pref_foreach().
| pref | A preference. |
| unstash_data_p | A pointer to a pref_unstash_data_t structure. |
| WS_DLL_PUBLIC unsigned int prefs_get_effect_flags | ( | pref_t * | pref | ) |
Fetch flags that show the effect of the preference
| pref | A preference. |
| WS_DLL_PUBLIC unsigned int prefs_get_module_effect_flags | ( | module_t * | module | ) |
Fetch flags that show module's preferences effect The flag values of the module will be applied to any individual preferences of the module when they are created
| module | A preference module. |
| WS_DLL_PUBLIC void prefs_range_add_value | ( | pref_t * | pref, |
| uint32_t | val | ||
| ) |
Add a range value of a range preference.
| WS_DLL_PUBLIC void prefs_range_remove_value | ( | pref_t * | pref, |
| uint32_t | val | ||
| ) |
Remove a range value of a range preference.
| WS_DLL_PUBLIC void prefs_read_module | ( | const char * | name | ) |
Given a module name, read the preferences associated with only that module. Checks for a file in the personal configuration directory named after the module with a ".cfg" extension added first.
| name | The preference module name, e.g. "extcap". |
| WS_DLL_PUBLIC void prefs_set_effect_flags | ( | pref_t * | pref, |
| unsigned int | flags | ||
| ) |
Set flags for the effect of the preference The intention is to distinguish preferences that affect dissection from those that don't. A bitmask was added to provide greater flexibility in the types of effects preferences can have.
| pref | A preference. |
| flags | Bitmask of flags to apply to preference. Note that flags must be non-zero to ensure preference is properly saved to disk. |
| WS_DLL_PUBLIC void prefs_set_effect_flags_by_name | ( | module_t * | module, |
| const char * | pref, | ||
| unsigned int | flags | ||
| ) |
Same as prefs_set_effect_flags, just different way to get preference
| WS_DLL_PUBLIC void prefs_set_module_effect_flags | ( | module_t * | module, |
| unsigned int | flags | ||
| ) |
Set flags for module's preferences effect The intention is to distinguish preferences that affect dissection from those that don't. Since modules are a grouping of preferences, it's likely that a whole module will want the same flags for its preferences. The flag values of the module will be applied to any individual preferences of the module when they are created
| module | A preference module. |
| flags | Bitmask of flags to apply to module. Note that flags must be non-zero to ensure preferences are properly saved to disk. |
| WS_DLL_PUBLIC int read_prefs_file | ( | const char * | pf_path, |
| FILE * | pf, | ||
| pref_set_pair_cb | pref_set_pair_fct, | ||
| void * | private_data | ||
| ) |
read the preferences file (or similar) and call the callback function to set each key/value pair found
| WS_DLL_PUBLIC void reset_stashed_pref | ( | pref_t * | pref | ) |
Set a stashed preference to its default value.
| pref | A preference. |
| WS_DLL_PUBLIC module_t* protocols_module |
Module used for protocol preferences. With MSVC and a libwireshark.dll, we need a special declaration.