auto.tcl
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:20k
源码类别:

通讯编程

开发平台:

Visual C++

  1. # auto.tcl --
  2. #
  3. # utility procs formerly in init.tcl dealing with auto execution
  4. # of commands and can be auto loaded themselves.
  5. #
  6. # RCS: @(#) $Id: auto.tcl,v 1.12.2.10 2005/07/23 03:31:41 dgp Exp $
  7. #
  8. # Copyright (c) 1991-1993 The Regents of the University of California.
  9. # Copyright (c) 1994-1998 Sun Microsystems, Inc.
  10. #
  11. # See the file "license.terms" for information on usage and redistribution
  12. # of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  13. #
  14. # auto_reset --
  15. #
  16. # Destroy all cached information for auto-loading and auto-execution,
  17. # so that the information gets recomputed the next time it's needed.
  18. # Also delete any procedures that are listed in the auto-load index
  19. # except those defined in this file.
  20. #
  21. # Arguments: 
  22. # None.
  23. proc auto_reset {} {
  24.     global auto_execs auto_index auto_oldpath
  25.     foreach p [info procs] {
  26. if {[info exists auto_index($p)] && ![string match auto_* $p]
  27. && ([lsearch -exact {unknown pkg_mkIndex tclPkgSetup
  28. tcl_findLibrary pkg_compareExtension
  29. tclPkgUnknown tcl::MacOSXPkgUnknown
  30. tcl::MacPkgUnknown} $p] < 0)} {
  31.     rename $p {}
  32. }
  33.     }
  34.     unset -nocomplain auto_execs auto_index auto_oldpath
  35. }
  36. # tcl_findLibrary --
  37. #
  38. # This is a utility for extensions that searches for a library directory
  39. # using a canonical searching algorithm. A side effect is to source
  40. # the initialization script and set a global library variable.
  41. #
  42. # Arguments:
  43. #  basename Prefix of the directory name, (e.g., "tk")
  44. # version Version number of the package, (e.g., "8.0")
  45. # patch Patchlevel of the package, (e.g., "8.0.3")
  46. # initScript Initialization script to source (e.g., tk.tcl)
  47. # enVarName environment variable to honor (e.g., TK_LIBRARY)
  48. # varName Global variable to set when done (e.g., tk_library)
  49. proc tcl_findLibrary {basename version patch initScript enVarName varName} {
  50.     upvar #0 $varName the_library
  51.     global env errorInfo
  52.     set dirs {}
  53.     set errors {}
  54.     # The C application may have hardwired a path, which we honor
  55.     if {[info exists the_library] && $the_library ne ""} {
  56. lappend dirs $the_library
  57.     } else {
  58. # Do the canonical search
  59. # 1. From an environment variable, if it exists.
  60. #    Placing this first gives the end-user ultimate control
  61. #    to work-around any bugs, or to customize.
  62.         if {[info exists env($enVarName)]} {
  63.             lappend dirs $env($enVarName)
  64.         }
  65. # 2. In the package script directory registered within
  66. #    the configuration of the package itself.
  67. #
  68. # Only do this for Tcl 8.5+, when Tcl_RegsiterConfig() is available.
  69. #if {[catch {
  70. #    ::${basename}::pkgconfig get scriptdir,runtime
  71. #} value] == 0} {
  72. #    lappend dirs $value
  73. #}
  74. # 3. Relative to auto_path directories.  This checks relative to the
  75. # Tcl library as well as allowing loading of libraries added to the
  76. # auto_path that is not relative to the core library or binary paths.
  77. foreach d $::auto_path {
  78.     lappend dirs [file join $d $basename$version]
  79.     if {$::tcl_platform(platform) eq "unix"
  80. && $::tcl_platform(os) eq "Darwin"} {
  81. # 4. On MacOSX, check the Resources/Scripts subdir too
  82. lappend dirs [file join $d $basename$version Resources Scripts]
  83.     }
  84. }
  85. # 3. Various locations relative to the executable
  86. # ../lib/foo1.0 (From bin directory in install hierarchy)
  87. # ../../lib/foo1.0 (From bin/arch directory in install hierarchy)
  88. # ../library (From unix directory in build hierarchy)
  89.         set parentDir [file dirname [file dirname [info nameofexecutable]]]
  90.         set grandParentDir [file dirname $parentDir]
  91.         lappend dirs [file join $parentDir lib $basename$version]
  92.         lappend dirs [file join $grandParentDir lib $basename$version]
  93.         lappend dirs [file join $parentDir library]
  94. # Remaining locations are out of date (when relevant, they ought
  95. # to be covered by the $::auto_path seach above).
  96. #
  97. # ../../library (From unix/arch directory in build hierarchy)
  98. # ../../foo1.0.1/library
  99. # (From unix directory in parallel build hierarchy)
  100. # ../../../foo1.0.1/library
  101. # (From unix/arch directory in parallel build hierarchy)
  102. #
  103. # For the sake of extra compatibility safety, we keep adding these
  104. # paths during the 8.4.* release series.
  105. if {1} {
  106.     lappend dirs [file join $grandParentDir library]
  107.     lappend dirs [file join $grandParentDir $basename$patch library]
  108.     lappend dirs [file join [file dirname $grandParentDir] 
  109.       $basename$patch library]
  110. }
  111.     }
  112.     # uniquify $dirs in order
  113.     array set seen {}
  114.     foreach i $dirs {
  115. # For Tcl 8.4.9, we've disabled the use of [file normalize] here.
  116. # This means that two different path names that are the same path
  117. # in normalized form, will both remain on the search path.  There
  118. # should be no harm in that, just a bit more file system access
  119. # than is strictly necessary.
  120. #
  121. # [file normalize] has been disabled because of reports it has
  122. # caused difficulties with the freewrap utility.  To keep
  123. # compatibility with freewrap's needs, we'll keep this disabled
  124. # throughout the 8.4.x (x >= 9) releases.  See Bug 1072136.
  125. if {1 || [interp issafe]} {
  126.     set norm $i
  127. } else {
  128.     set norm [file normalize $i]
  129. }
  130. if {[info exists seen($norm)]} { continue }
  131. set seen($norm) ""
  132. lappend uniqdirs $i
  133.     }
  134.     set dirs $uniqdirs
  135.     foreach i $dirs {
  136.         set the_library $i
  137.         set file [file join $i $initScript]
  138. # source everything when in a safe interpreter because
  139. # we have a source command, but no file exists command
  140.         if {[interp issafe] || [file exists $file]} {
  141.             if {![catch {uplevel #0 [list source $file]} msg]} {
  142.                 return
  143.             } else {
  144.                 append errors "$file: $msgn$errorInfon"
  145.             }
  146.         }
  147.     }
  148.     unset -nocomplain the_library
  149.     set msg "Can't find a usable $initScript in the following directories: n"
  150.     append msg "    $dirsnn"
  151.     append msg "$errorsnn"
  152.     append msg "This probably means that $basename wasn't installed properly.n"
  153.     error $msg
  154. }
  155. # ----------------------------------------------------------------------
  156. # auto_mkindex
  157. # ----------------------------------------------------------------------
  158. # The following procedures are used to generate the tclIndex file
  159. # from Tcl source files.  They use a special safe interpreter to
  160. # parse Tcl source files, writing out index entries as "proc"
  161. # commands are encountered.  This implementation won't work in a
  162. # safe interpreter, since a safe interpreter can't create the
  163. # special parser and mess with its commands.  
  164. if {[interp issafe]} {
  165.     return ;# Stop sourcing the file here
  166. }
  167. # auto_mkindex --
  168. # Regenerate a tclIndex file from Tcl source files.  Takes as argument
  169. # the name of the directory in which the tclIndex file is to be placed,
  170. # followed by any number of glob patterns to use in that directory to
  171. # locate all of the relevant files.
  172. #
  173. # Arguments: 
  174. # dir - Name of the directory in which to create an index.
  175. # args - Any number of additional arguments giving the
  176. # names of files within dir.  If no additional
  177. # are given auto_mkindex will look for *.tcl.
  178. proc auto_mkindex {dir args} {
  179.     global errorCode errorInfo
  180.     if {[interp issafe]} {
  181.         error "can't generate index within safe interpreter"
  182.     }
  183.     set oldDir [pwd]
  184.     cd $dir
  185.     set dir [pwd]
  186.     append index "# Tcl autoload index file, version 2.0n"
  187.     append index "# This file is generated by the "auto_mkindex" commandn"
  188.     append index "# and sourced to set up indexing information for one orn"
  189.     append index "# more commands.  Typically each line is a command thatn"
  190.     append index "# sets an element in the auto_index array, where then"
  191.     append index "# element name is the name of a command and the value isn"
  192.     append index "# a script that loads the command.nn"
  193.     if {[llength $args] == 0} {
  194. set args *.tcl
  195.     }
  196.     auto_mkindex_parser::init
  197.     foreach file [eval [linsert $args 0 glob --]] {
  198.         if {[catch {auto_mkindex_parser::mkindex $file} msg] == 0} {
  199.             append index $msg
  200.         } else {
  201.             set code $errorCode
  202.             set info $errorInfo
  203.             cd $oldDir
  204.             error $msg $info $code
  205.         }
  206.     }
  207.     auto_mkindex_parser::cleanup
  208.     set fid [open "tclIndex" w]
  209.     puts -nonewline $fid $index
  210.     close $fid
  211.     cd $oldDir
  212. }
  213. # Original version of auto_mkindex that just searches the source
  214. # code for "proc" at the beginning of the line.
  215. proc auto_mkindex_old {dir args} {
  216.     global errorCode errorInfo
  217.     set oldDir [pwd]
  218.     cd $dir
  219.     set dir [pwd]
  220.     append index "# Tcl autoload index file, version 2.0n"
  221.     append index "# This file is generated by the "auto_mkindex" commandn"
  222.     append index "# and sourced to set up indexing information for one orn"
  223.     append index "# more commands.  Typically each line is a command thatn"
  224.     append index "# sets an element in the auto_index array, where then"
  225.     append index "# element name is the name of a command and the value isn"
  226.     append index "# a script that loads the command.nn"
  227.     if {[llength $args] == 0} {
  228. set args *.tcl
  229.     }
  230.     foreach file [eval [linsert $args 0 glob --]] {
  231. set f ""
  232. set error [catch {
  233.     set f [open $file]
  234.     while {[gets $f line] >= 0} {
  235. if {[regexp {^proc[  ]+([^  ]*)} $line match procName]} {
  236.     set procName [lindex [auto_qualify $procName "::"] 0]
  237.     append index "set [list auto_index($procName)]"
  238.     append index " [list source [file join $dir [list $file]]]n"
  239. }
  240.     }
  241.     close $f
  242. } msg]
  243. if {$error} {
  244.     set code $errorCode
  245.     set info $errorInfo
  246.     catch {close $f}
  247.     cd $oldDir
  248.     error $msg $info $code
  249. }
  250.     }
  251.     set f ""
  252.     set error [catch {
  253. set f [open tclIndex w]
  254. puts -nonewline $f $index
  255. close $f
  256. cd $oldDir
  257.     } msg]
  258.     if {$error} {
  259. set code $errorCode
  260. set info $errorInfo
  261. catch {close $f}
  262. cd $oldDir
  263. error $msg $info $code
  264.     }
  265. }
  266. # Create a safe interpreter that can be used to parse Tcl source files
  267. # generate a tclIndex file for autoloading.  This interp contains
  268. # commands for things that need index entries.  Each time a command
  269. # is executed, it writes an entry out to the index file.
  270. namespace eval auto_mkindex_parser {
  271.     variable parser ""          ;# parser used to build index
  272.     variable index ""           ;# maintains index as it is built
  273.     variable scriptFile ""      ;# name of file being processed
  274.     variable contextStack ""    ;# stack of namespace scopes
  275.     variable imports ""         ;# keeps track of all imported cmds
  276.     variable initCommands ""    ;# list of commands that create aliases
  277.     proc init {} {
  278. variable parser
  279. variable initCommands
  280. if {![interp issafe]} {
  281.     set parser [interp create -safe]
  282.     $parser hide info
  283.     $parser hide rename
  284.     $parser hide proc
  285.     $parser hide namespace
  286.     $parser hide eval
  287.     $parser hide puts
  288.     $parser invokehidden namespace delete ::
  289.     $parser invokehidden proc unknown {args} {}
  290.     # We'll need access to the "namespace" command within the
  291.     # interp.  Put it back, but move it out of the way.
  292.     $parser expose namespace
  293.     $parser invokehidden rename namespace _%@namespace
  294.     $parser expose eval
  295.     $parser invokehidden rename eval _%@eval
  296.     # Install all the registered psuedo-command implementations
  297.     foreach cmd $initCommands {
  298. eval $cmd
  299.     }
  300. }
  301.     }
  302.     proc cleanup {} {
  303. variable parser
  304. interp delete $parser
  305. unset parser
  306.     }
  307. }
  308. # auto_mkindex_parser::mkindex --
  309. #
  310. # Used by the "auto_mkindex" command to create a "tclIndex" file for
  311. # the given Tcl source file.  Executes the commands in the file, and
  312. # handles things like the "proc" command by adding an entry for the
  313. # index file.  Returns a string that represents the index file.
  314. #
  315. # Arguments: 
  316. # file Name of Tcl source file to be indexed.
  317. proc auto_mkindex_parser::mkindex {file} {
  318.     variable parser
  319.     variable index
  320.     variable scriptFile
  321.     variable contextStack
  322.     variable imports
  323.     set scriptFile $file
  324.     set fid [open $file]
  325.     set contents [read $fid]
  326.     close $fid
  327.     # There is one problem with sourcing files into the safe
  328.     # interpreter:  references like "$x" will fail since code is not
  329.     # really being executed and variables do not really exist.
  330.     # To avoid this, we replace all $ with  (literally, the null char)
  331.     # later, when getting proc names we will have to reverse this replacement,
  332.     # in case there were any $ in the proc name.  This will cause a problem
  333.     # if somebody actually tries to have a  in their proc name.  Too bad
  334.     # for them.
  335.     set contents [string map "$ u0000" $contents]
  336.     
  337.     set index ""
  338.     set contextStack ""
  339.     set imports ""
  340.     $parser eval $contents
  341.     foreach name $imports {
  342.         catch {$parser eval [list _%@namespace forget $name]}
  343.     }
  344.     return $index
  345. }
  346. # auto_mkindex_parser::hook command
  347. #
  348. # Registers a Tcl command to evaluate when initializing the
  349. # slave interpreter used by the mkindex parser.
  350. # The command is evaluated in the master interpreter, and can
  351. # use the variable auto_mkindex_parser::parser to get to the slave
  352. proc auto_mkindex_parser::hook {cmd} {
  353.     variable initCommands
  354.     lappend initCommands $cmd
  355. }
  356. # auto_mkindex_parser::slavehook command
  357. #
  358. # Registers a Tcl command to evaluate when initializing the
  359. # slave interpreter used by the mkindex parser.
  360. # The command is evaluated in the slave interpreter.
  361. proc auto_mkindex_parser::slavehook {cmd} {
  362.     variable initCommands
  363.     # The $parser variable is defined to be the name of the
  364.     # slave interpreter when this command is used later.
  365.     lappend initCommands "$parser eval [list $cmd]"
  366. }
  367. # auto_mkindex_parser::command --
  368. #
  369. # Registers a new command with the "auto_mkindex_parser" interpreter
  370. # that parses Tcl files.  These commands are fake versions of things
  371. # like the "proc" command.  When you execute them, they simply write
  372. # out an entry to a "tclIndex" file for auto-loading.
  373. #
  374. # This procedure allows extensions to register their own commands
  375. # with the auto_mkindex facility.  For example, a package like
  376. # [incr Tcl] might register a "class" command so that class definitions
  377. # could be added to a "tclIndex" file for auto-loading.
  378. #
  379. # Arguments:
  380. # name  Name of command recognized in Tcl files.
  381. # arglist Argument list for command.
  382. # body  Implementation of command to handle indexing.
  383. proc auto_mkindex_parser::command {name arglist body} {
  384.     hook [list auto_mkindex_parser::commandInit $name $arglist $body]
  385. }
  386. # auto_mkindex_parser::commandInit --
  387. #
  388. # This does the actual work set up by auto_mkindex_parser::command
  389. # This is called when the interpreter used by the parser is created.
  390. #
  391. # Arguments:
  392. # name  Name of command recognized in Tcl files.
  393. # arglist Argument list for command.
  394. # body  Implementation of command to handle indexing.
  395. proc auto_mkindex_parser::commandInit {name arglist body} {
  396.     variable parser
  397.     set ns [namespace qualifiers $name]
  398.     set tail [namespace tail $name]
  399.     if {$ns eq ""} {
  400.         set fakeName [namespace current]::_%@fake_$tail
  401.     } else {
  402.         set fakeName [namespace current]::[string map {:: _} _%@fake_$name]
  403.     }
  404.     proc $fakeName $arglist $body
  405.     # YUK!  Tcl won't let us alias fully qualified command names,
  406.     # so we can't handle names like "::itcl::class".  Instead,
  407.     # we have to build procs with the fully qualified names, and
  408.     # have the procs point to the aliases.
  409.     if {[string match *::* $name]} {
  410.         set exportCmd [list _%@namespace export [namespace tail $name]]
  411.         $parser eval [list _%@namespace eval $ns $exportCmd]
  412.  
  413. # The following proc definition does not work if you
  414. # want to tolerate space or something else diabolical
  415. # in the procedure name, (i.e., space in $alias)
  416. # The following does not work:
  417. #   "_%@eval {$alias} $args"
  418. # because $alias gets concat'ed to $args.
  419. # The following does not work because $cmd is somehow undefined
  420. #   "set cmd {$alias} ; _%@eval {$cmd} $args"
  421. # A gold star to someone that can make test
  422. # autoMkindex-3.3 work properly
  423.         set alias [namespace tail $fakeName]
  424.         $parser invokehidden proc $name {args} "_%@eval {$alias} $args"
  425.         $parser alias $alias $fakeName
  426.     } else {
  427.         $parser alias $name $fakeName
  428.     }
  429.     return
  430. }
  431. # auto_mkindex_parser::fullname --
  432. # Used by commands like "proc" within the auto_mkindex parser.
  433. # Returns the qualified namespace name for the "name" argument.
  434. # If the "name" does not start with "::", elements are added from
  435. # the current namespace stack to produce a qualified name.  Then,
  436. # the name is examined to see whether or not it should really be
  437. # qualified.  If the name has more than the leading "::", it is
  438. # returned as a fully qualified name.  Otherwise, it is returned
  439. # as a simple name.  That way, the Tcl autoloader will recognize
  440. # it properly.
  441. #
  442. # Arguments:
  443. # name - Name that is being added to index.
  444. proc auto_mkindex_parser::fullname {name} {
  445.     variable contextStack
  446.     if {![string match ::* $name]} {
  447.         foreach ns $contextStack {
  448.             set name "${ns}::$name"
  449.             if {[string match ::* $name]} {
  450.                 break
  451.             }
  452.         }
  453.     }
  454.     if {[namespace qualifiers $name] eq ""} {
  455.         set name [namespace tail $name]
  456.     } elseif {![string match ::* $name]} {
  457.         set name "::$name"
  458.     }
  459.     
  460.     # Earlier, mkindex replaced all $'s with .  Now, we have to reverse
  461.     # that replacement.
  462.     return [string map "u0000 $" $name]
  463. }
  464. # Register all of the procedures for the auto_mkindex parser that
  465. # will build the "tclIndex" file.
  466. # AUTO MKINDEX:  proc name arglist body
  467. # Adds an entry to the auto index list for the given procedure name.
  468. auto_mkindex_parser::command proc {name args} {
  469.     variable index
  470.     variable scriptFile
  471.     # Do some fancy reformatting on the "source" call to handle platform
  472.     # differences with respect to pathnames.  Use format just so that the
  473.     # command is a little easier to read (otherwise it'd be full of 
  474.     # backslashed dollar signs, etc.
  475.     append index [list set auto_index([fullname $name])] 
  476.     [format { [list source [file join $dir %s]]} 
  477.     [file split $scriptFile]] "n"
  478. }
  479. # Conditionally add support for Tcl byte code files.  There are some
  480. # tricky details here.  First, we need to get the tbcload library
  481. # initialized in the current interpreter.  We cannot load tbcload into the
  482. # slave until we have done so because it needs access to the tcl_patchLevel
  483. # variable.  Second, because the package index file may defer loading the
  484. # library until we invoke a command, we need to explicitly invoke auto_load
  485. # to force it to be loaded.  This should be a noop if the package has
  486. # already been loaded
  487. auto_mkindex_parser::hook {
  488.     if {![catch {package require tbcload}]} {
  489. if {[namespace which -command tbcload::bcproc] eq ""} {
  490.     auto_load tbcload::bcproc
  491. }
  492. load {} tbcload $auto_mkindex_parser::parser
  493. # AUTO MKINDEX:  tbcload::bcproc name arglist body
  494. # Adds an entry to the auto index list for the given pre-compiled
  495. # procedure name.  
  496. auto_mkindex_parser::commandInit tbcload::bcproc {name args} {
  497.     variable index
  498.     variable scriptFile
  499.     # Do some nice reformatting of the "source" call, to get around
  500.     # path differences on different platforms.  We use the format
  501.     # command just so that the code is a little easier to read.
  502.     append index [list set auto_index([fullname $name])] 
  503.     [format { [list source [file join $dir %s]]} 
  504.     [file split $scriptFile]] "n"
  505. }
  506.     }
  507. }
  508. # AUTO MKINDEX:  namespace eval name command ?arg arg...?
  509. # Adds the namespace name onto the context stack and evaluates the
  510. # associated body of commands.
  511. #
  512. # AUTO MKINDEX:  namespace import ?-force? pattern ?pattern...?
  513. # Performs the "import" action in the parser interpreter.  This is
  514. # important for any commands contained in a namespace that affect
  515. # the index.  For example, a script may say "itcl::class ...",
  516. # or it may import "itcl::*" and then say "class ...".  This
  517. # procedure does the import operation, but keeps track of imported
  518. # patterns so we can remove the imports later.
  519. auto_mkindex_parser::command namespace {op args} {
  520.     switch -- $op {
  521.         eval {
  522.             variable parser
  523.             variable contextStack
  524.             set name [lindex $args 0]
  525.             set args [lrange $args 1 end]
  526.             set contextStack [linsert $contextStack 0 $name]
  527.     $parser eval [list _%@namespace eval $name] $args
  528.             set contextStack [lrange $contextStack 1 end]
  529.         }
  530.         import {
  531.             variable parser
  532.             variable imports
  533.             foreach pattern $args {
  534.                 if {$pattern ne "-force"} {
  535.                     lappend imports $pattern
  536.                 }
  537.             }
  538.             catch {$parser eval "_%@namespace import $args"}
  539.         }
  540.     }
  541. }
  542. return