Changeset 562

Timestamp:

Dec 15, 2006 11:11:16 PM (17 years ago)

Author:

dkearney

Message:

adjustments to how gauge.tcl deals with values for integer and number entries and properly identifies users inputted units if any.
added tests to units.test for some corner case inputs i found caused segfaults. these corner cases were fixed in the core units library and in the tcl bindings. they were mainly bugs regarding the new "rappture units search for" function and the description function. addeda function called unitsSlice() which centralizes the function used to split a string into what we think are probably units and a double value. this was centralized in preparation for possible inclusion of demensionless values like which might be refered to with a name in front of the numerical value, like "mach 1"

Location:

trunk

Files:

• gui/scripts/gauge.tcl (modified) (1 diff)
• src/core/RpUnits.cc (modified) (6 diffs)
• src/core/RpUnits.h (modified) (1 diff)
• src/tcl/src/RpUnitsTclInterface.cc (modified) (3 diffs)
• src/tcl/tests/units.test (modified) (3 diffs)

trunk/gui/scripts/gauge.tcl

@@ -220 +220 @@
         if {$units != ""} {
             set nvUnits [Rappture::Units::Search::for $nv]
+            if { "" == $nvUnits} {
+                set msg [Rappture::Units::description $units]
+                error "Unrecognized units: $nv\n$mesg"
+            }
             set newval [Rappture::Units::convert $newval \
                 -context $units]

trunk/src/core/RpUnits.cc

@@ -987 +987 @@
         }
 
+        // check to see if we came across a '*' character
+        if (myInUnits[last] == '*') {
+            // type = myInUnits[last] + type;
+            // ignore * because we assume everything is multiplied together
+            myInUnits.erase(last);
+            continue;
+        }
+
         // get the exponent
         offset = RpUnits::grabExponent(myInUnits,&exponent);
         myInUnits.erase(offset);
         idx = offset - 1;
+        last = myInUnits.length()-1;
+        if (last == -1) {
+            // the string is empty, units were not correctly entered
+            err = 1;
+            break;
+        }
 
         // grab the largest string we can find
         offset = RpUnits::grabUnitString(myInUnits);
-        idx = offset;
+
+        // if idx > length, then the grabUnitString went through the whole
+        // string and did not find a good string we could use as units.
+        // this generally means the string was filled with non alphabetical
+        // symbols like *&^%$#@!)(~`{}[]:;"'?/><,.-_=+\ or |
+
+        if (offset > last) {
+            err = 1;
+            // erase the last offending character
+            myInUnits.erase(last);
+            // reset our vars and try again
+            idx = 0;
+            offset = 0;
+            exponent = 1;
+            continue;
+        }
+        else {
+            idx = offset;
+        }
 
         // figure out if we have some defined units in that string
@@ -1019 +1051 @@
             // raise error and delete character for now
             err = 1;
-            myInUnits.erase(last);
+            myInUnits.erase(idx);
         }
 
@@ -1247 +1279 @@
     double fromExp = 0;
     int convErr = 0;
-    char* endptr = NULL;
     std::stringstream outVal;
 
@@ -1272 +1303 @@
     //
 
-    numVal = strtod(val.c_str(),&endptr);
+    convErr = unitSlice(val,fromUnitsName,numVal);
     origNumVal = numVal;
 
