2 * Definitions for preference handling routines
4 * $Id: prefs.h,v 1.27 2001/01/03 07:53:44 guy Exp $
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@zing.org>
8 * Copyright 1998 Gerald Combs
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
34 #define PR_DEST_FILE 1
36 typedef struct _e_prefs {
43 color_t st_client_fg, st_client_bg, st_server_fg, st_server_bg;
44 gboolean gui_scrollbar_on_right;
45 gboolean gui_plist_sel_browse;
46 gboolean gui_ptree_sel_browse;
47 gint gui_ptree_line_style;
48 gint gui_ptree_expander_style;
49 gboolean gui_hex_dump_highlight_style;
51 color_t gui_marked_fg;
52 color_t gui_marked_bg;
58 * Routines to let modules that have preference settings register
59 * themselves by name, and to let them register preference settings
64 typedef struct pref_module module_t;
67 * Register a module that will have preferences.
68 * Specify the name used for the module in the preferences file, the
69 * title used in the tab for it in a preferences dialog box, and a
70 * routine to call back when we apply the preferences.
72 * In case of dissectors, the specified name should be the protocol
73 * name specified at the proto_register_protocol() call in order to
74 * make the "Protocol Properties..." menu item work.
76 module_t *prefs_register_module(const char *name, const char *title,
77 void (*apply_cb)(void));
79 typedef void (*module_cb)(module_t *module, gpointer user_data);
82 * Register that a protocol has preferences.
84 module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
87 * Call a callback function, with a specified argument, for each module.
89 void prefs_module_foreach(module_cb callback, gpointer user_data);
92 * Call the "apply" callback function for each module if any of its
93 * preferences have changed, and then clear the flag saying its
94 * preferences have changed, as the module has been notified of that
97 void prefs_apply_all(void);
101 typedef struct preference pref_t;
104 * Returns TRUE if the given protocol has registered preferences
106 gboolean prefs_is_registered_protocol(char *name);
109 * Returns the module title of a registered protocol (or NULL if unknown)
111 const char *prefs_get_title_by_name(char *name);
114 * Register a preference with an unsigned integral value.
116 void prefs_register_uint_preference(module_t *module, const char *name,
117 const char *title, const char *description, guint base, guint *var);
120 * Register a preference with an Boolean value.
122 void prefs_register_bool_preference(module_t *module, const char *name,
123 const char *title, const char *description, gboolean *var);
126 * Register a preference with an enumerated value.
133 void prefs_register_enum_preference(module_t *module, const char *name,
134 const char *title, const char *description, gint *var,
135 const enum_val_t *enumvals, gboolean radio_buttons);
138 * Register a preference with a character-string value.
140 void prefs_register_string_preference(module_t *module, const char *name,
141 const char *title, const char *description, char **var);
143 typedef void (*pref_cb)(pref_t *pref, gpointer user_data);
146 * Call a callback function, with a specified argument, for each preference
149 void prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data);
152 * Register all non-dissector modules' preferences.
154 void prefs_register_modules(void);
156 /* Read the preferences file, fill in "prefs", and return a pointer to it.
158 If we got an error (other than "it doesn't exist") trying to read
159 the global preferences file, stuff the errno into "*gpf_errno_return"
160 and a pointer to the path of the file into "*gpf_path_return", and
163 If we got an error (other than "it doesn't exist") trying to read
164 the user's preferences file, stuff the errno into "*pf_errno_return"
165 and a pointer to the path of the file into "*pf_path_return", and
167 e_prefs *read_prefs(int *, char **, int *, char **);
169 /* Write out "prefs" to the user's preferences file, and return 0.
171 If we got an error, stuff a pointer to the path of the preferences file
172 into "*pf_path_return", and return the errno. */
173 int write_prefs(char **);
175 /* Copy a set of preferences. */
176 void copy_prefs(e_prefs *dest, e_prefs *src);
178 /* Free a set of preferences. */
179 void free_prefs(e_prefs *pr);
182 * Given a string of the form "<pref name>:<pref value>", as might appear
183 * as an argument to a "-o" option, parse it and set the preference in
184 * question. Return an indication of whether it succeeded or failed
187 #define PREFS_SET_OK 0 /* succeeded */
188 #define PREFS_SET_SYNTAX_ERR 1 /* syntax error in string */
189 #define PREFS_SET_NO_SUCH_PREF 2 /* no such preference */
191 int prefs_set_pref(char *prefarg);