/* range.c
* Range routines
*
- * $Id$
- *
* Dick Gooris <gooris@lucent.com>
* Ulf Lamping <ulf.lamping@web.de>
*
- * Ethereal - Network traffic analyzer
- * By Gerald Combs <gerald@ethereal.com>
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifdef HAVE_CONFIG_H
#include "config.h"
-#endif
#include <string.h>
-#include <ctype.h>
+#include <stdlib.h>
+#include <errno.h>
#include <glib.h>
#include <epan/range.h>
#include <stdio.h>
-/* init the range struct */
-void range_init(range_t *range) {
+/*
+ * Size of the header of a range_t.
+ */
+#define RANGE_HDR_SIZE (sizeof (range_t) - sizeof (range_admin_t))
+
+/* Allocate an empty range. */
+range_t *range_empty(void)
+{
+ range_t *range;
- range->nranges = 0;
- range->ranges[range->nranges].low = 0L;
- range->ranges[range->nranges].high = 0L;
+ range = (range_t *)g_malloc(RANGE_HDR_SIZE);
+ range->nranges = 0;
+ return range;
}
/******************** Range Entry Parser *********************************/
* The parameter 'max_value' specifies the maximum value in a
* range.
*
- * This function fills the array range->ranges containing low and high values
- * with the number of ranges being range->nranges. After having called this
- * function, the function value_is_in_range() determines whether a given
- * number is within the range or not.
+ * This function allocates a range_t large enough to hold the number
+ * of ranges specified, and fills the array range->ranges containing
+ * low and high values with the number of ranges being range->nranges.
+ * After having called this function, the function value_is_in_range()
+ * determines whether a given number is within the range or not.
*
- * In case of a single number, we make a range where low is equal to high.
+ * In case of a single number, we make a range where low is equal to high.
* We take care on wrongly entered ranges; opposite order will be taken
* care of.
- *
+ *
* The following syntax is accepted :
*
* 1-20,30-40 Range from 1 to 20, and packets 30 to 40
*/
convert_ret_t
-range_convert_str(range_t *range, const gchar *es, guint32 max_value)
+range_convert_str(range_t **rangep, const gchar *es, guint32 max_value)
{
- const gchar *p;
- char *endp;
- gchar c;
- guint i;
- guint32 tmp;
- unsigned long val;
-
- /* Reset the number of ranges we are going to find */
- range->nranges = 0;
- range->ranges[range->nranges].low = 0L;
- range->ranges[range->nranges].high = 0L;
-
- /* Process the ranges separately until we get a comma or end of string.
- *
- * We build a structure array called ranges of high and low values. After the
- * following loop, we have the nranges variable which tells how many ranges
- * were found. The number of individual ranges is limited to 'MaxRanges'
- */
-
- p = es;
- for (;;) {
- /* Skip white space. */
- while ((c = *p) == ' ' || c == '\t')
- p++;
- if (c == '\0')
- break;
-
- /* This must be a subrange. */
- if (range->nranges == MaxRange) {
- /* We've filled up the structure; no room for any more. */
- return CVT_TOO_MANY_SUBRANGES;
- }
-
- if (c == '-') {
- /* Subrange starts with 1. */
- range->ranges[range->nranges].low = 1;
- } else {
- /* Subrange starts with the specified number */
- val = strtol(p, &endp, 10);
- if (p == endp) {
+ return range_convert_str_work(rangep, es, max_value, TRUE);
+}
+
+/* This version of range_convert_str() allows the caller to specify whether
+ * values in excess of the range's specified maximum should cause an error or
+ * be silently lowered.
+ * XXX - both the function and the variable could probably use better names.
+ */
+convert_ret_t
+range_convert_str_work(range_t **rangep, const gchar *es, guint32 max_value,
+ gboolean err_on_max)
+{
+
+ range_t *range;
+ guint nranges;
+ const gchar *p;
+ char *endp;
+ gchar c;
+ guint i;
+ guint32 tmp;
+ unsigned long val;
+
+ if ( (rangep == NULL) || (es == NULL) )
+ return CVT_SYNTAX_ERROR;
+
+ /* Allocate a range; this has room for one subrange. */
+ range = (range_t *)g_malloc(RANGE_HDR_SIZE + sizeof (range_admin_t));
+ range->nranges = 0;
+ nranges = 1;
+
+ /* Process the ranges separately until we get a comma or end of string.
+ *
+ * We build a structure array called ranges of high and low values. After the
+ * following loop, we have the nranges variable which tells how many ranges
+ * were found. The number of individual ranges is limited to 'MaxRanges'
+ */
+
+ p = es;
+ for (;;) {
+ /* Skip white space. */
+ while ((c = *p) == ' ' || c == '\t')
+ p++;
+ if (c == '\0')
+ break;
+
+ /* This must be a subrange. Make sure we have room for it. */
+ if (range->nranges >= nranges) {
+ /* Grow the structure.
+ * 4 is an arbitrarily chosen number.
+ * We start with 1, under the assumption that people
+ * will often give a single number or range, and then
+ * proceed to keep it a multiple of 4.
+ */
+ if (nranges == 1)
+ nranges = 4;
+ else
+ nranges += 4;
+ range = (range_t *)g_realloc(range, RANGE_HDR_SIZE +
+ nranges*sizeof (range_admin_t));
+ }
+
+ if (c == '-') {
+ /* Subrange starts with 1. */
+ range->ranges[range->nranges].low = 1;
+ } else if (g_ascii_isdigit(c)) {
+ /* Subrange starts with the specified number */
+ errno = 0;
+ val = strtoul(p, &endp, 0);
+ if (p == endp) {
+ /* That wasn't a valid number. */
+ g_free(range);
+ return CVT_SYNTAX_ERROR;
+ }
+ if (errno == ERANGE || val > max_value) {
+ /* That was valid, but it's too big. Return an error if requested
+ * (e.g., except when reading from the preferences file).
+ */
+ if (err_on_max) {
+ g_free(range);
+ return CVT_NUMBER_TOO_BIG;
+ } else {
+ /* Silently use the range's maximum value */
+ val = max_value;
+ }
+ }
+ p = endp;
+ range->ranges[range->nranges].low = (guint32)val;
+
+ /* Skip white space. */
+ while ((c = *p) == ' ' || c == '\t')
+ p++;
+ } else {
+ /* Neither empty nor a number. */
+ g_free(range);
+ return CVT_SYNTAX_ERROR;
+ }
+
+ if (c == '-') {
+ /* There's a hyphen in the range. Skip past it. */
+ p++;
+
+ /* Skip white space. */
+ while ((c = *p) == ' ' || c == '\t')
+ p++;
+
+ if (c == ',' || c == '\0') {
+ /* End of subrange string; that means the subrange ends
+ * with max_value.
+ */
+ range->ranges[range->nranges].high = max_value;
+ } else if (g_ascii_isdigit(c)) {
+ /* Subrange ends with the specified number. */
+ errno = 0;
+ val = strtoul(p, &endp, 0);
+ if (p == endp) {
/* That wasn't a valid number. */
+ g_free(range);
return CVT_SYNTAX_ERROR;
- }
- p = endp;
- range->ranges[range->nranges].low = val;
+ }
+ if (errno == ERANGE || val > max_value) {
+ /* That was valid, but it's too big. Return an error if requested
+ * (e.g., except when reading from the preferences file).
+ */
+ if (err_on_max) {
+ g_free(range);
+ return CVT_NUMBER_TOO_BIG;
+ } else {
+ /* Silently use the range's maximum value */
+ val = max_value;
+ }
+ }
+ p = endp;
+ range->ranges[range->nranges].high = (guint32)val;
- /* Skip white space. */
- while ((c = *p) == ' ' || c == '\t')
+ /* Skip white space. */
+ while ((c = *p) == ' ' || c == '\t')
p++;
- }
-
- if (c == '-') {
- /* There's a hyphen in the range. Skip past it. */
- p++;
+ } else {
+ /* Neither empty nor a number. */
+ g_free(range);
+ return CVT_SYNTAX_ERROR;
+ }
+ } else if (c == ',' || c == '\0') {
+ /* End of subrange string; that means there's no hyphen
+ * in the subrange, so the start and the end are the same.
+ */
+ range->ranges[range->nranges].high = range->ranges[range->nranges].low;
+ } else {
+ /* Invalid character. */
+ g_free(range);
+ return CVT_SYNTAX_ERROR;
+ }
+ range->nranges++;
+
+ if (c == ',') {
+ /* Subrange is followed by a comma; skip it. */
+ p++;
+ }
+ }
- /* Skip white space. */
- while ((c = *p) == ' ' || c == '\t')
- p++;
+ /* Now we are going through the low and high values, and check
+ * whether they are in a proper order. Low should be equal or lower
+ * than high. So, go through the loop and swap if needed.
+ */
+ for (i=0; i < range->nranges; i++) {
+ if (range->ranges[i].low > range->ranges[i].high) {
+ tmp = range->ranges[i].low;
+ range->ranges[i].low = range->ranges[i].high;
+ range->ranges[i].high = tmp;
+ }
+ }
- if (c == ',' || c == '\0') {
- /*
- * End of subrange string; that means the subrange ends
- * with max_value.
- */
- range->ranges[range->nranges].high = max_value;
- } else {
- /* Subrange ends with the specified number. */
- val = strtol(p, &endp, 10);
- if (p == endp) {
- /* That wasn't a valid number. */
- return CVT_SYNTAX_ERROR;
- }
- p = endp;
- range->ranges[range->nranges].high = val;
-
- /* Skip white space. */
- while ((c = *p) == ' ' || c == '\t')
- p++;
- }
- } else if (c == ',' || c == '\0') {
- /*
- * End of subrange string; that means there's no hyphen
- * in the subrange, so the start and the end are the same.
- */
- range->ranges[range->nranges].high =
- range->ranges[range->nranges].low;
- } else {
- /* Invalid character. */
- return CVT_SYNTAX_ERROR;
- }
- range->nranges++;
-
- if (c == ',') {
- /* Subrange is followed by a comma; skip it. */
- p++;
- }
- }
-
- /* Now we are going through the low and high values, and check
- * whether they are in a proper order. Low should be equal or lower
- * than high. So, go through the loop and swap if needed.
- */
- for (i=0; i < range->nranges; i++) {
- if (range->ranges[i].low > range->ranges[i].high) {
- tmp = range->ranges[i].low;
- range->ranges[i].low = range->ranges[i].high;
- range->ranges[i].high = tmp;
- }
- }
-
- /* In case we want to know what the result ranges are :
- *
- * for (i=0; i < range->nranges; i++) {
- * printf("Function : range_convert_str L=%u \t H=%u\n",range->ranges[i].low,range->ranges[i].high);
- * }
- *
- */
- return CVT_NO_ERROR;
+ /* In case we want to know what the result ranges are :
+ *
+ * for (i=0; i < range->nranges; i++) {
+ * printf("Function : range_convert_str L=%u \t H=%u\n",range->ranges[i].low,range->ranges[i].high);
+ * }
+ *
+ */
+ *rangep = range;
+ return CVT_NO_ERROR;
} /* range_convert_str */
/* This function returns TRUE if a given value is within one of the ranges
* stored in the ranges array.
*/
-gboolean value_is_in_range(range_t *range, guint32 val)
+gboolean
+value_is_in_range(range_t *range, guint32 val)
{
guint i;
- for (i=0; i < range->nranges; i++) {
- if (val >= range->ranges[i].low && val <= range->ranges[i].high)
- return TRUE;
+ if (range) {
+ for (i=0; i < range->nranges; i++) {
+ if (val >= range->ranges[i].low && val <= range->ranges[i].high)
+ return TRUE;
+ }
}
return(FALSE);
}
/* This function returns TRUE if the two given range_t's are equal.
*/
-gboolean ranges_are_equal(range_t *a, range_t *b)
+gboolean
+ranges_are_equal(range_t *a, range_t *b)
{
guint i;
+ if ( (a == NULL) || (b == NULL) )
+ return FALSE;
+
if (a->nranges != b->nranges)
return FALSE;
for (i=0; i < a->nranges; i++) {
if (a->ranges[i].low != b->ranges[i].low)
- return FALSE;
+ return FALSE;
if (a->ranges[i].high != b->ranges[i].high)
- return FALSE;
+ return FALSE;
}
return TRUE;
{
guint32 i, j;
- for (i=0; i < range->nranges; i++) {
- for (j = range->ranges[i].low; j <= range->ranges[i].high; j++)
- callback(j);
+ if (range && callback) {
+ for (i=0; i < range->nranges; i++) {
+ for (j = range->ranges[i].low; j <= range->ranges[i].high; j++)
+ callback(j);
+ }
}
}
-/* This function converts a range_t to a (caller-provided) string. */
+/* This function converts a range_t to a (wmem-allocated) string. */
char *
-range_convert_range(range_t *range, char *string)
+range_convert_range(wmem_allocator_t *scope, const range_t *range)
{
- guint32 i, k;
-
- k = 0;
- string[k] = '\0';
-
- for (i=0; i < range->nranges; i++) {
- if (i != 0)
- string[k++] = ',';
-
- k += sprintf(&string[k], "%d-%d", range->ranges[i].low,
- range->ranges[i].high);
+ guint32 i;
+ gboolean prepend_comma = FALSE;
+ wmem_strbuf_t *strbuf;
+
+ strbuf=wmem_strbuf_new(scope, "");
+
+ if (range) {
+ for (i=0; i < range->nranges; i++) {
+ if (range->ranges[i].low == range->ranges[i].high) {
+ wmem_strbuf_append_printf(strbuf, "%s%u", prepend_comma?",":"", range->ranges[i].low);
+ } else {
+ wmem_strbuf_append_printf(strbuf, "%s%u-%u", prepend_comma?",":"", range->ranges[i].low, range->ranges[i].high);
+ }
+ prepend_comma = TRUE;
+ }
}
+ return wmem_strbuf_finalize(strbuf);
+}
+
+/* Create a copy of a range. */
+range_t *
+range_copy(range_t *src)
+{
+ range_t *dst;
+ size_t range_size;
- return(string);
+ if (src == NULL)
+ return NULL;
+ range_size = RANGE_HDR_SIZE + src->nranges*sizeof (range_admin_t);
+ dst = (range_t *)g_malloc(range_size);
+ memcpy(dst, src, range_size);
+ return dst;
}
#if 0
/* This is a debug function to check the range functionality */
-static void value_is_in_range_check(range_t *range, guint32 val)
+static void
+value_is_in_range_check(range_t *range, guint32 val)
{
+ /* Print the result for a given value */
+ printf("Function : value_is_in_range_check Number %u\t",val);
- /* Print the result for a given value */
- printf("Function : value_is_in_range_check Number %u\t",val);
-
- if (value_is_in_range(range, val)) {
- printf("is in range\n");
- } else {
- printf("is not in range\n");
- }
+ if (value_is_in_range(range, val)) {
+ printf("is in range\n");
+ } else {
+ printf("is not in range\n");
+ }
}
#endif
+
+/*
+ * Editor modelines - http://www.wireshark.org/tools/modelines.html
+ *
+ * Local Variables:
+ * c-basic-offset: 3
+ * tab-width: 8
+ * indent-tabs-mode: nil
+ * End:
+ *
+ * ex: set shiftwidth=3 tabstop=8 expandtab:
+ * :indentSize=3:tabSize=8:noTabs=true:
+ */