b4849cd376906df5a1880d2ef49768a6bd8fb9de
[obnox/wireshark/wip.git] / dfilter.h
1 /* dfilter.h
2  * Definitions for display filters
3  *
4  * $Id: dfilter.h,v 1.9 1999/08/20 20:37:46 gram Exp $
5  *
6  * Ethereal - Network traffic analyzer
7  * By Gerald Combs <gerald@zing.org>
8  * Copyright 1998 Gerald Combs
9  *
10  * 
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  * 
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  * 
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26 #ifndef __DFILTER_H__
27 #define __DFILTER_H__
28
29 #define DFILTER_CONTAINS_FILTER(x)      ((x)->dftree)
30
31 /* dfilter_error_msg is NULL if there was no error during dfilter_compile,
32  * otherwise it points to a displayable error message. */
33 extern gchar *dfilter_error_msg;
34 extern gchar dfilter_error_msg_buf[1024];
35
36 typedef struct {
37
38         GNode *dftree;
39         gchar *dftext;
40
41         /* space for dfilter_nodes */
42         GMemChunk *node_memchunk;
43
44         /* list of byte arrays we allocate during parse. We can traverse this list
45          * faster than the tree when we go back and free the byte arrays */
46         GSList *list_of_byte_arrays;
47 } dfilter;
48
49 /* Initialization of the symbol table. Called once during program startup */
50 void dfilter_init(void);
51
52 /* Allocate and initialize new dfilter struct. Returns pointer to new dfilter */
53 dfilter* dfilter_new(void);
54
55 /* Frees all memory used by dfilter, and frees dfilter itself */
56 void dfilter_destroy(dfilter *df);
57
58 /* Compile display filter text */
59 int dfilter_compile(dfilter* df, gchar* dfilter_text);
60
61 /* Apply compiled dfilter to a proto_tree */
62 gboolean dfilter_apply(dfilter *df, proto_tree *ptree, const guint8* pd);
63
64 /* Clears the current filter int the dfilter */
65 void dfilter_clear_filter(dfilter *df);
66
67 #endif /* ! __DFILTER_H__ */