Merge pull request #1 from markjfisher/atari-init

Add first implementation for atari with makefile

Author: tschak909

.gitignore

@@ -35,6 +35,7 @@
 *.i*86
 *.x86_64
 *.hex
+*.xex
 
 # Debug files
 *.dSYM/
@@ -50,3 +51,7 @@ modules.order
 Module.symvers
 Mkfile.old
 dkms.conf
+
+# generated files
+dist/
+obj/

Changelog.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.0.0] - 2023-09-24
+
+### Added
+
+- This changelog to instil a process of clean version documentation for the library.
+- Common Makefile
+- Initial implementations of atari functions:
+  - network_close, network_open, network_read, network_write, network_status
+- cross platform BDD testing framework, atari implementation done, c64 skeleton created
+
+## Notes
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+Use Added, Removed, Changed in triple headings.
+
+Keep entries to lists and simple statements.

Makefile

@@ -0,0 +1,324 @@
+# Adapted from the generic cc65 makefile.
+# Notible exceptions:
+# - recursive dirs for src
+# - final files go into build/ directory instead of polluting root folder (e.g. lbl, com file etc)
+
+###############################################################################
+### In order to override defaults - values can be assigned to the variables ###
+###############################################################################
+
+# Space or comma separated list of cc65 supported target platforms to build for.
+TARGETS := atari
+
+# Name of the final, single-file library.
+PROGRAM := fujinet-network.lib
+
+# Path(s) to additional libraries required for linking the program
+# Use only if you don't want to place copies of the libraries in SRCDIR
+# Default: none
+LIBS    :=
+
+# Custom linker configuration file
+# Use only if you don't want to place it in SRCDIR
+# Default: none
+CONFIG  :=
+
+# Additional C compiler flags and options.
+# Default: none
+CFLAGS  =
+
+# Additional assembler flags and options.
+# Default: none
+ASFLAGS =
+
+# Additional linker flags and options.
+# Default: none
+LDFLAGS =
+
+# Path to the directory containing C and ASM sources.
+# Default: src
+SRCDIR :=
+
+# Path to the directory where object files are to be stored (inside respective target subdirectories).
+# Default: obj
+OBJDIR :=
+
+# Command used to run the emulator.
+# Default: depending on target platform. For default (c64) target: x64 -kernal kernal -VICIIdsize -autoload
+EMUCMD :=
+
+# Build dir for putting final built program rather than cluttering root
+BUILD_DIR = build
+
+# Options state file name. You should not need to change this, but for those
+# rare cases when you feel you really need to name it differently - here you are
+STATEFILE := Makefile.options
+
+# Object Dir for writing compiled files to
+OBJDIR := obj
+
+###################################################################################
+####  DO NOT EDIT BELOW THIS LINE, UNLESS YOU REALLY KNOW WHAT YOU ARE DOING!  ####
+###################################################################################
+
+###################################################################################
+### Mapping abstract options to the actual compiler, assembler and linker flags ###
+### Predefined compiler, assembler and linker flags, used with abstract options ###
+### valid for 2.14.x. Consult the documentation of your cc65 version before use ###
+###################################################################################
+
+# Compiler flags used to tell the compiler to optimise for SPEED
+define _optspeed_
+  CFLAGS += -Oris
+endef
+
+# Compiler flags used to tell the compiler to optimise for SIZE
+define _optsize_
+  CFLAGS += -Or
+endef
+
+# Compiler and assembler flags for generating listings
+define _listing_
+  CFLAGS += --listing $(BUILD_DIR)/$$(@:.o=.lst)
+  ASFLAGS += --listing $(BUILD_DIR)/$$(@:.o=.lst)
+  REMOVES += $(addsuffix .lst,$(basename $(OBJECTS)))
+endef
+
+# Linker flags for generating map file
+define _mapfile_
+  LDFLAGS += --mapfile $(BUILD_DIR)/$$@.map
+  REMOVES += $(BUILD_DIR)/$(PROGRAM).map
+endef
+
+# Linker flags for generating VICE label file
+define _labelfile_
+  LDFLAGS += -Ln $(BUILD_DIR)/$$@.lbl
+  REMOVES += $(BUILD_DIR)/$(PROGRAM).lbl
+endef
+
+# Linker flags for generating a debug file
+define _debugfile_
+  LDFLAGS += -Wl --dbgfile,$(BUILD_DIR)/$$@.dbg
+  REMOVES += $(BUILD_DIR)/$(PROGRAM).dbg
+endef
+
+###############################################################################
+###  Defaults to be used if nothing defined in the editable sections above  ###
+###############################################################################
+
+# Presume the C64 target like the cl65 compile & link utility does.
+# Set TARGETS to override.
+ifeq ($(TARGETS),)
+  TARGETS := c64
+endif
+
+# Presume we're in a project directory so name the program like the current
+# directory. Set PROGRAM to override.
+ifeq ($(PROGRAM),)
+  PROGRAM := $(notdir $(CURDIR))
+endif
+
+# Presume the C and asm source files to be located in the subdirectory 'src'.
+# Set SRCDIR to override.
+ifeq ($(SRCDIR),)
+  SRCDIR := src
+endif
+
+TARGETOBJDIR := $(OBJDIR)/$(TARGETS)
+
+# On Windows it is mandatory to have CC65_HOME set. So do not unnecessarily
+# rely on cl65 being added to the PATH in this scenario.
+ifdef CC65_HOME
+  CC := $(CC65_HOME)/bin/cl65
+else
+  CC := cl65
+endif
+
+
+###############################################################################
+### The magic begins                                                        ###
+###############################################################################
+
+# The "Native Win32" GNU Make contains quite some workarounds to get along with
+# cmd.exe as shell. However it does not provide means to determine that it does
+# actually activate those workarounds. Especially does $(SHELL) NOT contain the
+# value 'cmd.exe'. So the usual way to determine if cmd.exe is being used is to
+# execute the command 'echo' without any parameters. Only cmd.exe will return a
+# non-empy string - saying 'ECHO is on/off'.
+#
+# Many "Native Win32" prorams accept '/' as directory delimiter just fine. How-
+# ever the internal commands of cmd.exe generally require '\' to be used.
+#
+# cmd.exe has an internal command 'mkdir' that doesn't understand nor require a
+# '-p' to create parent directories as needed.
+#
+# cmd.exe has an internal command 'del' that reports a syntax error if executed
+# without any file so make sure to call it only if there's an actual argument.
+ifeq ($(shell echo),)
+  MKDIR = mkdir -p $1
+  RMDIR = rmdir $1
+  RMFILES = $(RM) $1
+else
+  MKDIR = mkdir $(subst /,\,$1)
+  RMDIR = rmdir $(subst /,\,$1)
+  RMFILES = $(if $1,del /f $(subst /,\,$1))
+endif
+COMMA := ,
+SPACE := $(N/A) $(N/A)
+define NEWLINE
+
+
+endef
+# Note: Do not remove any of the two empty lines above !
+
+rwildcard=$(wildcard $(1)$(2))$(foreach d,$(wildcard $1*), $(call rwildcard,$d/,$2))
+
+TARGETLIST := $(subst $(COMMA),$(SPACE),$(TARGETS))
+
+ifeq ($(words $(TARGETLIST)),1)
+
+# Strip potential variant suffix from the actual cc65 target.
+CC65TARGET := $(firstword $(subst .,$(SPACE),$(TARGETLIST)))
+
+# Set PROGRAM to something like 'myprog.c64'.
+override PROGRAM := $(PROGRAM).$(TARGETLIST)
+
+# Set SOURCES to something like 'src/foo.c src/bar.s'.
+# Use of assembler files with names ending differently than .s is deprecated!
+
+# Add to SOURCES something like 'src/c64/me.c src/c64/too.s'.
+# Use of assembler files with names ending differently than .s is deprecated!
+# Recursive files
+SOURCES += $(call rwildcard,$(TARGETLIST)/$(SRCDIR)/,*.s)
+SOURCES += $(call rwildcard,$(TARGETLIST)/$(SRCDIR)/,*.c)
+
+# remove trailing and leading spaces.
+SOURCES := $(strip $(SOURCES))
+
+# Set OBJECTS to something like 'obj/c64/foo.o obj/c64/bar.o'.
+# convert from src/your/long/path/foo.[c|s] to obj/your/long/path/foo.o
+OBJ1 := $(SOURCES:.c=.o)
+OBJECTS := $(OBJ1:.s=.o)
+OBJECTS := $(OBJECTS:$(TARGETLIST)/$(SRCDIR)/%=$(OBJDIR)/$(TARGETLIST)/%)
+
+# Set DEPENDS to something like 'obj/c64/foo.d obj/c64/bar.d'.
+DEPENDS := $(OBJECTS:.o=.d)
+
+# Add to LIBS something like 'src/foo.lib src/c64/bar.lib'.
+LIBS += $(wildcard $(TARGETLIST)/$(SRCDIR)/*.lib)
+
+ASFLAGS += --asm-include-dir common/inc --asm-include-dir $(TARGETLIST)/$(SRCDIR)/inc
+CFLAGS += --include-dir common/inc --include-dir $(TARGETLIST)/$(SRCDIR)/inc
+
+CHANGELOG = Changelog.md
+
+VERSION_FILE = version.txt
+VERSION_STRING := $(file < $(VERSION_FILE))
+
+FN_NW_HEADER = fujinet-network.h
+FN_NW_INC = fujinet-network.inc
+
+.SUFFIXES:
+.PHONY: all clean dist fujinet-network.lib.$(TARGETLIST)
+
+all: fujinet-network.lib.$(TARGETLIST)
+
+-include $(DEPENDS)
+-include $(STATEFILE)
+
+# If OPTIONS are given on the command line then save them to STATEFILE
+# if (and only if) they have actually changed. But if OPTIONS are not
+# given on the command line then load them from STATEFILE. Have object
+# files depend on STATEFILE only if it actually exists.
+ifeq ($(origin OPTIONS),command line)
+  ifneq ($(OPTIONS),$(_OPTIONS_))
+    ifeq ($(OPTIONS),)
+      $(info Removing OPTIONS)
+      $(shell $(RM) $(STATEFILE))
+      $(eval $(STATEFILE):)
+    else
+      $(info Saving OPTIONS=$(OPTIONS))
+      $(shell echo _OPTIONS_=$(OPTIONS) > $(STATEFILE))
+    endif
+    $(eval $(OBJECTS): $(STATEFILE))
+  endif
+else
+  ifeq ($(origin _OPTIONS_),file)
+    $(info Using saved OPTIONS=$(_OPTIONS_))
+    OPTIONS = $(_OPTIONS_)
+    $(eval $(OBJECTS): $(STATEFILE))
+  endif
+endif
+
+# Transform the abstract OPTIONS to the actual cc65 options.
+$(foreach o,$(subst $(COMMA),$(SPACE),$(OPTIONS)),$(eval $(_$o_)))
+
+$(OBJDIR):
+	$(call MKDIR,$@)
+
+$(TARGETOBJDIR):
+	$(call MKDIR,$@)
+
+$(BUILD_DIR):
+	$(call MKDIR,$@)
+
+SRC_INC_DIRS := \
+  $(sort $(dir $(wildcard $(TARGETLIST)/$(SRCDIR)/*)))
+
+# $(info $$SOURCES = ${SOURCES})
+# $(info $$OBJECTS = ${OBJECTS})
+# $(info $$SRC_INC_DIRS = ${SRC_INC_DIRS})
+# $(info $$ASFLAGS = ${ASFLAGS})
+# $(info $$TARGETOBJDIR = ${TARGETOBJDIR})
+# $(info $$TARGETLIST = ${TARGETLIST})
+
+vpath %.c $(SRC_INC_DIRS)
+
+$(TARGETOBJDIR)/%.o: %.c | $(TARGETOBJDIR)
+	@$(call MKDIR,$(dir $@))
+	$(CC) -t $(TARGETLIST) -c --create-dep $(@:.o=.d) $(CFLAGS) -o $@ $<
+
+vpath %.s $(SRC_INC_DIRS)
+
+$(TARGETOBJDIR)/%.o: %.s | $(TARGETOBJDIR)
+	@$(call MKDIR,$(dir $@))
+	$(CC) -t $(TARGETLIST) -c --create-dep $(@:.o=.d) $(ASFLAGS) -o $@ $<
+
+$(BUILD_DIR)/$(PROGRAM): $(OBJECTS) | $(BUILD_DIR)
+	ar65 a $@ $(OBJECTS)
+
+$(PROGRAM): $(BUILD_DIR)/$(PROGRAM) | $(BUILD_DIR)
+
+clean:
+	$(call RMFILES,$(OBJECTS))
+	$(call RMFILES,$(DEPENDS))
+	$(call RMFILES,$(REMOVES))
+	$(call RMFILES,$(BUILD_DIR)/$(PROGRAM))
+	$(call RMFILES,dist/*)
+
+dist: $(PROGRAM)
+	$(call MKDIR,dist/)
+	$(call RMFILES,dist/fujinet-network-$(TARGETLIST)-*.lib)
+	cp build/$(PROGRAM) dist/fujinet-network-$(TARGETLIST)_$(VERSION_STRING).lib
+	cp $(FN_NW_HEADER) dist/
+	cp $(FN_NW_INC) dist/
+	cp $(CHANGELOG) dist/
+	cd dist && zip fujinet-network-$(TARGETLIST)_$(VERSION_STRING).zip $(CHANGELOG) fujinet-network-$(TARGETLIST)_$(VERSION_STRING).lib *.h *.inc
+	$(call RMFILES,dist/fujinet-network-$(TARGETLIST)_*.lib)
+	$(call RMFILES,dist/$(CHANGELOG))
+	$(call RMFILES,dist/*.h)
+	$(call RMFILES,dist/*.inc)
+
+else # $(words $(TARGETLIST)),1
+
+all:
+	$(foreach t,$(TARGETLIST),$(MAKE) TARGETS=$t clean all dist$(NEWLINE))
+
+endif # $(words $(TARGETLIST)),1
+
+
+###################################################################
+###  Place your additional targets in the additional Makefiles  ###
+### in the same directory - their names have to end with ".mk"! ###
+###################################################################
+-include *.mk