e447701d2e3e1072c58abc92a54d39e19f6ba2e0
[obnox/wireshark/wip.git] / dfilter-int.h
1 /* dfilter-int.h
2  * Definitions for routines common to multiple modules in the display
3  * filter code, but not used outside that code.
4  *
5  * $Id: dfilter-int.h,v 1.8 1999/10/11 06:39:04 guy Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@zing.org>
9  * Copyright 1998 Gerald Combs
10  *
11  * 
12  * This program is free software; you can redistribute it and/or
13  * modify it under the terms of the GNU General Public License
14  * as published by the Free Software Foundation; either version 2
15  * of the License, or (at your option) any later version.
16  * 
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  * 
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  */
26
27 #ifndef __DFILTER_INT_H__
28 #define __DFILTER_INT_H__
29
30 /* in dfilter-scanner.l */
31 GByteArray *byte_str_to_guint8_array(const char *s);
32 void dfilter_scanner_text(char*);
33 void dfilter_scanner_cleanup(void);
34
35 /* in dfilter-grammar.y */
36 extern dfilter *global_df;
37
38 /* Here we provide interfaces to make our scanner act and look like lex */
39 int dfilter_lex(void);
40 void dfilter_error(char *s);
41
42 /* Report an error during compilation of a filter; this is called by code
43  * other than parser code, so all it does is record that an error occurred,
44  * so that even if the filter is nominally syntactically valid, we still
45  * fail.
46  */
47 #if __GNUC__ == 2
48 void dfilter_fail(char *fmt, ...)
49     __attribute__((format (printf, 1, 2)));
50 #else
51 void dfilter_fail(char *fmt, ...);
52 #endif
53
54 /* functions that dfilter-grammar.y needs during parsing*/
55 gboolean check_relation_numeric(gint operand, GArray *a, GArray *b);
56 gboolean check_relation_ether(gint operand, GArray *a, GArray *b);
57 gboolean check_relation_bytes(gint operand, GArray *a, GArray *b);
58
59 gboolean fill_array_numeric_value(GNode *gnode, gpointer data);
60 gboolean fill_array_numeric_variable(GNode *gnode, gpointer data);
61 gboolean fill_array_ether_value(GNode *gnode, gpointer data);
62 gboolean fill_array_ether_variable(GNode *gnode, gpointer data);
63 gboolean fill_array_bytes_value(GNode *gnode, gpointer data);
64 gboolean fill_array_bytes_variable(GNode *gnode, gpointer data);
65
66 #ifdef WIN32
67 #define boolean truth_value
68 #endif
69
70 enum node_type {
71         relation,       /* eq, ne, gt, ge, lt, le */
72         logical,        /* and, or, not, xor */
73         variable,       /* protocol or header field id */
74         existence,      /* existence of a variable (protocol or hf) */
75         alternation,    /* &, | */
76         boolean,        /* true, false */
77         numeric,        /* uint8, uint16, or uint32 value */
78         abs_time,
79         string,
80         ether,
81         bytes,
82         ipv4,
83         ipxnet
84 };
85
86 typedef gboolean(*CheckRelationFunc) (gint operand, GArray *a, GArray *b);
87
88 /* This struct is the parse tree node created by this grammary and used
89  * directly in the display filter routines to filter packets.
90  */
91 typedef struct dfilter_node {
92         enum node_type                  ntype; /* from dfilter-grammar.h */
93         int                             elem_size; /* computed at dfilter parse time rather than
94                                                 when finding elements for each packet. Saves time
95                                                 in get_values_from_ptree() */
96         CheckRelationFunc               check_relation_func;
97         GNodeTraverseFunc               fill_array_func;
98
99         /* copied from proto.h */
100         union {
101                 gint            relation; /* if type == relation (eq, ne, gt, ge, lt, le) */
102                 gint            logical;  /* if type == logical (and, or, not, xor) */
103                 gint            variable; /* if type == variable (protocol or header field abbrev) */
104                 gint            alternation; /* if type == alternation (& or |) */
105
106                 guint32         numeric;
107                 struct timeval  abs_time; /* the whole struct, not a pointer */
108                 gchar           *string;
109                 guint8          ether[6];
110                 GByteArray      *bytes;
111         }                               value;
112
113         /* used for byte-ranges */
114         gint                            offset;
115         guint                           length;
116 } dfilter_node;
117
118 /* lookup an abbreviation in our token hash, returing the ID # */
119 int dfilter_lookup_token(char *abbrev);
120
121 #endif /* ! __DFILTER_INT_H__ */