MAC LTE: upgrade dissector to v13.1.0
[metze/wireshark/wip.git] / epan / prefs.h
1 /* prefs.h
2  * Definitions for preference handling routines
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21  */
22
23 #ifndef __PREFS_H__
24 #define __PREFS_H__
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif /* __cplusplus */
29
30 #include <glib.h>
31
32 #include "color_filters.h"
33
34 #include <epan/params.h>
35 #include <epan/range.h>
36
37 #include "ws_symbol_export.h"
38
39 #define PR_DEST_CMD  0
40 #define PR_DEST_FILE 1
41
42 #define DEF_WIDTH 750
43 #define DEF_HEIGHT 550
44
45 #define MAX_VAL_LEN  1024
46
47 #define RTP_PLAYER_DEFAULT_VISIBLE 4
48 #define TAP_UPDATE_DEFAULT_INTERVAL 3000
49 #define ST_DEF_BURSTRES 5
50 #define ST_DEF_BURSTLEN 100
51 #define ST_MAX_BURSTRES 600000 /* somewhat arbirary limit of 10 minutes */
52 #define ST_MAX_BURSTBUCKETS 100 /* somewhat arbirary limit - more buckets degrade performance */
53
54 struct epan_uat;
55 struct _e_addr_resolve;
56
57 /*
58  * Convert a string listing name resolution types to a bitmask of
59  * those types.
60  *
61  * Set "*name_resolve" to the bitmask, and return '\0', on success;
62  * return the bad character in the string on error.
63  */
64 WS_DLL_PUBLIC
65 char string_to_name_resolve(const char *string, struct _e_addr_resolve *name_resolve);
66
67 /*
68  * Modes for the starting directory in File Open dialogs.
69  */
70 #define FO_STYLE_LAST_OPENED    0 /* start in last directory we looked at */
71 #define FO_STYLE_SPECIFIED      1 /* start in specified directory */
72
73 /*
74  * Toolbar styles.
75  */
76 #define TB_STYLE_ICONS          0
77 #define TB_STYLE_TEXT           1
78 #define TB_STYLE_BOTH           2
79
80 /*
81  * Types of layout of summary/details/hex panes.
82  */
83 typedef enum {
84     layout_unused,  /* entry currently unused */
85     layout_type_5,
86     layout_type_2,
87     layout_type_1,
88     layout_type_4,
89     layout_type_3,
90     layout_type_6,
91     layout_type_max
92 } layout_type_e;
93
94 /*
95  * Types of pane.
96  */
97 typedef enum {
98     layout_pane_content_none,
99     layout_pane_content_plist,
100     layout_pane_content_pdetails,
101     layout_pane_content_pbytes
102 } layout_pane_content_e;
103
104 /*
105  * open console behaviour (win32 only)
106  */
107 typedef enum {
108     console_open_never,
109     console_open_auto,
110     console_open_always
111 } console_open_e;
112
113 /*
114  * Places version information will show up
115  */
116 typedef enum {
117     version_welcome_only,
118     version_title_only,
119     version_both,
120     version_neither
121 } version_info_e;
122
123 typedef enum {
124     pref_default,
125     pref_stashed,
126     pref_current
127 } pref_source_t;
128
129 typedef enum {
130     ELIDE_LEFT,
131     ELIDE_RIGHT,
132     ELIDE_MIDDLE,
133     ELIDE_NONE
134 } elide_mode_e;
135
136
137 /*
138  * Update channel.
139  */
140 typedef enum {
141     UPDATE_CHANNEL_DEVELOPMENT,
142     UPDATE_CHANNEL_STABLE
143 } software_update_channel_e;
144
145 typedef struct _e_prefs {
146   gint         pr_format;
147   gint         pr_dest;
148   gchar       *pr_file;
149   gchar       *pr_cmd;
150   GList       *col_list;
151   gint         num_cols;
152   color_t      st_client_fg, st_client_bg, st_server_fg, st_server_bg;
153   color_t      gui_text_valid, gui_text_invalid, gui_text_deprecated;
154   gboolean     gui_altern_colors;
155   gboolean     gui_expert_composite_eyecandy;
156   gboolean     filter_toolbar_show_in_statusbar;
157   gint         gui_ptree_line_style;
158   gint         gui_ptree_expander_style;
159   gboolean     gui_hex_dump_highlight_style;
160   gint         gui_toolbar_main_style;
161   gint         gui_toolbar_filter_style; /* GTK only? */
162   gchar       *gui_gtk2_font_name;
163   gchar       *gui_qt_font_name;
164   color_t      gui_marked_fg;
165   color_t      gui_marked_bg;
166   color_t      gui_ignored_fg;
167   color_t      gui_ignored_bg;
168   gchar       *gui_colorized_fg;
169   gchar       *gui_colorized_bg;
170   gboolean     gui_geometry_save_position;
171   gboolean     gui_geometry_save_size;
172   gboolean     gui_geometry_save_maximized;
173   gboolean     gui_macosx_style;
174   console_open_e gui_console_open;
175   guint        gui_recent_df_entries_max;
176   guint        gui_recent_files_count_max;
177   guint        gui_fileopen_style;
178   gchar       *gui_fileopen_dir;
179   guint        gui_fileopen_preview;
180   gboolean     gui_ask_unsaved;
181   gboolean     gui_find_wrap;
182   gboolean     gui_use_pref_save;
183   gchar       *gui_webbrowser;
184   gchar       *gui_window_title;
185   gchar       *gui_prepend_window_title;
186   gchar       *gui_start_title;
187   version_info_e gui_version_placement;
188   gboolean     gui_auto_scroll_on_expand;
189   guint        gui_auto_scroll_percentage;
190   layout_type_e gui_layout_type;
191   layout_pane_content_e gui_layout_content_1;
192   layout_pane_content_e gui_layout_content_2;
193   layout_pane_content_e gui_layout_content_3;
194   gint         console_log_level;
195   gchar       *capture_device;
196   gchar       *capture_devices_linktypes;
197   gchar       *capture_devices_descr;
198   gchar       *capture_devices_hide;
199   gchar       *capture_devices_monitor_mode;
200 #ifdef CAN_SET_CAPTURE_BUFFER_SIZE
201   gchar       *capture_devices_buffersize;
202 #endif
203   gchar       *capture_devices_snaplen;
204   gchar       *capture_devices_pmode;
205   gchar       *capture_devices_filter; /* XXX - Mostly unused. Deprecate? */
206   gboolean     capture_prom_mode;
207   gboolean     capture_pcap_ng;
208   gboolean     capture_real_time;
209   gboolean     capture_auto_scroll;
210   gboolean     capture_show_info;
211   GList       *capture_columns;
212   guint        rtp_player_max_visible;
213   guint        tap_update_interval;
214   gboolean     display_hidden_proto_items;
215   gboolean     display_byte_fields_with_spaces;
216   gboolean     enable_incomplete_dissectors_check;
217   gpointer     filter_expressions;/* Actually points to &head */
218   gboolean     gui_update_enabled;
219   software_update_channel_e gui_update_channel;
220   gint         gui_update_interval;
221   gchar       *saved_at_version;
222   gboolean     unknown_prefs; /* unknown or obsolete pref(s) */
223   gboolean     unknown_colorfilters; /* unknown or obsolete color filter(s) */
224   gboolean     gui_qt_packet_list_separator;
225   gboolean     gui_packet_editor; /* Enable Packet Editor */
226   elide_mode_e gui_packet_list_elide_mode;
227   gboolean     gui_packet_list_show_related;
228   gboolean     gui_packet_list_show_minimap;
229   gboolean     st_enable_burstinfo;
230   gboolean     st_burst_showcount;
231   gint         st_burst_resolution;
232   gint         st_burst_windowlen;
233   gboolean     st_sort_casesensitve;
234   gboolean     st_sort_rng_fixorder;
235   gboolean     st_sort_rng_nameonly;
236   gint         st_sort_defcolflag;
237   gboolean     st_sort_defdescending;
238   gboolean     st_sort_showfullname;
239 #ifdef HAVE_EXTCAP
240   gboolean     extcap_save_on_start;
241 #endif
242 } e_prefs;
243
244 WS_DLL_PUBLIC e_prefs prefs;
245
246 /*
247  * Routines to let modules that have preference settings register
248  * themselves by name, and to let them register preference settings
249  * by name.
250  */
251 struct pref_module;
252
253 struct pref_custom_cbs;
254
255 typedef struct pref_module module_t;
256
257 /** Sets up memory used by proto routines. Called at program startup */
258 void prefs_init(void);
259
260 /** Reset preferences to default values.  Called at profile change */
261 WS_DLL_PUBLIC void prefs_reset(void);
262
263 /** Frees memory used by proto routines. Called at program shutdown */
264 void prefs_cleanup(void);
265
266 /*
267  * Register a module that will have preferences.
268  * Specify the module under which to register it or NULL to register it
269  * at the top level, the name used for the module in the preferences file,
270  * the title used in the tab for it in a preferences dialog box, a
271  * routine to call back when we apply the preferences, and if it should
272  * use the GUI controls provided by the preferences or it has its own.
273  *
274  * This should not be used for dissector preferences;
275  * "prefs_register_protocol()" should be used for that, so that the
276  * preferences go under the "Protocols" subtree, and so that the
277  * name is the protocol name specified at the "proto_register_protocol()"
278  * call so that the "Protocol Properties..." menu item works.
279  */
280 WS_DLL_PUBLIC module_t *prefs_register_module(module_t *parent, const char *name,
281     const char *title, const char *description, void (*apply_cb)(void),
282     const gboolean use_gui);
283
284 /*
285  * Register a subtree that will have modules under it.
286  * Specify the module under which to register it or NULL to register it
287  * at the top level and the title used in the tab for it in a preferences
288  * dialog box.
289  */
290 WS_DLL_PUBLIC module_t *prefs_register_subtree(module_t *parent, const char *title,
291     const char *description, void (*apply_cb)(void));
292
293 /*
294  * Register that a protocol has preferences.
295  */
296 WS_DLL_PUBLIC module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
297
298 /**
299  * Deregister preferences from a protocol.
300  */
301 void prefs_deregister_protocol(int id);
302
303 /*
304  * Register that a statistical tap has preferences.
305  *
306  * "name" is a name for the tap to use on the command line with "-o"
307  * and in preference files.
308  *
309  * "title" is a short human-readable name for the tap.
310  *
311  * "description" is a longer human-readable description of the tap.
312  */
313 WS_DLL_PUBLIC module_t *prefs_register_stat(const char *name, const char *title,
314     const char *description, void (*apply_cb)(void));
315
316 /*
317  * Register that a protocol has preferences and group it under a single
318  * subtree
319  */
320 #define PREFERENCE_GROUPING
321 WS_DLL_PUBLIC module_t *prefs_register_protocol_subtree(const char *subtree, int id,
322     void (*apply_cb)(void));
323
324 /*
325  * Register that a protocol used to have preferences but no longer does,
326  * by creating an "obsolete" module for it.
327  */
328 module_t *prefs_register_protocol_obsolete(int id);
329
330 /*
331  * Callback function for module list scanners.
332  */
333 typedef guint (*module_cb)(module_t *module, gpointer user_data);
334
335 /*
336  * Returns TRUE if module has any submodules
337  */
338 WS_DLL_PUBLIC gboolean prefs_module_has_submodules(module_t *module);
339
340 /*
341  * Call a callback function, with a specified argument, for each module
342  * in the list of all modules.  (This list does not include subtrees.)
343  *
344  * Ignores "obsolete" modules; their sole purpose is to allow old
345  * preferences for dissectors that no longer have preferences to be
346  * silently ignored in preference files.
347  */
348 WS_DLL_PUBLIC guint prefs_modules_foreach(module_cb callback, gpointer user_data);
349
350 /*
351  * Call a callback function, with a specified argument, for each submodule
352  * of specified modules.  If the module is NULL, goes through the top-level
353  * list in the display tree of modules.
354  *
355  * Ignores "obsolete" modules; their sole purpose is to allow old
356  * preferences for dissectors that no longer have preferences to be
357  * silently ignored in preference files.  Does not ignore subtrees,
358  * as this can be used when walking the display tree of modules.
359  */
360 WS_DLL_PUBLIC guint prefs_modules_foreach_submodules(module_t *module, module_cb callback, gpointer user_data);
361
362 /*
363  * Call the "apply" callback function for each module if any of its
364  * preferences have changed, and then clear the flag saying its
365  * preferences have changed, as the module has been notified of that
366  * fact.
367  */
368 WS_DLL_PUBLIC void prefs_apply_all(void);
369
370 /*
371  * Call the "apply" callback function for a specific module if any of
372  * its preferences have changed, and then clear the flag saying its
373  * preferences have changed, as the module has been notified of that
374  * fact.
375  */
376 WS_DLL_PUBLIC void prefs_apply(module_t *module);
377
378
379 struct preference;
380
381 typedef struct preference pref_t;
382
383 /*
384  * Returns TRUE if the given protocol has registered preferences.
385  */
386 WS_DLL_PUBLIC gboolean prefs_is_registered_protocol(const char *name);
387
388 /*
389  * Returns the module title of a registered protocol (or NULL if unknown).
390  */
391 WS_DLL_PUBLIC const char *prefs_get_title_by_name(const char *name);
392
393 /** Given a module name, return a pointer to its pref_module struct,
394  * or NULL if it's not found.
395  *
396  * @param name The preference module name.  Usually the same as the protocol
397  * name, e.g. "tcp".
398  * @return A pointer to the corresponding preference module, or NULL if it
399  * wasn't found.
400  */
401 WS_DLL_PUBLIC module_t *prefs_find_module(const char *name);
402
403 /** Given a module name, and a preference name return a pointer to the given
404  * module's given preference or NULL if it's not found.
405  *
406  * @param module The preference module name.  Usually the same as the protocol
407  * name, e.g. "tcp".
408  * @param pref The preference name, e.g. "desegment".
409  * @return A pointer to the corresponding preference, or NULL if it
410  * wasn't found.
411  */
412 WS_DLL_PUBLIC pref_t *prefs_find_preference(module_t * module, const char *pref);
413
414 /*
415  * Register a preference with an unsigned integral value.
416  */
417 WS_DLL_PUBLIC void prefs_register_uint_preference(module_t *module, const char *name,
418     const char *title, const char *description, guint base, guint *var);
419
420 /*
421  * Register a preference with an Boolean value.
422  * Note that the name must be in lowercase letters only (underscore allowed).
423  */
424 WS_DLL_PUBLIC void prefs_register_bool_preference(module_t *module, const char *name,
425     const char *title, const char *description, gboolean *var);
426
427 /*
428  * Register a preference with an enumerated value.
429  */
430 WS_DLL_PUBLIC void prefs_register_enum_preference(module_t *module, const char *name,
431     const char *title, const char *description, gint *var,
432     const enum_val_t *enumvals, gboolean radio_buttons);
433
434 /*
435  * Register a preference with a character-string value.
436  */
437 WS_DLL_PUBLIC void prefs_register_string_preference(module_t *module, const char *name,
438     const char *title, const char *description, const char **var);
439
440 /*
441  * Register a preference with a file name (string) value.
442  * File name preferences are basically like string preferences
443  * except that the GUI gives the user the ability to browse for the
444  * file.
445  */
446 WS_DLL_PUBLIC void prefs_register_filename_preference(module_t *module, const char *name,
447     const char *title, const char *description, const char **var);
448
449 /*
450  * Register a preference with a directory name (string) value.
451  * Directory name preferences are basically like string preferences
452  * except that the GUI gives the user the ability to browse for a
453  * directory.
454  */
455 WS_DLL_PUBLIC void prefs_register_directory_preference(module_t *module, const char *name,
456     const char *title, const char *description, const char **var);
457
458 /*
459  * Register a preference with a ranged value.
460  */
461 WS_DLL_PUBLIC void prefs_register_range_preference(module_t *module, const char *name,
462     const char *title, const char *description, range_t **var,
463     guint32 max_value);
464
465 /*
466  * Register a static text 'preference'. It can be used to add some info/explanation.
467  */
468 WS_DLL_PUBLIC void prefs_register_static_text_preference(module_t *module, const char *name,
469     const char *title, const char *description);
470
471 /*
472  * Register a uat 'preference'. It adds a button that opens the uat's window in the
473  * preferences tab of the module.
474  */
475 WS_DLL_PUBLIC void prefs_register_uat_preference(module_t *module,
476     const char *name, const char* title, const char *description,  struct epan_uat* uat);
477
478 /*
479  * Register a uat 'preference' for QT only. It adds a button that opens the uat's window in the
480  * preferences tab of the module.
481  */
482 WS_DLL_PUBLIC void prefs_register_uat_preference_qt(module_t *module,
483     const char *name, const char* title, const char *description,  struct epan_uat* uat);
484
485
486 /*
487  * Register a color preference.  Currently does not have any "GUI Dialog" support
488  * so the color data needs to be managed independently.  Currently used by the
489  * "GUI preferences" to aid in reading/writing the preferences file, but the
490  * "data" is still managed by the specific "GUI preferences" dialog.
491  */
492 void prefs_register_color_preference(module_t *module, const char *name,
493     const char *title, const char *description, color_t *color);
494
495 /*
496  * Register a custom preference.  Currently does not have any "GUI Dialog" support
497  * so data needs to be managed independently.  Currently used by the
498  * "GUI preferences" to aid in reading/writing the preferences file, but the
499  * "data" is still managed by the specific "GUI preferences" dialog.
500  */
501 void prefs_register_custom_preference(module_t *module, const char *name,
502     const char *title, const char *description, struct pref_custom_cbs* custom_cbs,
503     void** custom_data);
504
505 /*
506  * Register a preference that used to be supported but no longer is.
507  */
508 WS_DLL_PUBLIC void prefs_register_obsolete_preference(module_t *module,
509     const char *name);
510
511
512 typedef guint (*pref_cb)(pref_t *pref, gpointer user_data);
513
514 /*
515  * Call a callback function, with a specified argument, for each preference
516  * in a given module.
517  *
518  * If any of the callbacks return a non-zero value, stop and return that
519  * value, otherwise return 0.
520  */
521 WS_DLL_PUBLIC guint prefs_pref_foreach(module_t *module, pref_cb callback,
522     gpointer user_data);
523
524 /* Parse through a list of comma-separated, possibly quoted strings.
525  *  Return a list of the string data.
526  */
527 WS_DLL_PUBLIC GList *prefs_get_string_list(const gchar *str);
528
529 /* Clear the given list of string data. */
530 WS_DLL_PUBLIC void prefs_clear_string_list(GList *sl);
531
532 /** Fetch a short preference type name, e.g. "Integer".
533  *
534  * @param pref A preference.
535  *
536  * @return The preference type name. May be NULL.
537  */
538 WS_DLL_PUBLIC
539 const char *prefs_pref_type_name(pref_t *pref);
540
541 /** Fetch a long description of the preference type
542  *
543  * @param pref A preference.
544  *
545  * @return A description of the preference type including allowed
546  * values for enums. The description may include newlines. Must be
547  * g_free()d.
548  */
549 WS_DLL_PUBLIC
550 char *prefs_pref_type_description(pref_t *pref);
551
552 /** Fetch a string representation of the preference.
553  *
554  * @param pref A preference.
555  * @param source Which value of the preference to return, see pref_source_t.
556  *
557  * @return A string representation of the preference. Must be g_free()d.
558  */
559 WS_DLL_PUBLIC
560 char *prefs_pref_to_str(pref_t *pref, pref_source_t source);
561
562 /* Read the preferences file, fill in "prefs", and return a pointer to it.
563
564    If we got an error (other than "it doesn't exist") trying to read
565    the global preferences file, stuff the errno into "*gpf_errno_return"
566    on an open error and into "*gpf_read_errno_return" on a read error,
567    stuff a pointer to the path of the file into "*gpf_path_return", and
568    return NULL.
569
570    If we got an error (other than "it doesn't exist") trying to read
571    the user's preferences file, stuff the errno into "*pf_errno_return"
572    on an open error and into "*pf_read_errno_return" on a read error,
573    stuff a pointer to the path of the file into "*pf_path_return", and
574    return NULL. */
575 WS_DLL_PUBLIC e_prefs *read_prefs(int *, int *, char **, int *, int *, char **);
576
577 /* Write out "prefs" to the user's preferences file, and return 0.
578
579    If we got an error, stuff a pointer to the path of the preferences file
580    into "*pf_path_return", and return the errno. */
581 WS_DLL_PUBLIC int write_prefs(char **);
582
583 /*
584  * Given a string of the form "<pref name>:<pref value>", as might appear
585  * as an argument to a "-o" option, parse it and set the preference in
586  * question.  Return an indication of whether it succeeded or failed
587  * in some fashion.
588  *
589  * XXX - should supply, for syntax errors, a detailed explanation of
590  * the syntax error.
591  */
592 typedef enum {
593     PREFS_SET_OK,               /* succeeded */
594     PREFS_SET_SYNTAX_ERR,       /* syntax error in string */
595     PREFS_SET_NO_SUCH_PREF,     /* no such preference */
596     PREFS_SET_OBSOLETE          /* preference used to exist but no longer does */
597 } prefs_set_pref_e;
598
599 WS_DLL_PUBLIC prefs_set_pref_e prefs_set_pref(char *prefarg);
600
601 /*
602  * Get or set a preference's obsolete status. These can be used to make a
603  * preference obsolete after startup so that we can fetch its value but
604  * keep it from showing up in the prefrences dialog.
605  */
606 gboolean prefs_get_preference_obsolete(pref_t *pref);
607 prefs_set_pref_e prefs_set_preference_obsolete(pref_t *pref);
608
609
610 /*
611  * Returns TRUE if the given device is hidden
612  */
613 WS_DLL_PUBLIC gboolean prefs_is_capture_device_hidden(const char *name);
614
615 /*
616  * Returns TRUE if the given device should capture in monitor mode by default
617  */
618 WS_DLL_PUBLIC gboolean prefs_capture_device_monitor_mode(const char *name);
619
620 WS_DLL_PUBLIC gboolean prefs_capture_options_dialog_column_is_visible(const gchar *column);
621
622 #ifdef __cplusplus
623 }
624 #endif /* __cplusplus */
625
626 #endif /* prefs.h */
627
628 /*
629  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
630  *
631  * Local variables:
632  * c-basic-offset: 4
633  * tab-width: 8
634  * indent-tabs-mode: nil
635  * End:
636  *
637  * vi: set shiftwidth=4 tabstop=8 expandtab:
638  * :indentSize=4:tabSize=8:noTabs=true:
639  */