envmodules/modules
1
0
Fork 0
mirror of https://github.com/envmodules/modules.git synced 2026-06-18 00:06:53 +08:00
Code Issues Actions 5 Packages Projects Releases Wiki Activity

Introduce 'module-virtual' modulefile command

Browse Source 
Introduce the virtual module concept with the 'module-virtual'
modulefile command. This new command takes a module name as first
argument and a modulefile location as second argument.

A virtual module stands for this module name associated to a modulefile.
The modulefile is the script interpreted when loading or unloading the
virtual module which appears or can be found with its virtual name.

Like a module aliases, virtual modules are expected to be defined within
modulerc files (at whatever rc level). Virtual modules can be targeted
by aliases or symbolic versions. They also compete with aliases and
regular modules for the implicit default version of a module.

Multiple virtual modules may target the same modulefile, which can
distinguish between these various virtual names by use of the
"[module-info name]" command.

A virtual module cannot be loaded using a full path name (merge of its
module path and its module name) as this file does not exist.

Based on a proof of concept made by Bert Wesarg [1].

[1] https://github.com/bertwesarg/modules-tcl/commit/545e9f
This commit is contained in:
Xavier Delaruelle
2018-01-06 14:48:24 +01:00
parent 3425d25b06
commit 26502e2b04
1 changed files with 108 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

121
modulecmd.tcl.in
View File

