Xcode 4 isn't available on DVD, but is available for download from
[obnox/wireshark/wip.git] / 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 CONVERSATION_COLOR_PREFIX       "___conversation_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 /** Reload the color filters */
54 void color_filters_reload(void);
55
56 /** Cleanup remaining color filter zombies */
57 void color_filters_cleanup(void);
58
59 /** Color filters currently used?
60  *
61  * @return TRUE, if filters are used
62  */
63 gboolean color_filters_used(void);
64
65 /** Are there any temporary coloring filters used?
66  *
67  * @return TRUE, if temporary coloring filters are used
68  */
69 gboolean tmp_color_filters_used(void);
70
71 /** En-/disable color filters
72  *
73  * @param enable TRUE to enable (default)
74  */
75 void
76 color_filters_enable(gboolean enable);
77
78 /** Set the filter string of a temporary color filter
79  *
80  * @param filt_nr a number 1-10 pointing to a temporary color
81  * @param filter the new filter-string
82  * @param disabled whether the filter-rule should be disabled
83  */
84 void
85 color_filters_set_tmp(guint8 filt_nr, gchar *filter, gboolean disabled);
86
87 /** Reset the temporary color filters
88  *
89  */
90 void
91 color_filters_reset_tmp(void);
92
93 /* Prime the epan_dissect_t with all the compiler
94  * color filters of the current filter list.
95  *
96  * @param the epan dissector details
97  */
98 void color_filters_prime_edt(epan_dissect_t *edt);
99
100 /** Colorize a specific packet.
101  *
102  * @param row the row in the packet list
103  * @param edt the dissected packet
104  * @return the matching color filter or NULL
105  */
106 const color_filter_t *
107 color_filters_colorize_packet(epan_dissect_t *edt);
108
109 /** Clone the currently active filter list.
110  *
111  * @param user_data will be returned by each call to to color_filter_add_cb()
112  */
113 void color_filters_clone(gpointer user_data);
114
115 /** Load filters (import) from some other filter file.
116  *
117  * @param path the path to the import file
118  * @param user_data will be returned by each call to to color_filter_add_cb()
119  * @return TRUE, if read succeeded
120  */
121 gboolean color_filters_import(gchar *path, gpointer user_data);
122
123 /** Read filters from the global filter file (not the users file).
124  *
125  * @param user_data will be returned by each call to to color_filter_add_cb()
126  * @return TRUE, if read succeeded
127  */
128 gboolean color_filters_read_globals(gpointer user_data);
129
130 /** A color filter was added (while importing).
131  * (color_filters.c calls this for every filter coming in)
132  *
133  * @param colorf the new color filter
134  * @param user_data from caller
135  */
136 void color_filter_add_cb (color_filter_t *colorf, gpointer user_data);
137
138
139
140 /** Apply a changed filter list.
141  *
142  * @param tmp_cfl the temporary color filter list to apply
143  * @param edit_cfl the edited permanent color filter list to apply
144  */
145 void color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl);
146
147 /** Save filters in users filter file.
148  *
149  * @param cfl the filter list to write
150  * @return TRUE if write succeeded
151  */
152 gboolean color_filters_write(GSList *cfl);
153
154 /** Save filters (export) to some other filter file.
155  *
156  * @param path the path to the filter file
157  * @param cfl the filter list to write
158  * @param only_selected TRUE if only the selected filters should be saved
159  * @return TRUE, if write succeeded
160  */
161 gboolean color_filters_export(gchar *path, GSList *cfl, gboolean only_selected);
162
163
164
165 /** Create a new color filter (g_malloc'ed).
166  *
167  * @param name the name of the filter
168  * @param filter_string the filter string
169  * @param bg_color background color
170  * @param fg_color foreground color
171  * @param disabled gboolean
172  * @return the new color filter
173  */
174 color_filter_t *color_filter_new(
175     const gchar *name, const gchar *filter_string,
176     color_t *bg_color, color_t *fg_color, gboolean disabled);
177
178 /** Delete a single color filter (g_free'ed).
179  *
180  * @param colorf the color filter to be removed
181  */
182 void color_filter_delete(color_filter_t *colorf);
183
184
185
186
187 /** Delete a filter list including all entries.
188  *
189  * @param cfl the filter list to delete
190  */
191 void color_filter_list_delete(GSList **cfl);
192
193
194
195 #endif