#----------------------------------------------------------------------
# Eskil, Plugin handling
#
# Copyright (c) 2008-2016, Peter Spjuth (peter.spjuth@gmail.com)
#
# 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; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.
#
#----------------------------------------------------------------------
# $Revision$
#----------------------------------------------------------------------
proc PluginSearchPath {} {
set dirs [list . ./plugins]
lappend dirs [file join $::eskil(thisDir) .. ..]
lappend dirs [file join $::eskil(thisDir) .. .. plugins]
lappend dirs [file join $::eskil(thisDir) .. plugins]
return $dirs
}
# Locate plugin source and extract some info
proc LocatePlugin {plugin} {
set res [dict create name "" src "" opts ""]
set fSrc ""
set dirs [PluginSearchPath]
foreach dir $dirs {
set dir [file normalize $dir]
set files {}
lappend files [file join $dir $plugin]
lappend files [file join $dir $plugin.tcl]
foreach file $files {
if {![file exists $file]} continue
if {![file isfile $file]} continue
if {![file readable $file]} continue
set ch [open $file r]
set data [read $ch 20]
close $ch
if {[string match "##Eskil Plugin*" $data]} {
set fSrc $file
break
}
}
if {$fSrc ne ""} break
}
if {$fSrc ne ""} {
dict set res name $plugin
dict set res src $fSrc
# Look for declarations of command line options
set ch [open $fSrc r]
while {[gets $ch line] >= 0} {
# Only look until empty line
if {[string trim $line] eq ""} break
if {[regexp {^\#\# Option\s+(\S+)(.*)} $line -> name rest]} {
# structure is name flag doc
dict lappend res opts $name 0 [string trim $rest " :"]
}
if {[regexp {^\#\# Flag\s+(\S+)(.*)} $line -> name rest]} {
dict lappend res opts $name 1 [string trim $rest " :"]
}
}
close $ch
}
return $res
}
proc createPluginInterp {plugin info allow pinfoName} {
upvar 1 $pinfoName pinfo
set res [LocatePlugin $plugin]
set src [dict get $res src]
if {$src eq ""} {
return ""
}
# Create interpreter and load source
if {$allow} {
set pi [interp create]
$pi eval [list source $src]
} else {
set pi [interp create -safe]
$pi invokehidden -global source $src
}
# Setup info
$pi eval [list set ::WhoAmI [file rootname [file tail $src]]]
$pi eval [list set ::WhoAmIFull [file normalize $src]]
$pi eval [list set ::Info $info]
interp share {} stdout $pi
# Expose needed commands
if {!$allow} {
interp expose $pi fconfigure ;# needed??
interp hide $pi close
}
set pinfo {file 0 dir 0}
dict set pinfo "allow" $allow
if {[$pi eval info proc PreProcess] ne ""} {
dict set pinfo file 1
}
if {[$pi eval info proc FileCompare] ne ""} {
dict set pinfo dir 1
}
return $pi
}
proc printPlugin {plugin {short 0}} {
set res [LocatePlugin $plugin]
set src [dict get $res src]
if {$src eq ""} {
printPlugins
return
}
set ch [open $src]
set lines [split [read $ch] \n]
foreach line $lines {
set line [string trim $line]
if {$short} {
if {![string match "#*" $line]} {
break
}
}
puts $line
}
close $ch
}
proc listPlugins {} {
set dirs [PluginSearchPath]
set result {}
foreach dir $dirs {
set dir [file normalize $dir]
set files [glob -nocomplain [file join $dir *.tcl]]
foreach file $files {
set file [file normalize $file]
if {[info exists done($file)]} continue
if {![file exists $file]} continue
if {![file isfile $file]} continue
if {![file readable $file]} continue
set done($file) 1
set ch [open $file r]
set data [read $ch 200]
if {[regexp {^\#\#Eskil Plugin :(.*?)(\n|$)} $data -> descr]} {
set root [file rootname [file tail $file]]
dict set result $root "descr" $descr
dict set result $root "file" 0
dict set result $root "dir" 0
# Load it all for inspection
append data [read $ch]
if {[string first "proc PreProcess " $data] >= 0} {
dict set result $root "file" 1
}
if {[string first "proc FileCompare " $data] >= 0} {
dict set result $root "dir" 1
}
}
close $ch
}
}
set resultSort {}
foreach elem [lsort -dictionary [dict keys $result]] {
dict set resultSort $elem [dict get $result $elem]
}
return $resultSort
}
proc printPlugins {} {
set plugins [listPlugins]
if {[llength $plugins] == 0} {
puts "No plugins found."
return
}
set w 0
foreach {plugin info} $plugins {
if {[string length $plugin] > $w} {
set w [string length $plugin]
}
}
incr w 2
puts "Available plugins:"
foreach {plugin info} $plugins {
set descr [dict get $info descr]
puts "Plugin [format %-*s $w \"$plugin\"] : $descr"
}
}
proc preparePlugin {top} {
disallowEdit $top
set allow [dict get $::eskil($top,pluginpinfo) allow]
# Pass ::argv to plugin
set pArgv $::eskil(argv)
if {[info exists ::eskil($top,pluginargv)]} {
lappend pArgv {*}$::eskil($top,pluginargv)
}
$::eskil($top,plugin) eval [list set ::argv $pArgv]
# Pass ::Pref to plugin
$::eskil($top,plugin) eval [list array set ::Pref [array get ::Pref]]
# Pass File info to plugin
$::eskil($top,plugin) eval [list set ::File(left) $::eskil($top,leftFile)]
$::eskil($top,plugin) eval [list set ::File(right) $::eskil($top,rightFile)]
set out1 [tmpFile]
set out2 [tmpFile]
set chi [open $::eskil($top,leftFile) r]
set cho [open $out1 w]
set chi2 [open $::eskil($top,rightFile) r]
set cho2 [open $out2 w]
interp share {} $chi $::eskil($top,plugin)
interp share {} $cho $::eskil($top,plugin)
interp share {} $chi2 $::eskil($top,plugin)
interp share {} $cho2 $::eskil($top,plugin)
set cmd1 [list PreProcess left $chi $cho]
set cmd2 [list PreProcess right $chi2 $cho2]
if {[info commands yield] ne ""} {
# When in 8.6, this is done in coroutines allowing each call
# to yield and to alternate between them until done
set c1 __plugin_cr1$top
set c2 __plugin_cr2$top
set cmd1 [linsert $cmd1 0 coroutine $c1]
set cmd2 [linsert $cmd2 0 coroutine $c2]
set usenew1 [$::eskil($top,plugin) eval $cmd1]
set usenew2 [$::eskil($top,plugin) eval $cmd2]
interp alias {} pnw $::eskil($top,plugin) namespace which
while {[pnw $c1] ne {} || [pnw $c2] ne {}} {
if {[pnw $c1] ne {}} {
set usenew1 [$::eskil($top,plugin) eval $c1]
}
if {[pnw $c2] ne {}} {
set usenew2 [$::eskil($top,plugin) eval $c2]
}
}
} else {
set usenew1 [$::eskil($top,plugin) eval $cmd1]
set usenew2 [$::eskil($top,plugin) eval $cmd2]
}
if {$allow} {
$::eskil($top,plugin) eval close $chi
$::eskil($top,plugin) eval close $cho
$::eskil($top,plugin) eval close $chi2
$::eskil($top,plugin) eval close $cho2
} else {
$::eskil($top,plugin) invokehidden close $chi
$::eskil($top,plugin) invokehidden close $cho
$::eskil($top,plugin) invokehidden close $chi2
$::eskil($top,plugin) invokehidden close $cho2
}
close $chi
close $cho
close $chi2
close $cho2
if {$usenew1} {
# The file after processing should be used both
# for comparison and for displaying.
set ::eskil($top,leftFileBak) $::eskil($top,leftFile)
set ::eskil($top,leftFile) $out1
} else {
set ::eskil($top,leftFileDiff) $out1
}
if {$usenew2} {
set ::eskil($top,rightFileBak) $::eskil($top,rightFile)
set ::eskil($top,rightFile) $out2
} else {
set ::eskil($top,rightFileDiff) $out2
}
}
proc cleanupPlugin {top} {
if {[info exists ::eskil($top,leftFileBak)]} {
set ::eskil($top,leftFile) $::eskil($top,leftFileBak)
}
if {[info exists ::eskil($top,rightFileBak)]} {
set ::eskil($top,rightFile) $::eskil($top,rightFileBak)
}
unset -nocomplain \
::eskil($top,leftFileBak) ::eskil($top,rightFileBak) \
::eskil($top,leftFileDiff) ::eskil($top,rightFileDiff)
}
# GUI for plugin selection
proc EditPrefPlugins {top {dirdiff 0}} {
set wt $top.prefplugin
# Create window
destroy $wt
toplevel $wt -padx 3 -pady 3
ttk::frame $wt._bg
place $wt._bg -x 0 -y 0 -relwidth 1.0 -relheight 1.0 -border outside
wm title $wt "Preferences: Plugins"
set plugins [listPlugins]
if {[llength $plugins] == 0} {
grid [ttk::label $wt.l -text "No plugins found."] - -padx 3 -pady 3
}
if {![info exists ::eskil($top,pluginname)]} {
set ::eskil($top,pluginname) ""
}
if {![info exists ::eskil($top,plugininfo)]} {
set ::eskil($top,plugininfo) ""
}
if {![info exists ::eskil($top,pluginallow)]} {
set ::eskil($top,pluginallow) 0
}
set ::eskil($top,edit,pluginname) $::eskil($top,pluginname)
set ::eskil($top,edit,plugininfo) $::eskil($top,plugininfo)
set ::eskil($top,edit,pluginallow) $::eskil($top,pluginallow)
ttk::labelframe $wt.lfs -text "Select"
grid columnconfigure $wt.lfs 1 -weight 1
set t 0
foreach {plugin info} $plugins {
set descr [dict get $info descr]
if {$dirdiff && ![dict get $info dir]} continue
ttk::radiobutton $wt.rb$t -variable ::eskil($top,edit,pluginname) \
-value $plugin -text $plugin
ttk::label $wt.l$t -text $descr -anchor w
grid $wt.rb$t $wt.l$t -in $wt.lfs -sticky we -padx 3 -pady 3
incr t
}
ttk::radiobutton $wt.rb$t -variable ::eskil($top,edit,pluginname) \
-value "" -text "No Plugin"
ttk::button $wt.bs -text "Show" \
-command "ShowPlugin $wt \$::eskil($top,edit,pluginname)"
addBalloon $wt.bs "Show plugin source code."
grid $wt.rb$t $wt.bs -in $wt.lfs -sticky we -padx 3 -pady 3
grid $wt.bs -sticky e
ttk::labelframe $wt.lfgc -text "Generic Configuration"
grid columnconfigure $wt.lfgc 1 -weight 1
ttk::label $wt.li -text "Info" -anchor w
addBalloon $wt.li "Info passed to plugin. Plugin specific."
ttk::entry $wt.ei -textvariable ::eskil($top,edit,plugininfo)
grid $wt.li $wt.ei -in $wt.lfgc -sticky we -padx 3 -pady 3
ttk::checkbutton $wt.cb -text "Privilege" \
-variable ::eskil($top,edit,pluginallow)
addBalloon $wt.cb "Run plugin with raised privileges"
grid $wt.cb - -in $wt.lfgc -sticky w -padx 3 -pady 3
ttk::labelframe $wt.lfsc -text "Specific Configuration"
set ::widgets($top,prefPluginsSpec) $wt.lfsc
trace add variable ::eskil($top,edit,pluginname) write \
[list UpdateSpecificPluginConf $top]
UpdateSpecificPluginConf $top
ttk::frame $wt.fb -padding 3
ttk::button $wt.fb.b1 -text "Ok" \
-command [list EditPrefPluginsOk $top $wt 0]
ttk::button $wt.fb.b2 -text "Apply" \
-command [list EditPrefPluginsOk $top $wt 1]
ttk::button $wt.fb.b3 -text "Cancel" -command [list destroy $wt]
set ::widgets($top,prefPluginsOk) $wt.fb.b1
grid $wt.fb.b1 x $wt.fb.b2 x $wt.fb.b3 -sticky we
grid columnconfigure $wt.fb {0 2 4} -uniform a
grid columnconfigure $wt.fb {1 3} -weight 1
grid $wt.lfs -sticky we -padx 3 -pady 3
grid $wt.lfgc -sticky we -padx 3 -pady 3
grid $wt.lfsc -sticky we -padx 3 -pady 3
grid $wt.fb -sticky we -padx 3 -pady 3
grid columnconfigure $wt 0 -weight 1
}
proc UpdateSpecificPluginConf {top args} {
set w $::widgets($top,prefPluginsSpec)
# If the dialog is closed w might not exist
if {![winfo exists $w]} return
eval destroy [winfo children $w]
set arg $::eskil($top,edit,pluginname)
set pOpts {}
if {$arg ne ""} {
set res [LocatePlugin $arg]
set pOpts [dict get $res opts]
}
# Look for declarations of command line options
set n 0
set ::eskil($top,edit,opts) $pOpts
foreach {name flag doc} $pOpts {
ttk::label $w.l$n -text $name
addBalloon $w.l$n $doc
grid $w.l$n -sticky "w" -padx 3 -pady 3
if {$flag} {
ttk::checkbutton $w.s$n -text "On" \
-variable ::eskil($top,edit,$name)
grid $w.s$n -row $n -column 1 -sticky "w" -padx 3 -pady 3
} else {
ttk::entry $w.s$n \
-textvariable ::eskil($top,edit,$name)
grid $w.s$n -row $n -column 1 -sticky we -padx 3 -pady 3
}
incr n
}
grid columnconfigure $w 1 -weight 1
if {$n == 0} {
ttk::label $w.l -text "No specific configuration"
grid $w.l -sticky "w" -padx 3 -pady 3
return
}
}
proc EditPrefPluginsOk {top wt apply} {
if {!$apply} {
destroy $wt
}
set ::eskil($top,pluginname) $::eskil($top,edit,pluginname)
set ::eskil($top,plugininfo) $::eskil($top,edit,plugininfo)
set ::eskil($top,pluginallow) $::eskil($top,edit,pluginallow)
if {$::eskil($top,pluginname) ne ""} {
set pinterp [createPluginInterp $::eskil($top,pluginname) \
$::eskil($top,plugininfo) \
$::eskil($top,pluginallow) pinfo]
} else {
set pinterp ""
set pinfo ""
}
set ::eskil($top,plugin) $pinterp
set ::eskil($top,pluginpinfo) $pinfo
set ::eskil($top,pluginargv) {}
foreach {name flag doc} $::eskil($top,edit,opts) {
if {$flag} {
if {[info exists ::eskil($top,edit,$name)] && \
$::eskil($top,edit,$name)} {
lappend ::eskil($top,pluginargv) $name
}
} else {
if {[info exists ::eskil($top,edit,$name)] && \
$::eskil($top,edit,$name) ne ""} {
lappend ::eskil($top,pluginargv) $name $::eskil($top,edit,$name)
}
}
}
}
# Put Tcl code in a text widget, with some syntax highlighting
proc TextViewTcl {t data} {
$t tag configure comment -foreground "#b22222"
foreach line [split $data \n] {
if {[regexp {^\s*#} $line]} {
$t insert end $line\n comment
} elseif {[regexp {^(.*;\s*)(#.*)$} $line -> pre post]} {
$t insert end $pre
$t insert end $post\n comment
} else {
$t insert end $line\n
}
}
}
# Show plugin source
proc ShowPlugin {parent plugin} {
set res [LocatePlugin $plugin]
set src [dict get $res src]
if {$src eq ""} return
set ch [open $src]
set data [read $ch]
close $ch
set wt $parent.plugin
if {[winfo exists $wt]} {
wm deiconify $wt
} else {
toplevel $wt -padx 3 -pady 3
}
destroy {*}[winfo children $wt]
ttk::frame $wt._bg
place $wt._bg -x 0 -y 0 -relwidth 1.0 -relheight 1.0 -border outside
wm title $wt "Plugin: $plugin"
set t [Scroll both text $wt.t -width 80 -height 30 -font myfont -wrap none]
pack $wt.t -fill both -expand 1
bind $t <Control-a> "[list $t tag add sel 1.0 end];break"
TextViewTcl $t $data
}