color_filters.h

   1 /* color_filters.h
   2  * Definitions for color filters
   3  *
   4  * $Id$
   5  *
   6  * Wireshark - Network traffic analyzer
   7  * By Gerald Combs <gerald@wireshark.org>
   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 #ifndef  __COLOR_FILTERS_H__
  25 #define  __COLOR_FILTERS_H__
  26
  27 #define TEMP_COLOR_PREFIX       "___tmp_color_filter___"
  28 /** @file
  29  *  Color filters.
  30  */
  31
  32 /* Data for a color filter. */
  33 typedef struct _color_filter {
  34         gchar     *filter_name;   /* name of the filter */
  35         gchar     *filter_text;   /* text of the filter expression */
  36         color_t    bg_color;      /* background color for packets that match */
  37         color_t    fg_color;      /* foreground color for packets that match */
  38         gboolean   disabled;      /* set if the filter is disabled */
  39         gboolean   selected;      /* set if the filter is selected in the color dialog box */
  40
  41         /* only used inside of color_filters.c */
  42         dfilter_t *c_colorfilter; /* compiled filter expression */
  43
  44         /* only used outside of color_filters.c (beside init) */
  45         void      *edit_dialog;   /* if filter is being edited, dialog
  46                                    * box for it */
  47 } color_filter_t;
  48
  49
  50 /** Init the color filters (incl. initial read from file). */
  51 void color_filters_init(void);
  52
  53 /** Cleanup remaining color filter zombies */
  54 void color_filters_cleanup(void);
  55
  56 /** Color filters currently used?
  57  *
  58  * @return TRUE, if filters are used
  59  */
  60 gboolean color_filters_used(void);
  61
  62 /** Are there any temporary coloring filters used?
  63  *
  64  * @return TRUE, if temporary coloring filters are used
  65  */
  66 gboolean tmp_color_filters_used(void);
  67
  68 /** En-/disable color filters
  69  *
  70  * @param enable TRUE to enable (default)
  71  */
  72 void
  73 color_filters_enable(gboolean enable);
  74
  75 /** Set the filter string of a temporary color filter
  76  *
  77  * @param filt_nr a number 1-10 pointing to a temporary color
  78  * @param filter the new filter-string
  79  * @param disabled whether the filter-rule should be disabled
  80  */
  81 void
  82 color_filters_set_tmp(guint8 filt_nr, gchar *filter, gboolean disabled);
  83
  84 /** Reset the temporary color filters
  85  *
  86  */
  87 void
  88 color_filters_reset_tmp(void);
  89
  90 /* Prime the epan_dissect_t with all the compiler
  91  * color filters of the current filter list.
  92  *
  93  * @param the epan dissector details
  94  */
  95 void color_filters_prime_edt(epan_dissect_t *edt);
  96
  97 /** Colorize a specific packet.
  98  *
  99  * @param row the row in the packet list
 100  * @param edt the dissected packet
 101  * @return the matching color filter or NULL
 102  */
 103 color_filter_t *
 104 color_filters_colorize_packet(gint row, epan_dissect_t *edt);
 105
 106
 107
 108 /** Clone the currently active filter list.
 109  *
 110  * @param user_data will be returned by each call to to color_filter_add_cb()
 111  */
 112 void color_filters_clone(gpointer user_data);
 113
 114 /** Load filters (import) from some other filter file.
 115  *
 116  * @param path the path to the import file
 117  * @param user_data will be returned by each call to to color_filter_add_cb()
 118  * @return TRUE, if read succeeded
 119  */
 120 gboolean color_filters_import(gchar *path, gpointer user_data);
 121
 122 /** Read filters from the global filter file (not the users file).
 123  *
 124  * @param user_data will be returned by each call to to color_filter_add_cb()
 125  * @return TRUE, if read succeeded
 126  */
 127 gboolean color_filters_read_globals(gpointer user_data);
 128
 129 /** A color filter was added (while importing).
 130  * (color_filters.c calls this for every filter coming in)
 131  *
 132  * @param colorf the new color filter
 133  * @param user_data from caller
 134  */
 135 void color_filter_add_cb (color_filter_t *colorf, gpointer user_data);
 136
 137
 138
 139 /** Apply a changed filter list.
 140  *
 141  * @param tmp_cfl the temporary color filter list to apply
 142  * @param edit_cfl the edited permanent color filter list to apply
 143  */
 144 void color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl);
 145
 146 /** Save filters in users filter file.
 147  *
 148  * @param cfl the filter list to write
 149  * @return TRUE if write succeeded
 150  */
 151 gboolean color_filters_write(GSList *cfl);
 152
 153 /** Save filters (export) to some other filter file.
 154  *
 155  * @param path the path to the filter file
 156  * @param cfl the filter list to write
 157  * @param only_selected TRUE if only the selected filters should be saved
 158  * @return TRUE, if write succeeded
 159  */
 160 gboolean color_filters_export(gchar *path, GSList *cfl, gboolean only_selected);
 161
 162
 163
 164 /** Create a new color filter (g_malloc'ed).
 165  *
 166  * @param name the name of the filter
 167  * @param filter_string the filter string
 168  * @param bg_color background color
 169  * @param fg_color foreground color
 170  * @return the new color filter
 171  */
 172 color_filter_t *color_filter_new(
 173     const gchar *name, const gchar *filter_string,
 174     color_t *bg_color, color_t *fg_color, gboolean disabled);
 175
 176 /** Delete a single color filter (g_free'ed).
 177  *
 178  * @param colorf the color filter to be removed
 179  */
 180 void color_filter_delete(color_filter_t *colorf);
 181
 182
 183
 184
 185 /** Delete a filter list including all entries.
 186  *
 187  * @param cfl the filter list to delete
 188  */
 189 void color_filter_list_delete(GSList **cfl);
 190
 191
 192
 193 #endif