Support for configuration file with additional script search directories

Author: WheretIB

LuaDkmDebugger/source.extension.vsixmanifest

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
     <Metadata>
-        <Identity Id="LuaDkmDebugger.e3e2ef04-27c9-46a6-ad45-79bd29067eb6" Version="0.2.3" Language="en-US" Publisher="WheretIB" />
+        <Identity Id="LuaDkmDebugger.e3e2ef04-27c9-46a6-ad45-79bd29067eb6" Version="0.2.4" Language="en-US" Publisher="WheretIB" />
         <DisplayName>C++ debugger extensions for Lua</DisplayName>
         <Description xml:space="preserve">This Visual Studio extension enables limited support for inspection of Lua (Version 5.3) state in C++ applications during debug.</Description>
         <License>license.txt</License>

LuaDkmDebuggerComponent/LocalComponent.cs

@@ -7,10 +7,17 @@
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.IO;
 using System.Linq;
+using System.Web.Script.Serialization;
 
 namespace LuaDkmDebuggerComponent
 {
+    internal class LuaDebugConfiguration
+    {
+        public List<string> ScriptPaths = new List<string>();
+    }
+
     internal class LuaLocalProcessData : DkmDataItem
     {
         public DkmCustomRuntimeInstance runtimeInstance = null;
@@ -21,6 +28,8 @@ internal class LuaLocalProcessData : DkmDataItem
         public bool workingDirectoryRequested = false;
         public string workingDirectory = null;
 
+        public LuaDebugConfiguration configuration;
+
         // Stack walk data for multiple switches between Lua and C++
         public bool seenLuaFrame = false;
         public int skipFrames = 0; // How many Lua frames to skip
@@ -113,6 +122,45 @@ internal string TryEvaluateStringExpression(string expression, DkmStackContext s
             return ExecuteExpression(expression + ",sb", stackContext, input, false, out _);
         }
 
+        internal void LoadConfigurationFile(DkmProcess process, LuaLocalProcessData processData)
+        {
+            // Check if already loaded
+            if (processData.configuration != null)
+                return;
+
+            bool TryLoad(string path)
+            {
+                if (File.Exists(path))
+                {
+                    var serializer = new JavaScriptSerializer();
+
+                    try
+                    {
+                        processData.configuration = serializer.Deserialize<LuaDebugConfiguration>(File.ReadAllText(path));
+
+                        return processData.configuration != null;
+                    }
+                    catch (Exception e)
+                    {
+                        Debug.WriteLine("Failed to load configuration: " + e.Message);
+                    }
+                }
+
+                return false;
+            }
+
+            string pathA = $"{Path.GetDirectoryName(process.Path)}\\";
+
+            if (TryLoad(pathA + "lua_dkm_debug.json"))
+                return;
+
+            if (processData.workingDirectory == null)
+                return;
+
+            if (TryLoad($"{processData.workingDirectory}\\" + "lua_dkm_debug.json"))
+                return;
+        }
+
         DkmStackWalkFrame[] IDkmCallStackFilter.FilterNextFrame(DkmStackContext stackContext, DkmStackWalkFrame input)
         {
             // null input frame indicates the end of the call stack
@@ -168,6 +216,7 @@ DkmStackWalkFrame[] IDkmCallStackFilter.FilterNextFrame(DkmStackContext stackCon
                 if (processData.scratchMemory == 0)
                     return new DkmStackWalkFrame[1] { input };
 
+                // Find out the current process working directory (Lua script files will be resolved from that location)
                 if (processData.workingDirectory == null && !processData.workingDirectoryRequested)
                 {
                     processData.workingDirectoryRequested = true;
@@ -184,6 +233,8 @@ DkmStackWalkFrame[] IDkmCallStackFilter.FilterNextFrame(DkmStackContext stackCon
                     }
                 }
 
+                LoadConfigurationFile(process, processData);
+
                 // TODO: Replace with enumerations from Bytecode.cs
                 const int luaBaseTypeMask = 0xf;
                 const int luaExtendedTypeMask = 0x3f;
@@ -436,24 +487,74 @@ DkmSourcePosition IDkmSymbolQuery.GetSourcePosition(DkmInstructionSymbol instruc
 
             frameData.ReadFrom(instructionSymbol.AdditionalData.ToArray());
 
+            string CheckConfigPaths(string winSourcePath)
+            {
+                if (processData.configuration != null && processData.configuration.ScriptPaths != null)
+                {
+                    foreach (var path in processData.configuration.ScriptPaths)
+                    {
+                        var finalPath = path.Replace('/', '\\');
+
+                        if (!Path.IsPathRooted(finalPath))
+                        {
+                            if (processData.workingDirectory != null)
+                            {
+                                string test = Path.GetFullPath(Path.Combine(processData.workingDirectory, finalPath)) + winSourcePath.Substring(1);
+
+                                if (File.Exists(test))
+                                    return test;
+                            }
+
+                            {
+                                string test = Path.GetFullPath(Path.Combine(Path.GetDirectoryName(process.Path), finalPath)) + winSourcePath.Substring(1);
+
+                                if (File.Exists(test))
+                                    return test;
+                            }
+                        }
+                        else
+                        {
+                            string test = finalPath + winSourcePath.Substring(1);
+
+                            if (File.Exists(test))
+                                return test;
+                        }
+                    }
+                }
+
+                return null;
+            }
+
             string filePath;
 
             if (frameData.source.StartsWith("@"))
             {
                 string winSourcePath = frameData.source.Replace('/', '\\');
 
-                if (processData.workingDirectory != null)
-                    filePath = $"{processData.workingDirectory}\\{winSourcePath.Substring(1)}";
-                else
-                    filePath = winSourcePath.Substring(1);
+                filePath = CheckConfigPaths(winSourcePath);
+
+                if (filePath == null)
+                {
+                    if (processData.workingDirectory != null)
+                        filePath = $"{processData.workingDirectory}\\{winSourcePath.Substring(1)}";
+                    else
+                        filePath = winSourcePath.Substring(1);
+                }
             }
             else
             {
-                // TODO: how can we display internal scripts in the debugger?
-                if (processData.workingDirectory != null)
-                    filePath = $"{processData.workingDirectory}\\internal.lua";
-                else
-                    filePath = "internal.lua";
+                string winSourcePath = frameData.source.Replace('/', '\\');
+
+                filePath = CheckConfigPaths(winSourcePath);
+
+                if (filePath == null)
+                {
+                    // TODO: how can we display internal scripts in the debugger?
+                    if (processData.workingDirectory != null)
+                        filePath = $"{processData.workingDirectory}\\internal.lua";
+                    else
+                        filePath = "internal.lua";
+                }
             }
 
             startOfLine = true;

LuaDkmDebuggerComponent/LuaDkmDebuggerComponent.csproj

@@ -33,6 +33,7 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.Core" />
+    <Reference Include="System.Web.Extensions" />
     <Reference Include="System.Xml.Linq" />
     <Reference Include="System.Data.DataSetExtensions" />
     <Reference Include="Microsoft.CSharp" />

README.md

@@ -14,6 +14,24 @@ This Visual Studio extension enables limited support for inspection of Lua (Vers
 
 ![Example debug session](https://github.com/WheretIB/LuaDkmDebugger/blob/master/resource/front_image.png?raw=true)
 
- ## Known Issues:
+## Additional configuration
+
+In the default configuration, debugger searches for script files in current working directory and application executable directory.
+
+Application may provide Lua with script file paths that do not match the file system. To help the debugger find your script files in this scenario, additional script search paths can be provided using an optional configuration file.
+
+`lua_dkm_debug.json` file can be placed in application working directory or near the executable file.
+
+Add `ScriptPaths` key with an array of additional search paths.
+
+```
+{
+  "ScriptPaths": [
+    "../",
+    "../scripts/base/"
+  ]
+}
+```
+
+## Known Issues:
  * This extension will always add Lua module to the application (can be seen in 'Modules' section of the debugger) even when debugging applications with no Lua code (check notes in RemoteComponent.cs)
- * Lua source files are located based on the process working directory, additional configuration options are planned in the future