name change

[obnox/wireshark/wip.git] / color_filters.h

diff --git a/color_filters.h b/color_filters.h
index 9b5aa2a0341bc2e3a7daf6ac093edae4e3162ea9..d253517af081b6e5c5a6834e38159ee946a32850 100644 (file)
--- a/color_filters.h
+++ b/color_filters.h
@@ -3,8 +3,8 @@
  *
  * $Id$
  *
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
  * Copyright 1998 Gerald Combs
  *
  * This program is free software; you can redistribute it and/or
@@ -28,20 +28,77 @@
  *  Color filters.
  */
 
+/* Data for a color filter. */
+typedef struct _color_filter {
+        gchar     *filter_name;   /* name of the filter */
+        gchar     *filter_text;   /* text of the filter expression */
+        color_t    bg_color;      /* background color for packets that match */
+        color_t    fg_color;      /* foreground color for packets that match */
+        dfilter_t *c_colorfilter; /* compiled filter expression */
+        void      *edit_dialog;   /* if filter is being edited, dialog
+                                   * box for it */
+       gboolean    marked;         /* set if the filter is marked in the color dialog box */
+} color_filter_t;
+
+/* List of all color filters. */
+extern GSList *color_filter_list;
+
 /** Init the color filters. */
-void colfilter_init(void);
+void color_filters_init(void);
 
 /** Save filters in users filter file.
  *
  * @return TRUE if write succeeded
  */
-gboolean write_filters(void);
+gboolean color_filters_write(void);
 
 /** Delete users filter file and reload global filters.
  *
  * @return TRUE if write succeeded
  */
-gboolean revert_filters(void);
+gboolean color_filters_revert(void);
+
+/** Load filters (import) from some other filter file.
+ *
+ * @param path the path to the filter file
+ * @param arg the color filter widget
+ * @return TRUE, if read succeeded
+ */
+gboolean color_filters_import(gchar *path, gpointer arg);
+
+/** Save filters (export) to some other filter file.
+ *
+ * @param path the path to the filter file
+ * @param only_marked TRUE if only the marked filters should be saved
+ * @return TRUE, if write succeeded
+ */
+gboolean color_filters_export(gchar *path, gboolean only_marked);
+
+/** @todo don't what this function is for, please add explanation
+ */
+void color_filters_prime_edt(epan_dissect_t *edt);
+
+/** Color filters currently used?
+ *
+ * @return TRUE, if filters are used
+ */
+gboolean color_filters_used(void);
+
+/** En-/disable color filters
+ *
+ * @param enable TRUE to enable (default)
+ */
+void
+color_filters_enable(gboolean enable);
+
+/** Colorize a specific packet.
+ *
+ * @param row the row in the packet list
+ * @param edt the dissected packet
+ * @return the matching color filter or NULL
+ */
+color_filter_t *
+color_filters_colorize_packet(gint row, epan_dissect_t *edt);
 
 /** Create a new color filter.
  *
@@ -51,29 +108,20 @@ gboolean revert_filters(void);
  * @param fg_color foreground color
  * @return the new color filter
  */
-color_filter_t *new_color_filter(gchar *name, gchar *filter_string,
+color_filter_t *color_filter_new(const gchar *name, const gchar *filter_string,
     color_t *bg_color, color_t *fg_color);
 
 /** Remove the color filter.
  *
  * @param colorf the color filter to be removed
  */
-void remove_color_filter(color_filter_t *colorf);
+void color_filter_remove(color_filter_t *colorf);
 
-/** Load filters from some other filter file.
+/** Add a color filter.
  *
- * @param path the path to the filter file
+ * @param colorf the new color filter
  * @param arg the color filter widget
- * @return TRUE, if read succeeded
- */
-gboolean read_other_filters(gchar *path, gpointer arg);
-
-/** Save filters to some other filter file.
- *
- * @param path the path to the filter file
- * @param only_marked TRUE if only the marked filters should be saved
- * @return TRUE, if write succeeded
  */
-gboolean write_other_filters(gchar *path, gboolean only_marked);
+void color_filter_add_cb (color_filter_t *colorf, gpointer arg);
 
 #endif