Tcl语言自动加载机制

“pkg_mkIndex”是一个Tcl命令，它用来为自动加载功能建立索引文件。自动加载功能允许你编写一组Tcl过程放到一个脚本文件中，然后把该文件放到某个目录之下，当程序调用这些过程的时候，如果没有这些过程，他们会被Tcl解释器会自动加载。自动加载提供了两个好处，首先，你可以把有用的过程建立为过程库，而你无需精确知道过程的定义到底在哪个源文件中，自动加载机制会自动替你寻找，第二个好处在于自动加载是非常有效率的，如果没有自动加载机制你将不得不在TCL应用的开头使用source命令来加载所有可能用到的库文件，而应用自动加载机制，应用启动时无需加载任何库文件，而且有些用不到的库文件永远都不会被加载，既缩短了启动时间又节省了内存。

 

使用自动加载只需简单的按下面三步来做：

第一，在一个目录下创建一组脚本文件作为库，一般这些文件都以".tcl"结尾。每个文件可以包含任意数量的过程定义。建议尽量减少各脚本文件之间的关联，让相互关联的过程位于同一个文件中。为了能够让自动加载功能正确运行，proc命令定义一定要顶到最左边，并且与函数名用空格分开，过程名保持与proc在同一行上。

第二步，为自动加载建立索引。启动Tcl应用比如tclsh，调用命令auto_mkindex dir pattern , 第一个参数是目录名，第二个参数是一个模式。auto_mkindex在目录dir中扫描文件名和模式pattern匹配的文件，并建立索引以指出哪些过程定义在哪些文件中，并把索引保存到目录dir下一个叫tclindex的文件中。如果修改了文件或者增减过程，需要重新生成索引。

第三步是在应用中设置变量auto_path，把存放了希望使用到的库所在的目录赋给它。auto_path变量包含了一个目录的列表，当自动加载被启动的时候，会搜索auto_path中所指的目录，检查各目录下的tclindex文件来确认过程被定义在哪个文件中。如果一个函数被定义在几个库中，则自动加载使用在auto_path中靠前的那个库。

 

例如，若一个应用使用目录/usr/local/tcl/lib/shapes下的库，则在启动描述中应增加：

set auto_path [linsert $auto_path 0 /usr/local/tcl/lib/shapes]

这将把/usr/local/tcl/lib/shapes作为起始搜索库的路径，同时保持所有的Tcl/Tk库不变，但是在/usr/local/tcl/lib/shapes中定义的过程具有更高的优先级，一旦一个含有索引的目录加到了auto_path中，里面所有的过程都可以通过自动加载使用了。

 

以下是一个具体使用实例：

 

 

bash-2.03# pwd

/data/grant/test/tclTest

bash-2.03# cat libraryTest.tcl

#!/usr/local/bin/tclsh

 

proc AutoLoadTest {} {

        puts "================AutoLoadTest===================";

}

 

bash-2.03# tclsh

 

% auto_mkIndex /data/grant/test/tclTest *.tcl

 

 

bash-2.03# vi test.tcl

#!/usr/local/bin/tclsh

set auto_path [linsert $auto_path 0 /data/grant/test/tclTest]

 

AutoLoadTest

 

执行test.tcl，输出结果为：

================AutoLoadTest===================