Changeset 4962

Timestamp:

Jan 29, 2015, 7:05:50 PM (10 years ago)

Author:

mmc

Message:

Fixed the way that Rappture handles tool parameters. When Rappture starts
up, it looks for the TOOL_PARAMETERS environment variable and loads values
from that file. Any "file" parameters are used to load driver files, run
files, or data into controls. See ​http://rappture.org/wiki/RapptureApi
for details.

Location:

branches/1.3/gui

Files:

• apps/launcher.tcl (modified) (5 diffs)
• scripts/main.tcl (modified) (6 diffs)
• scripts/textentry.tcl (modified) (1 diff)

branches/1.3/gui/apps/launcher.tcl

@@ -27 +27 @@
 set mainscript ""
 set alist ""
+set loadlist ""
 set toolxml ""
+
+# ----------------------------------------------------------------------
+#  Look for parameters passed into the tool session.  If there are
+#  any "file" parameters, they indicate files that should be loaded
+#  for browsing or executed to get results:
+#
+#    file(load):/path/to/run.xml
+#    file(execute):/path/to/driver.xml
+# ----------------------------------------------------------------------
+set params(opt) ""
+set params(load) ""
+set params(execute) ""
+set params(input) ""
+
+if {[info exists env(TOOL_PARAMETERS)]} {
+    # if we can't find the file, wait a little
+    set ntries 25
+    while {$ntries > 0 && ![file exists $env(TOOL_PARAMETERS)]} {
+        after 200
+        incr ntries -1
+    }
+
+    if {![file exists $env(TOOL_PARAMETERS)]} {
+        # still no file after all that? then skip parameters
+        puts stderr "WARNING: can't read tool parameters in file \"$env(TOOL_PARAMETERS)\"\nFile not found."
+
+    } elseif {[catch {
+        # read the file and parse the contents
+        set fid [open $env(TOOL_PARAMETERS) r]
+        set info [read $fid]
+        close $fid
+    } result] != 0} {
+        puts stderr "WARNING: can't read tool parameters in file \"$env(TOOL_PARAMETERS)\"\n$result"
+
+    } else {
+        # parse the contents of the tool parameter file
+        foreach line [split $info \n] {
+            set line [string trim $line]
+            if {$line eq "" || [regexp {^#} $line]} {
+                continue
+            }
+
+            if {[regexp {^([a-zA-Z]+)(\(into\:)(.+)\)\:(.+)$} $line match type name path value]
+                || [regexp {^([a-zA-Z]+)(\([^)]+\))?\:(.+)} $line match type name value]} {
+                if {$type eq "file"} {
+                    switch -exact -- $name {
+                        "(load)" - "" {
+                            lappend params(load) $value
+                            set params(opt) "-load"
+                        }
+                        "(execute)" {
+                            set params(execute) $value
+                            set params(opt) "-execute"
+                        }
+                        "(input)" {
+                            set params(input) $value
+                            set params(opt) "-input"
+                        }
+                        "(into:" {
+                            namespace eval ::Rappture { # forward decl }
+                            set ::Rappture::parameters($path) $value
+                        }
+                        default {
+                            puts stderr "WARNING: directive $name not recognized for file parameter \"$value\""
+                        }
+                    }
+                }
+            }
+        }
+    }
+}
 
 # scan through the arguments and look for the function
@@ -81 +153 @@
                 lappend alist -tool $toolxml
             }
-            -tool - -testdir - -nosim {
+            -testdir - -nosim {
                 lappend alist $opt [lindex $argv 0]
                 set argv [lrange $argv 1 end]
@@ -93 +165 @@
             }
             -load {
-                lappend alist $opt
                 while { [llength $argv] > 0 } {
                     set val [lindex $argv 0]
@@ -99 +170 @@
                         break
                     }
-                    lappend alist $val
+                    lappend loadlist $val
                     set argv [lrange $argv 1 end]
                 }
@@ -115 +186 @@
 }
 
-# If no arguments, assume that it's the -run option
+# If no arguments, check to see if there are any tool parameters.
+# If not, then assume that it's the -run option.
 if {$mainscript eq ""} {
-    package require RapptureGUI
-    set guidir $RapptureGUI::library
-    set mainscript [file join $guidir scripts main.tcl]
-    set reqpkgs Tk
+    switch -- $params(opt) {
+        -load {
+            # add tool parameters to the end of any files given on cmd line
+            set loadlist [concat $loadlist $params(load)]
+            set alist [concat $alist -load $loadlist]
+
+            package require RapptureGUI
+            set guidir $RapptureGUI::library
+            set mainscript [file join $guidir scripts main.tcl]
+            set reqpkgs Tk
+        }
+        -execute {
+            if {[llength $params(execute)] != 1} {
+                puts stderr "ERROR: wrong number of (execute) files in TOOL_PARAMETERS (should be only 1)"
+                exit 1
+            }
+            set driverxml [lindex $params(execute) 0]
+            if {![file readable $driverxml]} {
+                puts stderr "error: driver file \"$driverxml\" not found"
+                exit 1
+            }
+            set dir [file dirname [info script]]
+            set mainscript [file join $dir execute.tcl]
+            set reqpkgs ""
+        }
+        "" - "-input" {
+            package require RapptureGUI
+            set guidir $RapptureGUI::library
+            set mainscript [file join $guidir scripts main.tcl]
+            set reqpkgs Tk
+
+            # finalize the -input argument for "rappture -run"
+            if {$params(input) ne ""} {
+                if {![file readable $params(input)]} {
+                    puts stderr "error: driver file \"$params(input)\" not found"
+                    exit 1
+                }
+                set alist [concat $alist -input $params(input)]
+            }
+
+            # finalize any pending -load arguments for "rappture -run"
+            if {[llength $loadlist] > 0} {
+                set alist [concat $alist -load $loadlist]
+            }
+        }
+        default {
+            puts stderr "internal error: funny action \"$params(opt)\" inferred from TOOL_PARAMETERS"
+            exit 1
+        }
+    }
+} else {
+    # finalize any pending -load arguments for "rappture -run"
+    if {[llength $loadlist] > 0} {
+        set alist [concat $alist -load $loadlist]
+    }
 }
 

branches/1.3/gui/scripts/main.tcl

@@ -93 +93 @@
     value -tool tool.xml
     list  -load ""
+    value -input ""
     value -nosim 0
-}
-
-proc ReadToolParameters { numTries } {
-    incr numTries -1 
-    if { $numTries < 0 } {
-        return
-    }
-    global env
-    set paramsFile $env(TOOL_PARAMETERS)
-    if { ![file readable $paramsFile] } {
-        after 500 ReadToolParmeters $numTries
-        return
-    }
-    catch { 
-        set f [open $paramsFile "r"]
-        set contents [read $f]
-        close $f
-        set pattern {^file\((.*)\):(.*)$} 
-        foreach line [split $contents "\n"] {
-            if { [regexp $pattern $line match path rest] } {
-                set ::Rappture::parameters($path) $rest
-            }
-        }
-    }
-}
-
-if { [info exists env(TOOL_PARAMETERS)] } {
-    ReadToolParameters 10
 }
 
