2 * Definitions for preference handling routines
4 * $Id: prefs.h,v 1.37 2002/01/13 20:35:08 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
39 * Convert a string listing name resolution types to a bitmask of
42 * Set "*name_resolve" to the bitmask, and return '\0', on success;
43 * return the bad character in the string on error.
45 char string_to_name_resolve(char *string, guint32 *name_resolve);
47 typedef struct _e_prefs {
54 color_t st_client_fg, st_client_bg, st_server_fg, st_server_bg;
55 gboolean gui_scrollbar_on_right;
56 gboolean gui_plist_sel_browse;
57 gboolean gui_ptree_sel_browse;
58 gint gui_ptree_line_style;
59 gint gui_ptree_expander_style;
60 gboolean gui_hex_dump_highlight_style;
62 color_t gui_marked_fg;
63 color_t gui_marked_bg;
64 gboolean gui_geometry_save_position;
65 gboolean gui_geometry_save_size;
66 gint gui_geometry_main_x;
67 gint gui_geometry_main_y;
68 gint gui_geometry_main_width;
69 gint gui_geometry_main_height;
71 gchar *capture_device;
72 gboolean capture_prom_mode;
73 gboolean capture_real_time;
74 gboolean capture_auto_scroll;
80 * Routines to let modules that have preference settings register
81 * themselves by name, and to let them register preference settings
86 typedef struct pref_module module_t;
89 * Register a module that will have preferences.
90 * Specify the name used for the module in the preferences file, the
91 * title used in the tab for it in a preferences dialog box, and a
92 * routine to call back when we apply the preferences.
94 * In case of dissectors, the specified name should be the protocol
95 * name specified at the proto_register_protocol() call in order to
96 * make the "Protocol Properties..." menu item work.
98 extern module_t *prefs_register_module(const char *name, const char *title,
99 void (*apply_cb)(void));
101 typedef void (*module_cb)(module_t *module, gpointer user_data);
104 * Register that a protocol has preferences.
106 extern module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
109 * Call a callback function, with a specified argument, for each module.
111 extern void prefs_module_foreach(module_cb callback, gpointer user_data);
114 * Call the "apply" callback function for each module if any of its
115 * preferences have changed, and then clear the flag saying its
116 * preferences have changed, as the module has been notified of that
119 extern void prefs_apply_all(void);
123 typedef struct preference pref_t;
126 * Returns TRUE if the given protocol has registered preferences.
128 extern gboolean prefs_is_registered_protocol(char *name);
131 * Returns the module title of a registered protocol (or NULL if unknown).
133 extern const char *prefs_get_title_by_name(char *name);
136 * Register a preference with an unsigned integral value.
138 extern void prefs_register_uint_preference(module_t *module, const char *name,
139 const char *title, const char *description, guint base, guint *var);
142 * Register a preference with an Boolean value.
144 extern void prefs_register_bool_preference(module_t *module, const char *name,
145 const char *title, const char *description, gboolean *var);
148 * Register a preference with an enumerated value.
155 extern void prefs_register_enum_preference(module_t *module, const char *name,
156 const char *title, const char *description, gint *var,
157 const enum_val_t *enumvals, gboolean radio_buttons);
160 * Register a preference with a character-string value.
162 extern void prefs_register_string_preference(module_t *module, const char *name,
163 const char *title, const char *description, char **var);
166 * Register a preference that used to be supported but no longer is.
168 extern void prefs_register_obsolete_preference(module_t *module,
171 typedef void (*pref_cb)(pref_t *pref, gpointer user_data);
174 * Call a callback function, with a specified argument, for each preference
177 extern void prefs_pref_foreach(module_t *module, pref_cb callback,
181 * Register all non-dissector modules' preferences.
183 extern void prefs_register_modules(void);
185 /* Read the preferences file, fill in "prefs", and return a pointer to it.
187 If we got an error (other than "it doesn't exist") trying to read
188 the global preferences file, stuff the errno into "*gpf_errno_return"
189 and a pointer to the path of the file into "*gpf_path_return", and
192 If we got an error (other than "it doesn't exist") trying to read
193 the user's preferences file, stuff the errno into "*pf_errno_return"
194 and a pointer to the path of the file into "*pf_path_return", and
196 extern e_prefs *read_prefs(int *, char **, int *, const char **);
198 /* Write out "prefs" to the user's preferences file, and return 0.
200 If we got an error, stuff a pointer to the path of the preferences file
201 into "*pf_path_return", and return the errno. */
202 extern int write_prefs(const char **);
204 /* Copy a set of preferences. */
205 extern void copy_prefs(e_prefs *dest, e_prefs *src);
207 /* Free a set of preferences. */
208 extern void free_prefs(e_prefs *pr);
211 * Given a string of the form "<pref name>:<pref value>", as might appear
212 * as an argument to a "-o" option, parse it and set the preference in
213 * question. Return an indication of whether it succeeded or failed
216 * XXX - should supply, for syntax errors, a detailed explanation of
219 #define PREFS_SET_OK 0 /* succeeded */
220 #define PREFS_SET_SYNTAX_ERR 1 /* syntax error in string */
221 #define PREFS_SET_NO_SUCH_PREF 2 /* no such preference */
222 #define PREFS_SET_OBSOLETE 3 /* preference used to exist but no longer does */
224 extern int prefs_set_pref(char *prefarg);