Clean up the Range class and associated usages. The code was

never clear about whether the end of the range was inclusive
or exclusive.  Make it inclusive, but also provide a RangeSize()
function that will generate a Range based on a start and a size.
This, in combination with using the comparison operators, makes
almost all usages of the range not care how it is stored.

base/range.cc:
    Make the end of the range inclusive.

    start/end -> first/last
    (end seems too much like end() in stl)
base/range.hh:
    Make the end of the range inclusive.

    Fix all comparison operators so that they work correctly with
    an inclusive range.  Also, when comparing one range to another
    with <, <=, >, >=, we only look at the beginning of the range
    beacuse x <= y should be the same as x < y || x == y.  (This wasn't
    the case before.)

    Add a few functions for making a range:
    RangeSize is start and size
    RangeEx is start and end where end is exclusive
    RangeIn is start and end where end is inclusive

    start/end -> first/last
    (end seems too much like end() in stl)
dev/alpha_console.cc:
dev/baddev.cc:
dev/ide_ctrl.cc:
dev/ns_gige.cc:
dev/pciconfigall.cc:
dev/pcidev.cc:
dev/tsunami_cchip.cc:
dev/tsunami_io.cc:
dev/tsunami_pchip.cc:
dev/uart.cc:
    Use the RangeSize function to create a range.

--HG--
extra : convert_revision : 29a7eb7fce745680f1c77fefff456c2144bc3994

2 files changed, 55 insertions, 82 deletions

diff --git a/base/range.cc b/base/range.cc
index 4453ecc9f..1087c02c8 100644
--- a/base/range.cc
+++ b/base/range.cc
@@ -34,12 +34,12 @@ using namespace std;
 
 template <class T>
 bool
-__x_parse_range(const std::string &str, T &start, T &end)
+__x_parse_range(const std::string &str, T &first, T &last)
 {
     std::vector<std::string> values;
     tokenize(values, str, ':');
 
-    T thestart, theend;
+    T thefirst, thelast;
 
     if (values.size() != 2)
         return false;
@@ -47,29 +47,29 @@ __x_parse_range(const std::string &str, T &start, T &end)
     std::string s = values[0];
     std::string e = values[1];
 
-    if (!to_number(s, thestart))
+    if (!to_number(s, thefirst))
         return false;
 
     bool increment = (e[0] == '+');
     if (increment)
         e = e.substr(1);
 
-    if (!to_number(e, theend))
+    if (!to_number(e, thelast))
         return false;
 
     if (increment)
-        theend += thestart;
+        thelast += thefirst - 1;
 
-    start = thestart;
-    end = theend;
+    first = thefirst;
+    last = thelast;
 
     return true;
 }
 
 #define RANGE_PARSE(type) \
 template<> bool \
-__parse_range(const std::string &s, type &start, type &end) \
-{ return __x_parse_range(s, start, end); }
+__parse_range(const std::string &s, type &first, type &last) \
+{ return __x_parse_range(s, first, last); }
 
 RANGE_PARSE(unsigned long long);
 RANGE_PARSE(signed long long);
diff --git a/base/range.hh b/base/range.hh
index 2197e2f86..9289792ea 100644
--- a/base/range.hh
+++ b/base/range.hh
@@ -26,44 +26,32 @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef __RANGE_HH__
-#define __RANGE_HH__
+#ifndef __BASE_RANGE_HH__
+#define __BASE_RANGE_HH__
 
 #include <cassert>
 #include <string>
 
+/**
+ * @param s range string
+ * EndExclusive Ranges are in the following format:
+ *    <range> := {<start_val>}:{<end>}
+ *    <start>   := <end_val> | +<delta>
+ */
 template <class T>
 bool __parse_range(const std::string &s, T &start, T &end);
 
 template <class T>
 struct Range
 {
-  private:
-    /**
-     * @param s range string
-     * Ranges are in the following format:
-     *    <range> := {<start_val>}:{<end>}
-     *    <end>   := <end_val> | +<delta>
-     */
-    void
-    parse(const std::string &s)
-    {
-        if (!__parse_range(s, start, end))
-            invalidate();
-    }
-
-  public:
     T start;
     T end;
 
-  public:
-    Range()
-    {
-        invalidate();
-    }
+    Range() { invalidate(); }
 
-    Range(T first, T second)
-        : start(first), end(second)
+    template <class U>
+    Range(const std::pair<U, U> &r)
+        : start(r.first), end(r.second)
     {}
 
     template <class U>
@@ -71,14 +59,10 @@ struct Range
         : start(r.start), end(r.end)
     {}
 
-    template <class U>
-    Range(const std::pair<U, U> &r)
-        : start(r.first), end(r.second)
-    {}
-
     Range(const std::string &s)
     {
-        parse(s);
+        if (!__parse_range(s, start, end))
+            invalidate();
     }
 
     template <class U>
@@ -99,32 +83,39 @@ struct Range
 
     const Range &operator=(const std::string &s)
     {
-        parse(s);
+        if (!__parse_range(s, start, end))
+            invalidate();
         return *this;
     }
 
-    void invalidate() { start = 0; end = 0; }
-    T size() const { return end - start; }
+    void invalidate() { start = 1; end = 0; }
+    T size() const { return end - start + 1; }
     bool valid() const { return start < end; }
 };
 
 template <class T>
