Create a "dfilter-int.h" file, containing stuff used internally to the
[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.1 1999/08/12 21:16:31 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
33 /* in dfilter-grammar.y */
34 extern GSList *dfilter_list_byte_arrays;
35
36 /* Here we provide interfaces to make our scanner act and look like lex */
37 int yylex(void);
38 void yyerror(char *s);
39 void dfilter_yyerror(char *fmt, ...);
40
41 /* functions that dfilter-grammar.y needs during parsing*/
42 gboolean check_relation_numeric(gint operand, GArray *a, GArray *b);
43 gboolean check_relation_ether(gint operand, GArray *a, GArray *b);
44 gboolean check_relation_bytes(gint operand, GArray *a, GArray *b);
45 gboolean check_relation_boolean(gint operand, GArray *a, GArray *b);
46
47 gboolean fill_array_numeric_value(GNode *gnode, gpointer data);
48 gboolean fill_array_numeric_variable(GNode *gnode, gpointer data);
49 gboolean fill_array_ether_value(GNode *gnode, gpointer data);
50 gboolean fill_array_ether_variable(GNode *gnode, gpointer data);
51 gboolean fill_array_bytes_value(GNode *gnode, gpointer data);
52 gboolean fill_array_bytes_variable(GNode *gnode, gpointer data);
53 gboolean fill_array_boolean_value(GNode *gnode, gpointer data);
54 gboolean fill_array_boolean_variable(GNode *gnode, gpointer data);
55
56 enum node_type {
57         relation,       /* eq, ne, gt, ge, lt, le */
58         logical,        /* and, or, not, xor */
59         variable,       /* protocol or header field id */
60         existence,      /* existence of a variable (protocol or hf) */
61         alternation,    /* &, | */
62         boolean,        /* true, false */
63         numeric,        /* uint8, uint16, or uint32 value */
64         abs_time,
65         string,
66         ether,
67         bytes,
68         ipv4,
69         ipxnet
70 };
71
72 typedef gboolean(*CheckRelationFunc) (gint operand, GArray *a, GArray *b);
73
74 /* This struct is the parse tree node created by this grammary and used
75  * directly in the display filter routines to filter packets.
76  */
77 typedef struct dfilter_node {
78         enum node_type                  ntype; /* from dfilter-grammar.h */
79         int                             elem_size; /* computed at dfilter parse time rather than
80                                                 when finding elements for each packet. Saves time
81                                                 in get_values_from_ptree() */
82         CheckRelationFunc               check_relation_func;
83         GNodeTraverseFunc               fill_array_func;
84
85         /* copied from proto.h */
86         union {
87                 gint            relation; /* if type == relation (eq, ne, gt, ge, lt, le) */
88                 gint            logical;  /* if type == logical (and, or, not, xor) */
89                 gint            variable; /* if type == variable (protocol or header field abbrev) */
90                 gint            alternation; /* if type == alternation (& or |) */
91
92                 gboolean        boolean;
93                 guint32         numeric;
94                 struct timeval  abs_time; /* the whole struct, not a pointer */
95                 gchar           *string;
96                 guint8          ether[6];
97                 GByteArray      *bytes;
98         }                               value;
99
100         /* used for byte-ranges */
101         gint                            offset;
102         guint                           length;
103 } dfilter_node;
104
105 /* lookup an abbreviation in our token hash, returing the ID # */
106 int dfilter_lookup_token(char *abbrev);
107
108 #endif /* ! __DFILTER_INT_H__ */