epan/prefs.h

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