Add support for querying supported CHIP-8 variants across emulators for correct disassembly and enhance CLI with version flag

Author: gulrak

CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.1.9-1.1.11] (wip)
+## [1.1.9-1.9.90] (wip)
 
 ### Added
 
@@ -36,7 +36,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [Desktop only] Library/Research screen and database integration allows for easier research on existing roms
   and interpreters, all information about programs, and even the binaries themselves are now kept
   in a local SQLite3 file in the configuration directory (<10MB for all known programs combined)
-- [Desktop only] Cadmium now remembers window position and scaling and starts like it was closed.
+- [Desktop only] Cadmium now remembers window position and scaling and starts like it was closed
+- Cadmium now has a `--version` command line option and shows the git commit hash in the about dialog
 
 ### Changed
 
@@ -51,6 +52,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+- Disassembly sometimes only showed hex bytes instead of opcodes
 - The VIP-CHIP-8E interpreter had a typo leading to `BBnn` not working ([#12](https://github.com/gulrak/cadmium/issues/12))
 - Disassembling 0x7C, 0x7D or 0x7F generated single byte opcodes instead two byte ones ([#13](https://github.com/gulrak/cadmium/issues/12))
 - Octo-Assembler would hang on macro definitions without name or parameter

src/cadmium.cpp

@@ -1811,7 +1811,7 @@ void main()
                     DrawTextureRec(_titleTexture, {34, 2, 60, 60}, {aboutScroll.x + 8.0f, aboutScroll.y + 31.0f}, WHITE);
                     auto styleColor = GetStyle(LABEL, TEXT_COLOR_NORMAL);
                     SetStyle(LABEL, TEXT_COLOR_NORMAL, ColorToInt(WHITE));
-                    Label("           Cadmium v" CADMIUM_VERSION);
+                    Label("           Cadmium v" CADMIUM_VERSION "-" CADMIUM_GIT_HASH);
                     SetStyle(LABEL, TEXT_COLOR_NORMAL, styleColor);
                     Space(4);
                     Label("           (c) 2022 by Steffen 'Gulrak' Schümann");
@@ -3550,6 +3550,7 @@ int main(int argc, char* argv[])
     bool compareRun = false;
     int64_t benchmark= 0;
     bool showHelp = false;
+    bool showVersion = false;
     bool opcodeTable = false;
     bool opcodeJSON = false;
     bool dumpLibNickel = false;
@@ -3568,6 +3569,7 @@ int main(int argc, char* argv[])
     cli.category("General Options");
 #ifndef PLATFORM_WEB
     cli.optionEnable({"-h", "--help"}, showHelp, "Show this help text");
+    cli.optionEnable({"-v", "--version"}, showVersion, "Show version information");
     cli.option({"-t", "--trace"}, traceLines, "Run headless and dump given number of trace lines");
     cli.optionEnable({"-c", "--compare"}, compareRun, "Run and compare with reference engine, trace until diff");
     cli.option({"-b", "--benchmark"}, benchmark, "Run given number of cycles as benchmark");
@@ -3698,6 +3700,11 @@ int main(int argc, char* argv[])
         cli.usage();
         exit(0);
     }
+    if(showVersion) {
+        std::cout << "Cadmium v" << CADMIUM_VERSION << "-" << CADMIUM_GIT_HASH << std::endl;
+        std::cout << "(c) Copyright 2022 by Steffen 'Gulrak' Schümann" << std::endl;
+        exit(0);
+    }
 #ifndef PLATFORM_WEB
     if(convertRomList) {
         convertKnownRomList();

src/emuhostex.cpp

@@ -384,10 +384,10 @@ bool EmuHostEx::loadBinary(std::string_view filename, ghc::span<const uint8_t> b
             auto startAddress = _properties->get<Property::Integer>("startAddress");
             auto loadAddress = startAddress ? startAddress->intValue : 0;
             emu::Chip8Decompiler decomp{_romImage, static_cast<uint32_t>(loadAddress)};
-            decomp.setVariants(chip8::Variant::CHIP_8 /*_options.presetAsVariant()*/, true); // TODO: Fix this!!
-            // TraceLog(LOG_INFO, "Setting variant.");
-            // decomp.setVariant(Chip8Variant::CHIP_8, true);
-            // TraceLog(LOG_INFO, "About to decompile...");
+            auto chip8Emu = dynamic_cast<emu::IChip8Emulator*>(_chipEmu->executionUnit(0));
+            TraceLog(LOG_INFO, "Setting variant.");
+            decomp.setVariants(chip8Emu ? chip8Emu->supportedChip8Variants() : chip8::Variant::NONE, true);
+            TraceLog(LOG_INFO, "About to decompile...");
             decomp.decompile(filename, loadAddress, &os, false, true);
             source = os.str();
         }

src/emulation/chip8generic.cpp

@@ -783,6 +783,11 @@ Chip8GenericEmulator::~Chip8GenericEmulator()
 #endif
 }
 
+chip8::VariantSet Chip8GenericEmulator::supportedChip8Variants() const
+{
+    return _options.variant();
+}
+
 int64_t Chip8GenericEmulator::executeFor(int64_t micros)
 {
     if (_execMode == ePAUSED || _cpuState == eERROR) {

src/emulation/chip8generic.hpp

@@ -114,6 +114,7 @@ class Chip8GenericEmulator : public Chip8GenericBase
     {
         return "Chip-8-MPT";
     }
+    chip8::VariantSet supportedChip8Variants() const override;
     uint32_t cpuID() const override { return 0xC8; }
     bool updateProperties(Properties& props, Property& changed) override;
     int64_t machineCycles() const override { return 0; }

src/emulation/chip8strict.cpp

@@ -85,6 +85,11 @@ struct StrictFactoryInfo final : public CoreRegistry::FactoryInfo<Chip8StrictEmu
 
 static bool registeredStrictC8 = CoreRegistry::registerFactory(PROP_CLASS, std::make_unique<StrictFactoryInfo>("First cycle exact HLE emulation of CHIP-8 on a COSMAC VIP"));
 
+chip8::VariantSet Chip8StrictEmulator::supportedChip8Variants() const
+{
+    return chip8::Variant::CHIP_8;
+}
+
 bool Chip8StrictEmulator::updateProperties(Properties& props, Property& changed)
 {
     (void)registeredStrictC8;

src/emulation/chip8strict.hpp

@@ -74,6 +74,7 @@ class Chip8StrictEmulator : public Chip8GenericBase
     {
         return "Chip-8-Strict";
     }
+    chip8::VariantSet supportedChip8Variants() const override;
     uint32_t cpuID() const override { return 0xC856; }
     uint8_t readMemoryByte(uint32_t addr) const override { return readByte(addr); }
     uint16_t getCurrentScreenWidth() const override { return 64; }

src/emulation/cosmacvip.cpp

@@ -872,6 +872,11 @@ std::string CosmacVIP::name() const
     return "Chip-8-RVIP";
 }
 
+chip8::VariantSet CosmacVIP::supportedChip8Variants() const
+{
+    return getVariantForInterpreter(_impl->_options.interpreter);
+}
+
 unsigned CosmacVIP::stackSize() const
 {
     return 24;

src/emulation/cosmacvip.hpp

@@ -55,6 +55,7 @@ class CosmacVIP : public Chip8RealCoreBase, public Cdp1802Bus
 
     bool updateProperties(Properties& props, Property& changed) override;
     std::string name() const override;
+    chip8::VariantSet supportedChip8Variants() const override;
 
     // IEmulationCore
     size_t numberOfExecutionUnits() const override;

src/emulation/dream6800.cpp

@@ -395,6 +395,11 @@ std::string Dream6800::name() const
     return "DREAM6800";
 }
 
+chip8::VariantSet Dream6800::supportedChip8Variants() const
+{
+    return _impl->_options.romName == "CHIPOS" ? chip8::Variant::CHIP_8_D6800 : chip8::Variant::CHIP_8_D6800_LOP;
+}
+
 bool Dream6800::updateProperties(Properties& props, Property& changed)
 {
     if(fuzzyAnyOf(changed.getName(), {"TraceLog", "InstructionsPerFrame", "FrameRate"})) {