QScripts v1.2.3

- bugfix: package dependencies reloading was not working properly
- added 'pkgparentmodname' variable

Author: 0xeb

README.md

@@ -67,7 +67,7 @@ See also:
 * `$basename$`: This variable is expanded to the base name of the current dependency line
 * `$env:EnvVariableName$`: `EnvVariableName` is expanded to its environment variable value if it exists or left unexpanded otherwise
 * `$pkgbase$`: Specify a package base directory. Can be used as part of a dependency file path.
-* `$pkgmodname$`: This is mainly used inside the `reload` directive. It replaces the path seperators with dots (which works nicely as a fully qualified module name). Please see the [package dependency](test_scripts/pkg-dependency/README.md) example file.
+* `$pkgparentmodname$` and `$pkgmodname$`: These are mainly used inside the `reload` directive. They help with proper [package dependency](test_scripts/pkg-dependency/README.md) reloading.
 * `$ext$`: This resolves to the plugin suffix and extension ("64.dll", ".so", "64.dylib", etc.). See the trigger native deps files for reference.
 
 ## Using QScripts with trigger files

qscripts.cpp

@@ -141,6 +141,7 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
                 if (ctx.main_file)
                 {
                     ctx.pkg_base = val;
+                    expand_file_name(ctx.pkg_base, ctx);
                     make_abs_path(ctx.pkg_base, ctx.base_dir.c_str(), true);
                 }
                 continue;
@@ -170,6 +171,7 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
             // From here on, the *line* variable is an expandable string leading to a script file
             ctx.script_file = line;
             expand_file_name(line, ctx);
+            normalize_path_sep(line);
 
             // Skip dependency scripts that (do not|no longer) exist
             script_info_t dep_script;
@@ -225,14 +227,38 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
     bool is_monitor_active()          const { return m_b_filemon_timer_active; }
     bool is_filemon_timer_installed() const { return m_filemon_timer != nullptr; }
 
