1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
|
# package.tcl --
#
# utility procs formerly in init.tcl which can be loaded on demand
# for package management.
#
# RCS: @(#) $Id: package.tcl,v 1.1.2.3 1998/10/05 18:46:03 stanton Exp $
#
# Copyright (c) 1991-1993 The Regents of the University of California.
# Copyright (c) 1994-1998 Sun Microsystems, Inc.
#
# See the file "license.terms" for information on usage and redistribution
# of this file, and for a DISCLAIMER OF ALL WARRANTIES.
#
# pkg_mkIndex --
# This procedure creates a package index in a given directory. The
# package index consists of a "pkgIndex.tcl" file whose contents are
# a Tcl script that sets up package information with "package require"
# commands. The commands describe all of the packages defined by the
# files given as arguments.
#
# Arguments:
# -direct (optional) If this flag is present, the generated
# code in pkgMkIndex.tcl will cause the package to be
# loaded when "package require" is executed, rather
# than lazily when the first reference to an exported
# procedure in the package is made.
# -nopkgrequire (optional) If this flag is present, "package require"
# commands are ignored. This flag is useful in some
# situations, for example when there is a circularity
# in package requires (package a requires package b,
# which in turns requires package a).
# -verbose (optional) Verbose output; the name of each file that
# was successfully rocessed is printed out. Additionally,
# if processing of a file failed a message is printed
# out; a file failure may not indicate that the indexing
# has failed, since pkg_mkIndex stores the list of failed
# files and tries again. The second time the processing
# may succeed, for example if a required package has been
# indexed by a previous pass.
# dir - Name of the directory in which to create the index.
# args - Any number of additional arguments, each giving
# a glob pattern that matches the names of one or
# more shared libraries or Tcl script files in
# dir.
proc pkg_mkIndex {args} {
global errorCode errorInfo
set usage {"pkg_mkIndex ?-nopkgrequire? ?-direct? ?-verbose? dir ?pattern ...?"};
set argCount [llength $args]
if {$argCount < 1} {
return -code error "wrong # args: should be\n$usage"
}
set more ""
set direct 0
set noPkgRequire 0
set doVerbose 0
for {set idx 0} {$idx < $argCount} {incr idx} {
set flag [lindex $args $idx]
switch -glob -- $flag {
-- {
# done with the flags
incr idx
break
}
-verbose {
set doVerbose 1
}
-direct {
set direct 1
append more " -direct"
}
-nopkgrequire {
set noPkgRequire 1
append more " -nopkgrequire"
}
-* {
return -code error "unknown flag $flag: should be\n$usage"
}
default {
# done with the flags
break
}
}
}
set dir [lindex $args $idx]
set patternList [lrange $args [expr $idx + 1] end]
if {[llength $patternList] == 0} {
set patternList [list "*.tcl" "*[info sharedlibextension]"]
}
append index "# Tcl package index file, version 1.1\n"
append index "# This file is generated by the \"pkg_mkIndex$more\" command\n"
append index "# and sourced either when an application starts up or\n"
append index "# by a \"package unknown\" script. It invokes the\n"
append index "# \"package ifneeded\" command to set up package-related\n"
append index "# information so that packages will be loaded automatically\n"
append index "# in response to \"package require\" commands. When this\n"
append index "# script is sourced, the variable \$dir must contain the\n"
append index "# full path name of this file's directory.\n"
set oldDir [pwd]
cd $dir
# In order to support building of index files from scratch, we make
# repeated passes on the files to index, until either all have been
# indexed, or we can no longer make any headway.
foreach file [eval glob $patternList] {
set toProcess($file) 1
}
while {[array size toProcess] > 0} {
set processed 0
foreach file [array names toProcess] {
# For each file, figure out what commands and packages it provides.
# To do this, create a child interpreter, load the file into the
# interpreter, and get a list of the new commands and packages
# that are defined. The interpeter uses a special version of
# tclPkgSetup to force loading of required packages at require
# time rather than lazily, so that we can keep track of commands
# and packages that are defined indirectly rather than from the
# file itself.
set c [interp create]
# Load into the child all packages currently loaded in the parent
# interpreter, in case the extension depends on some of them.
foreach pkg [info loaded] {
if {[lindex $pkg 1] == "Tk"} {
$c eval {set argv {-geometry +0+0}}
}
load [lindex $pkg 0] [lindex $pkg 1] $c
}
# We also call package ifneeded for all packages that have been
# identified so far. This way, each pass will have loaded the
# equivalent of the pkgIndex.tcl file that we are constructing,
# and packages whose processing failed in previous passes may
# be processed successfully now
foreach pkg [array names files] {
$c eval "package ifneeded $pkg\
\[list tclPkgSetup $dir \
[lrange $pkg 0 0] [lrange $pkg 1 1]\
[list $files($pkg)]\]"
}
if {$noPkgRequire == 1} {
$c eval {
rename package __package_orig
proc package {what args} {
switch -- $what {
require { return ; # ignore transitive requires }
default { eval __package_orig {$what} $args }
}
}
proc __dummy args {}
package unknown __dummy
}
} else {
$c eval {
rename package __package_orig
proc package {what args} {
switch -- $what {
require {
eval __package_orig require $args
# a package that was required needs to be
# placed in the list of packages to ignore.
# tclPkgSetup is unable to do it, so do it
# here.
set ::__ignorePkgs([lindex $args 0]) 1
}
provide {
# if package provide is called at level 1 and
# with two arguments, then this package is
# being provided by one of the files we are
# indexing, and therefore we need to add it
# to the list of packages to write out.
# We need to do this check because otherwise
# packages that are spread over multiple
# files are indexed only by their first file
# loaded.
# Note that packages that this cannot catch
# packages that are implemented by a
# combination of TCL files and DLLs
if {([info level] == 1) \
&& ([llength $args] == 2)} {
lappend ::__providedPkgs [lindex $args 0]
}
eval __package_orig provide $args
}
default { eval __package_orig {$what} $args }
}
}
}
}
$c eval [list set __file $file]
$c eval [list set __direct $direct]
if {[catch {
$c eval {
set __doingWhat "loading or sourcing"
# override the tclPkgSetup procedure (which is called by
# package ifneeded statements from pkgIndex.tcl) to force
# loads of packages, and also keep track of
# packages/namespaces/commands that the load generated
proc tclPkgSetup {dir pkg version files} {
# remember the current set of packages and commands,
# so that we can add any that were defined by the
# package files to the list of packages and commands
# to ignore
foreach __p [package names] {
set __localIgnorePkgs($__p) 1
}
foreach __ns [__pkgGetAllNamespaces] {
set __localIgnoreNs($__ns) 1
# if the namespace is already in the __ignoreNs
# array, its commands have already been imported
if {[info exists ::__ignoreNs($__ns)] == 0} {
namespace import ${__ns}::*
}
}
foreach __cmd [info commands] {
set __localIgnoreCmds($__cmd) 1
}
# load the files that make up the package
package provide $pkg $version
foreach __fileInfo $files {
set __f [lindex $__fileInfo 0]
set __type [lindex $__fileInfo 1]
if {$__type == "load"} {
load [file join $dir $__f] $pkg
} else {
source [file join $dir $__f]
}
}
# packages and commands that were defined by these
# files are to be ignored.
foreach __p [package names] {
if {[info exists __localIgnorePkgs($__p)] == 0} {
set ::__ignorePkgs($__p) 1
}
}
foreach __ns [__pkgGetAllNamespaces] {
if {([info exists __localIgnoreNs($__ns)] == 0) \
&& ([info exists ::__ignoreNs($__ns)] == 0)} {
namespace import ${__ns}::*
set ::__ignoreNs($__ns) 1
}
}
foreach __cmd [info commands] {
if {[info exists __localIgnoreCmds($__cmd)] == 0} {
lappend ::__ignoreCmds $__cmd
}
}
}
# we need to track command defined by each package even in
# the -direct case, because they are needed internally by
# the "partial pkgIndex.tcl" step above.
proc __pkgGetAllNamespaces {{root {}}} {
set __list $root
foreach __ns [namespace children $root] {
eval lappend __list [__pkgGetAllNamespaces $__ns]
}
return $__list
}
# initialize the list of packages to ignore; these are
# packages that are present before the script/dll is loaded
set ::__ignorePkgs(Tcl) 1
set ::__ignorePkgs(Tk) 1
foreach __pkg [package names] {
set ::__ignorePkgs($__pkg) 1
}
# before marking the original commands, import all the
# namespaces that may have been loaded from the parent;
# these namespaces and their commands are to be ignored
foreach __ns [__pkgGetAllNamespaces] {
set ::__ignoreNs($__ns) 1
namespace import ${__ns}::*
}
set ::__ignoreCmds [info commands]
set dir "" ;# in case file is pkgIndex.tcl
# Try to load the file if it has the shared library
# extension, otherwise source it. It's important not to
# try to load files that aren't shared libraries, because
# on some systems (like SunOS) the loader will abort the
# whole application when it gets an error.
set __pkgs {}
set __providedPkgs {}
if {[string compare [file extension $__file] \
[info sharedlibextension]] == 0} {
# The "file join ." command below is necessary.
# Without it, if the file name has no \'s and we're
# on UNIX, the load command will invoke the
# LD_LIBRARY_PATH search mechanism, which could cause
# the wrong file to be used.
set __doingWhat loading
load [file join . $__file]
set __type load
} else {
set __doingWhat sourcing
source $__file
set __type source
}
# Using __ variable names to avoid potential namespaces
# clash, even here in post processing because the
# loaded package could have set up traces,...
foreach __ns [__pkgGetAllNamespaces] {
if {[info exists ::__ignoreNs($__ns)] == 0} {
namespace import ${__ns}::*
}
}
foreach __i [info commands] {
set __cmds($__i) 1
}
foreach __i $::__ignoreCmds {
catch {unset __cmds($__i)}
}
foreach __i [array names __cmds] {
# reverse engineer which namespace a command comes from
set __absolute [namespace origin $__i]
# special case so that global names have no leading
# ::, this is required by the unknown command
set __absolute [auto_qualify $__absolute ::]
if {[string compare $__i $__absolute] != 0} {
set __cmds($__absolute) 1
unset __cmds($__i)
}
}
foreach __i $::__providedPkgs {
lappend __pkgs [list $__i [package provide $__i]]
set __ignorePkgs($__i) 1
}
foreach __i [package names] {
if {([string compare [package provide $__i] ""] != 0) \
&& ([info exists ::__ignorePkgs($__i)] == 0)} {
lappend __pkgs [list $__i [package provide $__i]]
}
}
}
} msg] == 1} {
set what [$c eval set __doingWhat]
if {$doVerbose} {
tclLog "warning: error while $what $file: $msg\nthis file will be retried in the next pass"
}
} else {
set type [$c eval set __type]
set cmds [lsort [$c eval array names __cmds]]
set pkgs [$c eval set __pkgs]
if {[llength $pkgs] > 1} {
tclLog "warning: \"$file\" provides more than one package ($pkgs)"
}
foreach pkg $pkgs {
# cmds is empty/not used in the direct case
lappend files($pkg) [list $file $type $cmds]
}
incr processed
unset toProcess($file)
if {$doVerbose} {
tclLog "processed $file"
}
}
interp delete $c
}
if {$processed == 0} {
tclLog "this iteration could not process any files: giving up here"
break
}
}
foreach pkg [lsort [array names files]] {
append index "\npackage ifneeded $pkg "
if {$direct} {
set cmdList {}
foreach elem $files($pkg) {
set file [lindex $elem 0]
set type [lindex $elem 1]
lappend cmdList "\[list $type \[file join \$dir\
[list $file]\]\]"
}
append index [join $cmdList "\\n"]
} else {
append index "\[list tclPkgSetup \$dir [lrange $pkg 0 0]\
[lrange $pkg 1 1] [list $files($pkg)]\]"
}
}
set f [open pkgIndex.tcl w]
puts $f $index
close $f
cd $oldDir
}
# tclPkgSetup --
# This is a utility procedure use by pkgIndex.tcl files. It is invoked
# as part of a "package ifneeded" script. It calls "package provide"
# to indicate that a package is available, then sets entries in the
# auto_index array so that the package's files will be auto-loaded when
# the commands are used.
#
# Arguments:
# dir - Directory containing all the files for this package.
# pkg - Name of the package (no version number).
# version - Version number for the package, such as 2.1.3.
# files - List of files that constitute the package. Each
# element is a sub-list with three elements. The first
# is the name of a file relative to $dir, the second is
# "load" or "source", indicating whether the file is a
# loadable binary or a script to source, and the third
# is a list of commands defined by this file.
proc tclPkgSetup {dir pkg version files} {
global auto_index
package provide $pkg $version
foreach fileInfo $files {
set f [lindex $fileInfo 0]
set type [lindex $fileInfo 1]
foreach cmd [lindex $fileInfo 2] {
if {$type == "load"} {
set auto_index($cmd) [list load [file join $dir $f] $pkg]
} else {
set auto_index($cmd) [list source [file join $dir $f]]
}
}
}
}
# tclMacPkgSearch --
# The procedure is used on the Macintosh to search a given directory for files
# with a TEXT resource named "pkgIndex". If it exists it is sourced in to the
# interpreter to setup the package database.
proc tclMacPkgSearch {dir} {
foreach x [glob -nocomplain [file join $dir *.shlb]] {
if {[file isfile $x]} {
set res [resource open $x]
foreach y [resource list TEXT $res] {
if {$y == "pkgIndex"} {source -rsrc pkgIndex}
}
catch {resource close $res}
}
}
}
# tclPkgUnknown --
# This procedure provides the default for the "package unknown" function.
# It is invoked when a package that's needed can't be found. It scans
# the auto_path directories and their immediate children looking for
# pkgIndex.tcl files and sources any such files that are found to setup
# the package database. (On the Macintosh we also search for pkgIndex
# TEXT resources in all files.)
#
# Arguments:
# name - Name of desired package. Not used.
# version - Version of desired package. Not used.
# exact - Either "-exact" or omitted. Not used.
proc tclPkgUnknown {name version {exact {}}} {
global auto_path tcl_platform env
if {![info exists auto_path]} {
return
}
for {set i [expr {[llength $auto_path] - 1}]} {$i >= 0} {incr i -1} {
# we can't use glob in safe interps, so enclose the following
# in a catch statement
catch {
foreach file [glob -nocomplain [file join [lindex $auto_path $i] \
* pkgIndex.tcl]] {
set dir [file dirname $file]
if {[catch {source $file} msg]} {
tclLog "error reading package index file $file: $msg"
}
}
}
set dir [lindex $auto_path $i]
set file [file join $dir pkgIndex.tcl]
# safe interps usually don't have "file readable", nor stderr channel
if {[interp issafe] || [file readable $file]} {
if {[catch {source $file} msg] && ![interp issafe]} {
tclLog "error reading package index file $file: $msg"
}
}
# On the Macintosh we also look in the resource fork
# of shared libraries
# We can't use tclMacPkgSearch in safe interps because it uses glob
if {(![interp issafe]) && ($tcl_platform(platform) == "macintosh")} {
set dir [lindex $auto_path $i]
tclMacPkgSearch $dir
foreach x [glob -nocomplain [file join $dir *]] {
if {[file isdirectory $x]} {
set dir $x
tclMacPkgSearch $dir
}
}
}
}
}
|