Merge branch 'master' into features/mame

Author: Duefectu

.github/workflows/build-zxbstudio.yml

@@ -29,6 +29,9 @@ jobs:
 
       - name: Build project
         run: dotnet build ZXBasicStudio.sln --configuration Release --no-restore
+        
+      - name: Run tests
+        run: dotnet test
 
       - name: Publish for Linux
         run: |

.gitignore

@@ -360,4 +360,7 @@ MigrationBackup/
 .ionide/
 
 # Fody - auto-generated XML schema
-FodyWeavers.xsd
+FodyWeavers.xsd
+
+# tmp/ dir
+tmp/

README.md

@@ -11,8 +11,26 @@ Documentation will come in the near future, take a look at the book [Boriel Basi
 
 Have fun!
 
+## Projects in this solution
+
+This solution contains several projects that work together to provide the ZX Basic Studio experience:
+
+- **ZXBStudio**: The main cross-platform Integrated Development Environment (IDE) built with [Avalonia](https://avaloniaui.net/).
+- **CoreSpectrum**: The core ZX Spectrum emulation library, providing hardware simulation.
+- **Z80dotNet**: A Z80 processor simulator that serves as the heart of the emulator.
+- **HeadlessEmulator**: A command-line (CLI) version of the emulator for running Spectrum programs without a GUI.
+- **Bufdio**: An audio handling library using FFmpeg for sound and tape I/O support.
+- **Common**: Shared logic and UI components used across the different projects.
+- **ZXBSInstaller**: A cross-platform installer for the IDE, built with Avalonia.
+- **ZXBasicStudioSite**: The source for the ZX Basic Studio website, built with Blazor WebAssembly.
+- **RomReconstructor** & **Rom128Reconstructor**: Specialized tools for reconstructing ZX Spectrum 48K and 128K ROMs.
+- **MsBox.Avalonia**: A customized message box library for the Avalonia user interface.
+- **ZXBasicStudioTest** & **TestZ80**: Unit tests and testing tools for ensuring the stability and correctness of the IDE and emulator.
+
 ## ZX Basic Studio Team
-- Development team:
+
+### Development team:
+
   - El Dr. Gusman
   - Boriel
   - Duefectu

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)

ZXBStudio/BuildSystem/ZXVariableMap.cs

@@ -42,7 +42,7 @@ public ZXVariableMap(string ICFile, string MapFile, ZXBasicMap BasicMap)
         }
 
 
-        private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasicMap BasicMap)
+        internal void ProcessGlobalVariables(string icContent, string mapContent, ZXBasicMap BasicMap)
         {
             int splitIndex = icContent.IndexOf("--- end of user code ---");
 
@@ -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,
@@ -144,7 +144,7 @@ private void ProcessGlobalVariables(string icContent, string mapContent, ZXBasic
             }
         }
 
-        private void ProcessLocalVariables(string icContent, string mapContent, ZXBasicMap BasicMap)
+        internal void ProcessLocalVariables(string icContent, string mapContent, ZXBasicMap BasicMap)
         {
             int splitIndex = icContent.IndexOf("--- end of user code ---");
 
@@ -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)

ZXBStudio/ZXBasicStudio.csproj

@@ -15,6 +15,10 @@
     <Deterministic>False</Deterministic>
     <Version>1.8.0.2</Version>
   </PropertyGroup>
+
+  <ItemGroup>
+    <InternalsVisibleTo Include="ZXBasicStudioTest" />
+  </ItemGroup>
   <ItemGroup>
     <AvaloniaXaml Remove="LanguageDefinitions\**" />
     <Compile Remove="LanguageDefinitions\**" />