Wireshark  4.3.0
The Wireshark network protocol analyzer
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
20 extern "C" {
21 #endif /* __cplusplus */
22 
27 struct pref_module {
28  const char *name;
29  const char *title;
30  const char *description;
31  void (*apply_cb)(void);
32  GList *prefs;
33  struct pref_module *parent;
35  int numprefs;
36  unsigned int prefs_changed_flags;
37  gboolean obsolete;
40  gboolean use_gui;
47  unsigned int effect_flags;
50 };
51 
52 typedef struct {
53  module_t *module;
54  FILE *pf;
56 
61 WS_DLL_PUBLIC module_t *protocols_module;
62 
63 typedef void (*pref_custom_free_cb) (pref_t* pref);
64 typedef void (*pref_custom_reset_cb) (pref_t* pref);
65 typedef prefs_set_pref_e (*pref_custom_set_cb) (pref_t* pref, const gchar* value, unsigned int* changed_flags);
66 /* typedef void (*pref_custom_write_cb) (pref_t* pref, write_pref_arg_t* arg); Deprecated. */
67 /* pref_custom_type_name_cb should return NULL for internal / hidden preferences. */
68 typedef const char * (*pref_custom_type_name_cb) (void);
69 typedef char * (*pref_custom_type_description_cb) (void);
70 typedef gboolean (*pref_custom_is_default_cb) (pref_t* pref);
71 typedef char * (*pref_custom_to_str_cb) (pref_t* pref, gboolean default_val);
72 
75  pref_custom_free_cb free_cb;
76  pref_custom_reset_cb reset_cb;
77  pref_custom_set_cb set_cb;
78  /* pref_custom_write_cb write_cb; Deprecated. */
79  pref_custom_type_name_cb type_name_cb;
80  pref_custom_type_description_cb type_description_cb;
81  pref_custom_is_default_cb is_default_cb;
82  pref_custom_to_str_cb to_str_cb;
83 };
84 
89 #define PREF_UINT (1u << 0)
90 #define PREF_BOOL (1u << 1)
91 #define PREF_ENUM (1u << 2)
92 #define PREF_STRING (1u << 3)
93 #define PREF_RANGE (1u << 4)
94 #define PREF_STATIC_TEXT (1u << 5)
95 #define PREF_UAT (1u << 6)
96 #define PREF_SAVE_FILENAME (1u << 7)
97 #define PREF_COLOR (1u << 8) /* XXX - These are only supported for "internal" (non-protocol) */
98 #define PREF_CUSTOM (1u << 9) /* use and not as a generic protocol preference */
99 #define PREF_OBSOLETE (1u << 10)
100 #define PREF_DIRNAME (1u << 11)
101 #define PREF_DECODE_AS_UINT (1u << 12) /* XXX - These are only supported for "internal" (non-protocol) */
102 #define PREF_DECODE_AS_RANGE (1u << 13) /* use and not as a generic protocol preference */
103 #define PREF_OPEN_FILENAME (1u << 14)
104 #define PREF_PASSWORD (1u << 15) /* like string, but never saved to prefs file */
109 #define PREF_PROTO_TCP_SNDAMB_ENUM (1u << 16)
110 
111 /* read_prefs_file: read in a generic config file and do a callback to */
112 /* pref_set_pair_fct() for every key/value pair found */
120 typedef prefs_set_pref_e (*pref_set_pair_cb) (gchar *key, const gchar *value, void *private_data, gboolean return_range_errors);
121 
122 WS_DLL_PUBLIC
123 const char* prefs_get_description(pref_t *pref);
124 
125 WS_DLL_PUBLIC
126 const char* prefs_get_title(pref_t *pref);
127 
128 WS_DLL_PUBLIC
129 const char* prefs_get_name(pref_t *pref);
130 
131 WS_DLL_PUBLIC
132 int prefs_get_type(pref_t *pref);
133 
134 WS_DLL_PUBLIC guint32 prefs_get_max_value(pref_t *pref);
135 
136 /* Bitmask of flags for the effect of a preference in Wireshark */
137 #define PREF_EFFECT_DISSECTION (1u << 0)
138 #define PREF_EFFECT_CAPTURE (1u << 1)
139 #define PREF_EFFECT_GUI_LAYOUT (1u << 2)
140 #define PREF_EFFECT_FIELDS (1u << 3)
141 
149 WS_DLL_PUBLIC
150 unsigned int prefs_get_effect_flags(pref_t *pref);
151 
163 WS_DLL_PUBLIC
164 void prefs_set_effect_flags(pref_t *pref, unsigned int flags);
165 
168 WS_DLL_PUBLIC
169 void prefs_set_effect_flags_by_name(module_t * module, const char *pref, unsigned int flags);
170 
180 WS_DLL_PUBLIC
181 unsigned int prefs_get_module_effect_flags(module_t * module);
182 
196 WS_DLL_PUBLIC
197 void prefs_set_module_effect_flags(module_t * module, unsigned int flags);
198 
199 WS_DLL_PUBLIC
200 gboolean prefs_set_range_value_work(pref_t *pref, const gchar *value,
201  gboolean return_range_errors, unsigned int *changed_flags);
202 
203 WS_DLL_PUBLIC
204 unsigned int
205 prefs_set_stashed_range_value(pref_t *pref, const gchar *value);
206 
208 WS_DLL_PUBLIC
209 void
210 prefs_range_add_value(pref_t *pref, guint32 val);
211 
213 WS_DLL_PUBLIC
214 void
215 prefs_range_remove_value(pref_t *pref, guint32 val);
216 
217 
218 WS_DLL_PUBLIC unsigned int prefs_set_bool_value(pref_t *pref, gboolean value, pref_source_t source);
219 WS_DLL_PUBLIC gboolean prefs_get_bool_value(pref_t *pref, pref_source_t source);
220 WS_DLL_PUBLIC void prefs_invert_bool_value(pref_t *pref, pref_source_t source);
221 
222 WS_DLL_PUBLIC unsigned int prefs_set_uint_value(pref_t *pref, guint value, pref_source_t source);
223 WS_DLL_PUBLIC guint prefs_get_uint_base(pref_t *pref);
224 WS_DLL_PUBLIC guint prefs_get_uint_value_real(pref_t *pref, pref_source_t source);
225 
226 
227 WS_DLL_PUBLIC unsigned int prefs_set_enum_value(pref_t *pref, gint value, pref_source_t source);
228 WS_DLL_PUBLIC unsigned int prefs_set_enum_string_value(pref_t *pref, const gchar *value, pref_source_t source);
229 WS_DLL_PUBLIC gint prefs_get_enum_value(pref_t *pref, pref_source_t source);
230 WS_DLL_PUBLIC const enum_val_t* prefs_get_enumvals(pref_t *pref);
231 WS_DLL_PUBLIC gboolean prefs_get_enum_radiobuttons(pref_t *pref);
232 
233 WS_DLL_PUBLIC gboolean prefs_set_color_value(pref_t *pref, color_t value, pref_source_t source);
234 WS_DLL_PUBLIC color_t* prefs_get_color_value(pref_t *pref, pref_source_t source);
235 
236 WS_DLL_PUBLIC unsigned int prefs_set_custom_value(pref_t *pref, const char *value, pref_source_t source);
237 
238 WS_DLL_PUBLIC unsigned int prefs_set_string_value(pref_t *pref, const char* value, pref_source_t source);
239 WS_DLL_PUBLIC char* prefs_get_string_value(pref_t *pref, pref_source_t source);
240 
241 WS_DLL_PUBLIC struct epan_uat* prefs_get_uat_value(pref_t *pref);
242 
243 WS_DLL_PUBLIC gboolean prefs_set_range_value(pref_t *pref, range_t *value, pref_source_t source);
244 WS_DLL_PUBLIC range_t* prefs_get_range_value_real(pref_t *pref, pref_source_t source);
245 
246 WS_DLL_PUBLIC gboolean prefs_add_decode_as_value(pref_t *pref, guint value, gboolean replace);
247 WS_DLL_PUBLIC gboolean prefs_remove_decode_as_value(pref_t *pref, guint value, gboolean set_default);
248 
249 WS_DLL_PUBLIC unsigned int prefs_set_password_value(pref_t *pref, const char* value, pref_source_t source);
250 WS_DLL_PUBLIC char* prefs_get_password_value(pref_t *pref, pref_source_t source);
251 
252 WS_DLL_PUBLIC void reset_pref(pref_t *pref);
253 
257 WS_DLL_PUBLIC
258 int
259 read_prefs_file(const char *pf_path, FILE *pf, pref_set_pair_cb pref_set_pair_fct, void *private_data);
260 
261 WS_DLL_PUBLIC
262 gboolean
263 prefs_pref_is_default(pref_t *pref);
264 
271 WS_DLL_PUBLIC
272 guint pref_stash(pref_t *pref, gpointer unused);
273 
274 typedef struct pref_unstash_data
275 {
276  /* Used to set prefs_changed member to TRUE if the preference
277  differs from its stashed values. Also used by "decode as" types
278  to look up dissector short name */
279  module_t *module;
280  /* Qt uses stashed values to then "applies" them
281  during unstash. Use this flag for that behavior */
282  gboolean handle_decode_as;
284 
293 WS_DLL_PUBLIC
294 guint pref_unstash(pref_t *pref, gpointer unstash_data_p);
295 
304 WS_DLL_PUBLIC
305 guint pref_clean_stash(pref_t *pref, gpointer unused);
306 
311 WS_DLL_PUBLIC
312 void reset_stashed_pref(pref_t *pref);
313 
323 WS_DLL_PUBLIC
324 char *
325 join_string_list(GList *sl);
326 
327 #ifdef __cplusplus
328 }
329 #endif /* __cplusplus */
330 
331 #endif /* prefs-int.h */
WS_DLL_PUBLIC void prefs_set_effect_flags(pref_t *pref, unsigned int flags)
Definition: prefs.c:6272
WS_DLL_PUBLIC void prefs_set_effect_flags_by_name(module_t *module, const char *pref, unsigned int flags)
Definition: prefs.c:6280
WS_DLL_PUBLIC void prefs_range_remove_value(pref_t *pref, guint32 val)
Definition: prefs.c:1718
WS_DLL_PUBLIC module_t * protocols_module
Definition: prefs-int.h:61
WS_DLL_PUBLIC void prefs_set_module_effect_flags(module_t *module, unsigned int flags)
Definition: prefs.c:6295
WS_DLL_PUBLIC unsigned int prefs_get_module_effect_flags(module_t *module)
Definition: prefs.c:6286
WS_DLL_PUBLIC void prefs_range_add_value(pref_t *pref, guint32 val)
Definition: prefs.c:1712
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:4515
WS_DLL_PUBLIC void reset_stashed_pref(pref_t *pref)
Definition: prefs.c:2228
WS_DLL_PUBLIC guint pref_clean_stash(pref_t *pref, gpointer unused)
Definition: prefs.c:2279
WS_DLL_PUBLIC guint pref_unstash(pref_t *pref, gpointer unstash_data_p)
Definition: prefs.c:2077
WS_DLL_PUBLIC unsigned int prefs_get_effect_flags(pref_t *pref)
Definition: prefs.c:6263
prefs_set_pref_e(* pref_set_pair_cb)(gchar *key, const gchar *value, void *private_data, gboolean return_range_errors)
Definition: prefs-int.h:120
WS_DLL_PUBLIC char * join_string_list(GList *sl)
Definition: prefs.c:3891
WS_DLL_PUBLIC guint pref_stash(pref_t *pref, gpointer unused)
Definition: prefs.c:2024
prefs_set_pref_e
Definition: prefs.h:919
Definition: wmem_tree-int.h:48
Definition: color.h:23
Definition: params.h:23
Definition: range.h:42
Definition: uat-int.h:38
Definition: prefs-int.h:74
Definition: prefs-int.h:27
unsigned int effect_flags
Definition: prefs-int.h:47
GList * prefs
Definition: prefs-int.h:32
wmem_tree_t * submodules
Definition: prefs-int.h:34
gboolean use_gui
Definition: prefs-int.h:40
gboolean obsolete
Definition: prefs-int.h:37
const char * description
Definition: prefs-int.h:30
const char * name
Definition: prefs-int.h:28
struct pref_module * parent
Definition: prefs-int.h:33
unsigned int prefs_changed_flags
Definition: prefs-int.h:36
void(* apply_cb)(void)
Definition: prefs-int.h:31
int numprefs
Definition: prefs-int.h:35
const char * title
Definition: prefs-int.h:29
Definition: prefs-int.h:275
Definition: prefs.c:200
Definition: prefs-int.h:52