pick up ROMs from executable directory on Mac; Makefile cleanups, ship docs

Author: mist64

.gitignore

@@ -1,3 +1,6 @@
 *.o
 x16emu
+x16emu.exe
+x16emu_mac.zip
+x16emu_win.zip
 rom_labels.h

Makefile

@@ -4,8 +4,13 @@
 # https://blog.wasin.io/2018/10/21/cross-compile-sdl2-library-and-app-on-windows-from-macos.html
 # for details on how to install mingw and libsdl2.
 
+# the mingw32 path on macOS installed through homebrew
+MINGW32=/usr/local/Cellar/mingw-w64/6.0.0_2/toolchain-i686/i686-w64-mingw32
+# the Windows SDL2 path on macOS installed through ./configure --prefix=... && make && make install
+WIN_SDL2=~/tmp/sdl2-win32
+
 ifeq ($(CROSS_COMPILE_WINDOWS),1)
-	SDL2CONFIG=~/tmp/sdl2-win32/bin/sdl2-config
+	SDL2CONFIG=$(WIN_SDL2)/bin/sdl2-config
 else
 	SDL2CONFIG=sdl2-config
 endif
@@ -18,7 +23,9 @@ ifeq ($(MAC_STATIC),1)
 endif
 
 ifeq ($(CROSS_COMPILE_WINDOWS),1)
-	LDFLAGS+=-L/usr/local/Cellar/mingw-w64/6.0.0_2/toolchain-i686/i686-w64-mingw32/lib -Wl,--subsystem,console
+	LDFLAGS+=-L$(MINGW32)/lib
+	# this enables printf() to show, but also forces a console window
+	LDFLAGS+=-Wl,--subsystem,console 
 	CC=i686-w64-mingw32-gcc
 endif
 
@@ -31,28 +38,37 @@ all: $(OBJS) $(HEADERS)
 %.o: %.c
 	$(CC) $(CFLAGS) -c $< -o $@
 
+
+# Packaging requires pandoc:
+#   brew install pandoc
+
+package: package_mac package_win
+	make clean
+
 package_mac:
 	(cd ../x16-kernalbasic/; ./build.sh)
 	MAC_STATIC=1 make clean all
-	rm -rf ~x16emu-package
+	rm -rf ~x16emu-package x16emu_mac.zip
 	mkdir ~x16emu-package
 	cp x16emu ~x16emu-package
 	cp ../x16-kernalbasic/rom.bin ~x16emu-package
 	cp -p ~/tmp/chargen ~x16emu-package/chargen.bin
+	pandoc --from gfm --to html --standalone README.md --output ~x16emu-package/README.html
 	(cd ~x16emu-package/; zip "../x16emu_mac.zip" *)
 	rm -rf ~x16emu-package
 
 package_win:
 	(cd ../x16-kernalbasic/; ./build.sh)
 	CROSS_COMPILE_WINDOWS=1 make clean all
-	rm -rf ~x16emu-package
+	rm -rf ~x16emu-package x16emu_win.zip
 	mkdir ~x16emu-package
 	cp x16emu.exe ~x16emu-package
-	cp /usr/local/Cellar/mingw-w64/6.0.0_2/toolchain-i686/i686-w64-mingw32/lib/libgcc_s_sjlj-1.dll ~x16emu-package/
-	cp /usr/local/Cellar/mingw-w64/6.0.0_2/toolchain-i686/i686-w64-mingw32/bin/libwinpthread-1.dll ~x16emu-package/
-	cp ~/tmp/sdl2-win32/bin/SDL2.dll ~x16emu-package/
+	cp $(MINGW32)/lib/libgcc_s_sjlj-1.dll ~x16emu-package/
+	cp $(MINGW32)/bin/libwinpthread-1.dll ~x16emu-package/
+	cp $(WIN_SDL2)/bin/SDL2.dll ~x16emu-package/
 	cp ../x16-kernalbasic/rom.bin ~x16emu-package
 	cp -p ~/tmp/chargen ~x16emu-package/chargen.bin
+	pandoc --from gfm --to html --standalone README.md --output ~x16emu-package/README.html
 	(cd ~x16emu-package/; zip "../x16emu_win.zip" *)
 	rm -rf ~x16emu-package
 

README.md

@@ -4,7 +4,9 @@ This is an emulator for the Commander X16 computer system. It only depends on SD
 
 ## Starting
 
-* When starting `x16emu` without arguments, it will pick up the system ROM (`rom.bin`) and the character ROM (`chargen.bin`).
+You can start `x16emu`/`x16emu.exe` either by double-clicking it, or from the command line. The latter allows you to specify additional arguments.
+
+* When starting `x16emu` without arguments, it will pick up the system ROM (`rom.bin`) and the character ROM (`chargen.bin`) from the executable's directory.
 * The system ROM and character ROM filenames/paths can be overridden with the `-rom` and `-char` command line arguments.
 * `-sdcard` lets you specify an SD card image (partition table + FAT32).
 * `-prg` leys you specify a `.prg` file that gets injected into RAM after start.
