5 # Allow the silent with lower caps to work the same way as upper caps
11 SUB_IS_SILENT := $(SILENT)
14 # We need to make sure that silent is always turned off at the top level
15 # Otherwise the [OK], [ERROR] and [WARN] messags won't be displayed correctly
16 override SILENT := false
18 ON_ERROR := error_occured=1
20 STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
21 ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
22 ROOT_DIR := $(dir $(ROOT_MAKEFILE))
26 ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
27 ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
28 ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
29 ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
30 STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
34 # Helper function to process the newt element of a space separated path
35 # It works a bit like the traditional functional head tail
36 # so the CURRENT_PATH_ELEMENT will beome the new head
37 # and the PATH_ELEMENTS are the rest that are still unprocessed
38 define NEXT_PATH_ELEMENT
39 $$(eval CURRENT_PATH_ELEMENT := $$(firstword $$(PATH_ELEMENTS)))
40 $$(eval PATH_ELEMENTS := $$(wordlist 2,9999,$$(PATH_ELEMENTS)))
43 # We change the / to spaces so that we more easily can work with the elements
45 PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
46 # Initialize the path elements list for further processing
47 $(eval $(call NEXT_PATH_ELEMENT))
49 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
50 # variables depending on which directory you stand in.
51 # It's really a very simple if else chain, if you squint enough,
52 # but the makefile syntax makes it very verbose.
53 # If we are in a subfolder of keyboards
54 ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
55 $(eval $(call NEXT_PATH_ELEMENT))
56 KEYBOARD := $(CURRENT_PATH_ELEMENT)
57 $(eval $(call NEXT_PATH_ELEMENT))
58 # If we are in a subfolder of keymaps, or in other words in a keymap
60 ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
61 $(eval $(call NEXT_PATH_ELEMENT))
62 KEYMAP := $(CURRENT_PATH_ELEMENT)
63 # else if we are not in the keyboard folder itself
64 else ifneq ($(CURRENT_PATH_ELEMENT),)
65 # the we can assume it's a subproject, as no other folders
66 # should have make files in them
67 SUBPROJECT := $(CURRENT_PATH_ELEMENT)
68 $(eval $(call NEXT_PATH_ELEMENT))
69 # if we are inside a keymap folder of a subproject
70 ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
71 $(eval $(call NEXT_PATH_ELEMENT))
72 KEYMAP := $(CURRENT_PATH_ELEMENT)
77 # Only consider folders with makefiles, to prevent errors in case there are extra folders
78 KEYBOARDS := $(notdir $(patsubst %/Makefile,%,$(wildcard $(ROOT_DIR)/keyboards/*/Makefile)))
80 #Compability with the old make variables, anything you specify directly on the command line
81 # always overrides the detected folders
83 KEYBOARD := $(keyboard)
89 SUBPROJECT := $(subproject)
95 # Uncomment these for debugging
96 #$(info Keyboard: $(KEYBOARD))
97 #$(info Keymap: $(KEYMAP))
98 #$(info Subproject: $(SUBPROJECT))
99 #$(info Keyboards: $(KEYBOARDS))
102 # Set the default goal depening on where we are running make from
103 # this handles the case where you run make without any arguments
106 ifeq ($(SUBPROJECT),)
107 # Inside a keymap folder, just build the keymap, with the
109 .DEFAULT_GOAL := $(KEYBOARD)-$(KEYMAP)
111 # Inside a subproject keyamp folder, build the keymap
112 # for that subproject
113 .DEFAULT_GOAL := $(KEYBOARD)-$(SUBPROJECT)-$(KEYMAP)
115 else ifneq ($(SUBPROJECT),)
116 # Inside a subproject folder, build all keymaps for that subproject
117 .DEFAULT_GOAL := $(KEYBOARD)-$(SUBPROJECT)-allkm
118 else ifneq ($(KEYBOARD),)
119 # Inside a keyboard folder, build all keymaps for all subprojects
120 # Note that this is different from the old behaviour, which would
121 # build only the default keymap of the default keyboard
122 .DEFAULT_GOAL := $(KEYBOARD)-allsp-allkm
126 # Compare the start of the RULE variable with the first argument($1)
127 # If the rules equals $1 or starts with $1-, RULE_FOUND is set to true
128 # and $1 is removed from the RULE variable
129 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
130 # The function is a bit tricky, since there's no built in $(startswith) function
131 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
136 STARTDASH_REMOVED=$$(subst START$1-,,START$$(RULE))
137 ifneq ($$(STARTDASH_REMOVED),START$$(RULE))
139 RULE := $$(STARTDASH_REMOVED)
146 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
147 # a function that returns the value
148 COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
151 # Recursively try to find a match for the start of the rule to be checked
152 # $1 The list to be checked
153 # If a match is found, then RULE_FOUND is set to true
154 # and MATCHED_ITEM to the item that was matched
155 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
157 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
158 MATCHED_ITEM := $$(firstword $1)
160 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
165 # A recursive helper function for finding the longest match
166 # $1 The list to be checed
167 # It works by always removing the currently matched item from the list
168 # and call itself recursively, until a match is found
169 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
170 # Stop the recursion when the list is empty
172 RULE_BEFORE := $$(RULE)
173 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
174 # If a match is found in the current list, otherwise just return what we had before
175 ifeq ($$(RULE_FOUND),true)
176 # Save the best match so far and call itself recursivel
177 BEST_MATCH := $$(MATCHED_ITEM)
178 BEST_MATCH_RULE := $$(RULE)
180 RULE := $$(RULE_BEFORE)
181 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
187 # Recursively try to find the longest match for the start of the rule to be checked
188 # $1 The list to be checked
189 # If a match is found, then RULE_FOUND is set to true
190 # and MATCHED_ITEM to the item that was matched
191 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
193 $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
194 ifneq ($$(BEST_MATCH),)
196 RULE := $$(BEST_MATCH_RULE)
197 MATCHED_ITEM := $$(BEST_MATCH)
204 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
205 TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
207 define ALL_IN_LIST_LOOP
208 OLD_RULE$1 := $$(RULE)
209 $$(eval $$(call $1,$$(ITEM$1)))
210 RULE := $$(OLD_RULE$1)
213 define PARSE_ALL_IN_LIST
214 $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
217 # The entry point for rule parsing
218 # parses a rule in the format <keyboard>-<subproject>-<keymap>-<target>
219 # but this particular function only deals with the first <keyboard> part
223 # If the rule starts with allkb, then continue the parsing from
224 # PARSE_ALL_KEYBOARDS
225 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkb),true)
226 $$(eval $$(call PARSE_ALL_KEYBOARDS))
227 # If the rule starts with the name of a known keyboard, then continue
228 # the parsing from PARSE_KEYBOARD
229 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
230 $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
231 # Otherwise use the KEYBOARD variable, which is determined either by
232 # the current directory you run make from, or passed in as an argument
233 else ifneq ($$(KEYBOARD),)
234 $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
236 $$(info make: *** No rule to make target '$1'. Stop.)
237 # Notice the tab instead of spaces below!
243 # Parses a rule in the format <subproject>-<keymap>-<target>
244 # the keyboard is already known when entering this function
245 define PARSE_KEYBOARD
247 # A subproject is any keyboard subfolder with a makefile
248 SUBPROJECTS := $$(notdir $$(patsubst %/Makefile,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/*/Makefile)))
249 # if the rule starts with allsp, then continue with looping over all subprojects
250 ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allsp),true)
251 $$(eval $$(call PARSE_ALL_SUBPROJECTS))
252 # A special case for matching the defaultsp (default subproject)
253 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,defaultsp),true)
254 $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
255 # If the rule starts with the name of a known subproject
256 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(SUBPROJECTS)),true)
257 $$(eval $$(call PARSE_SUBPROJECT,$$(MATCHED_ITEM)))
258 # Try to use the SUBPROJECT variable, which is either determined by the
259 # directory which invoked make, or passed as an argument to make
260 else ifneq ($$(SUBPROJECT),)
261 $$(eval $$(call PARSE_SUBPROJECT,$$(SUBPROJECT)))
262 # If there's no matching subproject, we assume it's the default
263 # This will allow you to leave the subproject part of the target out
265 $$(eval $$(call PARSE_SUBPROJECT,))
269 # if we are going to compile all keyboards, match the rest of the rule
271 define PARSE_ALL_KEYBOARDS
272 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
276 # When entering this, the keyboard and subproject are known, so now we need
277 # to determine which keymaps are going to get compiled
278 define PARSE_SUBPROJECT
279 # If we want to compile the default subproject, then we need to
280 # include the correct makefile to determine the actual name of it
282 ifeq ($$(CURRENT_SP),)
283 CURRENT_SP := defaultsp
285 ifeq ($$(CURRENT_SP),defaultsp)
287 $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/Makefile)
288 CURRENT_SP := $$(SUBPROJECT_DEFAULT)
290 # If current subproject is empty (the default was not defined), and we have a list of subproject
291 # then make all of them
292 ifeq ($$(CURRENT_SP),)
293 ifneq ($$(SUBPROJECTS),)
297 # The special allsp is handled later
298 ifneq ($$(CURRENT_SP),allsp)
299 # get a list of all keymaps
300 KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/keymaps/*/.)))
301 ifneq ($$(CURRENT_SP),)
302 # if the subproject is defined, then also look for keymaps inside the subproject folder
303 SP_KEYMAPS := $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/$$(CURRENT_SP)/keymaps/*/.)))
304 KEYMAPS := $$(sort $$(KEYMAPS) $$(SP_KEYMAPS))
306 # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
307 # compile all the keymaps
309 $$(eval $$(call PARSE_ALL_KEYMAPS))
310 # The same if allkm was specified
311 else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,allkm),true)
312 $$(eval $$(call PARSE_ALL_KEYMAPS))
313 # Try to match the specified keyamp with the list of known keymaps
314 else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
315 $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
316 # Otherwise try to match the keymap from the current folder, or arguments to the make command
317 else ifneq ($$(KEYMAP),)
318 $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
319 # No matching keymap found, so we assume that the rest of the rule is the target
320 # If we haven't been able to parse out a subproject, then make all of them
321 # This is consistent with running make without any arguments from the keyboard
324 $$(eval $$(call PARSE_ALL_SUBPROJECTS))
325 # Otherwise, make all keymaps, again this is consistent with how it works without
328 $$(eval $$(call PARSE_ALL_KEYMAPS))
331 # As earlier mentione,d when allsb is specified, we call our self recursively
332 # for all of the subprojects
333 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$(SUBPROJECTS)))
337 # If we want to parse all subprojects, but the keyboard doesn't have any,
338 # then use defaultsp instead
339 define PARSE_ALL_SUBPROJECTS
340 ifeq ($$(SUBPROJECTS),)
341 $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
343 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
348 # This is the meat of compiling a keyboard, when entering this, everything is known
349 # keyboard, subproject, and keymap
350 # Note that we are not directly calling the command here, but instead building a list,
351 # which will later be processed
354 # The rest of the rule is the target
355 # Remove the leading "-" from the target, as it acts as a separator
356 MAKE_TARGET := $$(patsubst -%,%,$$(RULE))
357 # We need to generate an unique indentifer to append to the COMMANDS list
358 COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB)_SUBPROJECT_$(CURRENT_SP)_KEYMAP_$$(CURRENT_KM)
359 COMMANDS += $$(COMMAND)
360 # If we are compiling a keyboard without a subproject, we want to display just the name
361 # of the keyboard, otherwise keyboard/subproject
362 ifeq ($$(CURRENT_SP),)
363 KB_SP := $(CURRENT_KB)
365 KB_SP := $(CURRENT_KB)/$$(CURRENT_SP)
368 KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
369 # Specify the variables that we are passing forward to submake
370 MAKE_VARS := KEYBOARD=$$(CURRENT_KB) SUBPROJECT=$$(CURRENT_SP) KEYMAP=$$(CURRENT_KM)
371 MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
372 # And the first part of the make command
373 MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
374 # The message to display
375 MAKE_MSG := $$(MSG_MAKE_KB)
376 # We run the command differently, depending on if we want more output or not
377 # The true version for silent output and the false version otherwise
378 COMMAND_true_$$(COMMAND) := \
379 printf "$$(MAKE_MSG)" | \
380 $$(MAKE_MSG_FORMAT); \
381 LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
382 if [ $$$$? -gt 0 ]; \
383 then $$(PRINT_ERROR_PLAIN); \
384 elif [ "$$$$LOG" != "" ] ; \
385 then $$(PRINT_WARNING_PLAIN); \
389 COMMAND_false_$$(COMMAND) := \
390 printf "$$(MAKE_MSG)\n\n"; \
391 $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false;
394 # Just parse all the keymaps for a specifc keyboard
395 define PARSE_ALL_KEYMAPS
396 $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
399 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
400 # By default it's on in that case, but it can be overriden by specifying silent=false
401 # from the command line
402 define SET_SILENT_MODE
404 SILENT_MODE := $(SUB_IS_SILENT)
405 else ifeq ($$(words $$(COMMANDS)),1)
412 include $(ROOT_DIR)/message.mk
415 $(COMMAND_$(SILENT_MODE)_$(COMMAND))
417 # Allow specifying just the subproject, in the keyboard directory, which will compile all keymaps
418 SUBPROJECTS := $(notdir $(patsubst %/Makefile,%,$(wildcard ./*/Makefile)))
419 .PHONY: $(SUBPROJECTS)
420 $(SUBPROJECTS): %: %-allkm
422 # Let's match everything, we handle all the rule parsing ourselves
425 # Check if we have the CMP tool installed
426 cmp --version >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
427 # Check if the submodules are dirty, and display a warning if they are
428 git submodule status --recursive 2>/dev/null | \
429 while IFS= read -r x; do \
432 *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
435 $(eval $(call PARSE_RULE,$@))
436 $(eval $(call SET_SILENT_MODE))
437 # Run all the commands in the same shell, notice the + at the first line
438 # it has to be there to allow parallel execution of the submake
439 # This always tries to compile everything, even if error occurs in the middle
440 # But we return the error code at the end, to trigger travis failures
442 $(foreach COMMAND,$(COMMANDS),$(RUN_COMMAND)) \
443 if [ $$error_occured -gt 0 ]; then printf "$(MSG_ERRORS)" & exit $$error_occured; fi
446 # All should compile everything
450 # Define some shortcuts, mostly for compability with the old syntax
451 .PHONY: all-keyboards
452 all-keyboards: allkb-allsp-allkm
454 .PHONY: all-keyboards-defaults
455 all-keyboards-defaults: allkb-allsp-default
458 # Generate the version.h file
459 GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
460 BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
461 $(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
462 $(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)