/* prefs.h
* Definitions for preference handling routines
*
- * $Id: prefs.h,v 1.8 1999/09/09 03:31:50 gram Exp $
+ * $Id: prefs.h,v 1.29 2001/04/15 03:37:13 guy Exp $
*
* Ethereal - Network traffic analyzer
* By Gerald Combs <gerald@zing.org>
#ifndef __PREFS_H__
#define __PREFS_H__
-#define PR_FMT_TEXT 0
-#define PR_FMT_PS 1
+#include <glib.h>
+
+#include "color.h"
#define PR_DEST_CMD 0
#define PR_DEST_FILE 1
typedef struct _e_prefs {
- gint pr_format;
- gint pr_dest;
- gchar *pr_file;
- gchar *pr_cmd;
- GList *col_list;
- gint num_cols;
+ 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;
+ gint gui_ptree_line_style;
+ gint gui_ptree_expander_style;
+ gboolean gui_hex_dump_highlight_style;
+ gchar *gui_font_name;
+ color_t gui_marked_fg;
+ color_t gui_marked_bg;
+ gboolean name_resolve;
+ gboolean capture_prom_mode;
+ gboolean capture_real_time;
+ gboolean capture_auto_scroll;
+
} e_prefs;
extern e_prefs prefs;
-e_prefs* read_prefs(char **);
-void write_prefs(void);
+/*
+ * 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 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.
+ * Note:
+ * In case of dissectors, the specified name should be the protocol
+ * name specified at the proto_register_protocol() call in order to
+ * make the "Protocol Properties..." menu item work.
+ */
+module_t *prefs_register_module(const char *name, const char *title,
+ void (*apply_cb)(void));
+
+typedef void (*module_cb)(module_t *module, gpointer user_data);
+
+/*
+ * Register that a protocol has preferences.
+ */
+module_t *prefs_register_protocol(int id, void (*apply_cb)(void));
+
+/*
+ * Call a callback function, with a specified argument, for each module.
+ */
+void prefs_module_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.
+ */
+void prefs_apply_all(void);
+
+struct preference;
+
+typedef struct preference pref_t;
+
+/*
+ * Returns TRUE if the given protocol has registered preferences
+ */
+gboolean prefs_is_registered_protocol(char *name);
+
+/*
+ * Returns the module title of a registered protocol (or NULL if unknown)
+ */
+const char *prefs_get_title_by_name(char *name);
+
+/*
+ * Register a preference with an unsigned integral value.
+ */
+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.
+ */
+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;
+ gint value;
+} enum_val_t;
+
+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.
+ */
+void prefs_register_string_preference(module_t *module, const char *name,
+ const char *title, const char *description, char **var);
+
+typedef void (*pref_cb)(pref_t *pref, gpointer user_data);
+
+/*
+ * Call a callback function, with a specified argument, for each preference
+ * in a given module.
+ */
+void prefs_pref_foreach(module_t *module, pref_cb callback, gpointer user_data);
+
+/*
+ * Register all non-dissector modules' preferences.
+ */
+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"
+ and 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"
+ and a pointer to the path of the file into "*pf_path_return", and
+ return NULL. */
+e_prefs *read_prefs(int *, char **, 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. */
+int write_prefs(char **);
+
+/* Copy a set of preferences. */
+void copy_prefs(e_prefs *dest, e_prefs *src);
+
+/* Free a set of preferences. */
+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.
+ */
+#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 */
+
+int prefs_set_pref(char *prefarg);
#endif /* prefs.h */
git.samba.org / obnox / wireshark / wip.git / blobdiff