-    if ( (numVal == 0) && (endptr == val.c_str()) ) {
+    if (convErr != 0) {
         // no conversion was done.
         // number in incorrect format probably.
@@ -1284 +1315 @@
     }
 
-    fromUnitsName = std::string(endptr);
-
     if (toUnitsName.empty())  {
-        // there were no units in the input 
+        // there were no units in the input
         // string or no conversion needed
         // assume fromUnitsName = toUnitsName
@@ -2685 +2714 @@
     return retVal;
 }
+
+/**********************************************************************/
+// FUNCTION: unitSlice()
+/// Convert a std::string into what might be the value and units
+/**
+ * Returns 0 on success, anything else is error
+ */
+
+int
+unitSlice (std::string inStr, std::string& outUnits, double& outVal)
+{
+    int retVal      = 0;  // return val 0 is success, otherwise failure
+    char *endptr    = NULL;
+
+    outVal = strtod(inStr.c_str(), &endptr);
+
+    if ( (outVal == 0) && (endptr == inStr.c_str()) ) {
+        // no conversion performed
+        retVal = 1;
+    }
+    else {
+    }
+
+    outUnits = std::string(endptr);
+
+    return retVal;
+}

trunk/src/core/RpUnits.h

@@ -708 +708 @@
 int list2str (std::list<std::string>& inList, std::string& outString);
 
+int unitSlice (std::string inStr, std::string& outUnits, double& outVal);
+
 #endif // ifdef __cplusplus
 

trunk/src/tcl/src/RpUnitsTclInterface.cc

@@ -327 +327 @@
     // parse through command line options
     if (argc != 2) {
-        Tcl_AppendResult(interp, 
+        Tcl_AppendResult(interp,
                 "wrong # args: should be \"", argv[0], 
                 " units\"", (char*)NULL);
@@ -500 +500 @@
 {
     std::string unitsName     = ""; // name of the units provided by user
+    std::string origUnitsName = ""; // name of the units provided by user
     std::string type          = ""; // junk variable that validate() needs
     int nextarg               = 1; // start parsing using the '2'th argument
     int err                   = 0; // err code for validate
-    char* endptr              = NULL;
+    double val                = 0;
 
     Tcl_ResetResult(interp);
@@ -515 +516 @@
 
     // find where the unitsName begins
-    strtod(argv[nextarg],&endptr);
-    unitsName = std::string(endptr);
+    unitSlice(std::string(argv[nextarg]),unitsName,val);
 
     err = RpUnits::validate(unitsName,type);
     if (err) {
         /*
-         * according to tcl version, in this case we 
+         * according to tcl version, in this case we
          * should return an empty string. i happen to disagree.
          * the next few lines is what i think the user should see.
         Tcl_AppendResult(interp,
-            "The units named: \"", unitsName.c_str(), 
-            "\" is not a recognized unit for rappture",
-            (char*)NULL);
+            "Unrecognized units: \"", origUnitsName.c_str(), "\"", (char*)NULL);
         return TCL_ERROR;
         */

trunk/src/tcl/tests/units.test

@@ -188 +188 @@
 } {0 {}}
 
-#test desc-2.2.0.1 {Rappture::Units::descption, valid units} {
-## this test passes for old tcl version, fails for new tcl bindings
-## because different order of units
-#    list [catch {Rappture::Units::description eV} msg] $msg
-#} {0 {energy (eV,J)}}
-
-test desc-2.2.0.2 {Rappture::Units::descption, valid units} {
+test desc-2.2.0 {Rappture::Units::descption, valid units} {
 # this test passes for new tcl bindings, fails for old tcl version
     list [catch {Rappture::Units::description eV} msg] $msg
 } {0 {energy (J,eV)}}
+
+test desc-2.2.1 {Rappture::Units::descption, *cm2*K/Vs} {
+    list [catch {Rappture::Units::description *cm2*K/Vs} msg] $msg
+} {0 {length*temperature/electric_potential*time (/V,/s,A2,C,F,K,R,cm2,in2,m2)}}
+
+test desc-2.2.2 {Rappture::Units::descption, cm2 areas} {
+    list [catch {Rappture::Units::description cm2} msg] $msg
+} {0 {area (A2,cm2,in2,m2)}}
+
+test desc-2.2.3 {Rappture::Units::descption, cm3 volumes} {
+    list [catch {Rappture::Units::description cm3} msg] $msg
+} {0 {volume (A3,cm3,in3,m3)}}
+
+test desc-2.2.4 {Rappture::Units::descption, K temperature} {
+    list [catch {Rappture::Units::description K} msg] $msg
+} {0 {temperature (C,F,K,R)}}
+
+test desc-2.2.5 {Rappture::Units::descption, s time} {
+    list [catch {Rappture::Units::description s} msg] $msg
+} {0 {time (s)}}
 
 test desc-2.3.0 {Rappture::Units::descption, too many args} {
@@ -203 +217 @@
 } {1 {wrong # args: should be "Rappture::Units::description units"}}
 
+test desc-2.3.0 {Rappture::Units::descption, incorrect input type} {
+    list [catch {Rappture::Units::description 3cm} msg] $msg
+} {0 {}}
 
 #----------------------------------------------------------
@@ -842 +859 @@
 } {0 {}}
 
-test search-for-6.0.1.2 {Rappture::Units::Search::for, notaunit} {
+test search-for-6.0.1.3 {Rappture::Units::Search::for, notaunit} {
     list [catch {Rappture::Units::Search::for ^&} msg] $msg
 } {0 {}}
 
+test search-for-6.0.1.4 {Rappture::Units::Search::for, notaunit} {
+    list [catch {Rappture::Units::Search::for x44} msg] $msg
+} {0 {}}
+
+test search-for-6.0.1.5 {Rappture::Units::Search::for, notaunit} {
+    list [catch {Rappture::Units::Search::for 3*44eV} msg] $msg
+} {0 {}}
+
 ::tcltest::cleanupTests
 return