diff options
Diffstat (limited to 'epan/prefs.h')
| -rw-r--r-- | epan/prefs.h | 343 |
1 files changed, 343 insertions, 0 deletions
diff --git a/epan/prefs.h b/epan/prefs.h new file mode 100644 index 0000000000..8f2c274fc1 --- /dev/null +++ b/epan/prefs.h @@ -0,0 +1,343 @@ +/* prefs.h + * Definitions for preference handling routines + * + * $Id$ + * + * Ethereal - Network traffic analyzer + * By Gerald Combs <gerald@ethereal.com> + * Copyright 1998 Gerald Combs + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + */ + +#ifndef __PREFS_H__ +#define __PREFS_H__ + +#include <glib.h> + +#include "color.h" + +#define PR_DEST_CMD 0 +#define PR_DEST_FILE 1 + +#define DEF_WIDTH 750 +#define DEF_HEIGHT 550 + +#define MAX_VAL_LEN 1024 + +/* only GTK1 *or* GTK2 font_name should be used */ +#if GTK_MAJOR_VERSION < 2 +#define PREFS_GUI_FONT_NAME gui_font_name1 +#else +#define PREFS_GUI_FONT_NAME gui_font_name2 +#endif + +/* + * Convert a string listing name resolution types to a bitmask of + * those types. + * + * Set "*name_resolve" to the bitmask, and return '\0', on success; + * return the bad character in the string on error. + */ +char string_to_name_resolve(char *string, guint32 *name_resolve); + +/* + * Modes for the starting directory in File Open dialogs. + */ +#define FO_STYLE_LAST_OPENED 0 /* start in last directory we looked at */ +#define FO_STYLE_SPECIFIED 1 /* start in specified directory */ + +/* + * Toolbar styles. + */ +#define TB_STYLE_ICONS 0 +#define TB_STYLE_TEXT 1 +#define TB_STYLE_BOTH 2 + +/* + * Types of layout of summary/details/hex panes. + */ +typedef enum { + layout_unused, /* entry currently unused */ + layout_type_5, + layout_type_2, + layout_type_1, + layout_type_4, + layout_type_3, + layout_type_6, + layout_type_max +} layout_type_e; + +/* + * Types of pane. + */ +typedef enum { + layout_pane_content_none, + layout_pane_content_plist, + layout_pane_content_pdetails, + layout_pane_content_pbytes +} layout_pane_content_e; + +/* + * open console behaviour (win32 only) + */ +typedef enum { + console_open_never, + console_open_auto, + console_open_always +} console_open_e; + + +typedef struct _e_prefs { + gint pr_format; + gint pr_dest; + gchar *pr_file; + gchar *pr_cmd; + GList *col_list; + gint num_cols; + color_t st_client_fg, st_client_bg, st_server_fg, st_server_bg; + gboolean gui_scrollbar_on_right; + gboolean gui_plist_sel_browse; + gboolean gui_ptree_sel_browse; + gboolean gui_altern_colors; + gboolean filter_toolbar_show_in_statusbar; + gint gui_ptree_line_style; + gint gui_ptree_expander_style; + gboolean gui_hex_dump_highlight_style; + gint gui_toolbar_main_style; + gchar *gui_font_name1; + gchar *gui_font_name2; + color_t gui_marked_fg; + color_t gui_marked_bg; + gboolean gui_geometry_save_position; + gboolean gui_geometry_save_size; + gboolean gui_geometry_save_maximized; + console_open_e gui_console_open; + guint gui_recent_files_count_max; + guint gui_fileopen_style; + gchar *gui_fileopen_dir; + guint gui_fileopen_preview; + gboolean gui_ask_unsaved; + gboolean gui_find_wrap; + gchar *gui_webbrowser; + layout_type_e gui_layout_type; + layout_pane_content_e gui_layout_content_1; + layout_pane_content_e gui_layout_content_2; + layout_pane_content_e gui_layout_content_3; + guint32 name_resolve; + gint name_resolve_concurrency; + gchar *capture_device; + gchar *capture_devices_descr; + gchar *capture_devices_hide; + gboolean capture_prom_mode; + gboolean capture_real_time; + gboolean capture_auto_scroll; + gboolean capture_show_info; +} e_prefs; + +ETH_VAR_IMPORT e_prefs prefs; + +/* + * Routines to let modules that have preference settings register + * themselves by name, and to let them register preference settings + * by name. + */ +struct pref_module; + +typedef struct pref_module module_t; + +/* + * Register a module that will have preferences. + * Specify the module under which to register it or NULL to register it + * at the top level, the name used for the module in the preferences file, + * the title used in the tab for it in a preferences dialog box, and a + * routine to call back when we apply the preferences. + * + * This should not be used for dissector preferences; + * "prefs_register_protocol()" should be used for that, so that the + * preferences go under the "Protocols" subtree, and so that the + * name is the protocol name specified at the "proto_register_protocol()" + * call so that the "Protocol Properties..." menu item works. + */ +extern module_t *prefs_register_module(module_t *parent, const char *name, + const char *title, void (*apply_cb)(void)); + +/* + * Register a subtree that will have modules under it. + * Specify the module under which to register it or NULL to register it + * at the top level and the title used in the tab for it in a preferences + * dialog box. + */ +extern module_t *prefs_register_subtree(module_t *parent, const char *title); + +/* + * Register that a protocol has preferences. + */ +extern module_t *prefs_register_protocol(int id, void (*apply_cb)(void)); + +/* + * Register that a protocol used to have preferences but no longer does, + * by creating an "obsolete" module for it. + */ +extern module_t *prefs_register_protocol_obsolete(int id); + +/* + * Callback function for module list scanners. + */ +typedef void (*module_cb)(module_t *module, gpointer user_data); + +/* + * Call a callback function, with a specified argument, for each module + * in a list of modules. If the list is NULL, searches the top-level + * list in the display tree of modules. + * + * Ignores "obsolete" modules; their sole purpose is to allow old + * preferences for dissectors that no longer have preferences to be + * silently ignored in preference files. Does not ignore subtrees, + * as this can be used when walking the display tree of modules. + */ +extern void prefs_module_list_foreach(GList *module_list, module_cb callback, + gpointer user_data); + +/* + * Call a callback function, with a specified argument, for each module + * in the list of all modules. (This list does not include subtrees.) + * + * Ignores "obsolete" modules; their sole purpose is to allow old + * preferences for dissectors that no longer have preferences to be + * silently ignored in preference files. + */ +extern void prefs_modules_foreach(module_cb callback, gpointer user_data); + +/* + * Call the "apply" callback function for each module if any of its + * preferences have changed, and then clear the flag saying its + * preferences have changed, as the module has been notified of that + * fact. + */ +extern void prefs_apply_all(void); + +struct preference; + +typedef struct preference pref_t; + +/* + * Returns TRUE if the given protocol has registered preferences. + */ +extern gboolean prefs_is_registered_protocol(char *name); + +/* + * Returns the module title of a registered protocol (or NULL if unknown). + */ +extern const char *prefs_get_title_by_name(char *name); + +/* + * Register a preference with an unsigned integral value. + */ +extern void prefs_register_uint_preference(module_t *module, const char *name, + const char *title, const char *description, guint base, guint *var); + +/* + * Register a preference with an Boolean value. + */ +extern void prefs_register_bool_preference(module_t *module, const char *name, + const char *title, const char *description, gboolean *var); + +/* + * Register a preference with an enumerated value. + */ +typedef struct { + char *name; + char *description; + gint value; +} enum_val_t; + +extern void prefs_register_enum_preference(module_t *module, const char *name, + const char *title, const char *description, gint *var, + const enum_val_t *enumvals, gboolean radio_buttons); + +/* + * Register a preference with a character-string value. + */ +extern void prefs_register_string_preference(module_t *module, const char *name, + const char *title, const char *description, char **var); + +/* + * Register a preference that used to be supported but no longer is. + */ +extern void prefs_register_obsolete_preference(module_t *module, + const char *name); + +typedef guint (*pref_cb)(pref_t *pref, gpointer user_data); + +/* + * Call a callback function, with a specified argument, for each preference + * in a given module. + * + * If any of the callbacks return a non-zero value, stop and return that + * value, otherwise return 0. + */ +extern guint prefs_pref_foreach(module_t *module, pref_cb callback, + gpointer user_data); + +/* + * Register all non-dissector modules' preferences. + */ +extern void prefs_register_modules(void); + +/* Read the preferences file, fill in "prefs", and return a pointer to it. + + If we got an error (other than "it doesn't exist") trying to read + the global preferences file, stuff the errno into "*gpf_errno_return" + on an open error and into "*gpf_read_errno_return" on a read error, + stuff a pointer to the path of the file into "*gpf_path_return", and + return NULL. + + If we got an error (other than "it doesn't exist") trying to read + the user's preferences file, stuff the errno into "*pf_errno_return" + on an open error and into "*pf_read_errno_return" on a read error, + stuff a pointer to the path of the file into "*pf_path_return", and + return NULL. */ +extern e_prefs *read_prefs(int *, int *, char **, int *, int *, char **); + +/* Write out "prefs" to the user's preferences file, and return 0. + + If we got an error, stuff a pointer to the path of the preferences file + into "*pf_path_return", and return the errno. */ +extern int write_prefs(char **); + +/* Copy a set of preferences. */ +extern void copy_prefs(e_prefs *dest, e_prefs *src); + +/* Free a set of preferences. */ +extern void free_prefs(e_prefs *pr); + +/* + * Given a string of the form "<pref name>:<pref value>", as might appear + * as an argument to a "-o" option, parse it and set the preference in + * question. Return an indication of whether it succeeded or failed + * in some fashion. + * + * XXX - should supply, for syntax errors, a detailed explanation of + * the syntax error. + */ +#define PREFS_SET_OK 0 /* succeeded */ +#define PREFS_SET_SYNTAX_ERR 1 /* syntax error in string */ +#define PREFS_SET_NO_SUCH_PREF 2 /* no such preference */ +#define PREFS_SET_OBSOLETE 3 /* preference used to exist but no longer does */ + +extern int prefs_set_pref(char *prefarg); + +#endif /* prefs.h */ |