@@ -76,6 +78,7 @@ Copyright (c) 2019 Michael Steil. All rights reserved. License: 2-clause BSD
 * Command line overhaul. Supports `-rom`, `-char`, `-sdcard` and `-prg`.
 * ROM and char filename defaults, so x16emu can be started without arguments.
 * Host Filesystem Interface supports LOAD"$"
+* macOS and Windows packaging logic in Makefile
 
 ### Release 26
 

main.c

@@ -8,6 +8,7 @@
 #include <stdio.h>
 #include <string.h>
 #include <unistd.h>
+#include <limits.h>
 #include "fake6502.h"
 #include "disasm.h"
 #include "memory.h"
@@ -91,22 +92,47 @@ main(int argc, char **argv)
 	uint16_t trace_address = 0;
 #endif
 
+	char *rom_filename = "/rom.bin";
+	char *char_filename = "/chargen.bin";
+	char rom_path_data[PATH_MAX];
+	char char_path_data[PATH_MAX];
+
+	char *rom_path = rom_path_data;
+	char *char_path = char_path_data;
+	char *prg_path = NULL;
+	char *sdcard_path = NULL;
+
+#ifdef __APPLE__
+	// on macOS, double clicking runs an executable in the user's
+	// home directory, so we prepend the executable's path to
+	// the rom filenames
+	if (argv[0][0] == '/') {
+		*strrchr(argv[0], '/') = 0;
+
+		strncpy(rom_path, argv[0], PATH_MAX);
+		strncpy(rom_path + strlen(rom_path), rom_filename, PATH_MAX - strlen(rom_path));
+		strncpy(char_path, argv[0], PATH_MAX);
+		strncpy(char_path + strlen(char_path), char_filename, PATH_MAX - strlen(char_path));
+	} else
+#endif
+	{
+		strncpy(rom_path, rom_filename + 1, PATH_MAX);
+		strncpy(char_path, char_filename + 1, PATH_MAX);
+	}
+
+	printf("%s / %s\n", rom_path, char_path);
+
 	argc--;
 	argv++;
 
-	char *rom_filename = "rom.bin";
-	char *char_filename = "chargen.bin";
-	char *prg_filename = NULL;
-	char *sdcard_filename = NULL;
-
 	while (argc > 0) {
 		if (!strcmp(argv[0], "-rom")) {
 			argc--;
 			argv++;
 			if (!argc) {
 				usage();
 			}
-			rom_filename = argv[0];
+			rom_path = argv[0];
 			argc--;
 			argv++;
 		} else if (!strcmp(argv[0], "-char")) {
@@ -115,7 +141,7 @@ main(int argc, char **argv)
 			if (!argc) {
 				usage();
 			}
-			char_filename = argv[0];
+			char_path = argv[0];
 			argc--;
 			argv++;
 		} else if (!strcmp(argv[0], "-prg")) {
@@ -124,7 +150,7 @@ main(int argc, char **argv)
 			if (!argc) {
 				usage();
 			}
-			prg_filename = argv[0];
+			prg_path = argv[0];
 			argc--;
 			argv++;
 		} else if (!strcmp(argv[0], "-sdcard")) {
@@ -133,7 +159,7 @@ main(int argc, char **argv)
 			if (!argc) {
 				usage();
 			}
-			sdcard_filename = argv[0];
+			sdcard_path = argv[0];
 			argc--;
 			argv++;
 #ifdef TRACE
@@ -156,43 +182,43 @@ main(int argc, char **argv)
 		}
 	}
 
-	FILE *f = fopen(rom_filename, "r");
+	FILE *f = fopen(rom_path, "r");
 	if (!f) {
-		printf("Cannot open %s!\n", rom_filename);
+		printf("Cannot open %s!\n", rom_path);
 		exit(1);
 	}
 	fread(ROM, 1, ROM_SIZE, f);
 	fclose(f);
 
-	f = fopen(char_filename, "r");
+	f = fopen(char_path, "r");
 	if (!f) {
-		printf("Cannot open %s!\n", char_filename);
+		printf("Cannot open %s!\n", char_path);
 		exit(1);
 	}
 	uint8_t chargen[4096];
 	fread(chargen, 1, sizeof(chargen), f);
 	fclose(f);
 
-	if (sdcard_filename) {
-		sdcard_file = fopen(sdcard_filename, "r");
+	if (sdcard_path) {
+		sdcard_file = fopen(sdcard_path, "r");
 		if (!sdcard_file) {
-			printf("Cannot open %s!\n", sdcard_filename);
+			printf("Cannot open %s!\n", sdcard_path);
 			exit(1);
 		}
 	}
 
 	FILE *prg_file = NULL;
 	int prg_override_start = -1;
-	if (prg_filename) {
-		char *comma = strchr(prg_filename, ',');
+	if (prg_path) {
+		char *comma = strchr(prg_path, ',');
 		if (comma) {
 			prg_override_start = (uint16_t)strtol(comma + 1, NULL, 16);
 			*comma = 0;
 		}
 
-		prg_file = fopen(prg_filename, "r");
+		prg_file = fopen(prg_path, "r");
 		if (!prg_file) {
-			printf("Cannot open %s!\n", prg_filename);
+			printf("Cannot open %s!\n", prg_path);
 			exit(1);
 		}
 	}