+# The entry point for rule parsing
+# parses a rule in the format <keyboard>-<subproject>-<keymap>-<target>
+# but this particular function only deals with the first <keyboard> part
+define PARSE_RULE
+ RULE := $1
+ COMMANDS :=
+ # If the rule starts with allkb, then continue the parsing from
+ # PARSE_ALL_KEYBOARDS
+ ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkb),true)
+ $$(eval $$(call PARSE_ALL_KEYBOARDS))
+ else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
+ $$(eval $$(call PARSE_TEST))
+ # If the rule starts with the name of a known keyboard, then continue
+ # the parsing from PARSE_KEYBOARD
+ else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
+ $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
+ # Otherwise use the KEYBOARD variable, which is determined either by
+ # the current directory you run make from, or passed in as an argument
+ else ifneq ($$(KEYBOARD),)
+ $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
+ else
+ $$(info make: *** No rule to make target '$1'. Stop.)
+ # Notice the tab instead of spaces below!
+ exit 1
+ endif
+endef
+
+# $1 = Keyboard
+# Parses a rule in the format <subproject>-<keymap>-<target>
+# the keyboard is already known when entering this function
+define PARSE_KEYBOARD
+ CURRENT_KB := $1
+ # A subproject is any keyboard subfolder with a makefile
+ SUBPROJECTS := $$(notdir $$(patsubst %/Makefile,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/*/Makefile)))
+ # if the rule starts with allsp, then continue with looping over all subprojects
+ ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allsp),true)
+ $$(eval $$(call PARSE_ALL_SUBPROJECTS))
+ # A special case for matching the defaultsp (default subproject)
+ else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,defaultsp),true)
+ $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
+ # If the rule starts with the name of a known subproject
+ else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(SUBPROJECTS)),true)
+ $$(eval $$(call PARSE_SUBPROJECT,$$(MATCHED_ITEM)))
+ # Try to use the SUBPROJECT variable, which is either determined by the
+ # directory which invoked make, or passed as an argument to make
+ else ifneq ($$(SUBPROJECT),)
+ $$(eval $$(call PARSE_SUBPROJECT,$$(SUBPROJECT)))
+ # If there's no matching subproject, we assume it's the default
+ # This will allow you to leave the subproject part of the target out
+ else
+ $$(eval $$(call PARSE_SUBPROJECT,))
+ endif
+endef
+
+# if we are going to compile all keyboards, match the rest of the rule
+# for each of them
+define PARSE_ALL_KEYBOARDS
+ $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
+endef
+
+# $1 Subproject
+# When entering this, the keyboard and subproject are known, so now we need
+# to determine which keymaps are going to get compiled
+define PARSE_SUBPROJECT
+ # If we want to compile the default subproject, then we need to
+ # include the correct makefile to determine the actual name of it
+ CURRENT_SP := $1
+ ifeq ($$(CURRENT_SP),)
+ CURRENT_SP := defaultsp
+ endif
+ ifeq ($$(CURRENT_SP),defaultsp)
+ SUBPROJECT_DEFAULT=
+ $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/Makefile)
+ CURRENT_SP := $$(SUBPROJECT_DEFAULT)
+ endif
+ # If current subproject is empty (the default was not defined), and we have a list of subproject
+ # then make all of them
+ ifeq ($$(CURRENT_SP),)
+ ifneq ($$(SUBPROJECTS),)
+ CURRENT_SP := allsp
+ endif
+ endif
+ # The special allsp is handled later
+ ifneq ($$(CURRENT_SP),allsp)
+ # get a list of all keymaps
+ KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/keymaps/*/.)))
+ ifneq ($$(CURRENT_SP),)
+ # if the subproject is defined, then also look for keymaps inside the subproject folder
+ SP_KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/$$(CURRENT_SP)/keymaps/*/.)))
+ KEYMAPS := $$(sort $$(KEYMAPS) $$(SP_KEYMAPS))
+ endif
+ # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
+ # compile all the keymaps
+ ifeq ($$(RULE),)
+ $$(eval $$(call PARSE_ALL_KEYMAPS))
+ # The same if allkm was specified
+ else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkm),true)
+ $$(eval $$(call PARSE_ALL_KEYMAPS))
+ # Try to match the specified keyamp with the list of known keymaps
+ else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
+ $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
+ # Otherwise try to match the keymap from the current folder, or arguments to the make command
+ else ifneq ($$(KEYMAP),)
+ $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
+ # No matching keymap found, so we assume that the rest of the rule is the target
+ # If we haven't been able to parse out a subproject, then make all of them
+ # This is consistent with running make without any arguments from the keyboard
+ # folder
+ else ifeq ($1,)
+ $$(eval $$(call PARSE_ALL_SUBPROJECTS))
+ # Otherwise, make all keymaps, again this is consistent with how it works without
+ # any arguments
+ else
+ $$(eval $$(call PARSE_ALL_KEYMAPS))
+ endif
+ else
+ # As earlier mentioned when allsb is specified, we call our self recursively
+ # for all of the subprojects
+ $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$(SUBPROJECTS)))
+ endif
+endef
+
+# If we want to parse all subprojects, but the keyboard doesn't have any,
+# then use defaultsp instead
+define PARSE_ALL_SUBPROJECTS
+ ifeq ($$(SUBPROJECTS),)
+ $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
+ else
+ $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
+ endif
+endef
+
+# $1 Keymap
+# This is the meat of compiling a keyboard, when entering this, everything is known
+# keyboard, subproject, and keymap
+# Note that we are not directly calling the command here, but instead building a list,
+# which will later be processed
+define PARSE_KEYMAP
+ CURRENT_KM = $1
+ # The rest of the rule is the target
+ # Remove the leading "-" from the target, as it acts as a separator
+ MAKE_TARGET := $$(patsubst -%,%,$$(RULE))
+ # We need to generate an unique indentifer to append to the COMMANDS list
+ COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB)_SUBPROJECT_$(CURRENT_SP)_KEYMAP_$$(CURRENT_KM)
+ # If we are compiling a keyboard without a subproject, we want to display just the name
+ # of the keyboard, otherwise keyboard/subproject
+ ifeq ($$(CURRENT_SP),)
+ KB_SP := $(CURRENT_KB)
+ else
+ KB_SP := $(CURRENT_KB)/$$(CURRENT_SP)
+ endif
+ # Format it in bold
+ KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
+ # Specify the variables that we are passing forward to submake
+ MAKE_VARS := KEYBOARD=$$(CURRENT_KB) SUBPROJECT=$$(CURRENT_SP) KEYMAP=$$(CURRENT_KM)
+ # And the first part of the make command
+ MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
+ # The message to display
+ MAKE_MSG := $$(MSG_MAKE_KB)
+ # We run the command differently, depending on if we want more output or not
+ # The true version for silent output and the false version otherwise
+ $$(eval $$(call BUILD))
+endef
+
+define BUILD
+ MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
+ COMMANDS += $$(COMMAND)
+ COMMAND_true_$$(COMMAND) := \
+ printf "$$(MAKE_MSG)" | \
+ $$(MAKE_MSG_FORMAT); \
+ LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
+ if [ $$$$? -gt 0 ]; \
+ then $$(PRINT_ERROR_PLAIN); \
+ elif [ "$$$$LOG" != "" ] ; \
+ then $$(PRINT_WARNING_PLAIN); \
+ else \
+ $$(PRINT_OK); \
+ fi;
+ COMMAND_false_$$(COMMAND) := \
+ printf "$$(MAKE_MSG)\n\n"; \
+ $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
+ if [ $$$$? -gt 0 ]; \
+ then error_occurred=1; \
+ fi;
+endef
+
+# Just parse all the keymaps for a specific keyboard
+define PARSE_ALL_KEYMAPS
+ $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
+endef
+
+define BUILD_TEST
+ TEST_NAME := $1
+ MAKE_TARGET := $2
+ COMMAND := $1
+ MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
+ MAKE_VARS := TEST=$$(TEST_NAME)
+ MAKE_MSG := $$(MSG_MAKE_TEST)
+ $$(eval $$(call BUILD))
+ ifneq ($$(MAKE_TARGET),clean)
+ TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
+ TESTS += $$(TEST_NAME)
+ TEST_MSG := $$(MSG_TEST)
+ $$(TEST_NAME)_COMMAND := \
+ printf "$$(TEST_MSG)\n"; \
+ $$(TEST_EXECUTABLE); \
+ if [ $$$$? -gt 0 ]; \
+ then error_occurred=1; \
+ fi; \
+ printf "\n";
+ endif
+endef
+
+define PARSE_TEST
+ TESTS :=
+ TEST_NAME := $$(firstword $$(subst -, ,$$(RULE)))
+ TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME)-,,$$(RULE)))
+ ifeq ($$(TEST_NAME),all)
+ MATCHED_TESTS := $$(TEST_LIST)
+ else
+ MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
+ endif
+ $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
+endef
+
+
+# Set the silent mode depending on if we are trying to compile multiple keyboards or not
+# By default it's on in that case, but it can be overridden by specifying silent=false
+# from the command line
+define SET_SILENT_MODE
+ ifdef SUB_IS_SILENT
+ SILENT_MODE := $(SUB_IS_SILENT)
+ else ifeq ($$(words $$(COMMANDS)),1)
+ SILENT_MODE := false
+ else
+ SILENT_MODE := true
+ endif
+endef
+
+include $(ROOT_DIR)/message.mk
+
+# The empty line is important here, as it will force a new shell to be created for each command
+# Otherwise the command line will become too long with a lot of keyboards and keymaps
+define RUN_COMMAND
++error_occurred=0;\
+$(COMMAND_$(SILENT_MODE)_$(COMMAND))\
+if [ $$error_occurred -gt 0 ]; then echo $$error_occurred > $(ERROR_FILE); fi;
+
+
+endef
+define RUN_TEST
++error_occurred=0;\
+$($(TEST)_COMMAND)\
+if [ $$error_occurred -gt 0 ]; then echo $$error_occurred > $(ERROR_FILE); fi;
+
+endef
+
+# Allow specifying just the subproject, in the keyboard directory, which will compile all keymaps
+SUBPROJECTS := $(notdir $(patsubst %/Makefile,%,$(wildcard ./*/Makefile)))
+.PHONY: $(SUBPROJECTS)
+$(SUBPROJECTS): %: %-allkm
+
+# Let's match everything, we handle all the rule parsing ourselves
+.PHONY: %
+%:
+ # Check if we have the CMP tool installed
+ cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
+ # Check if the submodules are dirty, and display a warning if they are
+ifndef SKIP_GIT
+ git submodule status --recursive 2>/dev/null | \
+ while IFS= read -r x; do \
+ case "$$x" in \
+ \ *) ;; \
+ *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
+ esac \
+ done