sl@0: # Commands covered:  auto_mkindex auto_import
sl@0: #
sl@0: # This file contains tests related to autoloading and generating
sl@0: # the autoloading index.
sl@0: #
sl@0: # Copyright (c) 1998  Lucent Technologies, Inc.
sl@0: # Copyright (c) 1998-1999 by Scriptics Corporation.
sl@0: #
sl@0: # See the file "license.terms" for information on usage and redistribution
sl@0: # of this file, and for a DISCLAIMER OF ALL WARRANTIES.
sl@0: #
sl@0: # RCS: @(#) $Id: autoMkindex.test,v 1.14.2.1 2004/10/28 00:01:06 dgp Exp $
sl@0: 
sl@0: if {[lsearch [namespace children] ::tcltest] == -1} {
sl@0:     package require tcltest 2
sl@0:     namespace import -force ::tcltest::*
sl@0: }
sl@0: 
sl@0: makeFile {# Test file for:
sl@0: #   auto_mkindex
sl@0: #
sl@0: # This file provides example cases for testing the Tcl autoloading
sl@0: # facility.  Things are much more complicated with namespaces and classes.
sl@0: # The "auto_mkindex" facility can no longer be built on top of a simple
sl@0: # regular expression parser.  It must recognize constructs like this:
sl@0: #
sl@0: #   namespace eval foo {
sl@0: #       proc test {x y} { ... }
sl@0: #       namespace eval bar {
sl@0: #           proc another {args} { ... }
sl@0: #       }
sl@0: #   }
sl@0: #
sl@0: # Note that procedures and itcl class definitions can be nested inside
sl@0: # of namespaces.
sl@0: #
sl@0: # Copyright (c) 1993-1998  Lucent Technologies, Inc.
sl@0: 
sl@0: # This shouldn't cause any problems
sl@0: namespace import -force blt::*
sl@0: 
sl@0: # Should be able to handle "proc" definitions, even if they are
sl@0: # preceded by white space.
sl@0: 
sl@0: proc normal {x y} {return [expr $x+$y]}
sl@0:   proc indented {x y} {return [expr $x+$y]}
sl@0: 
sl@0: #
sl@0: # Should be able to handle proc declarations within namespaces,
sl@0: # even if they have explicit namespace paths.
sl@0: #
sl@0: namespace eval buried {
sl@0:     proc inside {args} {return "inside: $args"}
sl@0: 
sl@0:     namespace export pub_*
sl@0:     proc pub_one {args} {return "one: $args"}
sl@0:     proc pub_two {args} {return "two: $args"}
sl@0: }
sl@0: proc buried::within {args} {return "within: $args"}
sl@0: 
sl@0: namespace eval buried {
sl@0:     namespace eval under {
sl@0:         proc neath {args} {return "neath: $args"}
sl@0:     }
sl@0:     namespace eval ::buried {
sl@0:         proc relative {args} {return "relative: $args"}
sl@0:         proc ::top {args} {return "top: $args"}
sl@0:         proc ::buried::explicit {args} {return "explicit: $args"}
sl@0:     }
sl@0: }
sl@0: 
sl@0: # With proper hooks, we should be able to support other commands
sl@0: # that create procedures
sl@0: 
sl@0: proc buried::myproc {name body args} {
sl@0:     ::proc $name $body $args
sl@0: }
sl@0: namespace eval ::buried {
sl@0:     proc mycmd1 args {return "mycmd"}
sl@0:     myproc mycmd2 args {return "mycmd"}
sl@0: }
sl@0: ::buried::myproc mycmd3 args {return "another"}
sl@0: 
sl@0: proc {buried::my proc} {name body args} {
sl@0:     ::proc $name $body $args
sl@0: }
sl@0: namespace eval ::buried {
sl@0:     proc mycmd4 args {return "mycmd"}
sl@0:     {my proc} mycmd5 args {return "mycmd"}
sl@0: }
sl@0: {::buried::my proc} mycmd6 args {return "another"}
sl@0: 
sl@0: # A correctly functioning [auto_import] won't choke when a child
sl@0: # namespace [namespace import]s from its parent.
sl@0: #
sl@0: namespace eval ::parent::child {
sl@0:     namespace import ::parent::*
sl@0: }
sl@0: proc ::parent::child::test {} {}
sl@0: 
sl@0: } autoMkindex.tcl
sl@0: 
sl@0: 
sl@0: # Save initial state of auto_mkindex_parser
sl@0: 
sl@0: auto_load auto_mkindex
sl@0: if {[info exists auto_mkindex_parser::initCommands]} {
sl@0:     set saveCommands $auto_mkindex_parser::initCommands
sl@0: }
sl@0: proc AutoMkindexTestReset {} {
sl@0:     global saveCommands
sl@0:     if {[info exists saveCommands]} {
sl@0: 	set auto_mkindex_parser::initCommands $saveCommands
sl@0:     } elseif {[info exists auto_mkindex_parser::initCommands]} {
sl@0: 	unset auto_mkindex_parser::initCommands
sl@0:     }
sl@0: }
sl@0: 
sl@0: set result ""
sl@0: 
sl@0: set origDir [pwd]
sl@0: cd $::tcltest::temporaryDirectory
sl@0: 
sl@0: test autoMkindex-1.1 {remove any existing tclIndex file} {
sl@0:     file delete tclIndex
sl@0:     file exists tclIndex
sl@0: } {0}
sl@0: 
sl@0: test autoMkindex-1.2 {build tclIndex based on a test file} {
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:     file exists tclIndex
sl@0: } {1}
sl@0: 
sl@0: set element "{source [file join . autoMkindex.tcl]}"
sl@0: 
sl@0: test autoMkindex-1.3 {examine tclIndex} {
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:     namespace eval tcl_autoMkindex_tmp {
sl@0:         set dir "."
sl@0:         variable auto_index
sl@0:         source tclIndex
sl@0:         set ::result ""
sl@0:         foreach elem [lsort [array names auto_index]] {
sl@0:             lappend ::result [list $elem $auto_index($elem)]
sl@0:         }
sl@0:     }
sl@0:     namespace delete tcl_autoMkindex_tmp
sl@0:     set ::result
sl@0: } "{::buried::explicit $element} {::buried::inside $element} {{::buried::my proc} $element} {::buried::mycmd1 $element} {::buried::mycmd4 $element} {::buried::myproc $element} {::buried::pub_one $element} {::buried::pub_two $element} {::buried::relative $element} {::buried::under::neath $element} {::buried::within $element} {::parent::child::test $element} {indented $element} {normal $element} {top $element}"
sl@0: 
sl@0: 
sl@0: test autoMkindex-2.1 {commands on the autoload path can be imported} {
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:     set interp [interp create]
sl@0:     set final [$interp eval {
sl@0:         namespace eval blt {}
sl@0:         set auto_path [linsert $auto_path 0 .]
sl@0:         set info [list [catch {namespace import buried::*} result] $result]
sl@0:         foreach name [lsort [info commands pub_*]] {
sl@0:             lappend info $name [namespace origin $name]
sl@0:         }
sl@0:         set info
sl@0:     }]
sl@0:     interp delete $interp
sl@0:     set final
sl@0: } "0 {} pub_one ::buried::pub_one pub_two ::buried::pub_two"
sl@0: 
sl@0: # Test auto_mkindex hooks
sl@0: 
sl@0: # Slave hook executes interesting code in the interp used to watch code.
sl@0: 
sl@0: test autoMkindex-3.1 {slaveHook} {
sl@0:     auto_mkindex_parser::slavehook {
sl@0: 	_%@namespace eval ::blt {
sl@0: 	    proc foo {} {}
sl@0: 	    _%@namespace export foo
sl@0: 	}
sl@0:     }
sl@0:     auto_mkindex_parser::slavehook { _%@namespace import -force ::blt::* }
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:      
sl@0:     # Reset initCommands to avoid trashing other tests
sl@0: 
sl@0:     AutoMkindexTestReset
sl@0:     file exists tclIndex
sl@0: } 1 
sl@0: 
sl@0: # The auto_mkindex_parser::command is used to register commands
sl@0: # that create new commands.
sl@0: 
sl@0: test autoMkindex-3.2 {auto_mkindex_parser::command} {
sl@0:     auto_mkindex_parser::command buried::myproc {name args} {
sl@0: 	variable index
sl@0: 	variable scriptFile
sl@0: 	append index [list set auto_index([fullname $name])] \
sl@0: 		" \[list source \[file join \$dir [list $scriptFile]\]\]\n"
sl@0:     }
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:     namespace eval tcl_autoMkindex_tmp {
sl@0:         set dir "."
sl@0:         variable auto_index
sl@0:         source tclIndex
sl@0:         set ::result ""
sl@0:         foreach elem [lsort [array names auto_index]] {
sl@0:             lappend ::result [list $elem $auto_index($elem)]
sl@0:         }
sl@0:     }
sl@0:     namespace delete tcl_autoMkindex_tmp
sl@0: 
sl@0:     # Reset initCommands to avoid trashing other tests
sl@0: 
sl@0:     AutoMkindexTestReset
sl@0:     set ::result
sl@0: } "{::buried::explicit $element} {::buried::inside $element} {{::buried::my proc} $element} {::buried::mycmd1 $element} {::buried::mycmd2 $element} {::buried::mycmd4 $element} {::buried::myproc $element} {::buried::pub_one $element} {::buried::pub_two $element} {::buried::relative $element} {::buried::under::neath $element} {::buried::within $element} {::parent::child::test $element} {indented $element} {mycmd3 $element} {normal $element} {top $element}"
sl@0: 
sl@0: 
sl@0: test autoMkindex-3.3 {auto_mkindex_parser::command} {knownBug} {
sl@0:     auto_mkindex_parser::command {buried::my proc} {name args} {
sl@0: 	variable index
sl@0: 	variable scriptFile
sl@0: 	puts "my proc $name"
sl@0: 	append index [list set auto_index([fullname $name])] \
sl@0: 		" \[list source \[file join \$dir [list $scriptFile]\]\]\n"
sl@0:     }
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . autoMkindex.tcl
sl@0:     namespace eval tcl_autoMkindex_tmp {
sl@0:         set dir "."
sl@0:         variable auto_index
sl@0:         source tclIndex
sl@0:         set ::result ""
sl@0:         foreach elem [lsort [array names auto_index]] {
sl@0:             lappend ::result [list $elem $auto_index($elem)]
sl@0:         }
sl@0:     }
sl@0:     namespace delete tcl_autoMkindex_tmp
sl@0: 
sl@0:     # Reset initCommands to avoid trashing other tests
sl@0: 
sl@0:     AutoMkindexTestReset
sl@0:     proc lvalue {list pattern} {
sl@0: 	set ix [lsearch $list $pattern]
sl@0: 	if {$ix >= 0} {
sl@0: 	    return [lindex $list $ix]
sl@0: 	} else {
sl@0: 	    return {}
sl@0: 	}
sl@0:     }
sl@0:     list [lvalue $::result *mycmd4*] [lvalue $::result *mycmd5*] [lvalue $::result *mycmd6*]
sl@0: } "{::buried::mycmd4 $element} {::buried::mycmd5 $element} {mycmd6 $element}"
sl@0: 
sl@0: 
sl@0: makeDirectory pkg
sl@0: makeFile {
sl@0: package provide football 1.0
sl@0:     
sl@0: namespace eval ::pro:: {
sl@0:     #
sl@0:     # export only public functions.
sl@0:     #
sl@0:     namespace export {[a-z]*}
sl@0: }
sl@0: namespace eval ::college:: {
sl@0:     #
sl@0:     # export only public functions.
sl@0:     #
sl@0:     namespace export {[a-z]*}
sl@0: }
sl@0: 
sl@0: proc ::pro::team {} {
sl@0:     puts "go packers!"
sl@0:     return true
sl@0: }
sl@0: 
sl@0: proc ::college::team {} {
sl@0:     puts "go badgers!"
sl@0:     return true
sl@0: }
sl@0: 
sl@0: } [file join pkg samename.tcl]
sl@0: 
sl@0: 
sl@0: test autoMkindex-4.1 {platform indenpendant source commands} {
sl@0:     file delete tclIndex
sl@0:     auto_mkindex . pkg/samename.tcl
sl@0:     set f [open tclIndex r]
sl@0:     set dat [split [string trim [read $f]] "\n"]
sl@0:     set len [llength $dat]
sl@0:     set result [lsort [lrange $dat [expr {$len-2}] [expr {$len-1}]]]
sl@0:     close $f
sl@0:     set result
sl@0: } {{set auto_index(::college::team) [list source [file join $dir pkg samename.tcl]]} {set auto_index(::pro::team) [list source [file join $dir pkg samename.tcl]]}}
sl@0: 
sl@0: removeFile [file join pkg samename.tcl]
sl@0: 
sl@0: makeFile {
sl@0: set dollar1 "this string contains an unescaped dollar sign -> \\$foo"
sl@0: set dollar2 "this string contains an escaped dollar sign -> \$foo \\\$foo"
sl@0: set bracket1 "this contains an unescaped bracket [NoSuchProc]"
sl@0: set bracket2 "this contains an escaped bracket \[NoSuchProc\]"
sl@0: set bracket3 "this contains nested unescaped brackets [[NoSuchProc]]"
sl@0: proc testProc {} {}
sl@0: } [file join pkg magicchar.tcl]
sl@0: 
sl@0: test autoMkindex-5.1 {escape magic tcl chars in general code} {
sl@0:     file delete tclIndex
sl@0:     set result {}
sl@0:     if { ![catch {auto_mkindex . pkg/magicchar.tcl}] } {
sl@0: 	set f [open tclIndex r]
sl@0: 	set dat [split [string trim [read $f]] "\n"]
sl@0: 	set result [lindex $dat end]
sl@0: 	close $f
sl@0:     }
sl@0:     set result
sl@0: } {set auto_index(testProc) [list source [file join $dir pkg magicchar.tcl]]}
sl@0: 
sl@0: removeFile [file join pkg magicchar.tcl]
sl@0: 
sl@0: makeFile {
sl@0: proc {[magic mojo proc]} {} {}
sl@0: } [file join pkg magicchar2.tcl]
sl@0: 
sl@0: test autoMkindex-5.2 {correctly locate auto loaded procs with []} {
sl@0:     file delete tclIndex
sl@0:     set result {}
sl@0:     if { ![catch {auto_mkindex . pkg/magicchar2.tcl}] } {
sl@0: 	# Make a slave interp to test the autoloading
sl@0: 	set c [interp create]
sl@0: 	$c eval {lappend auto_path [pwd]}
sl@0: 	set result [$c eval {catch {{[magic mojo proc]}}}]
sl@0: 	interp delete $c
sl@0:     }
sl@0:     set result
sl@0: } 0
sl@0: 
sl@0: removeFile [file join pkg magicchar2.tcl]
sl@0: removeDirectory pkg
sl@0: 
sl@0: # Clean up.
sl@0: 
sl@0: unset result
sl@0: AutoMkindexTestReset
sl@0: if {[info exists saveCommands]} {
sl@0:     unset saveCommands
sl@0: }
sl@0: rename AutoMkindexTestReset ""
sl@0: 
sl@0: removeFile autoMkindex.tcl
sl@0: if {[file exists tclIndex]} {
sl@0:     file delete -force tclIndex
sl@0: }
sl@0: 
sl@0: cd $origDir
sl@0: 
sl@0: ::tcltest::cleanupTests