| Wireshark 4.7.0 The Wireshark network protocol analyzer

Loading...
Searching...
No Matches
prefs-int.h
Go to the documentation of this file.
1/* prefs-int.h
2 * Definitions for implementation of preference handling routines;
3 * used by "friends" of the preferences type.
4 *
5 * Wireshark - Network traffic analyzer
6 * By Gerald Combs <gerald@wireshark.org>
7 * Copyright 1998 Gerald Combs
8 *
9 * SPDX-License-Identifier: GPL-2.0-or-later
10 */
11
12#ifndef __PREFS_INT_H__
13#define __PREFS_INT_H__
14
15#include <stdio.h>
16#include "ws_symbol_export.h"
17#include <epan/wmem_scopes.h>
18
19#ifdef __cplusplus
20extern "C" {
21#endif /* __cplusplus */
22
27 struct pref_module {
28 const char *name;
29 const char *title;
30 const char *description;
31 const char *help;
32 void (*apply_cb)(void);
33 GList *prefs;
34 struct pref_module *parent;
35 wmem_tree_t *submodules;
36 int numprefs;
37 unsigned int prefs_changed_flags;
38 bool obsolete;
41 bool use_gui;
48 unsigned int effect_flags;
51};
52
53 typedef struct {
54 module_t *module;
55 FILE *pf;
56} write_pref_arg_t;
57
58typedef void (*pref_custom_free_cb) (pref_t* pref);
59typedef void (*pref_custom_reset_cb) (pref_t* pref);
60typedef prefs_set_pref_e (*pref_custom_set_cb) (pref_t* pref, const char* value, unsigned int* changed_flags);
61/* typedef void (*pref_custom_write_cb) (pref_t* pref, write_pref_arg_t* arg); Deprecated. */
62/* pref_custom_type_name_cb should return NULL for internal / hidden preferences. */
63typedef const char * (*pref_custom_type_name_cb) (void);
64typedef char * (*pref_custom_type_description_cb) (void);
65typedef bool (*pref_custom_is_default_cb) (pref_t* pref);
66typedef char * (*pref_custom_to_str_cb) (pref_t* pref, bool default_val);
67
69 struct pref_custom_cbs {
70 pref_custom_free_cb free_cb;
71 pref_custom_reset_cb reset_cb;
72 pref_custom_set_cb set_cb;
73 /* pref_custom_write_cb write_cb; Deprecated. */
74 pref_custom_type_name_cb type_name_cb;
75 pref_custom_type_description_cb type_description_cb;
76 pref_custom_is_default_cb is_default_cb;
77 pref_custom_to_str_cb to_str_cb;
78};
79
80typedef enum {
81 PREF_UINT,
82 PREF_BOOL,
83 PREF_ENUM,
84 PREF_STRING,
85 PREF_RANGE,
86 PREF_STATIC_TEXT,
87 PREF_UAT,
88 PREF_SAVE_FILENAME,
89 PREF_COLOR, // (1)
90 PREF_CUSTOM, // (1)
91 PREF_DIRNAME,
92 PREF_DECODE_AS_RANGE, // (2)
93 PREF_OPEN_FILENAME,
94 PREF_PASSWORD, // (3)
95 PREF_PROTO_TCP_SNDAMB_ENUM, // (4)
96 PREF_DISSECTOR // (5)
97} pref_type_e;
98
99/*
100 * (1) These are only supported for "internal" (non-protocol) use
101 * and not as a generic protocol preference.
102 * (2) Internal use only, not a generic protocol preference.
103 * (3) Like string, but never saved to prefs file.
104 * (4) Dedicated to TCP PROTOCOL for handling manual SEQ interpretation,
105 * and allow users manage the sender traffic ambiguities
106 * (5) Like string, but with dissector name syntax check.
107 */
108
109/* read_prefs_file: read in a generic config file and do a callback to */
110/* pref_set_pair_fct() for every key/value pair found */
118 typedef prefs_set_pref_e (*pref_set_pair_cb) (char *key, const char *value, void *private_data, bool return_range_errors);
119
120WS_DLL_PUBLIC
121const char* prefs_get_description(pref_t *pref);
122
123WS_DLL_PUBLIC
124const char* prefs_get_title(pref_t *pref);
125
126WS_DLL_PUBLIC
127const char* prefs_get_name(pref_t *pref);
128
129WS_DLL_PUBLIC
130int prefs_get_type(pref_t *pref);
131
132WS_DLL_PUBLIC uint32_t prefs_get_max_value(pref_t *pref);
133
141WS_DLL_PUBLIC
142unsigned int prefs_get_effect_flags(pref_t *pref);
143
155WS_DLL_PUBLIC
156void prefs_set_effect_flags(pref_t *pref, unsigned int flags);
157
160WS_DLL_PUBLIC
161void prefs_set_effect_flags_by_name(module_t * module, const char *pref, unsigned int flags);
162
172WS_DLL_PUBLIC
173unsigned int prefs_get_module_effect_flags(module_t * module);
174
188WS_DLL_PUBLIC
189void prefs_set_module_effect_flags(module_t * module, unsigned int flags);
190
191WS_DLL_PUBLIC
192bool prefs_set_range_value_work(pref_t *pref, const char *value,
193 bool return_range_errors, unsigned int *changed_flags);
194
195WS_DLL_PUBLIC
196unsigned int
197prefs_set_stashed_range_value(pref_t *pref, const char *value);
198
200WS_DLL_PUBLIC
201void
202 prefs_range_add_value(pref_t *pref, uint32_t val);
203
205WS_DLL_PUBLIC
206void
207 prefs_range_remove_value(pref_t *pref, uint32_t val);
208
209
210WS_DLL_PUBLIC unsigned int prefs_set_bool_value(pref_t *pref, bool value, pref_source_t source);
211WS_DLL_PUBLIC bool prefs_get_bool_value(pref_t *pref, pref_source_t source);
212WS_DLL_PUBLIC void prefs_invert_bool_value(pref_t *pref, pref_source_t source);
213
214WS_DLL_PUBLIC unsigned int prefs_set_uint_value(pref_t *pref, unsigned value, pref_source_t source);
215WS_DLL_PUBLIC unsigned prefs_get_uint_base(pref_t *pref);
216WS_DLL_PUBLIC unsigned prefs_get_uint_value(pref_t *pref, pref_source_t source);
217
218
219WS_DLL_PUBLIC unsigned int prefs_set_enum_value(pref_t *pref, int value, pref_source_t source);
220WS_DLL_PUBLIC unsigned int prefs_set_enum_string_value(pref_t *pref, const char *value, pref_source_t source);
221WS_DLL_PUBLIC int prefs_get_enum_value(pref_t *pref, pref_source_t source);
222WS_DLL_PUBLIC const enum_val_t* prefs_get_enumvals(pref_t *pref);
223WS_DLL_PUBLIC bool prefs_get_enum_radiobuttons(pref_t *pref);
224
225WS_DLL_PUBLIC bool prefs_set_color_value(pref_t *pref, color_t value, pref_source_t source);
226WS_DLL_PUBLIC color_t* prefs_get_color_value(pref_t *pref, pref_source_t source);
227
228WS_DLL_PUBLIC unsigned int prefs_set_custom_value(pref_t *pref, const char *value, pref_source_t source);
229
230WS_DLL_PUBLIC unsigned int prefs_set_string_value(pref_t *pref, const char* value, pref_source_t source);
231WS_DLL_PUBLIC const char *prefs_get_string_value(pref_t *pref, pref_source_t source);
232
233WS_DLL_PUBLIC struct epan_uat* prefs_get_uat_value(pref_t *pref);
234
235WS_DLL_PUBLIC bool prefs_set_range_value(pref_t *pref, range_t *value, pref_source_t source);
236WS_DLL_PUBLIC range_t* prefs_get_range_value_real(pref_t *pref, pref_source_t source);
237
238WS_DLL_PUBLIC bool prefs_add_decode_as_value(pref_t *pref, unsigned value, bool replace);
239WS_DLL_PUBLIC bool prefs_remove_decode_as_value(pref_t *pref, unsigned value, bool set_default);
240
241WS_DLL_PUBLIC unsigned int prefs_set_password_value(pref_t *pref, const char* value, pref_source_t source);
242WS_DLL_PUBLIC const char *prefs_get_password_value(pref_t *pref, pref_source_t source);
243
244WS_DLL_PUBLIC bool prefs_add_list_value(pref_t *pref, void *value, pref_source_t source);
245WS_DLL_PUBLIC GList* prefs_get_list_value(pref_t *pref, pref_source_t source);
246
247WS_DLL_PUBLIC void reset_pref(pref_t *pref);
248
252WS_DLL_PUBLIC
253int
254 read_prefs_file(const char *pf_path, FILE *pf, pref_set_pair_cb pref_set_pair_fct, void *private_data);
255
262WS_DLL_PUBLIC
263void
264 prefs_read_module(const char *name, const char* app_env_var_prefix);
265
266WS_DLL_PUBLIC
267bool
268prefs_pref_is_default(pref_t *pref);
269
276WS_DLL_PUBLIC
277 unsigned pref_stash(pref_t *pref, void *unused);
278
279 typedef struct pref_unstash_data
280{
281 /* Used to set prefs_changed member to true if the preference
282 differs from its stashed values. */
283 module_t *module;
284 /* Qt uses stashed values to then "applies" them
285 during unstash. Use this flag for that behavior */
286 bool handle_decode_as;
287} pref_unstash_data_t;
288
297WS_DLL_PUBLIC
298unsigned pref_unstash(pref_t *pref, void *unstash_data_p);
299
308WS_DLL_PUBLIC
309 unsigned pref_clean_stash(pref_t *pref, void *unused);
310
315WS_DLL_PUBLIC
316void reset_stashed_pref(pref_t *pref);
317
327WS_DLL_PUBLIC
328char *
329 join_string_list(GList *sl);
330
331#ifdef __cplusplus
332}
333#endif /* __cplusplus */
334
335#endif /* prefs-int.h */
prefs_set_effect_flags
WS_DLL_PUBLIC void prefs_set_effect_flags(pref_t *pref, unsigned int flags)
Definition prefs.c:6518
prefs_set_effect_flags_by_name
WS_DLL_PUBLIC void prefs_set_effect_flags_by_name(module_t *module, const char *pref, unsigned int flags)
Definition prefs.c:6529
pref_unstash
WS_DLL_PUBLIC unsigned pref_unstash(pref_t *pref, void *unstash_data_p)
Definition prefs.c:2069
join_string_list
WS_DLL_PUBLIC char * join_string_list(GList *sl)
Definition prefs.c:4107
pref_set_pair_cb
prefs_set_pref_e(* pref_set_pair_cb)(char *key, const char *value, void *private_data, bool return_range_errors)
Definition prefs-int.h:118
prefs_set_module_effect_flags
WS_DLL_PUBLIC void prefs_set_module_effect_flags(module_t *module, unsigned int flags)
Definition prefs.c:6544
prefs_get_module_effect_flags
WS_DLL_PUBLIC unsigned int prefs_get_module_effect_flags(module_t *module)
Definition prefs.c:6535
prefs_range_remove_value
WS_DLL_PUBLIC void prefs_range_remove_value(pref_t *pref, uint32_t val)
Definition prefs.c:1731
pref_stash
WS_DLL_PUBLIC unsigned pref_stash(pref_t *pref, void *unused)
read_prefs_file
WS_DLL_PUBLIC int read_prefs_file(const char *pf_path, FILE *pf, pref_set_pair_cb pref_set_pair_fct, void *private_data)
Definition prefs.c:4753
reset_stashed_pref
WS_DLL_PUBLIC void reset_stashed_pref(pref_t *pref)
Definition prefs.c:2222
prefs_range_add_value
WS_DLL_PUBLIC void prefs_range_add_value(pref_t *pref, uint32_t val)
Definition prefs.c:1725
prefs_get_effect_flags
WS_DLL_PUBLIC unsigned int prefs_get_effect_flags(pref_t *pref)
Definition prefs.c:6509
pref_clean_stash
WS_DLL_PUBLIC unsigned pref_clean_stash(pref_t *pref, void *unused)
prefs_read_module
WS_DLL_PUBLIC void prefs_read_module(const char *name, const char *app_env_var_prefix)
Definition prefs.c:4589
prefs_set_pref_e
prefs_set_pref_e
Definition prefs.h:993
_wmem_tree_t
Internal representation of a wmem balanced tree.
Definition wmem_tree-int.h:81
color_t
RGB color representation with 16-bit precision per channel.
Definition color.h:27
enum_val_t
Definition params.h:23
epan_range
Definition range.h:41
epan_uat
Definition uat-int.h:40
pref_custom_cbs
Definition prefs-int.h:69
pref_module
Definition prefs-int.h:27
pref_module::effect_flags
unsigned int effect_flags
Definition prefs-int.h:48
pref_module::prefs
GList * prefs
Definition prefs-int.h:33
pref_module::use_gui
bool use_gui
Definition prefs-int.h:41
pref_module::submodules
wmem_tree_t * submodules
Definition prefs-int.h:35
pref_module::description
const char * description
Definition prefs-int.h:30
pref_module::name
const char * name
Definition prefs-int.h:28
pref_module::obsolete
bool obsolete
Definition prefs-int.h:38
pref_module::parent
struct pref_module * parent
Definition prefs-int.h:34
pref_module::prefs_changed_flags
unsigned int prefs_changed_flags
Definition prefs-int.h:37
pref_module::apply_cb
void(* apply_cb)(void)
Definition prefs-int.h:32
pref_module::numprefs
int numprefs
Definition prefs-int.h:36
pref_module::title
const char * title
Definition prefs-int.h:29
pref_module::help
const char * help
Definition prefs-int.h:31
pref_unstash_data
Definition prefs-int.h:280
preference
Definition prefs.c:216
write_pref_arg_t
Definition prefs-int.h:53
wmem_scopes.h