Rename "range.c" and "range.h" to "packet-range.c" and "packet-range.h";

they should ultimately be split into files with routines that handle
ranges, which are just subsets of [0,2^32), and packet ranges, which are
subsets of the packet list, possibly specified by a range.

Move them into epan, so they can be used by, for example, utilities that
handle ranges, such editcap.

svn path=/trunk/; revision=11890

1 files changed, 458 insertions, 0 deletions

diff --git a/epan/packet-range.c b/epan/packet-range.c
new file mode 100644
index 0000000000..c786afb3f9
--- /dev/null
+++ b/epan/packet-range.c
@@ -0,0 +1,458 @@
+/* packet-range.c
+ * Packet range routines (save, print, ...)
+ *
+ * $Id$
+ *
+ * Dick Gooris <gooris@lucent.com>
+ * Ulf Lamping <ulf.lamping@web.de>
+ *
+ * Ethereal - Network traffic analyzer
+ * By Gerald Combs <gerald@ethereal.com>
+ * Copyright 1998 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * 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.
+ */
+
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <string.h>
+#include <ctype.h>
+
+#include <glib.h>
+
+#include <epan/frame_data.h>
+
+#include <epan/packet-range.h>
+
+#include "globals.h"
+
+
+static gboolean packet_is_in_range(packet_range_t *range, guint32 val);
+
+
+/* (re-)calculate the packet counts (except the user specified range) */
+void packet_range_calc(packet_range_t *range) {
+  guint32       current_count;
+  guint32       mark_low;
+  guint32       mark_high;
+  guint32       displayed_mark_low;
+  guint32       displayed_mark_high;
+  frame_data    *packet;
+
+
+  range->selected_packet        = 0L;
+
+  mark_low                      = 0L;
+  mark_high                     = 0L;
+  range->mark_range_cnt         = 0L;
+
+  displayed_mark_low            = 0L;
+  displayed_mark_high           = 0L;
+  range->displayed_cnt          = 0L;
+  range->displayed_marked_cnt   = 0L;
+  range->displayed_mark_range_cnt=0L;
+
+  /* The next for-loop is used to obtain the amount of packets to be processed
+   * and is used to present the information in the Save/Print As widget.
+   * We have different types of ranges: All the packets, the number
+   * of packets of a marked range, a single packet, and a user specified 
+   * packet range. The last one is not calculated here since this
+   * data must be entered in the widget by the user.
+   */
+
+  current_count = 0;
+  for(packet = cfile.plist; packet != NULL; packet = packet->next) {
+      current_count++;
+      if (cfile.current_frame == packet) {
+          range->selected_packet = current_count;
+      }
+      if (packet->flags.passed_dfilter) {
+          range->displayed_cnt++;
+      }
+      if (packet->flags.marked) {
+            if (packet->flags.passed_dfilter) {
+                range->displayed_marked_cnt++;
+                if (displayed_mark_low == 0) {
+                   displayed_mark_low = current_count;
+                }
+                if (current_count > displayed_mark_high) {
+                   displayed_mark_high = current_count;
+                }
+            }
+
+            if (mark_low == 0) {
+               mark_low = current_count;
+            }
+            if (current_count > mark_high) {
+               mark_high = current_count;
+            }
+      }
+  }
+        
+  current_count = 0;
+  for(packet = cfile.plist; packet != NULL; packet = packet->next) {
+      current_count++;
+
+      if (current_count >= mark_low && 
+          current_count <= mark_high)
+      {
+          range->mark_range_cnt++;
+      }
+
+      if (current_count >= displayed_mark_low && 
+          current_count <= displayed_mark_high)
+      {
+          if (packet->flags.passed_dfilter) {
+            range->displayed_mark_range_cnt++;
+          }
+      }
+  }
+
+  /* in case we marked just one packet, we add 1. */
+  /*if (cfile.marked_count != 0) {
+    range->mark_range = mark_high - mark_low + 1;
+  }*/
+        
+  /* in case we marked just one packet, we add 1. */
+  /*if (range->displayed_marked_cnt != 0) {
+    range->displayed_mark_range = displayed_mark_high - displayed_mark_low + 1;
+  }*/
+}
+
+
+/* (re-)calculate the user specified packet range counts */
+void packet_range_calc_user(packet_range_t *range) {
+  guint32       current_count;
+  frame_data    *packet;
+
+  range->user_range_cnt             = 0L;
+  range->displayed_user_range_cnt   = 0L;
+
+  current_count = 0;
+  for(packet = cfile.plist; packet != NULL; packet = packet->next) {
+      current_count++;
+
+      if (packet_is_in_range(range, current_count)) {
+          range->user_range_cnt++;
+          if (packet->flags.passed_dfilter) {
+            range->displayed_user_range_cnt++;
+          }
+      }
+  }
+}
+
+
+/* init the range struct */
+void packet_range_init(packet_range_t *range) {
+
+  range->process            = range_process_all;
+  range->process_filtered   = FALSE;
+  range->nranges            = 0;
+  range->ranges[range->nranges].low  = 0L;
+  range->ranges[range->nranges].high = 0L;
+
+  /* calculate all packet range counters */
+  packet_range_calc(range);
+  packet_range_calc_user(range);
+}
+
+/* init the processing run */
+void packet_range_process_init(packet_range_t *range) {
+  /* "enumeration" values */
+  range->marked_range_active    = FALSE;
+  range->selected_done          = FALSE;
+
+  if (range->process_filtered == FALSE) {
+    range->marked_range_left = range->mark_range_cnt;
+  } else {
+    range->marked_range_left = range->displayed_mark_range_cnt;
+  }
+}
+
+/* do we have to process all packets? */
+gboolean packet_range_process_all(packet_range_t *range) {
+    return range->process == range_process_all && !range->process_filtered;
+}
+
+/* do we have to process this packet? */
+range_process_e packet_range_process_packet(packet_range_t *range, frame_data *fdata) {
+
+    switch(range->process) {
+    case(range_process_all):
+        break;
+    case(range_process_selected):
+        if (range->selected_done) {
+          return range_processing_finished;
+        }
+        if (fdata->num != cfile.current_frame->num) {
+          return range_process_next;
+        }
+        range->selected_done = TRUE;
+        break;
+    case(range_process_marked):
+        if (fdata->flags.marked == FALSE) {
+          return range_process_next;
+        }
+        break;
+    case(range_process_marked_range):
+        if (range->marked_range_left == 0) {
+          return range_processing_finished;
+        }
+        if (fdata->flags.marked == TRUE) {
+          range->marked_range_active = TRUE;
+        }
+        if (range->marked_range_active == FALSE ) {
+          return range_process_next;
+        }
+        if (!range->process_filtered ||
+          (range->process_filtered && fdata->flags.passed_dfilter == TRUE))
+        {
+          range->marked_range_left--;
+        }
+        break;
+    case(range_process_user_range):
+        if (packet_is_in_range(range, fdata->num) == FALSE) {
+          return range_process_next;
+        }
+        break;
+    default:
+        g_assert_not_reached();
+    }
+
+    /* this packet has to pass the display filter but didn't? -> try next */
+    if (range->process_filtered && fdata->flags.passed_dfilter == FALSE) {
+        return range_process_next;
+    }
+
+    /* We fell through the conditions above, so we accept this packet */
+    return range_process_this;
+}
+
+
+/******************** Range Entry Parser *********************************/
+
+/* Converts a range string to a fast comparable array of ranges.
+ * The parameter 'es' points to the string to be converted, and is defined in
+ * the Save/Print-As widget.
+ *
+ * This function fills the array ranges containing low and high values indexed 
+ * by a global variable nranges. After having called this function, the function 
+ * packet_is_in_range() determines whether a given (packet) number is within 
+ * the range or not. 
+ *
+ * In case of a single packet number, we make a range where low is equal to high. 
+ * We strip any characters other than commas, digits, or hyphens. 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
+ *   -20,30         Range from 1 to 20, and packet 30
+ *   20,30,40-      Packet number 20, 30, and the range from 40 to the end
+ *   20-10,30-25    Range from 10 to 20, and from 25 to 30
+ *   -              All packets
+ */
+
+void packet_range_convert_str(packet_range_t *range, const gchar *es)
+{
+    gchar     EntryStr[255], OrgStr[255], value[255], p;
+    guint     i, j=0;
+    guint32   tmp, val;
+    gboolean  hyphenseen;
+
+    /* 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;
+
+    /* Make a copy of the string, and check the validity of the input */
+    strcpy(OrgStr,es);
+    if (strlen(OrgStr) == 0 ) {
+        return;
+    }
+
+    /* Only keep digits, commas, and hyphens. */
+    for (i=0; i<=strlen(OrgStr); i++) {
+      if ( isdigit((guchar)OrgStr[i]) || OrgStr[i] == '-' || OrgStr[i] == ',' ) {
+         EntryStr[j++] = OrgStr[i];
+      }
+    }
+    EntryStr[j] = '\0';
+
+    /* Remove any starting commas */
+    strcpy(OrgStr,EntryStr);
+    i = 0;
+    while (OrgStr[i] == ',') {
+       i++;
+    }
+    strcpy(EntryStr,OrgStr+i);
+
+    /* Remove any double commas */
+    strcpy(OrgStr,EntryStr);
+    p = ',';
+    j = 0;
+    for (i=0; i<=strlen(OrgStr); i++) {
+      if ( OrgStr[i] != ',' || p != ',') {
+         EntryStr[j++] = OrgStr[i];
+      }
+      p = OrgStr[i];
+    }
+    EntryStr[j] = '\0';
+
+    /* Remove any double hyphens */
+    strcpy(OrgStr,EntryStr);
+    p = '-';
+    j = 0;
+    for (i=0; i<=strlen(OrgStr); i++) {
+      if (OrgStr[i] != '-' || p != '-' || i == 0) {
+         EntryStr[j++] = OrgStr[i];
+      }
+      p = OrgStr[i];
+    }
+    EntryStr[j] = '\0';
+
+    /* Remove any trailing commas */
+    i = strlen(EntryStr) - 1;
+    while (EntryStr[i] == ',') {
+       EntryStr[i] = '\0';
+       i--;
+    }
+
+    /* The entry string is now filtered, and ready for further parsing */
+    /* printf("Function : packet_range_convert_str EntryStr = %s\n",EntryStr); */
+
+    /* Now we are going to 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'
+     */
+
+    j = 0;
+    hyphenseen = FALSE;
+    for (i=0; i<=strlen(EntryStr);i++) {
+
+       /* Copy the digit string until a no-digit character is seen */
+       if (isdigit((guchar)EntryStr[i])) {
+          value[j++] = EntryStr[i];
+          continue;
+       }
+
+       /* Terminate the digit string, and convert it */
+       value[j] = '\0';
+       val=atol(value);
+       j=0;
+
+       /* In case we see a hyphen, store the value we read in the low part 
+        * of ranges. In case it is a trailer hyphen, store the low value, and
+        * set the high value to the maximum of packets captured.
+        */
+       if (EntryStr[i] == '-') {
+          /* If this is a trailer hyphen, then treat it in a different
+           * way, then the high value is the maximum number of packets counted
+           * and we are ready 
+           */
+          if (i == strlen(EntryStr)-1) {
+             range->ranges[range->nranges].low  = val;
+             range->ranges[range->nranges].high = cfile.count;
+             range->nranges++;
+             break;
+          } else {
+             /* Store the low value of the range */
+             range->ranges[range->nranges].low  = val;
+          }
+          hyphenseen=TRUE;
+          continue;
+       }
+
+       /* In case we see a comma, or end of string */
+       if (EntryStr[i] == ',' || i == strlen(EntryStr)) {
+          if (hyphenseen) {
+             /* Normal treatment: store the high value range in ranges */
+             range->ranges[range->nranges].high = val;
+          } else {
+             /* We did not see a hyphen and we get a comma, then this must
+              * be a single packet number */
+             range->ranges[range->nranges].low  = val;
+             range->ranges[range->nranges].high = val;
+          }
+          hyphenseen=FALSE;
+       }
+
+       /* Increase the index for the number of ranges we found, and protect
+        * against wildly outside array bound jumps */
+       range->nranges++;
+       if (range->nranges > MaxRange) {
+           range->nranges--;
+       }
+    }
+    range->nranges--;
+
+    /*  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 <= nranges; i++) {
+     *  printf("Function : packet_range_convert_str L=%u \t H=%u\n",ranges[i].low,ranges[i].high);
+     * }
+     *
+     */
+
+    /* calculate new user specified packet range counts */
+    packet_range_calc_user(range);
+} /* packet_range_convert_str */
+
+/* This function returns TRUE if a given value is within one of the ranges
+ * stored in the ranges array.
+ */
+static gboolean packet_is_in_range(packet_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;
+   }
+   return(FALSE);
+}
+
+#if 0
+/* This is a debug function to check the range functionality */
+static void packet_is_in_range_check(packet_range_t *range, guint32 val)
+{
+
+  /* Print the result for a given value */
+  printf("Function : packet_is_in_range_check Number %u\t",val);
+
+  if (packet_is_in_range(range, val)) {
+     printf("is in range\n");
+  } else {
+     printf("is not in range\n");
+  }
+}
+#endif