Upgrade to Qt6, error handling

Author: yikerman

CMakeLists.txt

@@ -13,11 +13,12 @@ set(CMAKE_AUTORCC ON)
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-find_package(Qt5 COMPONENTS Widgets REQUIRED)
+find_package(QT NAMES Qt6 Qt5 REQUIRED COMPONENTS Widgets)
+find_package(Qt${QT_VERSION_MAJOR} REQUIRED COMPONENTS Widgets)
 
 add_subdirectory(cchip8)
 
-add_executable(QChip8
+set(PROJECT_SOURCES
   main.cpp
 
   onboardwindow.h
@@ -35,20 +36,54 @@ add_executable(QChip8
   keymap.cpp
 )
 
-target_include_directories(QChip8 PUBLIC ${CCHIP8_INCLUDE})
+if(${QT_VERSION_MAJOR} GREATER_EQUAL 6)
+    qt_add_executable(QChip8
+        MANUAL_FINALIZATION
+        ${PROJECT_SOURCES}
+    )
+# Define target properties for Android with Qt 6 as:
+#    set_property(TARGET QChip8 APPEND PROPERTY QT_ANDROID_PACKAGE_SOURCE_DIR
+#                 ${CMAKE_CURRENT_SOURCE_DIR}/android)
+# For more information, see https://doc.qt.io/qt-6/qt-add-executable.html#target-creation
+else()
+    if(ANDROID)
+        add_library(QChip8 SHARED
+            ${PROJECT_SOURCES}
+        )
+# Define properties for Android with Qt 5 after find_package() calls as:
+#    set(ANDROID_PACKAGE_SOURCE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/android")
+    else()
+        add_executable(QChip8
+            ${PROJECT_SOURCES}
+        )
+    endif()
+endif()
+
+target_link_libraries(QChip8 PRIVATE Qt${QT_VERSION_MAJOR}::Widgets)
 
+target_include_directories(QChip8 PUBLIC ${CCHIP8_INCLUDE})
 target_link_libraries(QChip8 PUBLIC CChip8)
-target_link_libraries(QChip8 PRIVATE Qt5::Widgets)
+set_target_properties(QChip8 PROPERTIES
+    MACOSX_BUNDLE_GUI_IDENTIFIER top.ycao.qchip8
+    MACOSX_BUNDLE_BUNDLE_VERSION "${PROJECT_VERSION}"
+    MACOSX_BUNDLE_SHORT_VERSION_STRING "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}"
+    MACOSX_BUNDLE TRUE
+    WIN32_EXECUTABLE TRUE
+)
+
+install(TARGETS QChip8
+    BUNDLE DESTINATION .
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR})
 
+if(QT_VERSION_MAJOR EQUAL 6)
+    qt_finalize_executable(QChip8)
+endif()
 
 # Testing
 enable_testing()
-
-find_package(Qt5Test REQUIRED)
-add_executable(CPUTests
- cputests.cpp
-)
+find_package(Qt6Test REQUIRED)
+add_executable(CPUTests cputests.cpp)
 target_include_directories(CPUTests PUBLIC ${CCHIP8_INCLUDE})
-target_link_libraries(CPUTests CChip8 Qt5::Test)
-
+target_link_libraries(CPUTests CChip8 Qt6::Test)
 add_test(CPUTests CPUTests)
+

README.md

@@ -1,20 +1,14 @@
-# Yet Another Chip8 Emulator: QChip8
+# YACE: Yet Another Chip8 Emulator
 
-***Another Chip8 emulator with a better performance.***
+## Components
 
-## What's included
 - `QChip8`: Executable for the emulator using Qt.
 - `CChip8`: Core chip8 emulator for calculation only. Provided as a dynamic library.
 - `CPUTests`: Tests for `CChip8` using QtTest.
 
-## How to build
+## Building & Installing
 
-### Install Qt
-
-Both `Qt 5.12` and `Qt 5.15` are tested. See https://wiki.qt.io/Main 's **Install / Build** part, and make sure CMake can detect it. You may want to modify `CMAKE_PREFIX_PATH`.
-
-
-### Compile
+Works under Qt6.
 
 ```bash
 $ git clone https://github.com/xiaoyu2006/YACE.git

cchip8/cpu.c

@@ -23,7 +23,7 @@ uint8_t fontSet[FONT_SET_SIZE] = {
 
 /*
 * Function: makeCPU
-* --------------------
+* -----------------
 *  Create a Chip-8 CPU.
 *
 *  returns: pointer of the CPU
@@ -58,7 +58,7 @@ void skipInstruction(CPU* cpu)
 
 /*
 * Function: readRom
-* --------------------
+* -----------------
 *  Read ROM into the memory.
 *
 *  cpu: current cpu.
@@ -99,7 +99,7 @@ void tick(CPU* cpu, Interface* interface)
 
 /*
 * Function: step
-* --------------------
+* --------------
 *  Next step
 *
 *  cpu: current cpu
@@ -114,7 +114,7 @@ CChip8Errors step(CPU* cpu, Interface* interface)
 
 /*
 * Function: fetch
-* --------------------
+* ---------------
 *  Fetch an operation code from memory.
 *
 *  cpu: current cpu
@@ -129,7 +129,7 @@ uint16_t fetch(CPU* cpu)
 
 /*
 * Function: decode
-* --------------------
+* ----------------
 *  Disassemble the current operation code
 *
 *  opcode: operation code.
@@ -157,7 +157,7 @@ DecodedInst decode(uint16_t opcode)
 
 /*
 * Function: execute
-* --------------------
+* -----------------
 *  Execute an instruction.
 *
 *  cpu: current cpu
@@ -338,7 +338,7 @@ CChip8Errors execute(CPU* cpu, Interface* interface, DecodedInst inst)
 
     case 0xc000: // RND(VX, NN)
     {
-        cpu->registers[inst.args[0]] = ((rand() % 0xff) & inst.args[1]);
+        cpu->registers[inst.args[0]] = ((arc4random() % 0xff) & inst.args[1]);
         nextInstruction(cpu);
         break;
     }

cchip8/instructionset.h

@@ -11,7 +11,6 @@
 #include <stdlib.h>
 #include <stdbool.h>
 
-#include <cpu.h>
 #include <interface.h>
 
 // Arguments for a instruction

cchip8/interface.c

@@ -1,13 +1,15 @@
 // Copyright (c) 2020 Yi
 
+#include <stdlib.h>
+#include <string.h>
 #include "interface.h"
 
 /*
 * Function: makeInterface
 * --------------------
-*  Create a Interface interface.
+*  Create a new Interface.
 *
-*  returns: pointer of the interface
+*  returns: pointer to the interface
 */
 Interface* makeInterface()
 {

cchip8/interface.h

@@ -5,10 +5,8 @@
 #ifndef _INTERFACE_H_
 #define _INTERFACE_H_
 
-#include <stdio.h>
 #include <stdbool.h>
 #include <inttypes.h>
-#include <stdlib.h>
 
 #define KEYMAP_LEN 16
 
@@ -24,7 +22,6 @@ typedef struct Interface {
     int16_t     keyPressed;
 } Interface;
 
-#include "cpu.h"
 
 #ifdef __cplusplus
 extern "C" {

chip8screen.h

@@ -1,7 +1,7 @@
 #ifndef CHIP8SCREEN_H
 #define CHIP8SCREEN_H
 
-#include <QWidget>
+#include <QtWidgets>
 #include <QPaintDevice>
 #include <QPainter>
 #include <QBrush>

chip8ui.cpp

@@ -1,6 +1,11 @@
-#include "chip8ui.h"
+#include "chip8ui.h"
 #include "ui_chip8ui.h"
 
+#include "keymap.h"
+#include <QMessageBox>
+#include <QDialog>
+#include <QString>
+
 Chip8UI::Chip8UI(QWidget *parent) :
     QMainWindow(parent),
     ui(new Ui::Chip8UI)
@@ -56,9 +61,50 @@ void Chip8UI::timerEvent(QTimerEvent *event)
             chip8Timer = 0;
         }
         CChip8Errors error = step(cpu, interface);
-        if (error == UpdateScreen) update();
-        // TODO: Error handling.
+        switch(error) {
+        case ROMFileNotFound:
+            showErrorAndExit(tr("ROM file missing"));
+            break;
+        case ROMFileTooLarge:
+            showErrorAndExit(tr("ROM file too large"));
+            break;
+        case StackUnderflow:
+            showErrorAndExit(tr("Stack underflow"));
+            break;
+        case StackOverFlow:
+            showErrorAndExit(tr("Stack overflow"));
+            break;
+        case MemoryOutOfBounds:
+            showErrorAndExit(tr("Memory out of bounds"));
+            break;
+        case InvalidDigit:
+            showErrorAndExit(tr("Invalid digit"));
+            break;
+        case UnknownInstruction:
+            showErrorAndExit(tr("Unknown instruction"));
+            break;
+
+        case UpdateScreen:
+            update();
+            break;
+
+        case OK:
+            break;
+        }
     } else {
         event->ignore();
     }
 }
+
+void Chip8UI::showErrorAndExit(QString message)
+{
+    QString t(message + "\nDT: %1, I: %2, PC: %3, SP: %4, ST: %5");
+    QMessageBox::critical(this, "Error", t.arg(
+                              QString::number(cpu->DT),
+                              QString::number(cpu->I),
+                              QString::number(cpu->PC),
+                              QString::number(cpu->SP),
+                              QString::number(cpu->ST)));
+    killTimer(this->updateTimer);
+    this->close();
+}

chip8ui.h

@@ -7,8 +7,6 @@
 #include <QTimer>
 #include <QTimerEvent>
 
-#include "keymap.h"
-
 #include <cpu.h>
 #include <interface.h>
 
@@ -35,12 +33,12 @@ class Chip8UI : public QMainWindow
 
 private:
     Ui::Chip8UI *ui;
-
     CPU* cpu;
     Interface* interface;
     int chip8Timer;
-
     uint8_t updateTimer;
+
+    void showErrorAndExit(QString message);
 };
 
 #endif // CHIP8UI_H