add support for 'package forget'

Sometimes useful if replacing a package that has already been loaded

Signed-off-by: Steve Bennett <steveb@workware.net.au>

4 files changed, 40 insertions, 0 deletions

diff --git a/jim-package.c b/jim-package.c
index 69af074..18b64fe 100644
--- a/jim-package.c
+++ b/jim-package.c
@@ -148,6 +148,16 @@ int Jim_PackageRequire(Jim_Interp *interp, const char *name, int flags)
     return JIM_OK;
 }
 
+static int package_cmd_forget(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
+{
+    int i;
+
+    for (i = 0; i < argc; i++) {
+        Jim_DeleteHashEntry(&interp->packages, Jim_String(argv[i]));
+    }
+    return JIM_OK;
+}
+
 /*
  *----------------------------------------------------------------------
  *
@@ -216,6 +226,14 @@ static int package_cmd_names(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 static const jim_subcmd_type package_command_table[] = {
     {
+        "forget",
+        "package ...",
+        package_cmd_forget,
+        1,
+        -1,
+        /* Description: Forget that the given packages were loaded */
+    },
+    {
         "provide",
         "name ?version?",
         package_cmd_provide,
diff --git a/jim_tcl.txt b/jim_tcl.txt
index 5ea980a..7b321ef 100644
--- a/jim_tcl.txt
+++ b/jim_tcl.txt
@@ -55,6 +55,7 @@ RECENT CHANGES
 Changes since 0.83
 ~~~~~~~~~~~~~~~~~~
 1. `aio` - support for configurable read and write buffering
+2. Add support for `package forget`
 
 Changes between 0.82 and 0.83
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -3661,6 +3662,12 @@ See also `socket`, `pid`, `exec`
 
 package
 ~~~~~~~
++*package forget* '?name ...?'+
+
+Removes the knowledge that the given packages were loaded. This allows new, replacement
+packages to be loaded. Note that it does not remove any effects of the previous packages
+being loaded.
+
 +*package provide* 'name ?version?'+
 
 Indicates that the current script provides the package named +'name'+.
diff --git a/tests/forget-test.tcl b/tests/forget-test.tcl
new file mode 100644
index 0000000..8d4289b
--- /dev/null
+++ b/tests/forget-test.tcl
@@ -0,0 +1,3 @@
+# This is a dummy package used for testing package forget
+
+set forgotten 1
diff --git a/tests/package.test b/tests/package.test
index b8afa18..1484bd6 100644
--- a/tests/package.test
+++ b/tests/package.test
@@ -20,5 +20,17 @@ test package-1.3 {package names} -body {
 	expr {"stdlib" in [package names]}
 } -result 1
 
+test package-2.1 {package forget} -body {
+	# First pretend the package was loaded
+	package provide forget-test
+	# Now it won't load anything
+	package require forget-test
+	# Now forget it and another unloaded test
+	package forget forget-test missing
+	# And load the local package
+	package require forget-test
+	info exists forgotten
+} -result 1
+
 testreport