4410864a182b6c43d377035bb4de10c74a8368d0
[metze/wireshark/wip.git] / epan / color_filters.h
1 /* color_filters.h
2  * Definitions for color filters
3  *
4  * Wireshark - Network traffic analyzer
5  * By Gerald Combs <gerald@wireshark.org>
6  * Copyright 1998 Gerald Combs
7  *
8  * SPDX-License-Identifier: GPL-2.0-or-later
9  */
10 #ifndef  __COLOR_FILTERS_H__
11 #define  __COLOR_FILTERS_H__
12
13 #include "ws_symbol_export.h"
14
15 #ifdef __cplusplus
16 extern "C" {
17 #endif /* __cplusplus */
18
19 #include <wsutil/color.h>
20
21 struct epan_dissect;
22
23 #define CONVERSATION_COLOR_PREFIX       "___conversation_color_filter___"
24 /** @file
25  *  Color filters.
26  */
27
28 /* Data for a color filter. */
29 typedef struct _color_filter {
30     gchar     *filter_name;         /* name of the filter */
31     gchar     *filter_text;         /* text of the filter expression */
32     color_t    bg_color;            /* background color for packets that match */
33     color_t    fg_color;            /* foreground color for packets that match */
34     gboolean   disabled;            /* set if the filter is disabled */
35     gboolean   selected;            /* set if the filter is selected in the color dialog box. GTK+ only. */
36
37                                     /* only used inside of color_filters.c */
38     struct epan_dfilter *c_colorfilter;  /* compiled filter expression */
39
40                                     /* only used outside of color_filters.c (beside init) */
41     void      *color_edit_dlg_info; /* if filter is being edited, ptr to req'd info. GTK+ only. */
42 } color_filter_t;
43
44 /** A color filter was added (while importing).
45  * (color_filters.c calls this for every filter coming in)
46  *
47  * @param colorf the new color filter
48  * @param user_data from caller
49  */
50 typedef void (*color_filter_add_cb_func)(color_filter_t *colorf, gpointer user_data);
51
52 /** Init the color filters (incl. initial read from file). */
53 WS_DLL_PUBLIC gboolean color_filters_init(gchar** err_msg, color_filter_add_cb_func add_cb);
54
55 /** Reload the color filters */
56 WS_DLL_PUBLIC gboolean color_filters_reload(gchar** err_msg, color_filter_add_cb_func add_cb);
57
58 /** Cleanup remaining color filter zombies */
59 WS_DLL_PUBLIC void color_filters_cleanup(void);
60
61 /** Color filters currently used?
62  *
63  * @return TRUE, if filters are used
64  */
65 WS_DLL_PUBLIC gboolean color_filters_used(void);
66
67 /** Are there any temporary coloring filters used?
68  *
69  * @return TRUE, if temporary coloring filters are used
70  */
71 WS_DLL_PUBLIC gboolean tmp_color_filters_used(void);
72
73 /** Set the filter string of a temporary color filter
74  *
75  * @param filt_nr a number 1-10 pointing to a temporary color
76  * @param filter the new filter-string
77  * @param disabled whether the filter-rule should be disabled
78  * @param err_msg a string with error message
79  */
80 WS_DLL_PUBLIC gboolean
81 color_filters_set_tmp(guint8 filt_nr, const gchar *filter, gboolean disabled, gchar **err_msg);
82
83 /** Get a temporary color filter.
84  *
85  * @param filter_num A number from 1 to 10 specifying the color to fetch.
86  * @return The corresponding color or NULL.
87  */
88 WS_DLL_PUBLIC const color_filter_t *
89 color_filters_tmp_color(guint8 filter_num);
90
91 /** Reset the temporary color filters
92  *
93  */
94 WS_DLL_PUBLIC gboolean
95 color_filters_reset_tmp(gchar **err_msg);
96
97 /* Prime the epan_dissect_t with all the compiler
98  * color filters of the current filter list.
99  *
100  * @param the epan dissector details
101  */
102 WS_DLL_PUBLIC void color_filters_prime_edt(struct epan_dissect *edt);
103
104 /** Colorize a specific packet.
105  *
106  * @param edt the dissected packet
107  * @return the matching color filter or NULL
108  */
109 WS_DLL_PUBLIC const color_filter_t *
110 color_filters_colorize_packet(struct epan_dissect *edt);
111
112 /** Clone the currently active filter list.
113  *
114  * @param user_data will be returned by each call to to color_filter_add_cb()
115  * @param add_cb the callback function to add color filter
116  */
117 WS_DLL_PUBLIC void color_filters_clone(gpointer user_data, color_filter_add_cb_func add_cb);
118
119 /** Load filters (import) from some other filter file.
120  *
121  * @param path the path to the import file
122  * @param user_data will be returned by each call to to color_filter_add_cb()
123  * @param err_msg a string with error message
124  * @param add_cb the callback function to add color filter
125  * @return TRUE, if read succeeded
126  */
127 WS_DLL_PUBLIC gboolean color_filters_import(const gchar *path, gpointer user_data, gchar **err_msg, color_filter_add_cb_func add_cb);
128
129 /** Read filters from the global filter file (not the users file).
130  *
131  * @param user_data will be returned by each call to to color_filter_add_cb()
132  * @param err_msg a string with error message
133  * @param add_cb the callback function to add color filter
134  * @return TRUE, if read succeeded
135  */
136 WS_DLL_PUBLIC gboolean color_filters_read_globals(gpointer user_data, gchar** err_msg, color_filter_add_cb_func add_cb);
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  * @param err_msg a string with error message
144  */
145 WS_DLL_PUBLIC gboolean color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl, gchar** err_msg);
146
147 /** Save filters in users filter file.
148  *
149  * @param cfl the filter list to write
150  * @param err_msg a string with error message
151  * @return TRUE if write succeeded
152  */
153 WS_DLL_PUBLIC gboolean color_filters_write(GSList *cfl, gchar** err_msg);
154
155 /** Save filters (export) to some other filter file.
156  *
157  * @param path the path to the filter file
158  * @param cfl the filter list to write
159  * @param only_selected TRUE if only the selected filters should be saved
160  * @param err_msg a string with error message
161  * @return TRUE, if write succeeded
162  */
163 WS_DLL_PUBLIC gboolean color_filters_export(const gchar *path, GSList *cfl, gboolean only_selected, gchar** err_msg);
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 WS_DLL_PUBLIC 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 WS_DLL_PUBLIC void color_filter_delete(color_filter_t *colorf);
183
184 /** Delete a filter list including all entries.
185  *
186  * @param cfl the filter list to delete
187  */
188 WS_DLL_PUBLIC void color_filter_list_delete(GSList **cfl);
189
190 #ifdef __cplusplus
191 }
192 #endif /* __cplusplus */
193
194 #endif
195
196 /*
197  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
198  *
199  * Local variables:
200  * c-basic-offset: 4
201  * tab-width: 8
202  * indent-tabs-mode: nil
203  * End:
204  *
205  * vi: set shiftwidth=4 tabstop=8 expandtab:
206  * :indentSize=4:tabSize=8:noTabs=true:
207  */