Merge pull request #56 from suzukiplan/1.9.3

Add compile flags for performance

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change log
 
+## Version 1.9.3 (Jul 10, 2023 JST)
+
+- Add compile flags for performance:
+  - `-DZ80_DISABLE_DEBUG` ... disable `setDebugMessage` method
+  - `-DZ80_DISABLE_BREAKPOINT` ... disable `addBreakPoint` and `addBreakOperand` methods
+  - `-DZ80_DISABLE_NESTCHECK` ... disable `addCallHandler` and `addReturnHandler` methods
+- The return value of `consumeClock` was returning the number of clocks consumed, but this was changed to `void` because it was redundant.
+- Add the constructor without arguments.
+- Add an execute method without expected clocks
+- optimize acqauire register-pointer and register procedure
+- optimize bit calculation
+- optimize checkConditionFlags
+
 ## Version 1.9.2 (Jan 20, 2023 JST)
 
 - The value of the upper 8 bits of the port number of the immediate I/O operands (`IN A, (n)` and `OUT (n), A`) when executed in 16-bit port mode has been changed from register B to A.

README.md

@@ -384,6 +384,14 @@ ReturnHandler will be called back immediately **before** a branch by a RET instr
 - call `addReturnHandlerFP` if you want to use the function pointer.
 - In the case of a condition-specified branch instruction, only the case where the branch is executed is callbacked.
 
+## Advanced Compile Flags
+
+There is a compile flag that disables certain features in order to adapt to environments with poor performance environments, i.e: Arduino or ESP32:
+
+- `-DZ80_DISABLE_DEBUG` ... disable `setDebugMessage` method
+- `-DZ80_DISABLE_BREAKPOINT` ... disable `addBreakPoint` and `addBreakOperand` methods
+- `-DZ80_DISABLE_NESTCHECK` ... disable `addCallHandler` and `addReturnHandler` methods
+
 ## License
 
 [MIT](LICENSE.txt)

test-ex/Makefile

@@ -6,7 +6,8 @@ COMMON_FLAGS=-I../ \
 	-Wunused-variable \
 	-Wsign-conversion \
 	-Wtype-limits \
-	-Werror
+	-Werror \
+	-DZ80_DISABLE_DEBUG
 
 all: cpm zexdoc zexall
 

test-ex/cpm.cpp

@@ -90,17 +90,21 @@ int main(int argc, char* argv[])
 {
     char* cimPath = NULL;
     bool checkError = false;
+#ifndef Z80_DISABLE_DEBUG
     bool verboseMode = false;
+#endif
     bool noAnimation = false;
     for (int i = 1; i < argc; i++) {
         if ('-' == argv[i][0]) {
             switch (argv[i][1]) {
                 case 'e':
                     checkError = true;
                     break;
+#ifndef Z80_DISABLE_DEBUG
                 case 'v':
                     verboseMode = true;
                     break;
+#endif
                 case 'n':
                     noAnimation = true;
                     break;
@@ -131,11 +135,13 @@ int main(int argc, char* argv[])
     z80.addBreakPointFP(0xFF04, [](void* arg) {
         ((CPM*)arg)->halted = true;
     });
+#ifndef Z80_DISABLE_DEBUG
     if (verboseMode) {
         z80.setDebugMessageFP([](void* arg, const char* msg) {
             puts(msg);
         });
     }
+#endif
     cpm.lineCallback = [](CPM* cpmPtr, char* line) {
         if (cpmPtr->checkError && strstr(line, "ERROR")) {
             cpmPtr->halted = true;

test/Makefile

@@ -34,7 +34,7 @@ test-unknown:
 	cat test-unknown.txt
 
 test-clock:
-	clang $(CFLAGS) test-clock.cpp -lstdc++
+	clang $(CFLAGS) -DZ80_DISABLE_BREAKPOINT -DZ80_DISABLE_NESTCHECK test-clock.cpp -lstdc++
 	./a.out
 
 test-status: