6 * Dick Gooris <gooris@lucent.com>
7 * Ulf Lamping <ulf.lamping@web.de>
9 * Wireshark - Network traffic analyzer
10 * By Gerald Combs <gerald@wireshark.org>
11 * Copyright 1998 Gerald Combs
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.
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.
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.
34 * Range strings a variant of value_strings
37 /**@todo where's the best place for these? */
38 #define MAX_SCTP_PORT 65535
39 #define MAX_TCP_PORT 65535
40 #define MAX_UDP_PORT 65535
41 #define MAX_DCCP_PORT 65535
43 typedef struct range_admin_tag {
48 /** user specified range(s) */
49 typedef struct range {
50 guint nranges; /**< number of entries in ranges */
51 range_admin_t ranges[1]; /**< variable-length array */
55 * Return value from range_convert_str().
63 extern range_t *range_empty(void);
66 /*** Converts a range string to a fast comparable array of ranges.
67 * This function allocates a range_t large enough to hold the number
68 * of ranges specified, and fills the array range->ranges containing
69 * low and high values with the number of ranges being range->nranges.
70 * After having called this function, the function value_is_in_range()
71 * determines whether a given number is within the range or not.<BR>
72 * In case of a single number, we make a range where low is equal to high.
73 * We take care on wrongly entered ranges; opposite order will be taken
76 * The following syntax is accepted :
78 * 1-20,30-40 Range from 1 to 20, and packets 30 to 40
79 * -20,30 Range from 1 to 20, and packet 30
80 * 20,30,40- 20, 30, and the range from 40 to the end
81 * 20-10,30-25 Range from 10 to 20, and from 25 to 30
83 * @param range the range
84 * @param es points to the string to be converted.
85 * @param max_value' specifies the maximum value in a range.
88 extern convert_ret_t range_convert_str(range_t **range, const gchar *es,
91 extern convert_ret_t range_convert_str_work(range_t **range, const gchar *es,
92 guint32 max_value, gboolean err_on_max);
94 /** This function returns TRUE if a given value is within one of the ranges
95 * stored in the ranges array.
96 * @param range the range
97 * @param val the value to check
98 * @return TRUE if the value is in range
100 extern gboolean value_is_in_range(range_t *range, guint32 val);
102 /** This function returns TRUE if the two given range_t's are equal.
103 * @param a first range
104 * @param b second range
105 * @return TRUE if the value is in range
107 extern gboolean ranges_are_equal(range_t *a, range_t *b);
109 /** This function calls the provided callback function for each value in
111 * @param range the range
112 * @param callback the callback function
114 extern void range_foreach(range_t *range, void (*callback)(guint32 val));
117 * This function converts a range_t to a (ep_alloc()-allocated) string.
119 extern char *range_convert_range(range_t *range);
122 * Create a copy of a range.
123 * @param src the range to copy
124 * @return ep allocated copy of the range
126 extern range_t *range_copy(range_t *src);
128 #endif /* __RANGE_H__ */