From Harald Welte:
[obnox/wireshark/wip.git] / epan / dissector_filters.h
1 /* dissector_filters.h
2  * Routines for dissector generated display 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
25 #ifndef __DISSECTOR_FILTERS_H__
26 #define __DISSECTOR_FILTERS_H__
27
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif /* __cplusplus */
32
33 /** @file 
34  */
35
36 /** callback function definition: is a filter available for this packet? */
37 typedef gboolean (*is_filter_valid_func)(packet_info *pinfo);
38
39 /** callback function definition: return the available filter for this packet or NULL if no filter is available */
40 typedef const gchar* (*build_filter_string_func)(packet_info *pinfo);
41
42
43 /** register a dissector filter */
44 extern void register_dissector_filter(const char *name, is_filter_valid_func is_filter_valid, build_filter_string_func build_filter_string);
45
46
47
48 /*** THE FOLLOWING SHOULD NOT BE USED BY ANY DISSECTORS!!! ***/
49
50 typedef struct dissector_filter_s {
51     const char *                name;
52     is_filter_valid_func        is_filter_valid;
53     build_filter_string_func    build_filter_string;
54 } dissector_filter_t;
55
56 WS_VAR_IMPORT GList *dissector_filter_list;
57
58 #ifdef __cplusplus
59 }
60 #endif /* __cplusplus */
61
62 #endif /* dissector_filters.h */