Merge branch 'riiz'

natecraddock · Apr 28, 2022 · 9fb8d65 · 9fb8d65
2 parents 90b8ab2 + 8c375f9
commit 9fb8d65
Show file tree

Hide file tree

Showing 89 changed files with 1,458 additions and 145 deletions.
diff --git a/.clang-format b/.clang-format
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,2 @@
-*build*/
-.cache/
-CMakeFiles
-.vscode
-CMakeCache.txt
-*.o
+zig-cache/
+zig-out/
diff --git a/README.md b/README.md
@@ -1,10 +1,12 @@
 # Open Reckless Drivin'
 
-This project is an attempt to reimplement the classic Macintosh shareware game Reckless Drivin' as a cross-platform
-game. The source code of the original game was released by the author Jonas Echterhoff in 2019, but relies heavily
-on deprecated Macintosh system calls for most aspects of the game. Additionally, the game data (sprites, sounds,
-level data, etc.) are all LZRW3 compressed inside the resource fork of the original game, which is an additional
-barrier to reimplementation.
+This project is an attempt to reimplement the classic Macintosh shareware game
+Reckless Drivin' as a cross-platform game. The source code of the original game
+was released by the author Jonas Echterhoff in 2019, but relies heavily on
+deprecated Macintosh system calls for most aspects of the game. Additionally,
+the game data (sprites, sounds, level data, etc.) are all LZRW3 compressed
+inside the resource fork of the original game, which is an additional barrier to
+reimplementation.
 
 The original source may be found at https://github.com/jechter/RecklessDrivin.
 