@@ -132 +105 @@
     set status [catch {Rappture::library $runfile} result]
     lappend loadobjs $result
+}
+
+set inputobj {}
+if {$params(-input) ne ""} {
+    if {![file exists $params(-input)]} {
+        puts stderr "can't find input file: \"$params(-input)\""
+        exit 1
+    }
+    if {[catch {Rappture::library $params(-input)} result] == 0} {
+        set inputobj $result
+    }
 }
 
@@ -143 +127 @@
     # run.xml files they are loading.
     set pseudotool ""
-    if {0 == [llength $loadobjs]} {
+    if {[llength $loadobjs] == 0 && $inputobj eq ""} {
         puts stderr "can't find tool \"$params(-tool)\""
         exit 1
@@ -151 +135 @@
     # if there are loaders or notes, they will still need
     # examples/ and docs/ dirs from the install location
-    foreach runobj $loadobjs {
+    set check [concat $loadobjs $inputobj]
+    foreach runobj $check {
         set tdir \
             [string trim [$runobj get tool.version.application.directory(tool)]]
@@ -374 +359 @@
 
 # load previous xml runfiles
-if {0 != [llength $params(-load)]} {
+if {[llength $params(-load)] > 0} {
     foreach runobj $loadobjs {
-        # this doesn't seem to work with loaders
-        # loaders seem to get their value after this point
-        # may need to tell loader elements to update its value
-        $tool load $runobj
         $f.analyze load $runobj
     }
+    # load the inputs for the very last run
+    $tool load $runobj
+
     # don't need simulate button if we cannot simulate
     if {$params(-nosim)} {
@@ -388 +372 @@
     $f.analyze configure -notebookpage analyze
     $win.pager current analyzer
+} elseif {$params(-input) ne ""} {
+    $tool load $inputobj
+}
+
+# let components (loaders) settle after the newly loaded runs
+update
+
+foreach path [array names ::Rappture::parameters] {
+    set fname $::Rappture::parameters($path)
+    if {[catch {
+          set fid [open $fname r]
+          set info [read $fid]
+          close $fid}] == 0} {
+
+        set w [$tool widgetfor $path]
+        if {$w ne ""} {
+            if {[catch {$w value [string trim $info]} result]} {
+                puts stderr "WARNING: bad tool parameter value for \"$path\""
+                puts stderr "  $result"
+            }
+        } else {
+            puts stderr "WARNING: can't find control for tool parameter: $path"
+        }
+    }
 }
 

branches/1.3/gui/scripts/textentry.tcl

@@ -106 +106 @@
     # the string alone. 
     set str [string trim [$_owner xml get $path.default]]
-    if { [info exists ::Rappture::parameters($path.default)] } {
-        set fileName $::Rappture::parameters($path.default)
-        catch { 
-            set f [open $fileName "r"]
-            set contents [read $f]
-            close $f
-            set str $contents
-        } 
-    }
     if {"" != $str} {
         value $str