Track loaded modules qualified for refresh eval

Track loaded modules that are qualified for a refresh evaluation.
Refresh evaluation is only useful if module defines volatile environment
changes: shell completion, alias or function.

An internal state, named refresh_qualified, marks loading modules
defining such volatile environment changes. Such modules are then added
to the __MODULES_LMREFRESH environment variable to track this property
once module is loaded.

Code is also added to remove module from __MODULES_LMREFRESH when it is
unloaded.

Author: xdelaruelle

tcl/mfinterp.tcl.in

@@ -1612,6 +1612,9 @@ proc set-alias {alias what} {
    set ::g_Aliases($alias) $what
    set ::g_stateAliases($alias) new
 
+   # current module is qualified for refresh evaluation
+   lappendState -nodup refresh_qualified [currentState modulename]
+
    return {}
 }
 
@@ -1631,6 +1634,9 @@ proc set-function {function what} {
    set ::g_Functions($function) $what
    set ::g_stateFunctions($function) new
 
+   # current module is qualified for refresh evaluation
+   lappendState -nodup refresh_qualified [currentState modulename]
+
    return {}
 }
 
@@ -2677,6 +2683,9 @@ proc complete {shell name body} {
    # also some shells may set multiple definitions for a single name
    lappend ::g_Completes($name) $shell $body
    set ::g_stateCompletes($name) new
+
+   # current module is qualified for refresh evaluation
+   lappendState -nodup refresh_qualified [currentState modulename]
 }
 
 # undo complete in unload mode

tcl/modeval.tcl

