Add commodore stub functions and scripts to generate them

Author: markjfisher

GENERATE_STUBS.md

@@ -0,0 +1,58 @@
+# Generating stub functions for new platform
+
+When adding a new platform, the following can be run to generate stub functions for the various devices.
+
+This is a very simple parser of the include files to find function definitions and convert them to stub files that can then be implemented.
+
+## How the scripts work
+
+There are various assumptions in order to make the script very simple.
+
+- Read from the library device include files "fujinet-fuji.h", "fujinet-network.h"
+- Look for lines that start with one of the letters "b", "u", "i", or "v" (for bool, uint, int, void)
+- And have an open bracket on the line
+- Assume the line is the full function definition (i.e. all parameters on 1 line)
+- Remove the semi-colon from the line
+- Generate a stub file that returns "true" for bool, nothing for void, or 0 for number types.
+- Saves stub to "function name".cpp in appropriate subdir of src
+
+## setup
+
+Create the initial directories for the new platform
+
+```shell
+NEW_PLATFORM=commodore
+mkdir ${NEW_PLATFORM}/src/{bus,fn_fuji,fn_network}
+```
+
+## fuji
+
+```shell
+grep '^[buiv].*(' fujinet-fuji.h | while read f; do FILE_NAME=$(echo $f | cut -d\( -f1 | awk '{print $2}').cpp;  echo $f | awk '{
+  LINE=gsub(/;/, "")
+  printf("#include <stdbool.h>\n#include <stdint.h>\n#include \"fujinet-fuji.h\"\n\n%s\n{\n", $0)
+  if ($1 == "bool") {
+    printf("\treturn true;\n}\n")
+  } else if ($1 == "void") {
+    printf("}\n")
+  } else {
+    printf("\treturn 0;\n}\n")
+  }
+}' > $NEW_PLATFORM/src/fn_fuji/${FILE_NAME}; done
+```
+
+## network
+
+```shell
+grep '^[buiv].*(' fujinet-network.h | while read f; do FILE_NAME=$(echo $f | cut -d\( -f1 | awk '{print $2}').cpp;  echo $f | awk '{
+  LINE=gsub(/;/, "")
+  printf("#include <stdbool.h>\n#include <stdint.h>\n#include \"fujinet-network.h\"\n\n%s\n{\n", $0)
+  if ($1 == "bool") {
+    printf("\treturn true;\n}\n")
+  } else if ($1 == "void") {
+    printf("}\n")
+  } else {
+    printf("\treturn 0;\n}\n")
+  }
+}' > $NEW_PLATFORM/src/fn_network/${FILE_NAME}; done
+```

Makefile

@@ -3,7 +3,7 @@
 # - recursive dirs for src
 # - final files go into build/ directory instead of root folder (e.g. lbl, com file etc)
 
-TARGETS := atari apple2
+TARGETS := atari apple2 commodore
 PROGRAM := fujinet.lib
 LIBS    :=
 CONFIG  :=

apple2/src/fn_fuji/fuji_get_host_slots.c

@@ -7,20 +7,20 @@
 
 bool fuji_get_host_slots(HostSlot *h, size_t size)
 {
-    sp_error = sp_get_fuji_id();
+	sp_error = sp_get_fuji_id();
 	if (sp_error <= 0) {
 		return false;
 	}
 
 	sp_error = sp_status(sp_fuji_id, 0xF4);
-    if (sp_error == 0) {
+	if (sp_error == 0) {
 		if (sp_count != sizeof(HostSlot) * size) {
 			// didn't receive the correct amount of data for array we are filling
 			sp_error = SP_ERR_IO_ERROR;
 			return false;
 		}
-        memcpy(h, &sp_payload[0], sp_count);
-    }
+		memcpy(h, &sp_payload[0], sp_count);
+	}
 	return sp_error == 0;
 
 }

commodore/src/fn_fuji/fuji_appkey_open.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_appkey_open(AppKeyOpen *buffer)
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_appkey_read.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_appkey_read(AppKeyRead *buffer)
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_appkey_write.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_appkey_write(uint16_t count, AppKeyWrite *buffer)
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_base64_decode_compute.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_base64_decode_compute()
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_base64_decode_input.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_base64_decode_input(char *s, uint16_t len)
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_base64_decode_length.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_base64_decode_length(unsigned long *len)
+{
+	return 0;
+}

commodore/src/fn_fuji/fuji_base64_decode_output.cpp

@@ -0,0 +1,8 @@
+#include <stdbool.h>
+#include <stdint.h>
+#include "fujinet-fuji.h"
+
+uint8_t fuji_base64_decode_output(char *s, uint16_t len)
+{
+	return 0;
+}