Dev

.github/copilot-instructions.md

@@ -0,0 +1,38 @@
+# GitHub Copilot Instructions
+
+This document guides AI assistants when contributing to the Processor-Emulator repository.
+
+## 1. Project Overview
+- **Language & Framework**: C# (.NET 6) WPF application with a MainWindow UI and multiple emulator implementations.
+- **Core Purpose**: Load and analyze firmware images, emulate CPU architectures, probe filesystems, and extract data.
+- **Key Directories**:
+  - `/` root: main UI code (`App.xaml`, `MainWindow.xaml.cs`, `EmulatorLauncher.cs`)
+  - `/Emulation`: stub and SPARC emulators
+  - Files in root implement each chipset emulator and filesystem logic.
+
+## 2. Coding Conventions
+- **Naming**: PascalCase for public types and methods, _camelCase_ for private fields.
+- **Async Patterns**: Use `async Task` for I/O or longer-running operations and `await` inside.
+- **Helpers & Utilities**:
+  - Consolidate repeated logic in a single static helper.
+  - Place utility methods in `Tools.cs` or under a `Utilities` static class.
+- **UI Interaction**: Use `Dispatcher.Invoke` or `await` to update UI from background threads. Use shared `ShowTextWindow` helper for log output.
+
+## 3. AI Integration Guidelines
+- **Refactor Duplicates**: When encountering duplicate local functions (e.g., `AnalyzeFileType`, `ShowTextWindow`), merge into one shared definition without hitting request limit, length limit or creating invalid responses or getting stuck in loops.
+- **New Emulators**: Implement new `IChipsetEmulator` in its own file. Follow existing patterns: detect types, dispatch via `InstructionTranslator`.
+- **File Placement**: Match namespace and folder. Root-level emulators go in `/Emulation` folder or root if project-wide.
+- **Error Handling**: Leverage `try/catch` around disk I/O and emulator startup. Surface errors via `ShowTextWindow`.
+
+## 4. Build & Run Tasks
+- Use the existing `tasks.json`:
+  - **Build**: `dotnet build ProcessorEmulator.csproj`
+  - **Run**: `dotnet run --project ProcessorEmulator.csproj`
+- No unit tests present; ensure manual end-to-end validation of firmware loads.
+
+## 5. Pull Request Guidelines
+- Target `dev` branch. Keep PRs focused and small.
+- Include screenshots or logs for UI changes.
+- Verify compile and smoke-test emulation scenarios local to Windows/.NET 6.
+
+> _These instructions help AI assistants contribute consistently and correctly to the Processor-Emulator codebase._

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  build:
+    name: Build on Windows
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Restore dependencies
+        run: dotnet restore
+
+      - name: Build solution
+        run: dotnet build ProcessorEmulator.csproj --configuration Release --no-restore
+
+      - name: Run tests (if any)
+        run: |
+          echo "Skipping tests: no test projects defined."

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,24 @@
+name: "CodeQL Analysis"
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: csharp
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.github/workflows/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "nuget"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5

.github/workflows/dotnet-build.yml

@@ -0,0 +1,26 @@
+name: ".NET Build"
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  build:
+    name: build
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Restore dependencies
+        run: dotnet restore
+
+      - name: Build solution
+        run: dotnet build Processor-Emulator.sln --configuration Release --no-restore

.github/workflows/dotnet-desktop-build.yml

@@ -0,0 +1,28 @@
+name: ".NET Core Desktop build"
+
+on:
+  push:
+    branches: [dev, main]
+  pull_request:
+    branches: [dev, main]
+
+jobs:
+  build-debug:
+    name: build (Debug)
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+      - run: dotnet build ProcessorEmulator.csproj --configuration Debug
+
+  build-release:
+    name: build (Release)
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+      - run: dotnet build ProcessorEmulator.csproj --configuration Release

.github/workflows/dotnet.yml

@@ -2,9 +2,9 @@ name: .NET Build
 
 on:
   push:
-    branches: [ main, master ]
+    branches: [ dev, main ]
   pull_request:
-    branches: [ main, master ]
+    branches: [ dev, main ]
 
 jobs:
   build:

.github/workflows/nightly-build.yml

@@ -0,0 +1,34 @@
+name: Nightly Build
+
+on:
+  schedule:
+    # every day at 3am UTC
+    - cron: '0 3 * * *'
+
+jobs:
+  build:
+    name: Daily Windows Build
+    runs-on: windows-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Restore dependencies
+        run: dotnet restore
+
+      - name: Build solution
+        run: dotnet build ProcessorEmulator.csproj --configuration Release --no-restore
+
+      - name: Publish artifacts
+        run: dotnet publish ProcessorEmulator.csproj --configuration Release --output artifacts
+
+      - name: Upload nightly artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: nightly-build
+          path: artifacts