@@ -537,7 +537,7 @@ proc pushSettings {} {
       g_stateFunctions g_Functions g_stateCompletes g_Completes\
       g_newXResources g_delXResources g_loadedModules g_loadedModuleFiles\
       g_loadedModuleVariant g_loadedModuleConflict g_loadedModulePrereq\
-      g_loadedModuleAltname g_loadedModuleAutoAltname\
+      g_loadedModulesRefresh g_loadedModuleAltname g_loadedModuleAutoAltname\
       g_loadedModuleAliasAltname g_moduleDepend g_dependHash\
       g_moduleNPODepend g_dependNPOHash g_prereqViolation\
       g_prereqNPOViolation g_conflictViolation g_moduleUnmetDep\
@@ -564,7 +564,7 @@ proc popSettings {} {
       g_newXResources g_delXResources g_changeDir g_stdoutPuts\
       g_prestdoutPuts g_return_text g_loadedModules g_loadedModuleFiles\
       g_loadedModuleVariant g_loadedModuleConflict g_loadedModulePrereq\
-      g_loadedModuleAltname g_loadedModuleAutoAltname\
+      g_loadedModulesRefresh g_loadedModuleAltname g_loadedModuleAutoAltname\
       g_loadedModuleAliasAltname g_moduleDepend g_dependHash\
       g_moduleNPODepend g_dependNPOHash g_prereqViolation\
       g_prereqNPOViolation g_conflictViolation g_moduleUnmetDep\
@@ -580,7 +580,7 @@ proc restoreSettings {} {
       g_stateFunctions g_Functions g_stateCompletes g_Completes\
       g_newXResources g_delXResources g_loadedModules g_loadedModuleFiles\
       g_loadedModuleVariant g_loadedModuleConflict g_loadedModulePrereq\
-      g_loadedModuleAltname g_loadedModuleAutoAltname\
+      g_loadedModulesRefresh g_loadedModuleAltname g_loadedModuleAutoAltname\
       g_loadedModuleAliasAltname g_moduleDepend g_dependHash\
       g_moduleNPODepend g_dependNPOHash g_prereqViolation\
       g_prereqNPOViolation g_conflictViolation g_moduleUnmetDep\

tcl/modfind.tcl.in

@@ -435,7 +435,7 @@ proc getLoadedModulePropertyList {prop {filter_empty 1}} {
       }
       default {
          set envvar __MODULES_LM[string toupper $prop]
-         set subsplit [expr {$prop ni {init}}]
+         set subsplit [expr {$prop ni {init refresh}}]
          if {$prop in {altname conflict}} {
             set nosubsubsplit 1
          }
@@ -1141,7 +1141,11 @@ proc getModuleFromLoadingModulefile {modfile {idx all}} {
    }
 }
 
-proc setLoadedModule {mod modfile uasked {modvr {}}} {
+proc isModuleRefreshQualified {mod} {
+   return $::g_loadedModulesRefresh($mod)
+}
+
+proc setLoadedModule {mod modfile uasked {modvr {}} refresh} {
    set ::g_loadedModules($mod) $modfile
    # a loaded modfile may correspond to multiple loaded virtual modules
    lappend ::g_loadedModuleFiles($modfile) $mod
@@ -1154,6 +1158,9 @@ proc setLoadedModule {mod modfile uasked {modvr {}}} {
       setModuleTag $modvr $loadedtag
    }
 
+   # is module qualified for refresh evaluation
+   set ::g_loadedModulesRefresh($mod) $refresh
+
    # build dependency chain
    setModuleDependency $mod
 }
@@ -1167,6 +1174,9 @@ proc unsetLoadedModule {mod modfile} {
       set ::g_loadedModuleFiles($modfile) [replaceFromList\
          $::g_loadedModuleFiles($modfile) $mod]
    }
+
+   unset ::g_loadedModulesRefresh($mod)
+
    # update dependencies
    unsetModuleDependency $mod
 }
@@ -1991,6 +2001,7 @@ proc cacheCurrentModules {{exitonerr 1}} {
       set i 0
       set modfilelist [getLoadedModulePropertyList file]
       set modlist [getLoadedModulePropertyList name]
+      set refreshlist [getLoadedModulePropertyList refresh]
 
       if {[llength $modlist] == [llength $modfilelist]} {
          # cache declared variant of loaded modules
@@ -2060,7 +2071,8 @@ proc cacheCurrentModules {{exitonerr 1}} {
                set modvr {}
             }
             setLoadedModule $mod [lindex $modfilelist $i] [expr\
-               {![isModuleTagged $mod auto-loaded 1]}] $modvr
+               {![isModuleTagged $mod auto-loaded 1]}] $modvr [expr {$mod in\
+               $refreshlist}]
             incr i
          }
 

tcl/subcmd.tcl.in

@@ -1151,7 +1151,8 @@ proc cmdModuleLoad {context uasked tryload loadany tag_list args} {
          # allow duplicate modfile entries for virtual modules
          append-path --duplicates _LMFILES_ $modfile
          # update cache arrays
-         setLoadedModule $modname $modfile $uasked $modnamevr
+         setLoadedModule $modname $modfile $uasked $modnamevr [expr {$modname\
+            in [getState refresh_qualified]}]
 
          # register declared source-sh in environment
          if {[set modsrcsh [getLoadedSourceSh $modname 1]] ne {}} {
@@ -1186,6 +1187,11 @@ proc cmdModuleLoad {context uasked tryload loadany tag_list args} {
             append-path __MODULES_LMEXTRATAG $modtag
          }
 
+         # declare module qualified for refresh evaluation
+         if {[isModuleRefreshQualified $modname]} {
+            append-path __MODULES_LMREFRESH $modname
+         }
+
          # Load phase of dependent module reloading. These modules can adapt
          # now that mod is seen loaded. Except if switch action ongoing (DepRe
          # load phase will occur from switch)
@@ -1479,6 +1485,11 @@ proc cmdModuleUnload {context match auto force onlyureq onlyndep args} {
          # module was asked by user if tagged loaded instead of auto-loaded
          set uasked [isModuleTagged $modname loaded 1]
 
+         # unset module from list of loaded modules qualified for refresh eval
+         if {[isModuleRefreshQualified $modname]} {
+            remove-path __MODULES_LMREFRESH $modname
+         }
+
          # get module position in loaded list to remove corresponding loaded
          # modulefile (entry at same position in _LMFILES_)
          # need the unfiltered loaded module list to get correct index