-
Notifications
You must be signed in to change notification settings - Fork 120
Expand file tree
/
Copy pathmodfind.tcl.in
More file actions
3690 lines (3345 loc) · 132 KB
/
modfind.tcl.in
File metadata and controls
3690 lines (3345 loc) · 132 KB
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
##########################################################################
# MODFIND.TCL, available or loaded module find procedures
# Copyright (C) 2002-2004 Mark Lakata
# Copyright (C) 2004-2017 Kent Mein
# Copyright (C) 2016-2026 Xavier Delaruelle
#
# 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. If not, see <http://www.gnu.org/licenses/>.
##########################################################################
# convert environment variable references in string to their values
# every local variable is prefixed by '0' to ensure they will not be
# overwritten through variable reference resolution process
proc resolvStringWithEnv {0str} {
# fetch variable references in string
set 0match_list [regexp -all -inline {\$[{]?([A-Za-z_][A-Za-z0-9_]*)[}]?}\
${0str}]
if {[llength ${0match_list}]} {
# put in local scope every environment variable referred in string
for {set 0i 1} {${0i} < [llength ${0match_list}]} {incr 0i 2} {
set 0varname [lindex ${0match_list} ${0i}]
##nagelfar vartype 0varname varName
if {![info exists ${0varname}]} {
set ${0varname} [get-env ${0varname}]
}
}
# resolve variable reference with values (now in local scope)
set 0res [subst -nobackslashes -nocommands ${0str}]
} else {
set 0res ${0str}
}
reportDebug "'${0str}' resolved to '${0res}'"
return ${0res}
}
# in each string of a list, convert their variable reference into actual value
proc resolvStringListWithEnv {str_list} {
set res_list {}
foreach str $str_list {
lappend res_list [resolvStringWithEnv $str]
}
return $res_list
}
# Return first string in list matching given resolved string. Strings in list
# are resolved to help comparison in case they contain an env variable ref.
proc getStringFromListMatchingResString {str_list resolved_str} {
foreach str $str_list {
if {$resolved_str eq [resolvStringWithEnv $str]} {
return $str
}
}
}
# deduce modulepath from modulefile and module name
proc getModulepathFromModuleName {modfile modname} {
return [string range $modfile 0 end-[string length /$modname]]
}
# deduce module name from modulefile and modulepath
proc getModuleNameFromModulepath {modfile modpath} {
return [string range $modfile [string length $modpath/] end]
}
# check if given modulefile is hosted in one the given modulepaths
proc isModulefileInModulepathList {mod_file modulepath_list} {
set ret 0
foreach modulepath $modulepath_list {
if {[string first $modulepath/ $mod_file] == 0} {
set ret 1
break
}
}
return $ret
}
# return list of all enabled modulepaths matching given path
proc getMatchingModulepathList {path} {
set ret {}
foreach modulepath [getModulePathList] {
if {[string first $path/ $modulepath] == 0} {
lappend ret $modulepath
}
}
return $ret
}
# extract module name from modulefile and currently enabled modulepaths
proc findModuleNameFromModulefile {modfile} {
set ret {}
foreach modpath [getModulePathList] {
if {[string first $modpath/ $modfile/] == 0} {
set ret [getModuleNameFromModulepath $modfile $modpath]
break
}
}
return $ret
}
# extract modulepath from modulefile and currently enabled modulepaths
proc findModulepathFromModulefile {modfile} {
set ret {}
foreach modpath [getModulePathList] {
if {[string first $modpath/ $modfile/] == 0} {
set ret $modpath
break
}
}
return $ret
}
# Determine with a name provided as argument the corresponding module name,
# version and name/version. Module name is guessed from current module name
# when shorthand version notation is used. Both name and version are guessed
# from current module if name provided is empty. If 'name_relative_tocur' is
# enabled then name argument may be interpreted as a name relative to the
# current modulefile directory (useful for module-version and module-alias
# for instance).
proc getModuleNameVersion {{name {}} {name_relative_tocur 0}} {
set curmod [currentState modulename]
set curmodname [file dirname $curmod]
set curmodversion [file tail $curmod]
if {$name eq {}} {
set name $curmodname
set version $curmodversion
# check for shorthand version notation like "/version" or "./version"
# only if we are currently interpreting a modulefile or modulerc
} elseif {$curmod ne {} && [regexp {^\.?\/(.*)$} $name match version]} {
# if we cannot distinguish a module name, raise error when shorthand
# version notation is used
if {[currentState modulefile] ne $curmod && $curmod ne {.modulerc}} {
# name is the name of current module directory
set name $curmodname
} else {
reportError "Invalid modulename '$name' found"
return {}
}
} else {
set name [string trimright $name /]
set version [file tail $name]
if {$name eq $version} {
set version {}
} else {
set name [file dirname $name]
}
# name may correspond to last part of current module
# if so name is replaced by current module name
if {$name_relative_tocur && [file tail $curmodname] eq $name} {
set name $curmodname
}
}
if {$version eq {}} {
set mod $name
} else {
set mod $name/$version
}
return [list $mod $name $version]
}
# Register alias or symbolic version deep resolution in a global array that
# can be used thereafter to get in one query the actual modulefile behind
# a virtual name. Also consolidate a global array that in the same manner
# list all the symbols held by modulefiles.
proc setModuleResolution {mod target {symver {}} {override_res_path 1}\
{auto_symver 0}} {
global g_moduleResolved g_resolvedHash g_resolvedPath g_symbolHash
# find end-point module and register step-by-step path to get to it
set res $target
lappend res_path $res
while {$mod ne $res && [info exists g_resolvedPath($res)]} {
set res $g_resolvedPath($res)
lappend res_path $res
}
# error if resolution end on initial module
if {$mod eq $res} {
reportError "Resolution loop on '$res' detected"
return 0
}
# module name will be useful when registering symbol
if {$symver ne {}} {
lassign [getModuleNameVersion $mod] modfull modname
}
# change default symbol owner if previously given; auto symbol are defined
# only if no default is pre-existing
if {$symver eq {default} && !$auto_symver} {
# alternative name "modname" is set when mod = "modname/default" both
# names will be registered to be known for queries and resolution defs
set modalt $modname
if {[info exists g_moduleResolved($mod)]} {
set prev $g_moduleResolved($mod)
# there may not be a default in case of auto symbol
if {[info exists g_symbolHash($prev)] && [set idx [lsearch -exact\
$g_symbolHash($prev) default]] != -1} {
reportDebug "remove symbol 'default' from '$prev'"
set g_symbolHash($prev) [lreplace $g_symbolHash($prev) $idx $idx]
}
}
}
# register end-point resolution
reportDebug "$mod resolved to $res"
set g_moduleResolved($mod) $res
# set first element of resolution path only if not already set or
# scratching enabled, no change when propagating symbol along res path
if {$override_res_path || ![info exists g_resolvedPath($mod)]} {
set g_resolvedPath($mod) $target
}
lappend g_resolvedHash($res) $mod
# also register resolution on alternative name if any
if {[info exists modalt]} {
reportDebug "$modalt resolved to $res"
set g_moduleResolved($modalt) $res
if {$override_res_path || ![info exists g_resolvedPath($modalt)]} {
set g_resolvedPath($modalt) $target
}
lappend g_resolvedHash($res) $modalt
# register name alternative to know their existence
set ::g_moduleAltName($modalt) $mod
set ::g_moduleAltName($mod) $modalt
}
# if other modules were pointing to this one, adapt resolution end-point
set relmod_list {}
if {[info exists g_resolvedHash($mod)]} {
set relmod_list $g_resolvedHash($mod)
unset g_resolvedHash($mod)
}
# also adapt resolution for modules pointing to the alternative name
if {[info exists modalt] && [info exists g_resolvedHash($modalt)]} {
lappend relmod_list {*}$g_resolvedHash($modalt)
unset g_resolvedHash($modalt)
}
foreach relmod $relmod_list {
set g_moduleResolved($relmod) $res
reportDebug "$relmod now resolved to $res"
lappend g_resolvedHash($res) $relmod
}
# register and propagate symbols to the resolution path, exception made for
# auto symbol which are stored separately and not propagated
if {[info exists g_symbolHash($mod)]} {
set sym_list $g_symbolHash($mod)
} else {
set sym_list {}
}
if {$symver ne {} && $auto_symver} {
reportDebug "define auto symbolic version '$mod' targeting $target"
set ::g_autoSymbol($mod) $target
} elseif {$symver ne {} && !$auto_symver} {
# merge symbol definitions in case of alternative name
if {[info exists modalt] && [info exists g_symbolHash($modalt)]} {
set sym_list [lsort -dictionary -unique [list {*}$sym_list\
{*}$g_symbolHash($modalt)]]
reportDebug "set symbols '$sym_list' to $mod and $modalt"
set g_symbolHash($mod) $sym_list
set g_symbolHash($modalt) $sym_list
}
# dictionary-sort symbols and remove eventual duplicates
set sym_list [lsort -dictionary -unique [list {*}$sym_list $symver]]
# propagate symbols in g_symbolHash and g_moduleVersion toward the
# resolution path, handle that locally if we still work on same
# modulename, call for a proper resolution as soon as we change of
# module to get this new resolution registered
foreach modres $res_path {
lassign [getModuleNameVersion $modres] modfull modresname
if {$modname eq $modresname} {
if {[info exists g_symbolHash($modres)]} {
set modres_sym_list [lsort -dictionary -unique [list\
{*}$g_symbolHash($modres) {*}$sym_list]]
} else {
set modres_sym_list $sym_list
}
# sync symbols of alternative name if any
if {[info exists ::g_moduleAltName($modres)]} {
set altmodres $::g_moduleAltName($modres)
reportDebug "set symbols '$modres_sym_list' to $modres and\
$altmodres"
set g_symbolHash($altmodres) $modres_sym_list
} else {
reportDebug "set symbols '$modres_sym_list' to $modres"
}
set g_symbolHash($modres) $modres_sym_list
# register symbolic version for querying in g_moduleVersion
foreach symelt $sym_list {
set modvers $modresname/$symelt
reportDebug "module-version $modvers = $modres"
set ::g_moduleVersion($modvers) $modres
set ::g_sourceVersion($modvers) [currentState modulefile]
# record eventual missing resolution
if {![info exists g_moduleResolved($modvers)]} {
set g_moduleResolved($modvers) $modres
reportDebug "$modvers resolved to $modres"
lappend g_resolvedHash($modres) $modvers
}
}
# as we change of module name a proper resolution call should be
# made (see below) and will handle the rest of the resolution path
} else {
set need_set_res 1
break
}
}
# when registering an alias, existing symbols on alias source name should
# be broadcast along the resolution path with a proper resolution call
# (see below)
} else {
lassign [getModuleNameVersion $target] modres modresname
set need_set_res 1
}
# resolution needed to broadcast symbols along resolution path without
# altering initial path already set for these symbols
if {[info exists need_set_res]} {
foreach symelt $sym_list {
set modvers $modresname/$symelt
reportDebug "set resolution for $modvers"
setModuleResolution $modvers $modres $symelt 0
}
}
return 1
}
# retrieve all names that resolve to passed mod
proc getAllModuleResolvedName {mod {flag_type 0} {modspec {}} {filter_default\
0}} {
set namelist {}
set resmodlist {}
set icase [isIcase]
# get parent directories of mod
foreach modelt [split $mod /] {
if {[info exists modroot]} {
append modroot /
}
append modroot $modelt
lappend resmodlist $modroot
}
set modpar [file dirname $mod]
set moddfl $modpar/default
# add additionally all the altnames set on directories, parents of mod
# or on distant directories whose default version resolves to mod
for {set i 0} {$i < [llength $resmodlist]} {incr i 1} {
set modelt [getArrayKey ::g_resolvedHash [lindex $resmodlist $i] $icase]
if {[info exists ::g_resolvedHash($modelt)]} {
foreach resmod $::g_resolvedHash($modelt) {
# if alternative name corresponds to one root name test if default
# symbol is hidden
set resmoddfl [expr {[lsearch -exact $resmodlist $resmod] != -1 ?\
"$resmod/default" : {}}]
# if alternative name corresponds to default symbol and is hidden
# test if query matches bare module name
set resmodpar [expr {[file tail $resmod] eq {default} ? [file\
dirname $resmod] : {}}]
# if modelt is not a parent directory of mod, check its resolution
# points to mod (directly for alias/sym or indirectly for dir
# whose default version bridge resolution toward mod)
# if modspec arg is set, exclude hidden entries not explicitly
# matching modspec. auto symbols cannot be hidden
# if filter_default is asked, skip parent module name and /default
# symbol name from result list
if {($modspec eq {} || ([info exists ::g_autoSymbol($resmod)] &&\
$::g_autoSymbol($resmod) eq $mod) || (![isModuleHidden $resmod\
$modspec] && ($resmoddfl eq {} || ![isModuleHidden $resmoddfl\
$modspec])) || [modEq $modspec $resmod eqspec] || ($resmodpar\
ne {} && [modEq $modspec $resmodpar eqspec])) && ([modEq\
$modelt $mod eqstart] || $::g_moduleResolved($resmod) eq $mod\
|| $mod eq [lindex [getPathToModule\
$::g_moduleResolved($resmod) {} 0] 1]) && (!$filter_default ||\
(![modEq $resmod $modpar] && ![modEq $resmod $moddfl]))} {
# prefix automatically generated syms with type flag if asked
if {$flag_type} {
set name_entry [list]
if {[info exists ::g_moduleAlias($resmod)]} {
lappend name_entry al
} elseif {[info exists ::g_autoSymbol($resmod)]} {
lappend name_entry as
}
lappend name_entry $resmod
} else {
set name_entry $resmod
}
lappendNoDup namelist $name_entry
unset modroot
foreach reselt [split [file dirname $resmod] /] {
if {[info exists modroot]} {
append modroot /
}
append modroot $reselt
lappendNoDup resmodlist $modroot
}
}
}
}
}
return $namelist
}
# build list for a given loaded module of its alternative names plus its
# simplified names (name minus version or any subdir if this version or subdir
# are the implicit default for module)
proc getLoadedAltAndSimplifiedName {mod} {
if {[isModuleFullPath $mod]} {
set namelist [list $mod]
# use already computed name list if any
} elseif {[info exists ::g_loadedAltAndSimplifiedName($mod)]} {
set namelist $::g_loadedAltAndSimplifiedName($mod)
} else {
# get recorded alternative name
set namelist [getLoadedAltname $mod]
# also look through modpaths for simplified mod name
set modpathlist [getModulePathList]
if {[llength $modpathlist]} {
set modfile [getModulefileFromLoadedModule $mod]
set parentmod [file dirname $mod]
# simplify to parent name as long as it resolves to current mod
while {$parentmod ne {.}} {
lassign [getPathToModule $parentmod $modpathlist 0] parentfile
if {$parentfile eq $modfile} {
lappend namelist $parentmod
set parentmod [file dirname $parentmod]
} else {
set parentmod .
}
}
}
# recorded computed name list for later use
set ::g_loadedAltAndSimplifiedName($mod) $namelist
}
return $namelist
}
# return value list of a loaded module property by parsing corresponding
# environment variable
proc getEnvLoadedModulePropertyParsedList {prop} {
set unserialize_depth [getEnvLoadedModulePropertyStructDepth $prop]
set unserialize_proc unserialize${unserialize_depth}ModulePropertyValueList
set char_unmap_list [getEnvLoadedModulePropertyCharUnmapList $prop]
set serialized_value_list [getEnvLoadedModulePropertyList $prop]
set structured_value_list [$unserialize_proc $serialized_value_list\
$char_unmap_list]
return $structured_value_list
}
proc getEnvLoadedModulePropertyList {prop} {
set env_var_name [getLoadedModulePropertyEnvVarName $prop]
return [split [get-env $env_var_name] [getState path_separator]]
}
proc getLoadedModulePropertyEnvVarName {prop} {
switch -- $prop {
name {set env_var_name LOADEDMODULES}
file {set env_var_name _LMFILES_}
modulepath {set env_var_name MODULEPATH}
default {set env_var_name __MODULES_LM[string toupper $prop]}
}
return $env_var_name
}
# return list of module paths by parsing MODULEPATH env variable
# behavior param enables to exit in error when no MODULEPATH env variable
# is set. by default an empty list is returned if no MODULEPATH set
# resolv_var param tells if environment variable references in path elements
# should be resolved or passed as-is in result list
# set_abs param applies an absolute path name conversion to path elements
# if enabled
proc getModulePathList {{behavior returnempty} {resolv_var 1} {set_abs 1}} {
if {![isEnvVarDefined MODULEPATH] && $behavior eq {exiterronundef}} {
reportErrorAndExit {No module path defined}
}
set modpath_list [list]
foreach modpath [getEnvLoadedModulePropertyParsedList modulepath] {
if {$resolv_var} {
set modpath [resolvStringWithEnv $modpath]
}
if {$set_abs} {
set modpath [getAbsolutePath $modpath]
}
lappendNoDup modpath_list $modpath
}
return $modpath_list
}
proc getModulepathLabel {modpath} {
if {[info exists ::g_modulepathLabel($modpath)]} {
return $::g_modulepathLabel($modpath)
} else {
return $modpath
}
}
# return list of the configured and existing global RC files
proc getGlobalRcFileList {} {
set rclist {}
set rcfilelist [getConfList rcfile]
if {[llength $rcfilelist]} {
foreach rcfile $rcfilelist {
# if rcfile is a dir, look at a modulerc file in it
if {[file isdirectory $rcfile] && [file isfile $rcfile/modulerc]} {
lappend rclist $rcfile/modulerc
} elseif {[file isfile $rcfile]} {
lappend rclist $rcfile
}
}
}
if {[file isfile {@etcdir@/rc}]} {
lappend rclist {@etcdir@/rc}
}
# ignore user rc if relative configuration is enabled
if {![getConf ignore_user_rc] && [isEnvVarDefined HOME] && [file isfile\
$::env(HOME)/.modulerc]} {
lappend rclist $::env(HOME)/.modulerc
}
set readable_rclist {}
foreach rc $rclist {
if {[file readable $rc]} {
lappend readable_rclist $rc
}
}
return $readable_rclist
}
proc getModuleTag {mod full_path_mod tag} {
# check if tag is set on full path module designation (no prop there)
lassign [getFullPathModuleTagSpec $full_path_mod $tag] tag_mod_spec\
tag_props
if {[string length $tag_mod_spec]} {
return [list $tag $tag_props]
}
# look if mod matches one of the module specs applying to mod root
foreach {tmodspec tag_props} [getModuleRootTagSpecList $mod $tag] {
# first matching module spec wins with its properties
if {[modEq $tmodspec $mod eqstart 1 0 1]} {
return [list $tag $tag_props]
}
}
return {}
}
proc getModuleTagRuleList {mod full_path_mod tag} {
set rule_list {}
lassign [getFullPathModuleTagSpec $full_path_mod $tag] tag_mod_spec\
tag_props
if {[string length $tag_mod_spec]} {
lappend rule_list $tag_mod_spec
}
foreach {tag_mod_spec tag_props} [getModuleRootTagSpecList $mod $tag] {
if {$tag_mod_spec ni $rule_list && [modEq $tag_mod_spec $mod eqstart 1\
0 1]} {
lappend rule_list $tag_mod_spec
}
}
return $rule_list
}
proc getModuleRootTagSpecList {mod tag} {
set tag_spec_list {}
set mod_root [getModuleRootFromVersSpec $mod]
if {[info exists ::g_moduleTagRoot($mod_root)]} {
set idx [lsearch -exact $::g_moduleTagRoot($mod_root) $tag]
set tag_spec_list [lindex $::g_moduleTagRootSpec($mod_root) $idx]
}
return $tag_spec_list
}
proc getFullPathModuleTagSpec {full_path_mod tag} {
set tag_spec {}
if {$full_path_mod ne {} && [info exists\
::g_moduleTagFullPath($full_path_mod)]} {
set idx [lsearch -exact $::g_moduleTagFullPath($full_path_mod) $tag]
if {$idx != -1} {
set tag_spec [list $full_path_mod [lindex\
$::g_moduleTagFullPathSpec($full_path_mod) $idx]]
}
}
return $tag_spec
}
proc isModuleTagged {mod tag {collected 0} {fpmod {}}} {
# retrieve tag information from collected tags or raw info
if {$collected} {
return [expr {$tag in [getTagList $mod $fpmod]}]
} else {
return [llength [getModuleTag $mod $fpmod $tag]]
}
}
proc getTaggedLoadedModuleList {tag} {
set modlist [list]
foreach mod [getEnvLoadedModulePropertyParsedList name] {
if {[isModuleTagged $mod $tag 1]} {
lappend modlist $mod
}
}
return $modlist
}
proc getModuleTagProp {mod fpmod tag prop} {
array set tags [getModuleTag $mod $fpmod $tag]
if {[info exists tags($tag)]} {
array set props $tags($tag)
if {[info exists props($prop)]} {
return $props($prop)
}
}
}
# Gather all tags applying to a given module
proc collectModuleTags {mod} {
if {[info exists ::g_tagHash($mod)]} {
set known_tag_list $::g_tagHash($mod)
} else {
set known_tag_list {}
}
set tag_list [getMatchingTagList $mod $known_tag_list]
if {[llength $tag_list]} {
setModuleTag $mod {*}$tag_list
}
}
proc getMatchingTagList {mod {known_tag_list {}}} {
set tag_list {}
set modroot [getModuleRootFromVersSpec $mod]
# look if mod matches one of the module specs applying to mod root
if {[info exists ::g_moduleTagRoot($modroot)]} {
for {set i 0} {$i < [llength $::g_moduleTagRoot($modroot)]} {incr i} {
set tag [lindex $::g_moduleTagRoot($modroot) $i]
if {$tag ni $tag_list} {
foreach {tmodspec tprops} [lindex\
$::g_moduleTagRootSpec($modroot) $i] {
# add tag if one modspec matches mod
if {[modEq $tmodspec $mod eqstart 1 0 1]} {
lappend known_tag_list $tag
lappend tag_list $tag
break
}
}
}
}
}
return $tag_list
}
proc setModuleTag {mod args} {
lappendNoDup ::g_tagHash($mod) {*}$args
}
proc setModuleAndVariantsTag {mod mod_with_vr args} {
setModuleTag $mod {*}$args
if {$mod_with_vr ne {} && $mod ne $mod_with_vr} {
setModuleTag $mod_with_vr {*}$args
}
}
proc setModuleExtraTag {mod args} {
lappendNoDup ::g_extraTagHash($mod) {*}$args
}
proc setModuleAndVariantsExtraTag {mod mod_with_vr args} {
setModuleExtraTag $mod {*}$args
if {$mod_with_vr ne {} && $mod ne $mod_with_vr} {
setModuleExtraTag $mod_with_vr {*}$args
}
}
proc unsetModuleTag {mod args} {
if {[info exists ::g_tagHash($mod)]} {
lassign [getDiffBetweenList $::g_tagHash($mod) $args] diff_list
if {[llength $args] && [llength $diff_list]} {
set ::g_tagHash($mod) $diff_list
} else {
unset ::g_tagHash($mod)
}
}
}
proc unsetModuleAndVariantsTag {mod mod_with_vr args} {
unsetModuleTag $mod {*}$args
if {$mod_with_vr ne {} && $mod ne $mod_with_vr} {
unsetModuleTag $mod_with_vr {*}$args
}
}
proc unsetModuleExtraTag {mod args} {
if {[info exists ::g_extraTagHash($mod)]} {
lassign [getDiffBetweenList $::g_extraTagHash($mod) $args] diff_list
if {[llength $args] && [llength $diff_list]} {
set ::g_extraTagHash($mod) $diff_list
} else {
unset ::g_extraTagHash($mod)
}
}
}
proc unsetModuleAndVariantsExtraTag {mod mod_with_vr args} {
unsetModuleExtraTag $mod {*}$args
if {$mod_with_vr ne {} && $mod ne $mod_with_vr} {
unsetModuleExtraTag $mod_with_vr {*}$args
}
}
proc getTagList {mod {fpmod {}} {sort 1}} {
set tag_list {}
# get tags applied over module full path designation
if {$fpmod ne {} && [info exists ::g_moduleTagFullPath($fpmod)]} {
lappendNoDup tag_list {*}$::g_moduleTagFullPath($fpmod)
}
# recompute tags applying from module specification if mod is loaded but
# not the same modulefile. tags applying to loaded mod are recorded in
# g_tagHash but should not apply to same mod from a different modulepath
# do not make this distinction if modulefile is not provided
# directly check on g_loadedModules array to avoid triggering env check
if {[string length $fpmod] && [info exists ::g_loadedModules($mod)] &&\
$fpmod ne [getModulefileFromLoadedModule $mod]} {
lappendNoDup tag_list {*}[getMatchingTagList $mod]
# get collected tags applied on short designation
} elseif {[info exists ::g_tagHash($mod)]} {
lappendNoDup tag_list {*}$::g_tagHash($mod)
}
if {[llength $tag_list]} {
if {$sort} {
set tag_list [lsort -dictionary $tag_list]
}
reportDebug "'$mod' has tag list '$tag_list'"
}
return $tag_list
}
# return tags applying to mod that can be exported
proc getExportTagList {mod {fpmod {}}} {
# remove loaded/hidden tags from the list to register
lassign [getDiffBetweenList [getTagList $mod $fpmod 0] [list loaded\
hidden]] ret
return $ret
}
# return extra tags set on mod
proc getExtraTagList {mod} {
if {[info exists ::g_extraTagHash($mod)]} {
return $::g_extraTagHash($mod)
}
}
# return rule definition of sticky/super-sticky tag on given module
proc getStickyRuleList {mod {fpmod {}}} {
set ret {}
foreach tag {sticky super-sticky} {
if {[isModuleTagged $mod $tag 1]} {
set export_sticky_rule 1
set tag_rule_list [getModuleTagRuleList $mod $fpmod $tag]
# skip rule export if one matches module name and version or full
# path designation
foreach tag_rule $tag_rule_list {
if {[modEq $tag_rule $mod equal 1 0 1] || [modEq $tag_rule $fpmod\
equal 1 0 1]} {
set export_sticky_rule 0
break
}
}
if {[llength $tag_rule_list] && $export_sticky_rule} {
lappend ret [list $tag {*}$tag_rule_list]
}
}
}
return $ret
}
# return tags set on mod to record in collection
proc getSaveTagList {mod} {
# return all tags if pin tag is enabled, except nearly-forbidden that is
# not intended for save
if {[getConf collection_pin_tag]} {
lassign [getDiffBetweenList [getExportTagList $mod] [list\
nearly-forbidden]] ret
} else {
set ret [getExtraTagList $mod]
# in addition to those set with --tag option, add tags obtained by the
# way mod has been loaded
if {[isModuleTagged $mod auto-loaded 1]} {
lappend ret auto-loaded
}
if {[isModuleTagged $mod keep-loaded 1]} {
lappend ret keep-loaded
}
}
return $ret
}
proc abbrevTagList {taglist} {
set ret [list]
foreach tag $taglist {
if {[info exists ::g_tagAbbrev($tag)]} {
# empty string abbrev means no tag report
if {$::g_tagAbbrev($tag) ne {}} {
lappend ret $::g_tagAbbrev($tag)
}
} else {
lappend ret $tag
}
}
return [lsort -dictionary $ret]
}
proc getTagFromAbbrev {abbrev} {
if {![array exists ::g_abbrevTag]} {
getConf tag_abbrev
}
if {[info exists ::g_abbrevTag($abbrev)]} {
return $::g_abbrevTag($abbrev)
}
}
proc getVariantList {mod {report 0} {excl_dflval 0} {from 0}} {
set vrspeclist {}
set loadedsgrkey {}
# fetch variant information from
switch -- $from {
0 {
# variant set after module being loaded
if {[info exists ::g_loadedModuleVariant($mod)]} {
set vrspeclist $::g_loadedModuleVariant($mod)
}
}
1 {
# module specification
set vrspeclist {}
foreach vrspec [getVariantListFromVersSpec $mod] {
lassign $vrspec vrname vrnot vrvalisbool vrvalue
lappend vrspeclist [list $vrname $vrvalue $vrvalisbool]
}
}
2 {
# variant definition collected during scan evaluation
if {[info exists ::g_scanModuleVariant($mod)]} {
set vrspeclist $::g_scanModuleVariant($mod)
}
# if module is currently loaded, gather its variant values
if {[info exists ::g_loadedModuleVariant($mod)]} {
foreach lovrspec $::g_loadedModuleVariant($mod) {
lassign $lovrspec lovrname lovrvalue lovrvalisbool lovrvalisdfl
if {$lovrvalisbool} {
set lovrvalue [expr {$lovrvalue ? {on} : {off}}]
}
set lovrarr($lovrname) $lovrvalue
}
# get sgr key corresponding to loaded tag (if tag reported)
if {$report == 7 && [isEltInReport tag]} {
set loadedkind [expr {[isModuleTagged $mod auto-loaded 1] ?\
{auto-loaded} : {loaded}}]
lassign [abbrevTagList [list $loadedkind]] loadedsgrkey
}
}
}
}
# use array to make variant unique
foreach vrspec $vrspeclist {
if {$from == 2} {
# report all available variant values on avail
lassign $vrspec vrname vrvalues vrdefdflval vrdflval
set vrvalisbool 0
set vrvalisdfl 0
# build value list to output for free-variant value
if {![llength $vrvalues]} {
# if module is loaded, add loaded variant value
if {[info exists lovrarr($vrname)]} {
lappend vrvalues $lovrarr($vrname)
}
# if a default value is defined, add it to possible value list
if {$vrdefdflval && $vrdflval ni $vrvalues} {
lappend vrvalues $vrdflval
}
# indicate on free-value variant that all values are possible
lappend vrvalues *
}
} else {
lassign $vrspec vrname vrvalue vrvalisbool vrvalisdfl
set vrvalues [list $vrvalue]
}
# correct is-default value if invalid
if {![string is integer -strict $vrvalisdfl]} {
set vrvalisdfl 0
}
# correct is-boolean value if invalid
if {![string is boolean -strict $vrvalisbool]} {
set vrvalisbool 0
}
set vrisbool($vrname) $vrvalisbool
# correct boolean value if invalid
if {$vrvalisbool && ![string is boolean -strict $vrvalue]} {
set vrvalue 0
}
# do not return variant if value is default, unless if variant was
# specifically set to default value (isdfl=1) and we only want to
# exclude the automatically set default value (excl_dflval=2)
if {$excl_dflval > 0} {
if {$vrvalisdfl == 0 || ($excl_dflval == 2 && $vrvalisdfl == 1)} {
set vrarr($vrname) $vrvalue
# nullify previous duplicate definition if this one is default
} elseif {[info exists vrarr($vrname)]} {
unset vrarr($vrname)
}
} else {
if {$report == 7} {
# indicate what value in the list is the default one
if {[info exists vrdefdflval]} {
set vrdflidxarr($vrname) [expr {$vrdefdflval ? [lsearch -exact\
$vrvalues $vrdflval] : {-1}}]
} else {
set vrdflidxarr($vrname) [expr {$vrvalisdfl ? {0} : {-1}}]
}
# indicate what value in the list is the loaded one
set vrloidxarr($vrname) [expr {[info exists lovrarr($vrname)] ?\
[lsearch -exact $vrvalues $lovrarr($vrname)] : {-1}}]
if {$vrvalisbool} {
set vrarr($vrname) $vrvalue
} else {
set vrarr($vrname) $vrvalues
}
# is-default hint has to be transmitted on report mode '3'
} elseif {$report == 3} {
set vrarr($vrname) [list $vrvalue [expr {$vrvalisdfl > 0 &&\
$vrvalisdfl < 3}]]
} else {
set vrarr($vrname) $vrvalue
}
}
}
# sort variant to report
set ret {}
foreach vrname [lsort -dictionary [array names vrarr]] {
switch -- $report {
4 {lappend ret $vrname $vrarr($vrname) $vrisbool($vrname)}
3 {lappend ret $vrname [lindex $vrarr($vrname) 0] [lindex\
$vrarr($vrname) 1]}
2 {lappend ret [list $vrname 0 $vrisbool($vrname) $vrarr($vrname)]}
1 - 5 - 6 {
if {$vrisbool($vrname)} {
if {$vrarr($vrname)} {
lappend ret +$vrname
# track if +var variant has been reported to build key
# unless if key should not be updated (report mode '6')
if {$report != 6 && ![info exists ::g_used_va(on)]} {
set ::g_used_va(on) 1
}
} else {
lappend ret -$vrname
# track if -var variant has been reported to build key
# unless if key should not be updated (report mode '6')
if {$report != 6 && ![info exists ::g_used_va(off)]} {
set ::g_used_va(off) 1
}
}
# use defined shortcut to report if any set for this variant
# ignore shortcut if report=5 (when saving collection)
} elseif {$report != 5 && [info exists\
::g_variantShortcut($vrname)]} {
set sc $::g_variantShortcut($vrname)
lappend ret $sc$vrarr($vrname)
# track if variant shortcut has been reported to build key