.github/workflows/release-drafter.yml

@@ -0,0 +1,35 @@
+name: Release Drafter
+
+on:
+  push:
+    branches: [dev, main]
+
+jobs:
+  update_release_draft:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: release-drafter/release-drafter@v5
+        with:
+          config-name: "release-drafter.yml"
+          template: |
+            # 🎉 Release {{ version }}
+
+            Hello everyone!
+
+            We’re excited to share **{{ version }}** with you. Here’s what’s new:
+
+            {{#changes}}
+            {{> change}}
+            {{/changes}}
+
+            A heartfelt thank you to all contributors:
+            {{#contributors}}
+            - @{{this}}
+            {{/contributors}}
+
+            Stay tuned for more updates!
+          change-template: |
+            {{#if is:added}}✨ **New** {{description}} (thanks @{{author}})!{{/if}}
+            {{#if is:changed}}🔄 **Updated** {{description}} (thanks @{{author}})!{{/if}}
+            {{#if is:fixed}}🐞 **Fixed** {{description}} (thanks @{{author}})!{{/if}}

.github/workflows/release.yml

@@ -0,0 +1,48 @@
+name: "Release on Tag"
+
+on:
+  push:
+    # Trigger on git tags, e.g. v1.2.3
+    tags:
+      - 'v*'
+
+jobs:
+  build-and-release:
+    runs-on: windows-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup .NET 6 SDK
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: '6.0.x'
+
+      - name: Build solution
+        run: |
+          dotnet restore
+          dotnet build ProcessorEmulator.csproj --configuration Release
+
+      - name: Publish artifacts
+        run: |
+          dotnet publish ProcessorEmulator.csproj --configuration Release --output artifacts
+
+      - name: Create GitHub Release
+        id: create_release
+        uses: actions/create-release@v1
+        with:
+          tag_name: ${{ github.ref_name }}
+          release_name: Release ${{ github.ref_name }}
+          draft: false
+          prerelease: false
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload Release Asset
+        uses: actions/upload-release-asset@v1
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: artifacts/ProcessorEmulator.exe
+          asset_name: ProcessorEmulator-${{ github.ref_name }}.exe
+          asset_content_type: application/octet-stream

.gitignore

@@ -256,4 +256,4 @@ bin/Release/net6.0-windows/share/locale/tr/LC_MESSAGES/qemu.mo
 bin/Release/net6.0-windows/share/locale/uk/LC_MESSAGES/qemu.mo
 bin/Release/net6.0-windows/share/locale/zh_CN/LC_MESSAGES/qemu.mo
 bin/Release/net6.0-windows/share/man/man1/qemu.1
-/.github
+

.vscode/settings.json

@@ -0,0 +1,44 @@
+{
+    // Disable minimap for faster rendering
+    "editor.minimap.enabled": false,
+    // Reduce visual decorations
+    "editor.renderWhitespace": "none",
+    "editor.folding": false,
+    "editor.codeLens": false,
+    "editor.semanticHighlighting.enabled": false,
+
+    // Exclude build folders from file watchers and searches
+    "files.watcherExclude": {
+        "**/bin/**": true,
+        "**/obj/**": true
+    },
+    "search.exclude": {
+        "**/bin/**": true,
+        "**/obj/**": true
+    },
+
+    // Optimize C# performance
+    "omnisharp.enableRoslynAnalyzers": false,
+    "omnisharp.useModernNet": false,
+    "omnisharp.msbuildLogLevel": "quiet",
+    // Disable inlay hints to avoid LSP requests on null documents
+    "editor.inlayHints.enabled": "off",
+    "[csharp]": {
+        "editor.inlayHints.enabled": "off"
+    },
+    // Disable C# specific inlay hint settings
+    "csharp.inlayHints.parameterNames.enabled": "none",
+    "csharp.inlayHints.parameterTypes.enabled": "none",
+    "csharp.inlayHints.variableTypes.enabled": "none",
+
+    // Disable outline and breadcrumbs to reduce symbol requests
+    "outline.showFiles": false,
+    "breadcrumbs.enabled": false,
+
+    // Disable telemetry for reduced background activity
+    "telemetry.enableTelemetry": false,
+    "telemetry.telemetryLevel": "off",
+
+    // YAML: disable built-in validation to ignore ci.yml errors
+    "yaml.validate": false
+}

.vscode/tasks.json

@@ -0,0 +1,19 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build Project",
+      "type": "shell",
+      "command": "dotnet build \"${workspaceFolder}/ProcessorEmulator.csproj\" --configuration Debug",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "reveal": "always",
+        "panel": "shared"
+      },
+      "problemMatcher": ["$msCompile"]
+    }
+  ]
+}