Fix a couple (value) mistakes in value_strings. Found by Martin's patch on the ...
[obnox/wireshark/wip.git] / packet-range.h
1 /* packet-range.h
2  * Packet range routines (save, print, ...)
3  *
4  * $Id$
5  *
6  * Dick Gooris <gooris@lucent.com>
7  * Ulf Lamping <ulf.lamping@web.de>
8  *
9  * Wireshark - Network traffic analyzer
10  * By Gerald Combs <gerald@wireshark.org>
11  * Copyright 1998 Gerald Combs
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
26  */
27
28 #ifndef __PACKET_RANGE_H__
29 #define __PACKET_RANGE_H__
30
31 #include <glib.h>
32
33 #include <epan/frame_data.h>
34
35 #include <epan/range.h>
36
37 extern guint32  curr_selected_frame;
38
39 typedef enum {
40     range_process_all,
41     range_process_selected,
42     range_process_marked,
43     range_process_marked_range,
44     range_process_user_range
45 } packet_range_e;
46
47 typedef struct packet_range_tag {
48     /* values coming from the UI */
49     packet_range_e  process;            /* which range to process */
50     gboolean        process_filtered;   /* captured or filtered packets */
51     gboolean        remove_ignored;     /* remove ignored packets */
52
53     /* user specified range(s) and, if null, error status */
54     range_t         *user_range;
55     convert_ret_t   user_range_status;
56
57     /* calculated values */
58     guint32  selected_packet;       /* the currently selected packet */
59
60     /* current packet counts (captured) */
61     /* cfile.count */               /* packets in capture file */
62     /* cfile.marked_count */        /* packets marked */
63     guint32  mark_range_cnt;        /* packets in marked range */
64     guint32  user_range_cnt;        /* packets in user specified range */
65     guint32  ignored_cnt;           /* packets ignored */
66     guint32  ignored_marked_cnt;    /* packets ignored and marked */
67     guint32  ignored_mark_range_cnt;/* packets ignored in marked range */
68     guint32  ignored_user_range_cnt;/* packets ignored in user specified range */
69
70     /* current packet counts (displayed) */
71     guint32  displayed_cnt;
72     guint32  displayed_marked_cnt;
73     guint32  displayed_mark_range_cnt;
74     guint32  displayed_user_range_cnt;
75     guint32  displayed_ignored_cnt;
76     guint32  displayed_ignored_marked_cnt;
77     guint32  displayed_ignored_mark_range_cnt;
78     guint32  displayed_ignored_user_range_cnt;
79
80     /* "enumeration" values */
81     gboolean marked_range_active;   /* marked range is currently processed */
82     guint32  marked_range_left;     /* marked range packets left to do */
83     gboolean selected_done;         /* selected packet already processed */
84 } packet_range_t;
85
86 typedef enum {
87     range_process_this,             /* process this packet */
88     range_process_next,             /* skip this packet, process next */
89     range_processing_finished       /* stop processing, required packets done */
90 } range_process_e;
91
92 /* init the range structure */
93 extern void packet_range_init(packet_range_t *range);
94
95 /* check whether the packet range is OK */
96 extern convert_ret_t packet_range_check(packet_range_t *range);
97
98 /* init the processing run */
99 extern void packet_range_process_init(packet_range_t *range);
100
101 /* do we have to process all packets? */
102 extern gboolean packet_range_process_all(packet_range_t *range);
103
104 /* do we have to process this packet? */
105 extern range_process_e packet_range_process_packet(packet_range_t *range, frame_data *fdata);
106
107 /* convert user given string to the internal user specified range representation */
108 extern void packet_range_convert_str(packet_range_t *range, const gchar *es);
109
110 #endif /* __PACKET_RANGE_H__ */