Clean nimble and CMake configs, make incremental builds work reliably

.github/workflows/build.yml

@@ -110,4 +110,4 @@ jobs:
 
     - name: Run headless test
       working-directory: ./tests
-      run: xvfb-run ../PlaydateSDK-*/bin/PlaydateSimulator playdate_tests.pdx
+      run: xvfb-run ../PlaydateSDK-*/bin/PlaydateSimulator playdate.pdx

README.md

@@ -45,20 +45,20 @@ This package is an independent bindings library, not affiliated with Panic.
 You can quickly start using the bindings opening the `playdate_example` project included in this repository.<br>
 If you want to start from scratch, here are the steps to follow:
 
-1. If you haven't run it already, start by initializing your nimble package and follow the instructions:
+1. If you haven't done it already, start creating a folder (snake_case) and initializing your nimble package inside it running:
 
 ```
 nimble init
 ```
+Choose `binary` as the package type.
 
 2. Install the `playdate` package:
 
 ```
 nimble install playdate
 ```
 
-3. Move into your package directory.<br>
-Add the `playdate` package as a dependency and configure the build tasks by running the following:
+3. Add the `playdate` package as a dependency and configure the build tasks by running the following:
 
 ```
 echo 'requires "playdate"' >> *.nimble;
@@ -111,6 +111,11 @@ For simulator + device (pdx):
 nimble all
 ```
 
+You can also build for simulator and launch it in one command:
+```sh
+nimble simulate
+```
+
 The example project `playdate_example` also contains VSCode launch configurations to build, start and debug your Nim application from the editor.
 
 Each project also contains a simple CMakeLists.txt as a starting point in case you'd want to add libraries or other external code.

playdate.nimble

@@ -1,6 +1,6 @@
 # Package
 
-version       = "0.9.0"
+version       = "0.9.3"
 author        = "Samuele Zolfanelli"
 description   = "Playdate Nim bindings with extra features."
 license       = "MIT"

playdate_example/.vscode/launch.json

