Remove some GTK+-only code.
[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
36                                     /* only used inside of color_filters.c */
37     struct epan_dfilter *c_colorfilter;  /* compiled filter expression */
38
39                                     /* only used outside of color_filters.c (beside init) */
40 } color_filter_t;
41
42 /** A color filter was added (while importing).
43  * (color_filters.c calls this for every filter coming in)
44  *
45  * @param colorf the new color filter
46  * @param user_data from caller
47  */
48 typedef void (*color_filter_add_cb_func)(color_filter_t *colorf, gpointer user_data);
49
50 /** Init the color filters (incl. initial read from file). */
51 WS_DLL_PUBLIC gboolean color_filters_init(gchar** err_msg, color_filter_add_cb_func add_cb);
52
53 /** Reload the color filters */
54 WS_DLL_PUBLIC gboolean color_filters_reload(gchar** err_msg, color_filter_add_cb_func add_cb);
55
56 /** Cleanup remaining color filter zombies */
57 WS_DLL_PUBLIC void color_filters_cleanup(void);
58
59 /** Color filters currently used?
60  *
61  * @return TRUE, if filters are used
62  */
63 WS_DLL_PUBLIC 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 WS_DLL_PUBLIC gboolean tmp_color_filters_used(void);
70
71 /** Set the filter string of a temporary color filter
72  *
73  * @param filt_nr a number 1-10 pointing to a temporary color
74  * @param filter the new filter-string
75  * @param disabled whether the filter-rule should be disabled
76  * @param err_msg a string with error message
77  */
78 WS_DLL_PUBLIC gboolean
79 color_filters_set_tmp(guint8 filt_nr, const gchar *filter, gboolean disabled, gchar **err_msg);
80
81 /** Get a temporary color filter.
82  *
83  * @param filter_num A number from 1 to 10 specifying the color to fetch.
84  * @return The corresponding color or NULL.
85  */
86 WS_DLL_PUBLIC const color_filter_t *
87 color_filters_tmp_color(guint8 filter_num);
88
89 /** Reset the temporary color filters
90  *
91  */
92 WS_DLL_PUBLIC gboolean
93 color_filters_reset_tmp(gchar **err_msg);
94
95 /* Prime the epan_dissect_t with all the compiler
96  * color filters of the current filter list.
97  *
98  * @param the epan dissector details
99  */
100 WS_DLL_PUBLIC void color_filters_prime_edt(struct epan_dissect *edt);
101
102 /** Colorize a specific packet.
103  *
104  * @param edt the dissected packet
105  * @return the matching color filter or NULL
106  */
107 WS_DLL_PUBLIC const color_filter_t *
108 color_filters_colorize_packet(struct epan_dissect *edt);
109
110 /** Clone the currently active filter list.
111  *
112  * @param user_data will be returned by each call to to color_filter_add_cb()
113  * @param add_cb the callback function to add color filter
114  */
115 WS_DLL_PUBLIC void color_filters_clone(gpointer user_data, color_filter_add_cb_func add_cb);
116
117 /** Load filters (import) from some other filter file.
118  *
119  * @param path the path to the import file
120  * @param user_data will be returned by each call to to color_filter_add_cb()
121  * @param err_msg a string with error message
122  * @param add_cb the callback function to add color filter
123  * @return TRUE, if read succeeded
124  */
125 WS_DLL_PUBLIC gboolean color_filters_import(const gchar *path, gpointer user_data, gchar **err_msg, color_filter_add_cb_func add_cb);
126
127 /** Read filters from the global filter file (not the users file).
128  *
129  * @param user_data will be returned by each call to to color_filter_add_cb()
130  * @param err_msg a string with error message
131  * @param add_cb the callback function to add color filter
132  * @return TRUE, if read succeeded
133  */
134 WS_DLL_PUBLIC gboolean color_filters_read_globals(gpointer user_data, gchar** err_msg, color_filter_add_cb_func add_cb);
135
136
137 /** Apply a changed filter list.
138  *
139  * @param tmp_cfl the temporary color filter list to apply
140  * @param edit_cfl the edited permanent color filter list to apply
141  * @param err_msg a string with error message
142  */
143 WS_DLL_PUBLIC gboolean color_filters_apply(GSList *tmp_cfl, GSList *edit_cfl, gchar** err_msg);
144
145 /** Save filters in users filter file.
146  *
147  * @param cfl the filter list to write
148  * @param err_msg a string with error message
149  * @return TRUE if write succeeded
150  */
151 WS_DLL_PUBLIC gboolean color_filters_write(GSList *cfl, gchar** err_msg);
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  * @param err_msg a string with error message
159  * @return TRUE, if write succeeded
160  */
161 WS_DLL_PUBLIC gboolean color_filters_export(const gchar *path, GSList *cfl, gboolean only_selected, gchar** err_msg);
162
163 /** Create a new color filter (g_malloc'ed).
164  *
165  * @param name the name of the filter
166  * @param filter_string the filter string
167  * @param bg_color background color
168  * @param fg_color foreground color
169  * @param disabled gboolean
170  * @return the new color filter
171  */
172 WS_DLL_PUBLIC 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 WS_DLL_PUBLIC void color_filter_delete(color_filter_t *colorf);
181
182 /** Delete a filter list including all entries.
183  *
184  * @param cfl the filter list to delete
185  */
186 WS_DLL_PUBLIC void color_filter_list_delete(GSList **cfl);
187
188 #ifdef __cplusplus
189 }
190 #endif /* __cplusplus */
191
192 #endif
193
194 /*
195  * Editor modelines  -  http://www.wireshark.org/tools/modelines.html
196  *
197  * Local variables:
198  * c-basic-offset: 4
199  * tab-width: 8
200  * indent-tabs-mode: nil
201  * End:
202  *
203  * vi: set shiftwidth=4 tabstop=8 expandtab:
204  * :indentSize=4:tabSize=8:noTabs=true:
205  */