fix: Allow tracing string variables with "$" in the name

boriel · boriel · commit c893fe901dea · 2026-03-29T11:25:52.000+02:00
diff --git a/ZXBStudio/BuildSystem/ZXBasicMap.cs b/ZXBStudio/BuildSystem/ZXBasicMap.cs
@@ -179,7 +179,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string
                             ParseInputParameters(funcMatch.Groups[5].Value, currentFunction.InputParameters);
 
                         if (funcMatch.Groups[7].Success)
-                            currentFunction.ReturnType = StorageFromString(funcMatch.Groups[5].Value, currentFunction.Name);
+                            currentFunction.ReturnType = StorageFromString(funcMatch.Groups[7].Value, currentFunction.Name);
                         else
                             currentFunction.ReturnType = ZXVariableStorage.F;
 
@@ -202,8 +202,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string
                         if (varNameDef.Contains("(")) //array
                         {
                             string varName = varNameDef.Substring(0, varNameDef.IndexOf("(")).Trim();
-
-                            if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_]){varName}($|[^a-zA-Z0-9_])", RegexOptions.Multiline)))
+                            if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))
                                 continue;
 
                             string[] dims = varNameDef.Substring(varNameDef.IndexOf("(") + 1).Replace(")", "").Split(",", StringSplitOptions.RemoveEmptyEntries);
@@ -219,8 +218,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string
                             foreach (var vName in varNames)
                             {
                                 string varName = vName.Trim();
-
-                                if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_]){varName}($|[^a-zA-Z0-9_])", RegexOptions.Multiline)))
+                                if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))
                                     continue;
 
                                 var storage = StorageFromString(dimMatch.Groups[5].Value, varName);
@@ -291,15 +289,15 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string
                 //Search for the var in the sub/function that the location points to
                 if (location.LocationType == ZXBasicLocationType.Sub)
                 {
-                    var sub = subs.Where(s => s.Name == location.Name).FirstOrDefault();
+                    var sub = subs.FirstOrDefault(s => string.Equals(s.Name, location.Name, StringComparison.OrdinalIgnoreCase));
                     if(sub != null)
-                        foundVar = sub.LocalVariables.Where(v => v.Name == varName).FirstOrDefault();
+                        foundVar = sub.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase));
                 }
                 else
                 {
-                    var func = functions.Where(f => f.Name == location.Name).FirstOrDefault();
+                    var func = functions.FirstOrDefault(f => string.Equals(f.Name, location.Name, StringComparison.OrdinalIgnoreCase));
                     if (func != null)
-                        foundVar = func.LocalVariables.Where(v => v.Name == varName).FirstOrDefault();
+                        foundVar = func.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase));
                 }
             }
 
@@ -322,15 +320,15 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string
                 //(to avoid the very unprobable case where the same var is defined in different files in locations that match the same range)
                 if (possibleLocation.LocationType == ZXBasicLocationType.Sub)
                 {
-                    var sub = subs.Where(s => s.Name == possibleLocation.Name).FirstOrDefault();
+                    var sub = subs.FirstOrDefault(s => string.Equals(s.Name, possibleLocation.Name, StringComparison.OrdinalIgnoreCase));
                     if (sub != null)
-                        foundVar = sub.LocalVariables.Where(v => v.Name == varName && !v.Unused).FirstOrDefault();
+                        foundVar = sub.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase) && !v.Unused);
                 }
                 else
                 {
-                    var func = functions.Where(f => f.Name == possibleLocation.Name).FirstOrDefault();
+                    var func = functions.FirstOrDefault(f => string.Equals(f.Name, possibleLocation.Name, StringComparison.OrdinalIgnoreCase));
                     if (func != null)
-                        foundVar = func.LocalVariables.Where(v => v.Name == varName && !v.Unused).FirstOrDefault();
+                        foundVar = func.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase) && !v.Unused);
                 }
                 
                 //If the criteria finds a var, return it
@@ -359,11 +357,7 @@ void GetSubVars(ZXBasicSub Sub, string[] Lines)
                     if (varNameDef.Contains("(")) //array
                     {
                         string varName = varNameDef.Substring(0, varNameDef.IndexOf("(")).Trim();
-
-                        //Ignore unused vars (vars that are found only on its dim line, there may be the improbable
-                        //case where a var is defined and used in the same line using a colon and not used
-                        //anywhere else, but that would be an awful code :) )
-                        if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_]){varName}($|[^a-zA-Z0-9_])", RegexOptions.Multiline)))
+                        if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))
                             continue;
 
                         string[] dims = varNameDef.Substring(varNameDef.IndexOf("(") + 1).Replace(")", "").Split(",", StringSplitOptions.RemoveEmptyEntries);
