Changeset 549 for trunk

Timestamp:

Dec 7, 2006, 3:45:47 AM (18 years ago)

Author:

dkearney

Message:

added function Rappture::Units::Search::for which takes in a string and searches for and returns units if they exist. the returned units will be valid rappture units

Location:

trunk/src/tcl

Files:

• src/RpUnitsTclInterface.cc (modified) (4 diffs)
• tests/units.test (modified) (2 diffs)

trunk/src/tcl/src/RpUnitsTclInterface.cc

@@ -23 +23 @@
 // EXTERN int Rapptureunits_Init _ANSI_ARGS_((Tcl_Interp * interp));
 
-static int RpTclUnitsConvert   _ANSI_ARGS_((    ClientData cdata,
+static int RpTclUnitsConvert    _ANSI_ARGS_((   ClientData cdata,
                                                 Tcl_Interp *interp,
                                                 int argc, 
                                                 const char *argv[]    ));
 
-static int RpTclUnitsDesc      _ANSI_ARGS_((    ClientData cdata,
+static int RpTclUnitsDesc       _ANSI_ARGS_((   ClientData cdata,
                                                 Tcl_Interp *interp,
                                                 int argc, 
                                                 const char *argv[]    ));
 
-static int RpTclUnitsSysFor   _ANSI_ARGS_((    ClientData cdata,
+static int RpTclUnitsSysFor     _ANSI_ARGS_((   ClientData cdata,
                                                 Tcl_Interp *interp,
                                                 int argc, 
                                                 const char *argv[]    ));
 
-static int RpTclUnitsSysAll   _ANSI_ARGS_((    ClientData cdata,
+static int RpTclUnitsSysAll     _ANSI_ARGS_((   ClientData cdata,
+                                                Tcl_Interp *interp,
+                                                int argc, 
+                                                const char *argv[]    ));
+
+static int RpTclUnitsSearchFor  _ANSI_ARGS_((   ClientData cdata,
                                                 Tcl_Interp *interp,
                                                 int argc, 
@@ -64 +69 @@
  * ::Rappture::Units::System::for
  * ::Rappture::Units::System::all
+ * ::Rappture::Units::Search::for
  */
 
@@ -81 +87 @@
     Tcl_CreateCommand(interp, "::Rappture::Units::System::all",
         RpTclUnitsSysAll, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL);
+
+    Tcl_CreateCommand(interp, "::Rappture::Units::Search::for",
+        RpTclUnitsSearchFor, (ClientData)NULL, (Tcl_CmdDeleteProc*)NULL);
 
     return TCL_OK;
@@ -468 +477 @@
 
 /**********************************************************************/
+// FUNCTION: RpTclUnitsSearchfor()
+/// Rappture::Units::Search::for fxn in Tcl, returns string of found units
+/**
+ * Returns a list of all units from the given units string that
+ * were found within the units dictionary. This function takes in a
+ * string with or without a value. The string at the very least should
+ * contain the units you are searching for in the dictionary. If the
+ * string contains a value as well, the value will be ignored. A value
+ * is considered any numeric sequence as defined by the function
+ * strtod().
+ *
+ * Full function call:
+ * ::Rappture::Units::Search::for <units>
+ */
+
+int
+RpTclUnitsSearchFor (  ClientData cdata,
+                        Tcl_Interp *interp,
+                        int argc,
+                        const char *argv[]  )
+{
+    std::string unitsName     = ""; // 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;
+
+    Tcl_ResetResult(interp);
+
+    // parse through command line options
+    if (argc != 2) {
+        Tcl_AppendResult(interp, "wrong # args: should be \"", 
+                argv[0], " units\"", (char*)NULL);
+        return TCL_ERROR;
+    }
+
+    // find where the unitsName begins
+    strtod(argv[nextarg],&endptr);
+    unitsName = std::string(endptr);
+
+    err = RpUnits::validate(unitsName,type);
+    if (err) {
+        /*
+         * 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);
+        return TCL_ERROR;
+        */
+        return TCL_OK;
+    }
+
+    Tcl_AppendResult(interp, unitsName.c_str(), (char*)NULL);
+
+    return TCL_OK;
+}
+
+/**********************************************************************/
 // FUNCTION: list2str()
 /// Convert a std::list<std::string> into a comma delimited std::string

trunk/src/tcl/tests/units.test

@@ -4 +4 @@
 #   Rappture::Units::System::for
 #   Rappture::Units::System::all
+#   Rappture::Units::Search::for
 #
 # This file contains a collection of tests for one of the Rappture Tcl
@@ -802 +803 @@
 } {0 2e-07M2/KVUS}
 
+#--------------------------------------------------------------------
+# Rappture::Units::Search::for <units>
+#--------------------------------------------------------------------
+
+test search-for-6.0.0.1 {Rappture::Units::Search::for, 300K} {
+    list [catch {Rappture::Units::Search::for 300K} msg] $msg
+} {0 K}
+
+test search-for-6.0.0.2 {Rappture::Units::Search::for, 300cm2/Vs} {
+    list [catch {Rappture::Units::Search::for 300cm2/Vs} msg] $msg
+} {0 cm2/Vs}
+
+test search-for-6.0.0.3 {Rappture::Units::Search::for, cm2/Vs} {
+    list [catch {Rappture::Units::Search::for cm2/Vs} msg] $msg
+} {0 cm2/Vs}
+
+test search-for-6.0.1.1 {Rappture::Units::Search::for, 4notaunit} {
+    list [catch {Rappture::Units::Search::for 4notaunit} msg] $msg
+} {0 {}}
+
+test search-for-6.0.1.2 {Rappture::Units::Search::for, notaunit} {
+    list [catch {Rappture::Units::Search::for notaunit} msg] $msg
+} {0 {}}
+
+test search-for-6.0.1.2 {Rappture::Units::Search::for, notaunit} {
+    list [catch {Rappture::Units::Search::for ^&} msg] $msg
+} {0 {}}
 
 ::tcltest::cleanupTests