@@ -16,61 +18,73 @@ this in the
 where I'm rewriting in Zig! I discuss my rationale behind this in more detail on
 [my blog post](https://nathancraddock.com/blog/moving-to-zig/).
 
-**TL;DR**: The game is not playable. Binary data loading, decompression, decryption, and reading is working.
-Preferences are read from a file. The source code has been restructured and uses CMake. Currently working on
-using SDL2 for drawing sprites.
-
-The original source contained a file called `Data` containing the resource fork. This has been converted into
-a header file (`src/include/data`) to be embedded in the executable directly. This file contains various "Packs"
-of data including Apple QuickDraw images, sounds, sprites, and fonts. Work has been done to reliably read,
-decompress, decrypt, and interpret the data from this resource fork.
-
-As an indicator of progress, PPic Packs 1000 through 1008 (the Apple QuickDraw images) have been read from the
-resource fork. This verifies that the lzrw-3a decompression is working, and is a exciting marker of progress!
-See the images on the [wiki](https://github.com/natecraddock/open-reckless-drivin/wiki/QuickDraw-Pictures-(PPic)).
-
-The source code layout has been reorganized, with CMake as a build-system generator.
-
-A small test with SDL was done to open a window with the loading screen, but has been disabled for now.
-
-The preference file reading and writing is working well now. Because I'm developing on Linux, the paths are
-Linux-specific, but I have structured the code to make it easy to update when I start testing on other platforms.
-The format is INI for simplicity, and the expected file path is `~/.config/open-reckless-drivin/prefs.ini`. (or
-`$XDG_CONFIG_HOME/open-reckless-drivin/prefs.ini` if set). The `open-reckless-drivin` directory must exist and will not
-be created if it doesn't exist.
-
-The **name** and **code** preferences are read for checking for a registered copy of the game, allowing for
-decryption of levels 4 through 10.
-
-Currently I am adding game loop code one function at a time. This is a slow going process. There are many
-Macintosh system calls in each file that need to either be removed because they play no role in the game,
-or the functions need to be replaced with a cross-platform alternative.
+**TL;DR:** The game is not playable, but a lot of work has been done on
+decompressing, decrypting, and interpreting the bytes in the resource fork.
+
+I started the project summer 2020. Due to the demands of university, my work has
+been off-and-on since then. I recently picked the project up again since
+learning Zig and I am rewriting in Zig! See [this
+issue](https://github.com/natecraddock/open-reckless-drivin/issues/2) that
+tracks my progress on porting everything I did in C to Zig.
+
+Once I am caught up on what I have already done, I'll be pulling in GLFW and
+OpenGL libraries to start drawing sprites to the screen!
+
+The original source contained a file called `Data` containing the resource fork.
+This has been converted into a header file (`src/include/data`) to be embedded
+in the executable directly. This file contains various "Packs" of data including
+Apple QuickDraw images, sounds, sprites, and fonts. Work has been done to
+reliably read, decompress, decrypt, and interpret the data from this resource
+fork.
+
+As an indicator of progress, PPic Packs 1000 through 1008 (the Apple QuickDraw
+images) have been read from the resource fork. This verifies that the lzrw-3a
+decompression is working, and is a exciting marker of progress! See the images
+on the
+[wiki](https://github.com/natecraddock/open-reckless-drivin/wiki/QuickDraw-Pictures-(PPic)).
+
+The preference file reading and writing is working well now. Because I'm
+developing on Linux, the paths are Linux-specific, but I have structured the
+code to make it easy to update when I start testing on other platforms. The
+format is INI for simplicity, and the expected file path is
+`~/.config/open-reckless-drivin/prefs.ini`. (or
+`$XDG_CONFIG_HOME/open-reckless-drivin/prefs.ini` if set). The
+`open-reckless-drivin` directory must exist and will not be created if it
+doesn't exist.
+
+The **name** and **code** preferences are read for checking for a registered
+copy of the game, allowing for decryption of levels 4 through 10.
+
+Currently I am adding game loop code one function at a time. This is a slow
+going process. There are many Macintosh system calls in each file that need to
+either be removed because they play no role in the game, or the functions need
+to be replaced with a cross-platform alternative.
 
 # Building
 
-So far I have only built Open Reckless Drivin' on Arch Linux, but it should hopefully build elsewhere with no changes.
-I prefer Ninja, but Makefiles also work fine. Suggested build instructions:
+So far I have only built Open Reckless Drivin' on Arch Linux, but I see no
+reason why it wouldn't work elsewhere.
 
 ```text
-mkdir build && cd build
-cmake -GNinja ../
-ninja
+zig build
 ```
 
 To run tests
 
 ```
-ninja test
+zig build test
 ```
 
 ## Registration Keys
 
-Jonas released the game for free after it was no longer viable to update it for modern systems. More information
-can be found on the [game's website](http://jonasechterhoff.com/Reckless_Drivin.html). The free registration
+Jonas released the game for free after it was no longer viable to update it for
+modern systems. More information can be found on the [game's
+website](http://jonasechterhoff.com/Reckless_Drivin.html). The free registration
 information is:
 
 Name: Free<br>
 Code: B3FB09B1EB
 
-Registration keys can also be generated in your name using a Python script.
-See [the wiki](https://github.com/natecraddock/open-reckless-drivin/wiki/Decryption) for more info.
+Registration keys can also be generated in your name using a Python script. See
+[the wiki](https://github.com/natecraddock/open-reckless-drivin/wiki/Decryption)
+for more info.
diff --git a/build.zig b/build.zig
@@ -0,0 +1,44 @@
+const std = @import("std");
+
+pub fn build(b: *std.build.Builder) void {
+    const target = b.standardTargetOptions(.{});
+    const mode = b.standardReleaseOptions();
+
+    const exe = b.addExecutable("reckless-drivin", "src/main.zig");
+
+    exe.linkLibC();
+    exe.addIncludeDir("src/c/");
+    exe.addCSourceFile("src/c/lzrw.c", &.{
+        // The default is to enable undefined behavior detection in C code. I have
+        // verified that the packs are all decompressed fine, so there is no need
+        // to sanitize. See https://github.com/ziglang/zig/wiki/FAQ#why-do-i-get-illegal-instruction-when-using-with-zig-cc-to-build-c-code
+        // for more details.
+        "-fno-sanitize=undefined",
+    });
+
+    exe.setTarget(target);
+    exe.setBuildMode(mode);
+    exe.install();
+
+    const run_cmd = exe.run();
+    run_cmd.step.dependOn(b.getInstallStep());
+    if (b.args) |args| {
+        run_cmd.addArgs(args);
+    }
+
+    const run_step = b.step("run", "Run Reckless Drivin'");
+    run_step.dependOn(&run_cmd.step);
+
+    const exe_tests = b.addTest("src/main.zig");
+    exe_tests.linkLibC();
+    exe_tests.addIncludeDir("src/c/");
+    exe_tests.addCSourceFile("src/c/lzrw.c", &.{
+        "-fno-sanitize=undefined",
+    });
+
+    exe_tests.setTarget(target);
+    exe_tests.setBuildMode(mode);
+
+    const test_step = b.step("test", "Run tests");
+    test_step.dependOn(&exe_tests.step);
+}
diff --git a/CMakeLists.txt → c/CMakeLists.txt b/CMakeLists.txt → c/CMakeLists.txt
diff --git a/Makefile → c/Makefile b/Makefile → c/Makefile
diff --git a/scripts/convert.py → c/scripts/convert.py b/scripts/convert.py → c/scripts/convert.py
diff --git a/src/CMakeLists.txt → c/src/CMakeLists.txt b/src/CMakeLists.txt → c/src/CMakeLists.txt
diff --git a/src/IsPortListValid.c → c/src/IsPortListValid.c b/src/IsPortListValid.c → c/src/IsPortListValid.c
diff --git a/src/error.c → c/src/error.c b/src/error.c → c/src/error.c
diff --git a/src/gameendseq.c → c/src/gameendseq.c b/src/gameendseq.c → c/src/gameendseq.c
diff --git a/src/gameframe.c → c/src/gameframe.c b/src/gameframe.c → c/src/gameframe.c
diff --git a/src/gameinitexit.c → c/src/gameinitexit.c b/src/gameinitexit.c → c/src/gameinitexit.c
diff --git a/src/high.c → c/src/high.c b/src/high.c → c/src/high.c
diff --git a/src/include/data → c/src/include/data b/src/include/data → c/src/include/data
diff --git a/src/include/defines.h → c/src/include/defines.h b/src/include/defines.h → c/src/include/defines.h
diff --git a/src/include/error.h → c/src/include/error.h b/src/include/error.h → c/src/include/error.h
diff --git a/src/include/gameframe.h → c/src/include/gameframe.h b/src/include/gameframe.h → c/src/include/gameframe.h
diff --git a/src/include/gameinitexit.h → c/src/include/gameinitexit.h b/src/include/gameinitexit.h → c/src/include/gameinitexit.h
diff --git a/src/include/gamesounds.h → c/src/include/gamesounds.h b/src/include/gamesounds.h → c/src/include/gamesounds.h
diff --git a/src/include/high.h → c/src/include/high.h b/src/include/high.h → c/src/include/high.h
diff --git a/src/include/initexit.h → c/src/include/initexit.h b/src/include/initexit.h → c/src/include/initexit.h
diff --git a/src/include/input.h → c/src/include/input.h b/src/include/input.h → c/src/include/input.h
diff --git a/src/include/interface.h → c/src/include/interface.h b/src/include/interface.h → c/src/include/interface.h
diff --git a/src/include/objectcontrol.h → c/src/include/objectcontrol.h b/src/include/objectcontrol.h → c/src/include/objectcontrol.h
diff --git a/src/include/objects.h → c/src/include/objects.h b/src/include/objects.h → c/src/include/objects.h
diff --git a/src/include/packs.h → c/src/include/packs.h b/src/include/packs.h → c/src/include/packs.h
diff --git a/src/include/particlefx.h → c/src/include/particlefx.h b/src/include/particlefx.h → c/src/include/particlefx.h
diff --git a/src/include/preferences.h → c/src/include/preferences.h b/src/include/preferences.h → c/src/include/preferences.h
diff --git a/src/include/quickdraw.h → c/src/include/quickdraw.h b/src/include/quickdraw.h → c/src/include/quickdraw.h
diff --git a/src/include/random.h → c/src/include/random.h b/src/include/random.h → c/src/include/random.h
diff --git a/src/include/register.h → c/src/include/register.h b/src/include/register.h → c/src/include/register.h
diff --git a/src/include/renderframe.h → c/src/include/renderframe.h b/src/include/renderframe.h → c/src/include/renderframe.h
diff --git a/src/include/resource.h → c/src/include/resource.h b/src/include/resource.h → c/src/include/resource.h
diff --git a/src/include/rle.h → c/src/include/rle.h b/src/include/rle.h → c/src/include/rle.h
diff --git a/src/include/roads.h → c/src/include/roads.h b/src/include/roads.h → c/src/include/roads.h
diff --git a/src/include/screen.h → c/src/include/screen.h b/src/include/screen.h → c/src/include/screen.h
diff --git a/src/include/screenfx.h → c/src/include/screenfx.h b/src/include/screenfx.h → c/src/include/screenfx.h
diff --git a/src/include/sprites.h → c/src/include/sprites.h b/src/include/sprites.h → c/src/include/sprites.h
diff --git a/src/include/textfx.h → c/src/include/textfx.h b/src/include/textfx.h → c/src/include/textfx.h
diff --git a/src/include/trig.h → c/src/include/trig.h b/src/include/trig.h → c/src/include/trig.h
diff --git a/src/include/vec2d.h → c/src/include/vec2d.h b/src/include/vec2d.h → c/src/include/vec2d.h
diff --git a/src/initexit.c → c/src/initexit.c b/src/initexit.c → c/src/initexit.c
diff --git a/src/input.c → c/src/input.c b/src/input.c → c/src/input.c
diff --git a/src/interface.c → c/src/interface.c b/src/interface.c → c/src/interface.c
diff --git a/src/main.c → c/src/main.c b/src/main.c → c/src/main.c
diff --git a/src/objectCollision.c → c/src/objectCollision.c b/src/objectCollision.c → c/src/objectCollision.c
diff --git a/src/objectControl.c → c/src/objectControl.c b/src/objectControl.c → c/src/objectControl.c
diff --git a/src/objectPhysics.c → c/src/objectPhysics.c b/src/objectPhysics.c → c/src/objectPhysics.c
diff --git a/src/objects.c → c/src/objects.c b/src/objects.c → c/src/objects.c
diff --git a/src/packs.c → c/src/packs.c b/src/packs.c → c/src/packs.c
diff --git a/src/particlefx.c → c/src/particlefx.c b/src/particlefx.c → c/src/particlefx.c
diff --git a/src/pause.c → c/src/pause.c b/src/pause.c → c/src/pause.c
diff --git a/src/preferences.c → c/src/preferences.c b/src/preferences.c → c/src/preferences.c
diff --git a/src/quickdraw.c → c/src/quickdraw.c b/src/quickdraw.c → c/src/quickdraw.c
diff --git a/src/random.c → c/src/random.c b/src/random.c → c/src/random.c
diff --git a/src/register.c → c/src/register.c b/src/register.c → c/src/register.c
diff --git a/src/renderframe.c → c/src/renderframe.c b/src/renderframe.c → c/src/renderframe.c
diff --git a/src/renderframezoom.c → c/src/renderframezoom.c b/src/renderframezoom.c → c/src/renderframezoom.c
diff --git a/src/resource.c → c/src/resource.c b/src/resource.c → c/src/resource.c
diff --git a/src/rle.c → c/src/rle.c b/src/rle.c → c/src/rle.c
diff --git a/src/roaddraw.c → c/src/roaddraw.c b/src/roaddraw.c → c/src/roaddraw.c
diff --git a/src/screen.c → c/src/screen.c b/src/screen.c → c/src/screen.c
diff --git a/src/screenfx.c → c/src/screenfx.c b/src/screenfx.c → c/src/screenfx.c
diff --git a/src/sound.c → c/src/sound.c b/src/sound.c → c/src/sound.c
diff --git a/src/sprites.c → c/src/sprites.c b/src/sprites.c → c/src/sprites.c
diff --git a/src/textfx.c → c/src/textfx.c b/src/textfx.c → c/src/textfx.c
diff --git a/src/trig.c → c/src/trig.c b/src/trig.c → c/src/trig.c
diff --git a/tests/CMakeLists.txt → c/tests/CMakeLists.txt b/tests/CMakeLists.txt → c/tests/CMakeLists.txt
diff --git a/tests/decryption_test.c → c/tests/decryption_test.c b/tests/decryption_test.c → c/tests/decryption_test.c
diff --git a/tests/lzrw_test.c → c/tests/lzrw_test.c b/tests/lzrw_test.c → c/tests/lzrw_test.c
diff --git a/tests/preference-test.c → c/tests/preference-test.c b/tests/preference-test.c → c/tests/preference-test.c
diff --git a/tests/prefs-test.ini → c/tests/prefs-test.ini b/tests/prefs-test.ini → c/tests/prefs-test.ini
diff --git a/tests/resource_test.c → c/tests/resource_test.c b/tests/resource_test.c → c/tests/resource_test.c
diff --git a/scripts/generate-code.py b/scripts/generate-code.py
diff --git a/src/lzrw.c → src/c/lzrw.c b/src/lzrw.c → src/c/lzrw.c
@@ -102,19 +102,26 @@ static struct compress_identity identity = {
     "Public Domain"         /* Vendor of algorithm.             */
 };
 
-static void lzrw3a_compress_compress(uint8_t *, uint8_t *, uint32_t, uint8_t *,
+static void lzrw3a_compress_compress(uint8_t *, const uint8_t *, uint32_t, uint8_t *,
                                      uint64_t *);
-static void lzrw3a_compress_decompress(uint8_t *, uint8_t *, uint32_t,
+static void lzrw3a_compress_decompress(uint8_t *, const uint8_t *, uint32_t,
                                        uint8_t *, uint64_t *);
 
+
+/******************************************************************************/
+
+struct compress_identity lzrw_identity() {
+  return identity;
+}
+
 /******************************************************************************/
 
 /* This function is the only function exported by this module.                */
 /* Depending on its first parameter, the function can be requested to         */
 /* compress a block of memory, decompress a block of memory, or to identify   */
 /* itself. For more information, see the specification file "compress.h".     */
 
-void lzrw3a_compress(uint16_t action, uint8_t *wrk_mem, uint8_t *src_adr,
+void lzrw3a_compress(uint16_t action, uint8_t *wrk_mem, const uint8_t *src_adr,
                      uint32_t src_len, uint8_t *dst_adr, uint64_t *p_dst_len) {
   switch (action) {
     case COMPRESS_ACTION_COMPRESS:
@@ -386,7 +393,7 @@ void lzrw3a_compress(uint16_t action, uint8_t *wrk_mem, uint8_t *src_adr,
 
 /******************************************************************************/
 
-static void lzrw3a_compress_compress(uint8_t *p_wrk_mem, uint8_t *p_src_first,
+static void lzrw3a_compress_compress(uint8_t *p_wrk_mem, const uint8_t *p_src_first,
                                      uint32_t src_len, uint8_t *p_dst_first,
                                      uint64_t *p_dst_len)
 /* Input  : Hand over the required amount of working memory in p_wrk_mem.     */
@@ -680,7 +687,7 @@ static void lzrw3a_compress_compress(uint8_t *p_wrk_mem, uint8_t *p_src_first,
 
 /******************************************************************************/
 
-static void lzrw3a_compress_decompress(uint8_t *p_wrk_mem, uint8_t *p_src_first,
+static void lzrw3a_compress_decompress(uint8_t *p_wrk_mem, const uint8_t *p_src_first,
                                        uint32_t src_len, uint8_t *p_dst_first,
                                        uint64_t *p_dst_len)
 /* Input  : Hand over the required amount of working memory in p_wrk_mem.     */
@@ -738,11 +745,10 @@ static void lzrw3a_compress_decompress(uint8_t *p_wrk_mem, uint8_t *p_src_first,
 
   /* Check the leading copy flag to see if the compressor chose to use a copy */
   /* operation instead of a compression operation. If a copy operation was */
-  /* used, then all we need to do is copy the data over, set the output length
-   */
+  /* used, then all we need to do is copy the data over, set the output length */
   /* and return. */
   if (*p_src_first == FLAG_COPY) {
-    memcpy(p_src_first, p_src_first + FLAG_BYTES, src_len - FLAG_BYTES);
+    memcpy(p_dst_first, p_src_first + FLAG_BYTES, src_len - FLAG_BYTES);
     *p_dst_len = src_len - FLAG_BYTES;
     return;
   }
@@ -873,12 +879,9 @@ static void lzrw3a_compress_decompress(uint8_t *p_wrk_mem, uint8_t *p_src_first,
 /*                              End of LZRW3-A.C                              */
 /******************************************************************************/
 
-#include <stdio.h>
-
-#include "resource.h"
-
+/*
 void LZRWDecodeHandle(Handle *handle) {
-  /* Need the handle size to properly decompress. */
+  // Need the handle size to properly decompress.
   uint32_t handle_len = GetHandleSize(*handle);
 
   unsigned char *working_mem = malloc(sizeof *working_mem * identity.memory);
@@ -897,13 +900,14 @@ void LZRWDecodeHandle(Handle *handle) {
                   handle_len - 4, dst_mem, &dst_len);
   free(working_mem);
 
-  /* Reallocate the dst block to be exactly the right size. */
+  // Reallocate the dst block to be exactly the right size.
   dst_mem = realloc(dst_mem, dst_len);
   if (!dst_mem) {
     return;
   }
 
   **handle = dst_mem;
-  /* Store the new handle length. */
+  // Store the new handle length.
   SetHandleSize(*handle, dst_len);
 }
+*/
diff --git a/src/include/lzrw.h → src/c/lzrw.h b/src/include/lzrw.h → src/c/lzrw.h
@@ -122,6 +122,7 @@
 #ifndef LZRW_H
 #define LZRW_H
 
+#include <stdbool.h>
 #include <stdint.h>
 #include <string.h>
 
@@ -155,11 +156,14 @@ struct compress_identity {
   char *vendor;      /* Where the algorithm can be obtained.        */
 };
 
+/* returns id information for the compression algorithm */
+struct compress_identity lzrw_identity();
+
 void lzrw3a_compress(/* Single function interface to compression algorithm. */
                      uint16_t action,    /* Action to be performed.       */
                      uint8_t *wrk_mem,   /* Working memory temporarily given to
                                           routine to use. */
-                     uint8_t *src_adr,   /* Address of input  data.     */
+                     const uint8_t *src_adr,   /* Address of input  data.     */
                      uint32_t src_len,   /* Length  of input  data.   */
                      uint8_t *dst_adr,   /* Address of output data.     */
                      uint64_t *p_dst_len /* Pointer to a longword where routine
@@ -173,14 +177,4 @@ void lzrw3a_compress(/* Single function interface to compression algorithm. */
 /*                             End of COMPRESS.H                              */
 /******************************************************************************/
 
-#include "defines.h"
-
-/**
- * Decompress the bytes referenced by a handle.
- *
- * On success, the given Resource Handle is converted to a Memory Handle and
- * will need to be freed with DisposeHandle.
- */
-void LZRWDecodeHandle(Handle *handle);
-
 #endif /* LZRW_H */