@@ -10,7 +10,7 @@
             "name": "Debug PDX",
             "program": "${env:PLAYDATE_SDK_PATH}/bin/Playdate Simulator",
             "args": [
-                "${workspaceFolder}/playdate_example.pdx"
+                "${workspaceFolder}/playdate.pdx"
             ],
             "cwd": "${workspaceFolder}",
             "osx": {
@@ -33,7 +33,7 @@
             "program": "${env:PLAYDATE_SDK_PATH}/bin/Playdate Simulator",
             "preLaunchTask": "Build Universal PDX",
             "args": [
-                "${workspaceFolder}/playdate_example.pdx"
+                "${workspaceFolder}/playdate.pdx"
             ],
             "cwd": "${workspaceFolder}",
             "osx": {
@@ -56,7 +56,7 @@
             "program": "${env:PLAYDATE_SDK_PATH}/bin/Playdate Simulator",
             "preLaunchTask": "Build Simulator PDX",
             "args": [
-                "${workspaceFolder}/playdate_example.pdx"
+                "${workspaceFolder}/playdate.pdx"
             ],
             "cwd": "${workspaceFolder}",
             "osx": {

playdate_example/CMakeLists.txt

@@ -5,6 +5,7 @@
 # $ENV{PLAYDATE_PROJECT_NAME}: the project name
 # $ENV{PLAYDATE_MODULE_DIR}: the path to the installed playdate Nim module
 # $ENV{NIM_CACHE_DIR}: the path to the project Nim cache files
+# $ENV{NIM_C_SOURCE_FILES}: list of semicolon-separated, Nim-generated C files that have to be compiled
 # $ENV{NIM_INCLUDE_DIR}: the path to required Nim header files
 
 cmake_minimum_required(VERSION 3.14)
@@ -15,4 +16,8 @@ set(CMAKE_C_STANDARD 11)
 project($ENV{PLAYDATE_PROJECT_NAME} C ASM)
 
 # Include the playdate module CMake configuration
-include($ENV{PLAYDATE_MODULE_DIR}/playdate.cmake)
+include($ENV{PLAYDATE_MODULE_DIR}/playdate.cmake)
+
+# Targets:
+# ${PLAYDATE_GAME_NAME}: simulator
+# ${PLAYDATE_GAME_DEVICE}: device

src/CMakeLists.txt

@@ -5,6 +5,7 @@
 # $ENV{PLAYDATE_PROJECT_NAME}: the project name
 # $ENV{PLAYDATE_MODULE_DIR}: the path to the installed playdate Nim module
 # $ENV{NIM_CACHE_DIR}: the path to the project Nim cache files
+# $ENV{NIM_C_SOURCE_FILES}: list of semicolon-separated, Nim-generated C files that have to be compiled
 # $ENV{NIM_INCLUDE_DIR}: the path to required Nim header files
 
 cmake_minimum_required(VERSION 3.14)
@@ -14,5 +15,9 @@ set(CMAKE_C_STANDARD 11)
 # Setup the project and its name from the environment
 project($ENV{PLAYDATE_PROJECT_NAME} C ASM)
 
-# Include the playdate module CMake configuration
-include($ENV{PLAYDATE_MODULE_DIR}/playdate.cmake)
+# Include the playdate module CMake configuration, this defines the targets
+include($ENV{PLAYDATE_MODULE_DIR}/playdate.cmake)
+
+# Targets:
+# ${PLAYDATE_GAME_NAME}: simulator
+# ${PLAYDATE_GAME_DEVICE}: device

src/playdate.cmake

@@ -24,20 +24,18 @@ endif()
 set(CMAKE_CONFIGURATION_TYPES "Debug;Release")
 set(CMAKE_XCODE_GENERATE_SCHEME TRUE)
 
-file(GLOB nim_source_files "$ENV{NIM_CACHE_DIR}/*.c")
-
 # Game Name Customization
-set(PLAYDATE_GAME_NAME $ENV{PLAYDATE_PROJECT_NAME})
-set(PLAYDATE_GAME_DEVICE $ENV{PLAYDATE_PROJECT_NAME})
+set(PLAYDATE_GAME_NAME $ENV{PLAYDATE_PROJECT_NAME}_simulator)
+set(PLAYDATE_GAME_DEVICE $ENV{PLAYDATE_PROJECT_NAME}_device)
 
 # Include Nim required headers
 include_directories($ENV{NIM_INCLUDE_DIR})
 
 if (TOOLCHAIN STREQUAL "armgcc")
-	add_executable(${PLAYDATE_GAME_DEVICE} ${nim_source_files})
+	add_executable(${PLAYDATE_GAME_DEVICE} $ENV{NIM_C_SOURCE_FILES})
 	target_link_libraries(${PLAYDATE_GAME_DEVICE} rdimon c m gcc nosys)
 else()
-	add_library(${PLAYDATE_GAME_NAME} SHARED ${nim_source_files})
+	add_library(${PLAYDATE_GAME_NAME} SHARED $ENV{NIM_C_SOURCE_FILES})
 endif()
 
 include(${SDK}/C_API/buildsupport/playdate.cmake)
@@ -51,67 +49,55 @@ if (TOOLCHAIN STREQUAL "armgcc")
 		TARGET ${PLAYDATE_GAME_DEVICE} POST_BUILD
 		COMMAND ${CMAKE_STRIP} --strip-unneeded -R .comment -g
 		${PLAYDATE_GAME_DEVICE}.elf
-		-o ${CMAKE_CURRENT_SOURCE_DIR}/Source/pdex.elf
+		-o ${CMAKE_CURRENT_SOURCE_DIR}/source/pdex.elf
 	)
 
 	add_custom_command(
 		TARGET ${PLAYDATE_GAME_DEVICE} POST_BUILD
-		COMMAND ${PDC} Source ${PLAYDATE_GAME_NAME}.pdx
+		COMMAND ${PDC} source playdate.pdx
 		WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
 	)
 
 	set_property(
 		TARGET ${PLAYDATE_GAME_DEVICE} PROPERTY ADDITIONAL_CLEAN_FILES
-		${CMAKE_CURRENT_SOURCE_DIR}/${PLAYDATE_GAME_NAME}.pdx
+		${CMAKE_CURRENT_SOURCE_DIR}/playdate.pdx
 	)
 
 else ()
-
 	if (MSVC)
 		# MSVC not supported
 		message(FATAL_ERROR "MSVC is not supported! Use MinGW.")
-	
+
 	elseif(MINGW)
 		target_compile_definitions(${PLAYDATE_GAME_NAME} PUBLIC _WINDLL=1)
-		add_custom_command(
-			TARGET ${PLAYDATE_GAME_NAME} POST_BUILD
-			COMMAND ${CMAKE_COMMAND} -E copy
-			${CMAKE_CURRENT_BINARY_DIR}/lib${PLAYDATE_GAME_NAME}.dll
-			${CMAKE_CURRENT_SOURCE_DIR}/Source/pdex.dll)
+		set(DYLIB_EXT "dll")
 
 	elseif(APPLE)
 		target_sources(${PLAYDATE_GAME_NAME} PRIVATE ${SDK}/C_API/buildsupport/setup.c)
-		if(${CMAKE_GENERATOR} MATCHES "Xcode" )
-			set(BUILD_SUB_DIR $<CONFIG>/)
-			set_property(TARGET ${PLAYDATE_GAME_NAME} PROPERTY XCODE_SCHEME_ARGUMENTS \"${CMAKE_CURRENT_SOURCE_DIR}/${PLAYDATE_GAME_NAME}.pdx\")
-			set_property(TARGET ${PLAYDATE_GAME_NAME} PROPERTY XCODE_SCHEME_EXECUTABLE ${SDK}/bin/Playdate\ Simulator.app)
-		endif()
-
-		add_custom_command(
-			TARGET ${PLAYDATE_GAME_NAME} POST_BUILD
-			COMMAND ${CMAKE_COMMAND} -E copy
-			${CMAKE_CURRENT_BINARY_DIR}/${BUILD_SUB_DIR}lib${PLAYDATE_GAME_NAME}.dylib
-			${CMAKE_CURRENT_SOURCE_DIR}/Source/pdex.dylib)
+		set(DYLIB_EXT "dylib")
 
 	elseif(UNIX)
 		target_sources(${PLAYDATE_GAME_NAME} PRIVATE ${SDK}/C_API/buildsupport/setup.c)
-		add_custom_command(
-			TARGET ${PLAYDATE_GAME_NAME} POST_BUILD
-			COMMAND ${CMAKE_COMMAND} -E copy
-			${CMAKE_CURRENT_BINARY_DIR}/lib${PLAYDATE_GAME_NAME}.so
-			${CMAKE_CURRENT_SOURCE_DIR}/Source/pdex.so)
+		set(DYLIB_EXT "so")
+
 	else()
 		message(FATAL_ERROR "Platform not supported!")
 	endif()
 
+	add_custom_command(
+		TARGET ${PLAYDATE_GAME_NAME} POST_BUILD
+		COMMAND ${CMAKE_COMMAND} -E copy
+		${CMAKE_CURRENT_BINARY_DIR}/${BUILD_SUB_DIR}lib${PLAYDATE_GAME_NAME}.${DYLIB_EXT}
+		${CMAKE_CURRENT_SOURCE_DIR}/source/pdex.${DYLIB_EXT})
+
 	set_property(
 		TARGET ${PLAYDATE_GAME_NAME} PROPERTY ADDITIONAL_CLEAN_FILES
-		${CMAKE_CURRENT_SOURCE_DIR}/${PLAYDATE_GAME_NAME}.pdx
+		${CMAKE_CURRENT_SOURCE_DIR}/playdate.pdx
 	)
 
 	add_custom_command(
 		TARGET ${PLAYDATE_GAME_NAME} POST_BUILD
-		COMMAND ${PDC} ${CMAKE_CURRENT_SOURCE_DIR}/Source
-		${CMAKE_CURRENT_SOURCE_DIR}/${PLAYDATE_GAME_NAME}.pdx)
+		COMMAND ${PDC} ${CMAKE_CURRENT_SOURCE_DIR}/source
+		${CMAKE_CURRENT_SOURCE_DIR}/playdate.pdx)
 
 endif ()

src/playdate/build/config.nim

@@ -37,6 +37,7 @@ when defined(simulator):
     switch("checks", "on")
     switch("index", "on")
     switch("debuginfo", "on")
+    switch("stackTrace", "on")
     switch("lineTrace", "on")
     switch("lineDir", "on")
     switch("debugger", "native")