-    // Dynamic string expansion
-    // ------------------------
-    // basename                       Returns the basename of the input file
-    // env:Variable_Name              Expands the 'Variable_Name'
-    // pkgbase                        Sets the current pkgbase path
-    // pkgmodname                     Expands the file name using the pckbase into the form: 'module.submodule1.submodule2'
-    // ext                            Addon suffix including bitness and extension (example: 64.dll, .so, 64.so, .dylib, etc.)
-    void expand_string(qstring &input, qstring &output, const expand_ctx_t& ctx)
+    std::string expand_pkgmodname(const expand_ctx_t& ctx)
+    {
+        auto dep_file = selected_script.has_dep(ctx.script_file.c_str());
+        qstring pkg_base = dep_file == nullptr ? selected_script.pkg_base : dep_file->pkg_base;
+
+        // If the script file is in the package base, then replace the path separators with '.'
+        if (strncmp(ctx.script_file.c_str(), pkg_base.c_str(), pkg_base.length()) == 0)
+        {
+            qstring s = ctx.script_file.c_str() + pkg_base.length() + 1;
+            s.replace(SDIRCHAR, ".");
+            // Drop the extension too
+            auto idx = s.rfind('.');
+            if (idx != -1)
+                s.resize(idx);
+
+            return s.c_str();
+        }
+        return "";
+    }
+    
+    // Dynamic string expansion   Description
+    // ------------------------   -----------
+    // basename                   Returns the basename of the input file
+    // env:Variable_Name          Expands the 'Variable_Name'
+    // pkgbase                    Sets the current pkgbase path
+    // pkgmodname                 Expands the file name using the pkgbase into the form: 'module.submodule1.submodule2'
+    // pkgparentmodname           Expands the file name using the pkgbase into the form up to the parent module: 'module.submodule1'
+    // ext                        Add-on suffix including bitness and extension (example: 64.dll, .so, 64.so, .dylib, etc.)
+    void expand_string(
+        qstring &input, 
+        qstring &output, 
+        const expand_ctx_t& ctx)
     {
         output = std::regex_replace(
             input.c_str(),
@@ -243,22 +269,13 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
 
                 if (strncmp(match1.c_str(), "pkgmodname", 10) == 0)
                 {
-                    auto dep_file = selected_script.has_dep(ctx.script_file.c_str());
-                    qstring pkg_base = dep_file == nullptr ? selected_script.pkg_base : dep_file->pkg_base;
-
-                    // If the script file is in the package base, then replace the path separators with '.'
-                    if (strncmp(ctx.script_file.c_str(), pkg_base.c_str(), pkg_base.length()) == 0)
-                    {
-                        qstring s = ctx.script_file.c_str() + pkg_base.length() + 1;
-                        s.replace(SDIRCHAR, ".");
-                        // Drop the extension too
-                        auto idx = s.rfind('.');
-                        if (idx != -1)
-                            s.resize(idx);
-
-                        return s.c_str();
-                    }
-                    return "";
+					return expand_pkgmodname(ctx);
+                }
+                else if (strncmp(match1.c_str(), "pkgparentmodname", 16) == 0)
+                {
+                    std::string pkgmodname = expand_pkgmodname(ctx);
+                    size_t pos = pkgmodname.rfind('.');
+                    return pos == std::string::npos ? pkgmodname : pkgmodname.substr(0, pos);
                 }
                 else if (strncmp(match1.c_str(), "ext", 3) == 0)
                 {
@@ -307,15 +324,21 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
             qstring reload_cmd;
             expand_ctx_t ctx;
             ctx.script_file = script_file;
+            ctx.pkg_base = dep_script_file.pkg_base;
             expand_string(dep_script_file.reload_cmd, reload_cmd, ctx);
 
             if (!elang->eval_snippet(reload_cmd.c_str(), &err))
+            {
+				err.sprnt("failed to execute the reload directive for '%s' with command: %s!\n", 
+                    script_file,
+                    reload_cmd.c_str());
                 break;
+            }
             return true;
         } while (false);
 
         if (!silent)
-            msg("QScripts failed to reload script file: '%s':\n%s", script_file, err.c_str());
+            msg("QScripts failed to reload script file: '%s'\nReload command used: %s", script_file, err.c_str());
 
         return false;
     }
@@ -339,7 +362,7 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
         {
             auto script_file = script_info->file_path.c_str();
 
-            // First things first: always take the file's modification timestamp first so not to visit it again in the file monitor timer
+            // First things first: always take the file's modification time-stamp first so not to visit it again in the file monitor timer
             if (!get_file_modification_time(script_file, &script_info->modified_time))
             {
                 msg("Script file '%s' not found!\n", script_file);
@@ -392,7 +415,8 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
         return exec_ok;
     }
 
-    enum {
+    enum 
+    {
         OPTID_INTERVAL       = 0x0001,
         OPTID_CLEARLOG       = 0x0002,
         OPTID_SHOWNAME       = 0x0004,
@@ -537,9 +561,8 @@ struct qscripts_chooser_t: public plugmod_t, public chooser_t
                     qstring err;
                     dep_script_changed = true;
                     if (     dep_script.has_reload_directive()
-                         && !execute_reload_directive(dep_script, err))
+                         && !execute_reload_directive(dep_script, err, false))
                     {
-                        msg("QScripts: warning: failed to execute reload directive: %s\n", err.c_str());
                         brk = true;
                         break;
                     }

test_scripts/pkg-dependency/README.md

@@ -1,21 +1,18 @@
-This is an example where we have a dependency file that relies on a package.
+In this example, we're dealing with a dependency file for a package that's currently being developed. This setup is designed to ensure that modules from the package, `idapyx` in this instance, are automatically reloaded upon any changes.
 
-The package (supposedly) is under development and you want to have its modules be reloaded when they change.
+For this purpose, we can either explicitly specify the package's full path or refer to it through an environment variable, as demonstrated below:
 
+```plaintext
+# Define package base folder
+/pkgbase $env:idapyx$
+# Automatically reload the package's modules when they change
+/reload import importlib; from $pkgparentmodname$ import $basename$ as __qscripts_autoreload__; importlib.reload(__qscripts_autoreload__)
+# Specify the paths to the package modules that need to be reloaded if they change
+$pkgbase$/idapyx/bin/pe/rtfuncs.py
+$pkgbase$/idapyx/bin/pe/types.py
 ```
-# Non package dependencies first
-/reload import importlib;importlib.reload($basename$)
-dep.py
 
-# Package dependencies
-/pkgbase C:\Python38\Lib\site-packages
-/reload import importlib;import $pkgmodname$;importlib.reload($pkgmodname$)
-
-$pkgbase$\PIL\BlpImagePlugin.py
-$pkgbase$\PIL\ContainerIO.py
-```
-
-* We start by describing the local dependencies if any. Note the Python specific reload directive
-* Then we use `pkgbase` to define the package base. This will help with the reload directive
-* The reload directive uses the special variable `pkgmodname` that will use the package directory to formulate a Python module name
-* Finally, we define our dependencies relative to their package base folder using the variable `pkgbase`
+- The `/pkgbase` directive specifies the base path of the package, aiding in the module reload process.
+- The reload directive employs the `pkgmodparentname` variable to derive the Python parent module name based on the package directory.
+- Similarly, the reload directive utilizes the `basename` variable to determine the Python module name, again using the package directory.
+- Dependencies are specified relative to their package base folder, facilitated by the `pkgbase` variable.

test_scripts/pkg-dependency/example.py.deps.qscripts

@@ -1,10 +1,6 @@
-# Non package dependencies first
-/reload import importlib;importlib.reload($basename$)
-dep.py
+# Package dependencies (here, we use the environment variable 'IDAPYX' that contains the package path
+/pkgbase $env:idapyx$
+/reload import importlib;from $pkgparentmodname$ import $basename$ as __qscripts_autoreload__;importlib.reload(__qscripts_autoreload__)
+$pkgbase$/idapyx/bin/pe/rtfuncs.py
+$pkgbase$/idapyx/bin/pe/types.py
 
-# Package dependencies
-/pkgbase C:\Python38\Lib\site-packages
-/reload import importlib;import $pkgmodname$;importlib.reload($pkgmodname$)
-
-$pkgbase$\PIL\BlpImagePlugin.py
-$pkgbase$\PIL\ContainerIO.py