@@ -379,9 +373,7 @@ void GetSubVars(ZXBasicSub Sub, string[] Lines)
                         foreach (var vName in varNames)
                         {
                             string varName = vName.Trim();
-
-                            //Ignore unused vars
-                            if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_]){varName}($|[^a-zA-Z0-9_])", RegexOptions.Multiline)))
+                            if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))
                                 continue;
 
                             var storage = StorageFromString(dimMatch.Groups[5].Value, varName);
@@ -415,15 +407,15 @@ public List<ZXBasicLocation> GetBuildLocations(ZXCodeFile CodeFile)
 
                     if (subMatch != null && subMatch.Success)
                     {
-                        loc = new ZXBasicLocation { Name = subMatch.Groups[2].Value.Trim(), LocationType = ZXBasicLocationType.Sub, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };
+                        loc = new ZXBasicLocation { Name = subMatch.Groups[4].Value.Trim(), LocationType = ZXBasicLocationType.Sub, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };
                         continue;
                     }
 
                     var funcMatch = regFunc.Match(line);
 
                     if (funcMatch != null && funcMatch.Success)
                     {
-                        loc = new ZXBasicLocation { Name = funcMatch.Groups[2].Value.Trim(), LocationType = ZXBasicLocationType.Function, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };
+                        loc = new ZXBasicLocation { Name = funcMatch.Groups[4].Value.Trim(), LocationType = ZXBasicLocationType.Function, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };
                         continue;
                     }
                 }
@@ -465,7 +457,7 @@ public bool ContainsBuildDim(ZXCodeFile CodeFile, string VarName, int LineNumber
             if (LineNumber >= lines.Length)
                 return false;
 
-            return Regex.IsMatch(lines[LineNumber], $"(\\s|,){VarName}(\\s|,|\\(|$)", RegexOptions.Multiline);
+            return Regex.IsMatch(lines[LineNumber], $"(\\s|,){Regex.Escape(VarName)}(\\s|,|\\(|$)", RegexOptions.Multiline);
         }
 
         private static void ParseInputParameters(string ParameterString, List<ZXBasicParameter> Storage)
diff --git a/ZXBStudio/BuildSystem/ZXVariableMap.cs b/ZXBStudio/BuildSystem/ZXVariableMap.cs
@@ -60,7 +60,7 @@ private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasic
                 string varName = m.Groups[1].Value;
                 string bVarName = varName.Substring(1);
 
-                var basicVar = BasicMap.GlobalVariables.FirstOrDefault(v => v.Name == bVarName);
+                var basicVar = BasicMap.GlobalVariables.FirstOrDefault(v => string.Equals(v.Name.TrimEnd('$'), bVarName.TrimEnd('$'), StringComparison.OrdinalIgnoreCase));
 
                 if (basicVar == null)
                     continue;
