prefs.h

   1 /* prefs.h
   2  * Definitions for preference handling routines
   3  *
   4  * $Id: prefs.h,v 1.64 2004/05/24 02:25:20 guy Exp $
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  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.
  14  *
  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.
  19  *
  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.
  23  */
  24
  25 #ifndef __PREFS_H__
  26 #define __PREFS_H__
  27
  28 #include <glib.h>
  29
  30 #include "color.h"
  31
  32 #define PR_DEST_CMD  0
  33 #define PR_DEST_FILE 1
  34
  35 #define DEF_WIDTH 750
  36 #define DEF_HEIGHT 550
  37
  38 #define MAX_VAL_LEN  1024
  39
  40 /* only GTK1 *or* GTK2 font_name should be used */
  41 #if GTK_MAJOR_VERSION < 2
  42 #define PREFS_GUI_FONT_NAME gui_font_name1
  43 #else
  44 #define PREFS_GUI_FONT_NAME gui_font_name2
  45 #endif
  46
  47 /*
  48  * Convert a string listing name resolution types to a bitmask of
  49  * those types.
  50  *
  51  * Set "*name_resolve" to the bitmask, and return '\0', on success;
  52  * return the bad character in the string on error.
  53  */
  54 char string_to_name_resolve(char *string, guint32 *name_resolve);
  55
  56 /*
  57  * Modes for the starting directory in File Open dialogs.
  58  */
  59 #define FO_STYLE_LAST_OPENED    0       /* start in last directory we looked at */
  60 #define FO_STYLE_SPECIFIED      1       /* start in specified directory */
  61
  62 /*
  63  * Toolbar styles.
  64  */
  65 #define TB_STYLE_ICONS          0
  66 #define TB_STYLE_TEXT           1
  67 #define TB_STYLE_BOTH           2
  68
  69 /*
  70  * Types of layout of summary/details/hex panes.
  71  */
  72 typedef enum {
  73     layout_unused,  /* entry currently unused */
  74     layout_type_5,
  75     layout_type_2,
  76     layout_type_1,
  77     layout_type_4,
  78     layout_type_3,
  79     layout_type_6,
  80     layout_type_max
  81 } layout_type_e;
  82
  83 /*
  84  * Types of pane.
  85  */
  86 typedef enum {
  87     layout_pane_content_none,
  88     layout_pane_content_plist,
  89     layout_pane_content_pdetails,
  90     layout_pane_content_pbytes
  91 } layout_pane_content_e;
  92
  93 /*
  94  * open console behaviour (win32 only)
  95  */
  96 typedef enum {
  97     console_open_never,
  98     console_open_auto,
  99     console_open_always
 100 } console_open_e;
 101
 102
 103 typedef struct _e_prefs {
 104   gint     pr_format;
 105   gint     pr_dest;
 106   gchar   *pr_file;
 107   gchar   *pr_cmd;
 108   GList   *col_list;
 109   gint     num_cols;
 110   color_t  st_client_fg, st_client_bg, st_server_fg, st_server_bg;
 111   gboolean gui_scrollbar_on_right;
 112   gboolean gui_plist_sel_browse;
 113   gboolean gui_ptree_sel_browse;
 114   gboolean gui_altern_colors;
 115   gboolean filter_toolbar_show_in_statusbar;
 116   gint     gui_ptree_line_style;
 117   gint     gui_ptree_expander_style;
 118   gboolean gui_hex_dump_highlight_style;
 119   gint     gui_toolbar_main_style;
 120   gchar   *gui_font_name1;
 121   gchar   *gui_font_name2;
 122   color_t  gui_marked_fg;
 123   color_t  gui_marked_bg;
 124   gboolean gui_geometry_save_position;
 125   gboolean gui_geometry_save_size;
 126   gboolean gui_geometry_save_maximized;
 127   console_open_e gui_console_open;
 128   guint    gui_fileopen_style;
 129   guint    gui_recent_files_count_max;
 130   gchar    *gui_fileopen_dir;
 131   layout_type_e gui_layout_type;
 132   layout_pane_content_e gui_layout_content_1;
 133   layout_pane_content_e gui_layout_content_2;
 134   layout_pane_content_e gui_layout_content_3;
 135   guint32  name_resolve;
 136   gint     name_resolve_concurrency;
 137   gchar   *capture_device;
 138   gchar   *capture_devices_descr;
 139   gchar   *capture_devices_hide;
 140   gboolean capture_prom_mode;
 141   gboolean capture_real_time;
 142   gboolean capture_auto_scroll;
 143 } e_prefs;
 144
 145 ETH_VAR_IMPORT e_prefs prefs;
 146
 147 /*
 148  * Routines to let modules that have preference settings register
 149  * themselves by name, and to let them register preference settings
 150  * by name.
 151  */
 152 struct pref_module;
 153
 154 typedef struct pref_module module_t;
 155
 156 /*
 157  * Register a module that will have preferences.
 158  * Specify the module under which to register it or NULL to register it
 159  * at the top level, the name used for the module in the preferences file,
 160  * the title used in the tab for it in a preferences dialog box, and a
 161  * routine to call back when we apply the preferences.
 162  *
 163  * This should not be used for dissector preferences;
 164  * "prefs_register_protocol()" should be used for that, so that the
 165  * preferences go under the "Protocols" subtree, and so that the
 166  * name is the protocol name specified at the "proto_register_protocol()"
 167  * call so that the "Protocol Properties..." menu item works.
 168  */
 169 extern module_t *prefs_register_module(module_t *parent, const char *name,
 170     const char *title, void (*apply_cb)(void));
 171
 172 /*
 173  * Register a subtree that will have modules under it.
 174  * Specify the module under which to register it or NULL to register it
 175  * at the top level and the title used in the tab for it in a preferences
 176  * dialog box.
 177  */
 178 extern module_t *prefs_register_subtree(module_t *parent, const char *title);
 179
 180 /*
 181  * Register that a protocol has preferences.
 182  */
 183 extern module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
 184
 185 /*
 186  * Register that a protocol used to have preferences but no longer does,
 187  * by creating an "obsolete" module for it.
 188  */
 189 extern module_t *prefs_register_protocol_obsolete(int id);
 190
 191 /*
 192  * Callback function for module list scanners.
 193  */
 194 typedef void (*module_cb)(module_t *module, gpointer user_data);
 195
 196 /*
 197  * Call a callback function, with a specified argument, for each module
 198  * in a list of modules.  If the list is NULL, searches the top-level
 199  * list in the display tree of modules.
 200  *
 201  * Ignores "obsolete" modules; their sole purpose is to allow old
 202  * preferences for dissectors that no longer have preferences to be
 203  * silently ignored in preference files.  Does not ignore subtrees,
 204  * as this can be used when walking the display tree of modules.
 205  */
 206 extern void prefs_module_list_foreach(GList *module_list, module_cb callback,
 207     gpointer user_data);
 208
 209 /*
 210  * Call a callback function, with a specified argument, for each module
 211  * in the list of all modules.  (This list does not include subtrees.)
 212  *
 213  * Ignores "obsolete" modules; their sole purpose is to allow old
 214  * preferences for dissectors that no longer have preferences to be
 215  * silently ignored in preference files.
 216  */
 217 extern void prefs_modules_foreach(module_cb callback, gpointer user_data);
 218
 219 /*
 220  * Call the "apply" callback function for each module if any of its
 221  * preferences have changed, and then clear the flag saying its
 222  * preferences have changed, as the module has been notified of that
 223  * fact.
 224  */
 225 extern void prefs_apply_all(void);
 226
 227 struct preference;
 228
 229 typedef struct preference pref_t;
 230
 231 /*
 232  * Returns TRUE if the given protocol has registered preferences.
 233  */
 234 extern gboolean prefs_is_registered_protocol(char *name);
 235
 236 /*
 237  * Returns the module title of a registered protocol (or NULL if unknown).
 238  */
 239 extern const char *prefs_get_title_by_name(char *name);
 240
 241 /*
 242  * Register a preference with an unsigned integral value.
 243  */
 244 extern void prefs_register_uint_preference(module_t *module, const char *name,
 245     const char *title, const char *description, guint base, guint *var);
 246
 247 /*
 248  * Register a preference with an Boolean value.
 249  */
 250 extern void prefs_register_bool_preference(module_t *module, const char *name,
 251     const char *title, const char *description, gboolean *var);
 252
 253 /*
 254  * Register a preference with an enumerated value.
 255  */
 256 typedef struct {
 257         char    *name;
 258         char    *description;
 259         gint    value;
 260 } enum_val_t;
 261
 262 extern void prefs_register_enum_preference(module_t *module, const char *name,
 263     const char *title, const char *description, gint *var,
 264     const enum_val_t *enumvals, gboolean radio_buttons);
 265
 266 /*
 267  * Register a preference with a character-string value.
 268  */
 269 extern void prefs_register_string_preference(module_t *module, const char *name,
 270     const char *title, const char *description, char **var);
 271
 272 /*
 273  * Register a preference that used to be supported but no longer is.
 274  */
 275 extern void prefs_register_obsolete_preference(module_t *module,
 276     const char *name);
 277
 278 typedef guint (*pref_cb)(pref_t *pref, gpointer user_data);
 279
 280 /*
 281  * Call a callback function, with a specified argument, for each preference
 282  * in a given module.
 283  *
 284  * If any of the callbacks return a non-zero value, stop and return that
 285  * value, otherwise return 0.
 286  */
 287 extern guint prefs_pref_foreach(module_t *module, pref_cb callback,
 288     gpointer user_data);
 289
 290 /*
 291  * Register all non-dissector modules' preferences.
 292  */
 293 extern void prefs_register_modules(void);
 294
 295 /* Read the preferences file, fill in "prefs", and return a pointer to it.
 296
 297    If we got an error (other than "it doesn't exist") trying to read
 298    the global preferences file, stuff the errno into "*gpf_errno_return"
 299    on an open error and into "*gpf_read_errno_return" on a read error,
 300    stuff a pointer to the path of the file into "*gpf_path_return", and
 301    return NULL.
 302
 303    If we got an error (other than "it doesn't exist") trying to read
 304    the user's preferences file, stuff the errno into "*pf_errno_return"
 305    on an open error and into "*pf_read_errno_return" on a read error,
 306    stuff a pointer to the path of the file into "*pf_path_return", and
 307    return NULL. */
 308 extern e_prefs *read_prefs(int *, int *, char **, int *, int *, char **);
 309
 310 /* Write out "prefs" to the user's preferences file, and return 0.
 311
 312    If we got an error, stuff a pointer to the path of the preferences file
 313    into "*pf_path_return", and return the errno. */
 314 extern int write_prefs(char **);
 315
 316 /* Copy a set of preferences. */
 317 extern void copy_prefs(e_prefs *dest, e_prefs *src);
 318
 319 /* Free a set of preferences. */
 320 extern void free_prefs(e_prefs *pr);
 321
 322 /*
 323  * Given a string of the form "<pref name>:<pref value>", as might appear
 324  * as an argument to a "-o" option, parse it and set the preference in
 325  * question.  Return an indication of whether it succeeded or failed
 326  * in some fashion.
 327  *
 328  * XXX - should supply, for syntax errors, a detailed explanation of
 329  * the syntax error.
 330  */
 331 #define PREFS_SET_OK            0       /* succeeded */
 332 #define PREFS_SET_SYNTAX_ERR    1       /* syntax error in string */
 333 #define PREFS_SET_NO_SUCH_PREF  2       /* no such preference */
 334 #define PREFS_SET_OBSOLETE      3       /* preference used to exist but no longer does */
 335
 336 extern int prefs_set_pref(char *prefarg);
 337
 338 #endif /* prefs.h */