@@ -510,12 +510,12 @@ proc execute-modulefile {modfile {must_have_cookie 1}} {
module-info module-whatis module-whatis set-alias set-alias\
unset-alias unset-alias uname uname x-resource x-resource exit\
exitModfileCmd module-version module-version module-alias\
module-alias module-trace module-trace module-verbosity\
module-verbosity module-user module-user module-log module-log\
reportInternalBug reportInternalBug reportWarning reportWarning\
reportError reportError raiseErrorCount raiseErrorCount report\
report isWin isWin puts putsModfileCmd readModuleContent\
readModuleContent]
module-alias module-virtual module-virtual module-trace module-trace\
module-verbosity module-verbosity module-user module-user module-log\
module-log reportInternalBug reportInternalBug reportWarning\
reportWarning reportError reportError raiseErrorCount\
raiseErrorCount report report isWin isWin puts putsModfileCmd\
readModuleContent readModuleContent]
}
# dedicate an interpreter per level of interpretation to have in case of
@@ -648,11 +648,11 @@ proc execute-modulerc {modfile} {
# list interpreter alias commands to define
array set g_modrcAliases [list uname uname system system chdir\
chdir module-version module-version module-alias module-alias\
module module module-info module-info module-trace module-trace\
module-verbosity module-verbosity module-user module-user\
module-log module-log reportInternalBug reportInternalBug\
setModulesVersion setModulesVersion readModuleContent\
readModuleContent]
module-virtual module-virtual module module module-info\
module-info module-trace module-trace module-verbosity\
module-verbosity module-user module-user module-log module-log\
reportInternalBug reportInternalBug setModulesVersion\
setModulesVersion readModuleContent readModuleContent]
}
# dedicate an interpreter per level of interpretation to have in case of
@@ -1308,6 +1308,25 @@ proc module-alias {args} {
return {}
}
proc module-virtual {args} {
global g_moduleVirtual
global g_sourceVirtual ModulesCurrentModulefile
lassign [getModuleNameVersion [lindex $args 0]] mod
set modfile [getAbsolutePath [lindex $args 1]]
reportDebug "module-virtual: $mod = $modfile"
set g_moduleVirtual($mod) $modfile
set g_sourceVirtual($mod) $ModulesCurrentModulefile
if {[currentMode] eq "display" && !$::g_inhibit_dispreport} {
report "module-virtual\t$args"
}
return {}
}
proc module {command args} {
set mode [currentMode]
@@ -2799,6 +2818,10 @@ proc getPathToModule {mod {indir {}} {look_loaded "no"} {excdir {}}} {
# If mod was a file in this path, return that file
set retlist [list "$dir/$mod" $mod]
}
{virtual} {
# return virtual name with file it targets
set retlist [list [lindex $mod_list($mod) 2] $mod]
}
{invalid} - {accesserr} {
# may found mod but issue, so end search with error
set retlist [concat [list "" $mod] $mod_list($mod)]
@@ -2958,6 +2981,7 @@ proc runModulerc {} {
# Runs the global RC files if they exist
global env
global g_moduleAlias g_rcAlias g_moduleVersion g_rcVersion
global g_moduleVirtual g_rcVirtual
set rclist {}
reportDebug "runModulerc: running..."
@@ -2989,6 +3013,7 @@ proc runModulerc {} {
# able to include them or not in output or resolution processes
array set g_rcAlias [array get g_moduleAlias]
array set g_rcVersion [array get g_moduleVersion]
array set g_rcVirtual [array get g_moduleVirtual]
}
# manage settings to save as a stack to have a separate set of settings
@@ -4117,8 +4142,9 @@ proc findModules {dir {mod {}} {fetch_mtime 0} {fetch_hidden 0}} {
proc getModules {dir {mod {}} {fetch_mtime 0} {search {}} {fetch_hidden 0}} {
global ModulesCurrentModulefile
global g_sourceAlias g_sourceVersion g_resolvedPath
global g_sourceAlias g_sourceVersion g_sourceVirtual g_resolvedPath
global g_rcAlias g_moduleAlias g_rcVersion g_moduleVersion
global g_rcVirtual g_moduleVirtual
reportDebug "getModules: get '$mod' in $dir (fetch_mtime=$fetch_mtime,\
search=$search, fetch_hidden=$fetch_hidden)"
@@ -4209,6 +4235,9 @@ proc getModules {dir {mod {}} {fetch_mtime 0} {search {}} {fetch_hidden 0}} {
# but sometimes they may target an alias
} elseif {[info exists g_moduleAlias($versmod)]} {
lappend matching_versalias $versmod
# or a virtual module
} elseif {[info exists g_moduleVirtual($versmod)]} {
lappend matching_versvirt $versmod
}
}
}
@@ -4244,6 +4273,65 @@ proc getModules {dir {mod {}} {fetch_mtime 0} {search {}} {fetch_hidden 0}} {
}
}
# add virtual mods found when parsing .version or .modulerc files in this
# directory (skip virtual mods not registered from this directory except if
# global or user rc definitions should be included) if they match passed
# $mod (as for regular modulefiles) or if a symbolic versions targeting
# virtual mod match passed $mod
set matching_virtual [array names g_moduleVirtual -glob $mod*]
if {[info exists matching_versvirt]} {
foreach versvirt $matching_versvirt {
if {[lsearch -exact $matching_virtual $versvirt] == -1} {
lappend matching_virtual $versvirt
}
}
}
foreach virt $matching_virtual {
if {($dir ne "" && [string first "$dir/" $g_sourceVirtual($virt)] == 0)\
|| ($add_rc_defs && [info exists g_rcVirtual($virt)])} {
lassign [checkValidModule $g_moduleVirtual($virt)] check_valid\
check_msg
switch -- $check_valid {
{true} {
if {$fetch_mtime} {
set mtime [file mtime $g_moduleVirtual($virt)]
} else {
set mtime {}
}
# set mtime at index 1 like a modulefile entry
set mod_list($virt) [list "virtual" $mtime\
$g_moduleVirtual($virt)]
set add_ref_to_parent 1
}
default {
# register check error and relative message to get it in
# case of direct access of this module element, but no
# registering in parent directory structure as element
# is not valid
set mod_list($virt) [list $check_valid $check_msg\
$g_moduleVirtual($virt)]
# no reference to parent list
set add_ref_to_parent 0
}
}
# in case virtual mod overwrites a directory definition
if {[info exists dir_list($virt)]} {
unset dir_list($virt)
}
# add reference to this virtual mod in parent structure
if {$add_ref_to_parent} {
set parentname [file dirname $virt]
if {[info exists mod_list($parentname)]} {
lappend mod_list($parentname) [file tail $virt]
}
}
}
}
# work on directories integrated in the result list by registering
# default element in this dir and list of all child elements dictionary
# sorted, so last element in dir is also last element in this list
@@ -4386,7 +4474,7 @@ proc listModules {dir mod {show_flags {1}} {filter {}} {search "wild"}} {
lappend clean_list $elt
}
}
{modulefile} {
{modulefile} - {virtual} {
if {$show_mtime} {
# add to display file modification time in addition
# to potential tags
@@ -5009,6 +5097,9 @@ proc cmdModulePaths {mod} {
{modulefile} {
lappend g_return_text $dir/$elt
}
{virtual} {
lappend g_return_text [lindex $mod_list($elt) 2]
}
{alias} - {version} {
# resolve alias target
set aliastarget [lindex $mod_list($elt) 1]
@@ -5080,6 +5171,10 @@ proc cmdModuleSearch {{mod {}} {search {}}} {
# modulepaths) to get hints when solving aliases/version
set full_list($elt) 1
}
{virtual} {
set interp_list($elt) [lindex $mod_list($elt) 2]
set full_list($elt) 1
}
{alias} - {version} {
# resolve alias target
set elt_target [lindex $mod_list($elt) 1]