@@ -78,7 +78,7 @@ private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasic
 
                 ZXVariable newVar = new ZXVariable
                 {
-                    Name = bVarName,
+                    Name = basicVar.Name,
                     Address = new ZXVariableAddress { AddressType = ZXVariableAddressType.Absolute, AddressValue = addr },
                     Scope = ZXVariableScope.GlobalScope,
                     VariableType = ZXVariableType.Flat,
@@ -98,7 +98,7 @@ private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasic
 
                 string bVarName = varName.Substring(1);
 
-                var basicVar = BasicMap.GlobalVariables.FirstOrDefault(v => v.Name == bVarName);
+                var basicVar = BasicMap.GlobalVariables.FirstOrDefault(v => string.Equals(v.Name.TrimEnd('$'), bVarName.TrimEnd('$'), StringComparison.OrdinalIgnoreCase));
 
                 if (basicVar == null)
                     continue;
@@ -133,7 +133,7 @@ private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasic
 
                 ZXVariable newVar = new ZXVariable
                 {
-                    Name = bVarName,
+                    Name = basicVar.Name,
                     Address = new ZXVariableAddress { AddressType = ZXVariableAddressType.Absolute, AddressValue = addr },
                     Scope = ZXVariableScope.GlobalScope,
                     VariableType = ZXVariableType.Array,
@@ -179,10 +179,9 @@ private void ProcessLocalVariables(string icContent, string mapContent, ZXBasicM
 
                 ZXVariableScope currentScope = new ZXVariableScope { ScopeName = locName, StartAddress = startAddr, EndAddress = endAddr };
 
-                ZXBasicSub? sub = BasicMap.Subs.Where(m => m.Name == locName).FirstOrDefault();
-
+                ZXBasicSub? sub = BasicMap.Subs.FirstOrDefault(m => string.Equals(m.Name.TrimEnd('$'), locName.TrimEnd('$'), StringComparison.OrdinalIgnoreCase));
                 if (sub == null)
-                    sub = BasicMap.Functions.Where(m => m.Name == locName).FirstOrDefault();
+                    sub = BasicMap.Functions.FirstOrDefault(m => string.Equals(m.Name.TrimEnd('$'), locName.TrimEnd('$'), StringComparison.OrdinalIgnoreCase));
 
                 //Function params
                 if (sub != null)

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string`
`179`	`179`	`ParseInputParameters(funcMatch.Groups[5].Value, currentFunction.InputParameters);`
`180`	`180`
`181`	`181`	`if (funcMatch.Groups[7].Success)`
`182`		`- currentFunction.ReturnType = StorageFromString(funcMatch.Groups[5].Value, currentFunction.Name);`
	`182`	`+ currentFunction.ReturnType = StorageFromString(funcMatch.Groups[7].Value, currentFunction.Name);`
`183`	`183`	`else`
`184`	`184`	`currentFunction.ReturnType = ZXVariableStorage.F;`
`185`	`185`
`@@ -202,8 +202,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string`
`202`	`202`	`if (varNameDef.Contains("(")) //array`
`203`	`203`	`{`
`204`	`204`	`string varName = varNameDef.Substring(0, varNameDef.IndexOf("(")).Trim();`
`205`		`-`
`206`		`- if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_]){varName}($\|[^a-zA-Z0-9_])", RegexOptions.Multiline)))`
	`205`	`+ if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($\|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))`
`207`	`206`	`continue;`
`208`	`207`
`209`	`208`	`string[] dims = varNameDef.Substring(varNameDef.IndexOf("(") + 1).Replace(")", "").Split(",", StringSplitOptions.RemoveEmptyEntries);`
`@@ -219,8 +218,7 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string`
`219`	`218`	`foreach (var vName in varNames)`
`220`	`219`	`{`
`221`	`220`	`string varName = vName.Trim();`
`222`		`-`
`223`		`- if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_]){varName}($\|[^a-zA-Z0-9_])", RegexOptions.Multiline)))`
	`221`	`+ if (!jointLines.Skip(buc + 1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($\|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))`
`224`	`222`	`continue;`
`225`	`223`
`226`	`224`	`var storage = StorageFromString(dimMatch.Groups[5].Value, varName);`
`@@ -291,15 +289,15 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string`
`291`	`289`	`//Search for the var in the sub/function that the location points to`
`292`	`290`	`if (location.LocationType == ZXBasicLocationType.Sub)`
`293`	`291`	`{`
`294`		`- var sub = subs.Where(s => s.Name == location.Name).FirstOrDefault();`
	`292`	`+ var sub = subs.FirstOrDefault(s => string.Equals(s.Name, location.Name, StringComparison.OrdinalIgnoreCase));`
`295`	`293`	`if(sub != null)`
`296`		`- foundVar = sub.LocalVariables.Where(v => v.Name == varName).FirstOrDefault();`
	`294`	`+ foundVar = sub.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase));`
`297`	`295`	`}`
`298`	`296`	`else`
`299`	`297`	`{`
`300`		`- var func = functions.Where(f => f.Name == location.Name).FirstOrDefault();`
	`298`	`+ var func = functions.FirstOrDefault(f => string.Equals(f.Name, location.Name, StringComparison.OrdinalIgnoreCase));`
`301`	`299`	`if (func != null)`
`302`		`- foundVar = func.LocalVariables.Where(v => v.Name == varName).FirstOrDefault();`
	`300`	`+ foundVar = func.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase));`
`303`	`301`	`}`
`304`	`302`	`}`
`305`	`303`
`@@ -322,15 +320,15 @@ public ZXBasicMap(ZXCodeFile MainFile, IEnumerable<ZXCodeFile> AllFiles, string`
`322`	`320`	`//(to avoid the very unprobable case where the same var is defined in different files in locations that match the same range)`
`323`	`321`	`if (possibleLocation.LocationType == ZXBasicLocationType.Sub)`
`324`	`322`	`{`
`325`		`- var sub = subs.Where(s => s.Name == possibleLocation.Name).FirstOrDefault();`
	`323`	`+ var sub = subs.FirstOrDefault(s => string.Equals(s.Name, possibleLocation.Name, StringComparison.OrdinalIgnoreCase));`
`326`	`324`	`if (sub != null)`
`327`		`- foundVar = sub.LocalVariables.Where(v => v.Name == varName && !v.Unused).FirstOrDefault();`
	`325`	`+ foundVar = sub.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase) && !v.Unused);`
`328`	`326`	`}`
`329`	`327`	`else`
`330`	`328`	`{`
`331`		`- var func = functions.Where(f => f.Name == possibleLocation.Name).FirstOrDefault();`
	`329`	`+ var func = functions.FirstOrDefault(f => string.Equals(f.Name, possibleLocation.Name, StringComparison.OrdinalIgnoreCase));`
`332`	`330`	`if (func != null)`
`333`		`- foundVar = func.LocalVariables.Where(v => v.Name == varName && !v.Unused).FirstOrDefault();`
	`331`	`+ foundVar = func.LocalVariables.FirstOrDefault(v => string.Equals(v.Name, varName, StringComparison.OrdinalIgnoreCase) && !v.Unused);`
`334`	`332`	`}`
`335`	`333`
`336`	`334`	`//If the criteria finds a var, return it`
`@@ -359,11 +357,7 @@ void GetSubVars(ZXBasicSub Sub, string[] Lines)`
`359`	`357`	`if (varNameDef.Contains("(")) //array`
`360`	`358`	`{`
`361`	`359`	`string varName = varNameDef.Substring(0, varNameDef.IndexOf("(")).Trim();`
`362`		`-`
`363`		`- //Ignore unused vars (vars that are found only on its dim line, there may be the improbable`
`364`		`- //case where a var is defined and used in the same line using a colon and not used`
`365`		`- //anywhere else, but that would be an awful code :) )`
`366`		`- if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_]){varName}($\|[^a-zA-Z0-9_])", RegexOptions.Multiline)))`
	`360`	`+ if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($\|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))`
`367`	`361`	`continue;`
`368`	`362`
`369`	`363`	`string[] dims = varNameDef.Substring(varNameDef.IndexOf("(") + 1).Replace(")", "").Split(",", StringSplitOptions.RemoveEmptyEntries);`
`@@ -379,9 +373,7 @@ void GetSubVars(ZXBasicSub Sub, string[] Lines)`
`379`	`373`	`foreach (var vName in varNames)`
`380`	`374`	`{`
`381`	`375`	`string varName = vName.Trim();`
`382`		`-`
`383`		`- //Ignore unused vars`
`384`		`- if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_]){varName}($\|[^a-zA-Z0-9_])", RegexOptions.Multiline)))`
	`376`	`+ if (!Lines.Skip(buc+1).Any(l => Regex.IsMatch(l, $"(^\|[^a-zA-Z0-9_$]){Regex.Escape(varName)}($\|[^a-zA-Z0-9_$])", RegexOptions.Multiline)))`
`385`	`377`	`continue;`
`386`	`378`
`387`	`379`	`var storage = StorageFromString(dimMatch.Groups[5].Value, varName);`
`@@ -415,15 +407,15 @@ public List<ZXBasicLocation> GetBuildLocations(ZXCodeFile CodeFile)`
`415`	`407`
`416`	`408`	`if (subMatch != null && subMatch.Success)`
`417`	`409`	`{`
`418`		`- loc = new ZXBasicLocation { Name = subMatch.Groups[2].Value.Trim(), LocationType = ZXBasicLocationType.Sub, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };`
	`410`	`+ loc = new ZXBasicLocation { Name = subMatch.Groups[4].Value.Trim(), LocationType = ZXBasicLocationType.Sub, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };`
`419`	`411`	`continue;`
`420`	`412`	`}`
`421`	`413`
`422`	`414`	`var funcMatch = regFunc.Match(line);`
`423`	`415`
`424`	`416`	`if (funcMatch != null && funcMatch.Success)`
`425`	`417`	`{`
`426`		`- loc = new ZXBasicLocation { Name = funcMatch.Groups[2].Value.Trim(), LocationType = ZXBasicLocationType.Function, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };`
	`418`	`+ loc = new ZXBasicLocation { Name = funcMatch.Groups[4].Value.Trim(), LocationType = ZXBasicLocationType.Function, FirstLine = buc, File = Path.Combine(CodeFile.Directory, CodeFile.TempFileName) };`
`427`	`419`	`continue;`
`428`	`420`	`}`
`429`	`421`	`}`
`@@ -465,7 +457,7 @@ public bool ContainsBuildDim(ZXCodeFile CodeFile, string VarName, int LineNumber`
`465`	`457`	`if (LineNumber >= lines.Length)`
`466`	`458`	`return false;`
`467`	`459`
`468`		`- return Regex.IsMatch(lines[LineNumber], $"(\\s\|,){VarName}(\\s\|,\|\\(\|$)", RegexOptions.Multiline);`
	`460`	`+ return Regex.IsMatch(lines[LineNumber], $"(\\s\|,){Regex.Escape(VarName)}(\\s\|,\|\\(\|$)", RegexOptions.Multiline);`
`469`	`461`	`}`
`470`	`462`
`471`	`463`	`private static void ParseInputParameters(string ParameterString, List<ZXBasicParameter> Storage)`