Merge branch 'develop' into 'master'

Pipeline Cleanup & Expansion

See merge request spexeah/asuro!28

.gitignore

@@ -10,4 +10,5 @@
 /*.sh~
 /*.img
 src/include/asuro.pas
-localenv.json
+.vscode/launch.json
+.vscode

.vscode/launch.json

@@ -3,11 +3,18 @@
         {
             "name":"Run",
             "request": "launch",
-            "type": "PowerShell",
+            "type": "coreclr",
             "preLaunchTask": "Build",
-            "script": "${workspaceFolder}/virtualbox-wrapper.ps1",
+            "program": "VBoxSDL",
-            "args": ["-Command", "up"],
+            "args": [
+                "--comment", 
+                "Asuro", 
+                "--startvm", 
+                "7d395c96-891c-4139-b77d-9b6b144b0b93"
+            ],
             "cwd": "${workspaceFolder}",
+            "console": "internalConsole",
+            "internalConsoleOptions": "neverOpen"
         }
     ]
 }

.vscode/tasks.json

@@ -9,18 +9,14 @@
             "command": "docker-compose",
             "args": [
                 "run",
-                "builder",
+                "builder"
             ],
             "type": "shell",
             "problemMatcher": [],
             "group": {
                 "kind": "build",
                 "isDefault": true
-            },
+            }
-            "dependsOn": [
-                "Close VirtualBox",
-                "Clean"
-            ]
         },
         {
             "label": "Build (Builder)",
@@ -30,24 +26,6 @@
                 "builder"
             ],
             "type": "shell"
-        },
-        {
-            "label": "Clean",
-            "command": "docker-compose",
-            "args": [
-                "down",
-                "--remove-orphans"
-            ],
-            "type": "shell"
-        },
-        {
-            "label": "Close VirtualBox",
-            "command": "./virtualbox-wrapper.ps1",
-            "args": [
-                "-Command", 
-                "down"
-            ],
-            "type": "shell"
         }
     ]
 }

docker-compose.yml

@@ -1,3 +1,4 @@
+version: "3.9"
 services:
   builder:
     build: .

readme.md

@@ -13,8 +13,8 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     I don't think this needs an explaination.
 * [VSCode (Optional, but highly recommended)](https://code.visualstudio.com/)
     Visual Studio code is our IDE of choice, and we have a number of recommended plugins.
-    * [PowerShell Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-vscode.powershell)
+    * [C# Plugin by Microsoft](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp)
-        This plugin gives you the ability to use the 'PowerShell' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
+        This plugin gives you the ability to use the 'coreclr' task type, allowing the automatic launching of virtualbox with the resulting image generated during compilation of Asuro.
 * [VirtualBox](https://www.virtualbox.org/)
     Virtualbox is our Virtualisation environment of choice, don't ask why, it just is.
 
@@ -27,15 +27,15 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
 3. Install Docker for Windows.
 4. Install Git for Windows.
 5. Install VSCode & the listed plugins.
-6. Install VirtualBox (v7+).
+6. Install VirtualBox.
 7. Clone this repository.
 8. Run the following command in the root of the repo to build the docker image:
     ```powershell
-    docker compose build builder
+    docker-compose build builder
     ```
 9. Run the following command to compile Asuro:
     ```powershell
-    docker compose run builder
+    docker-compose run builder
     ```
 10. Create a new virtual machine in Virtualbox and mount the `Asuro.iso` generated in step 9 as a boot image.
 11. Add the virtualbox installation directory to your `%PATH%` environment variable, usually:
@@ -50,29 +50,32 @@ We welcome everyone to give building/breaking/fixing/shooting Asuro a go, feel f
     ```xml
     <Machine uuid="{7d395c96-891c-4139-b77d-9b6b144b0b93}" name="Asuro" OSType="Linux" snapshotFolder="Snapshots" lastStateChange="2021-06-20T20:33:07Z">
     ```
-    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` & create a `localenv.json` file in the project root with the following content:
+    Copy the uuid, in our case `7d395c96-891c-4139-b77d-9b6b144b0b93` and replace the uuid found in `.vscode\launch.json` under `args`, so that it looks something like this:
     ```json
     {
-        "VirtualBox":{
+        "configurations": [
-            "MachineName":"<YOUR_UUID_OR_MACHINE_NAME>"
+            {
-        }
+                "name":"Run",
+                "request": "launch",
+                "type": "coreclr",
+                "preLaunchTask": "Build",
+                "program": "VBoxSDL",
+                "args": [
+                    "--comment", 
+                    "Asuro", 
+                    "--startvm", 
+                    "<YOUR UUID HERE>"
+                ],
+                "cwd": "${workspaceFolder}",
+                "console": "internalConsole",
+                "internalConsoleOptions": "neverOpen"
+            }
+        ]
     }
     ```
     This will allow VSCode to automatically launch VirtualBox once Asuro has been compiled.
-    
-    You can also enable the serial adapter "COM1" in mode "Raw File", give it a path, and provide this path in the `localenv.json` as follows:
-    ```json
-    {
-        "VirtualBox" : {
-            "MachineName": "<YOUR_UUID_OR_MACHINE_NAME>",
-            "LogLocation": "Fully\\Qualified\\Path\\To\\Your\\Log\\File"
-        }
-    }
-    ```
-    This will allow you to see the console output from Asuro in your host terminal.
 13. Open your project folder in VSCode, use CTRL+SHIFT+B to build & F5 to build + run in VBox.
 14. Congratulations! You can now play with Asuro!
 
-### Notes & Gotchas
+### Gotchas
-- The above process has been updated to be compatible with VirtualBox 7+, in which VBoxSDL was removed and vboxmanage should be used in its place. A small wrapper powershell script is used to achieve this.
+- It was noted that Windows builds above `20H2` seem to have issues installing WSL2. We may have to wait for a patch from Microsoft to fix this. Our devs are currently using build `20H2`.
-- It was noted that Windows builds above `20H2` seem to have issues installing WSL2. We may have to wait for a patch from Microsoft to fix this. Our devs are currently using build `20H2`.

src/include/strings.pas

@@ -16,7 +16,6 @@
 	Include->Strings - String Manipulation.
 	
 	@author(Kieron Morris <kjm@kieronmorris.me>)
-    @author(Aaron Hance <ah@aaronhance.me>)
 }
 unit strings;
 
@@ -34,10 +33,6 @@ function stringCopy(str : pchar) : pchar;
 function stringNew(size : uint32) : pchar;
 function stringSize(str : pchar) : uint32;
 function stringConcat(str1, str2 : pchar) : pchar;
-function stringTrim(str : pchar; length : uint32) : pchar;
-function stringSub(str : pchar; start, size : uint32) : pchar;
-function stringReplace(str, find, replace : pchar) : pchar;
-function stringIndexOf(str, find : pchar) : sint32;
 function stringContains(str : pchar; sub : pchar) : boolean;
 function stringToInt(str : pchar) : uint32;
 function hexStringToInt(str : pchar) : uint32;
@@ -156,94 +151,6 @@ begin
     stringConcat:= result;
 end;
 
-// Trim the string to the specified length.
-function stringTrim(str : pchar; length : uInt32) : pchar;
-var
-    result : pchar;
-begin
-    result:= stringNew(length);
-    memcpy(uint32(str), uint32(result), length);
-    stringTrim:= result;
-end;
-
-// Return a substring of the string.
-function stringSub(str : pchar; start, size : uint32) : pchar;
-var
-    result : pchar;
-begin
-    result:= stringNew(size);
-    memcpy(uint32(str)+start, uint32(result), size);
-    stringSub:= result;
-end;
-
-// Replace first instance of a string with another.
-function stringReplace(str, find, replace : pchar) : pchar;
-var
-    result : pchar;
-    i, j, k : uint32;
-    found : boolean;
-begin
-
-    // Find the first instance of the find string.
-    i:= 0;
-    found:= false;
-    while (i < stringSize(str)) and (not found) do begin
-        if stringEquals(str+i, find) then begin
-            found:= true;
-        end else begin
-            inc(i);
-        end;
-    end;
-
-    // If we found the find string, replace it.
-    if found then begin
-        result:= stringNew(stringSize(str) - stringSize(find) + stringSize(replace));
-        j:= 0;
-        k:= 0;
-        while i < stringSize(str) do begin
-            if stringEquals(str+i, find) then begin
-                memcpy(uint32(replace), uint32(result+j), stringSize(replace));
-                j:= j + stringSize(replace);
-                inc(i, stringSize(find));
-            end else begin
-                result[j]:= str[i];
-                inc(j);
-                inc(i);
-            end;
-        end;
-        stringReplace:= result;
-    end else begin
-        stringReplace:= stringCopy(str);
-    end;
-
-    // Return the result.
-    stringReplace:= result;
-
-end;
-
-
-// Find the index of the first instance of a string.
-function stringIndexOf(str, find : pchar) : sint32;
-var 
-    i : uint32;
-    found : boolean;
-begin
-    i:= 0;
-    found:= false;
-    while (i < stringSize(str)) and (not found) do begin
-        if stringEquals(str+i, find) then begin
-            found:= true;
-        end else begin
-            inc(i);
-        end;
-    end;
-    if found then begin
-        stringIndexOf:= i;
-    end else begin
-        stringIndexOf:= -1;
-    end;
-end;
-
 function stringContains(str : pchar; sub : pchar) : boolean;
 var
     strEnd, subEnd, i, j, count : uint32;

virtualbox-wrapper.ps1

@@ -1,58 +0,0 @@
-<# 
-You need a local git-ignored localenv.json file with the following content:
-{
-  "virtualbox": {
-    "MachineName": "your-machine-name or guid"
-  }
-}
-#>
-
-param (
-  [Parameter(Mandatory=$true)]
-  [ValidateSet('up', 'down')]
-  [String]$Command
-)
-
-$Config = Get-Content .\localenv.json | ConvertFrom-Json
-$MachineName = $Config.virtualbox.MachineName
-$LogLocation = $Config.virtualbox.LogLocation
-$LogOutputEnabled = $LogLocation -ne $null
-
-if ($Command -eq 'up') {
-
-  if($LogOutputEnabled) {
-    Clear-Content $LogLocation
-  }
-
-  $MonitorJob = Start-Job -ArgumentList $MachineName -ScriptBlock {
-    param($MachineName)
-    Write-Output "Starting $MachineName"
-    VBoxManage.exe startvm $MachineName
-    $running=$true
-    while($running) {
-      $status=(VBoxManage.exe list runningvms)
-      if($status) {
-        $running=$status.contains($MachineName)
-      } else {
-        $running=$false
-      }
-    }
-  }
-  
-  if($LogOutputEnabled) {
-    $LogJob = Start-Job -ArgumentList $LogLocation -ScriptBlock {
-      param($LogLocation)
-      Get-Content -Path $LogLocation -Wait
-    }
-  }
-
-  while($MonitorJob.State -eq 'Running') {
-    if($LogOutputEnabled) {
-      Receive-Job $LogJob
-    }
-    Receive-Job $MonitorJob
-  }
-} elseif ($Command -eq 'down') {
-  Write-Output "Stopping $MachineName"
-  VBoxManage.exe controlvm $MachineName poweroff
-}