-inline Range<T>
-make_range(T start, T end)
-{
-    return Range<T>(start, end);
-}
-
-template <class T>
 inline std::ostream &
 operator<<(std::ostream &o, const Range<T> &r)
 {
-    // don't currently support output of invalid ranges
-    assert(r.valid());
-    o << r.start << ":" << r.end;
+    o << '[' << r.start << "," << r.end << ']';
     return o;
 }
 
+template <class T>
+inline Range<T>
+RangeEx(T start, T end)
+{ return std::make_pair(start, end - 1); }
+
+template <class T>
+inline Range<T>
+RangeIn(T start, T end)
+{ return std::make_pair(start, end); }
+
+template <class T, class U>
+inline Range<T>
+RangeSize(T start, U size)
+{ return std::make_pair(start, start + size - 1); }
+
 ////////////////////////////////////////////////////////////////////////
 //
 // Range to Range Comparisons
@@ -139,7 +130,6 @@ template <class T, class U>
 inline bool
 operator==(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
     return range1.start == range2.start && range1.end == range2.end;
 }
 
@@ -152,7 +142,6 @@ template <class T, class U>
 inline bool
 operator!=(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
     return range1.start != range2.start || range1.end != range2.end;
 }
 
@@ -165,8 +154,7 @@ template <class T, class U>
 inline bool
 operator<(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
-    return range1.end <= range2.start;
+    return range1.start < range2.start;
 }
 
 /**
@@ -179,8 +167,7 @@ template <class T, class U>
 inline bool
 operator<=(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
-    return range1.start <= range2.start && range1.end <= range2.end;
+    return range1.start <= range2.start;
 }
 
 /**
@@ -192,8 +179,7 @@ template <class T, class U>
 inline bool
 operator>(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
-    return range1.start >= range2.end;
+    return range1.start > range2.start;
 }
 
 /**
@@ -206,8 +192,7 @@ template <class T, class U>
 inline bool
 operator>=(const Range<T> &range1, const Range<U> &range2)
 {
-    assert(range1.valid() && range2.valid());
-    return range1.start >= range2.start && range1.end >= range2.end;
+    return range1.start >= range2.start;
 }
 
 ////////////////////////////////////////////////////////////////////////
@@ -224,7 +209,6 @@ template <class T, class U>
 inline bool
 operator==(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
     return pos >= range.start && pos <= range.end;
 }
 
@@ -237,8 +221,7 @@ template <class T, class U>
 inline bool
 operator!=(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
-    return pos < range.start || pos >= range.end;
+    return pos < range.start || pos > range.end;
 }
 
 /**
@@ -250,7 +233,6 @@ template <class T, class U>
 inline bool
 operator<(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
     return pos < range.start;
 }
 
@@ -263,8 +245,7 @@ template <class T, class U>
 inline bool
 operator<=(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
-    return pos < range.end;
+    return pos <= range.end;
 }
 
 /**
@@ -276,8 +257,7 @@ template <class T, class U>
 inline bool
 operator>(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
-    return pos >= range.end;
+    return pos > range.end;
 }
 
 /**
@@ -289,7 +269,6 @@ template <class T, class U>
 inline bool
 operator>=(const T &pos, const Range<U> &range)
 {
-    assert(range.valid());
     return pos >= range.start;
 }
 
@@ -307,8 +286,7 @@ template <class T, class U>
 inline bool
 operator==(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
-    return pos >= range.start && pos < range.end;
+    return pos >= range.start && pos <= range.end;
 }
 
 /**
@@ -320,8 +298,7 @@ template <class T, class U>
 inline bool
 operator!=(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
-    return pos < range.start || pos >= range.end;
+    return pos < range.start || pos > range.end;
 }
 
 /**
@@ -333,8 +310,7 @@ template <class T, class U>
 inline bool
 operator<(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
-    return range.end <= pos;
+    return range.end < pos;
 }
 
 /**
@@ -346,7 +322,6 @@ template <class T, class U>
 inline bool
 operator<=(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
     return range.start <= pos;
 }
 
@@ -359,7 +334,6 @@ template <class T, class U>
 inline bool
 operator>(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
     return range.start > pos;
 }
 
@@ -372,8 +346,7 @@ template <class T, class U>
 inline bool
 operator>=(const Range<T> &range, const U &pos)
 {
-    assert(range.valid());
-    return range.end > pos;
+    return range.end >= pos;
 }
 
-#endif // __RANGE_HH__
+#endif // __BASE_RANGE_HH__