2 * Definitions for preference handling routines
4 * $Id: prefs.h,v 1.50 2003/10/22 22:13:12 guy Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
33 #define PR_DEST_FILE 1
36 #define DEF_HEIGHT 550
38 #define MAX_VAL_LEN 1024
41 * Convert a string listing name resolution types to a bitmask of
44 * Set "*name_resolve" to the bitmask, and return '\0', on success;
45 * return the bad character in the string on error.
47 char string_to_name_resolve(char *string, guint32 *name_resolve);
50 * Modes for the starting directory in File Open dialogs.
52 #define FO_STYLE_LAST_OPENED 0 /* start in last directory we looked at */
53 #define FO_STYLE_SPECIFIED 1 /* start in specified directory */
58 #define TB_STYLE_ICONS 0
59 #define TB_STYLE_TEXT 1
60 #define TB_STYLE_BOTH 2
62 typedef struct _e_prefs {
69 color_t st_client_fg, st_client_bg, st_server_fg, st_server_bg;
70 gboolean gui_scrollbar_on_right;
71 gboolean gui_plist_sel_browse;
72 gboolean gui_ptree_sel_browse;
73 gboolean gui_altern_colors;
74 gint gui_ptree_line_style;
75 gint gui_ptree_expander_style;
76 gboolean gui_hex_dump_highlight_style;
77 gboolean gui_toolbar_main_show;
78 gint gui_toolbar_main_style;
80 color_t gui_marked_fg;
81 color_t gui_marked_bg;
82 gboolean gui_geometry_save_position;
83 gboolean gui_geometry_save_size;
84 gint gui_geometry_main_x;
85 gint gui_geometry_main_y;
86 gint gui_geometry_main_width;
87 gint gui_geometry_main_height;
88 gint gui_fileopen_style;
89 gchar *gui_fileopen_dir;
90 gchar *gui_fileopen_remembered_dir;
92 gint name_resolve_concurrency;
93 gchar *capture_device;
94 gchar *capture_devices_descr;
95 gchar *capture_devices_hide;
96 gboolean capture_prom_mode;
97 gboolean capture_real_time;
98 gboolean capture_auto_scroll;
101 extern e_prefs prefs;
104 * Routines to let modules that have preference settings register
105 * themselves by name, and to let them register preference settings
110 typedef struct pref_module module_t;
113 * Register a module that will have preferences.
114 * Specify the module under which to register it or NULL to register it
115 * at the top level, the name used for the module in the preferences file,
116 * the title used in the tab for it in a preferences dialog box, and a
117 * routine to call back when we apply the preferences.
119 * This should not be used for dissector preferences;
120 * "prefs_register_protocol()" should be used for that, so that the
121 * preferences go under the "Protocols" subtree, and so that the
122 * name is the protocol name specified at the "proto_register_protocol()"
123 * call so that the "Protocol Properties..." menu item works.
125 extern module_t *prefs_register_module(module_t *parent, const char *name,
126 const char *title, void (*apply_cb)(void));
129 * Register a subtree that will have modules under it.
130 * Specify the module under which to register it or NULL to register it
131 * at the top level and the title used in the tab for it in a preferences
134 extern module_t *prefs_register_subtree(module_t *parent, const char *title);
137 * Register that a protocol has preferences.
139 extern module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
142 * Register that a protocol used to have preferences but no longer does,
143 * by creating an "obsolete" module for it.
145 extern module_t *prefs_register_protocol_obsolete(int id);
148 * Callback function for module list scanners.
150 typedef void (*module_cb)(module_t *module, gpointer user_data);
153 * Call a callback function, with a specified argument, for each module
154 * in a list of modules. If the list is NULL, searches the top-level
155 * list in the display tree of modules.
157 * Ignores "obsolete" modules; their sole purpose is to allow old
158 * preferences for dissectors that no longer have preferences to be
159 * silently ignored in preference files. Does not ignore subtrees,
160 * as this can be used when walking the display tree of modules.
162 extern void prefs_module_list_foreach(GList *module_list, module_cb callback,
166 * Call a callback function, with a specified argument, for each module
167 * in the list of all modules. (This list does not include subtrees.)
169 * Ignores "obsolete" modules; their sole purpose is to allow old
170 * preferences for dissectors that no longer have preferences to be
171 * silently ignored in preference files.
173 extern void prefs_modules_foreach(module_cb callback, gpointer user_data);
176 * Call the "apply" callback function for each module if any of its
177 * preferences have changed, and then clear the flag saying its
178 * preferences have changed, as the module has been notified of that
181 extern void prefs_apply_all(void);
185 typedef struct preference pref_t;
188 * Returns TRUE if the given protocol has registered preferences.
190 extern gboolean prefs_is_registered_protocol(char *name);
193 * Returns the module title of a registered protocol (or NULL if unknown).
195 extern const char *prefs_get_title_by_name(char *name);
198 * Register a preference with an unsigned integral value.
200 extern void prefs_register_uint_preference(module_t *module, const char *name,
201 const char *title, const char *description, guint base, guint *var);
204 * Register a preference with an Boolean value.
206 extern void prefs_register_bool_preference(module_t *module, const char *name,
207 const char *title, const char *description, gboolean *var);
210 * Register a preference with an enumerated value.
217 extern void prefs_register_enum_preference(module_t *module, const char *name,
218 const char *title, const char *description, gint *var,
219 const enum_val_t *enumvals, gboolean radio_buttons);
222 * Register a preference with a character-string value.
224 extern void prefs_register_string_preference(module_t *module, const char *name,
225 const char *title, const char *description, char **var);
228 * Register a preference that used to be supported but no longer is.
230 extern void prefs_register_obsolete_preference(module_t *module,
233 typedef guint (*pref_cb)(pref_t *pref, gpointer user_data);
236 * Call a callback function, with a specified argument, for each preference
239 * If any of the callbacks return a non-zero value, stop and return that
240 * value, otherwise return 0.
242 extern guint prefs_pref_foreach(module_t *module, pref_cb callback,
246 * Register all non-dissector modules' preferences.
248 extern void prefs_register_modules(void);
250 /* Read the preferences file, fill in "prefs", and return a pointer to it.
252 If we got an error (other than "it doesn't exist") trying to read
253 the global preferences file, stuff the errno into "*gpf_errno_return"
254 on an open error and into "*gpf_read_errno_return" on a read error,
255 stuff a pointer to the path of the file into "*gpf_path_return", and
258 If we got an error (other than "it doesn't exist") trying to read
259 the user's preferences file, stuff the errno into "*pf_errno_return"
260 on an open error and into "*pf_read_errno_return" on a read error,
261 stuff a pointer to the path of the file into "*pf_path_return", and
263 extern e_prefs *read_prefs(int *, int *, char **, int *, int *, char **);
265 /* Write out "prefs" to the user's preferences file, and return 0.
267 If we got an error, stuff a pointer to the path of the preferences file
268 into "*pf_path_return", and return the errno. */
269 extern int write_prefs(char **);
271 /* Copy a set of preferences. */
272 extern void copy_prefs(e_prefs *dest, e_prefs *src);
274 /* Free a set of preferences. */
275 extern void free_prefs(e_prefs *pr);
278 * Given a string of the form "<pref name>:<pref value>", as might appear
279 * as an argument to a "-o" option, parse it and set the preference in
280 * question. Return an indication of whether it succeeded or failed
283 * XXX - should supply, for syntax errors, a detailed explanation of
286 #define PREFS_SET_OK 0 /* succeeded */
287 #define PREFS_SET_SYNTAX_ERR 1 /* syntax error in string */
288 #define PREFS_SET_NO_SUCH_PREF 2 /* no such preference */
289 #define PREFS_SET_OBSOLETE 3 /* preference used to exist but no longer does */
291 extern int prefs_set_pref(char *prefarg);