]> git.donarmstrong.com Git - qmk_firmware.git/blob - Makefile
make clean should remove .bin and .hex too
[qmk_firmware.git] / Makefile
1 ifndef VERBOSE
2 .SILENT:
3 endif
4
5 # Never run this makefile in parallel, as it could screw things up
6 # It won't affect the submakes, so you still get the speedup from specifying -jx
7 .NOTPARALLEL:
8
9 # Allow the silent with lower caps to work the same way as upper caps
10 ifdef silent
11     SILENT = $(silent)
12 endif
13
14 ifdef SILENT
15     SUB_IS_SILENT := $(SILENT)
16 endif
17
18 # We need to make sure that silent is always turned off at the top level
19 # Otherwise the [OK], [ERROR] and [WARN] messages won't be displayed correctly
20 override SILENT := false
21
22 ifndef SUB_IS_SILENT
23 QMK_VERSION := $(shell git describe --abbrev=0 --tags 2>/dev/null)
24 ifneq ($(QMK_VERSION),)
25 $(info QMK Firmware $(QMK_VERSION))
26 endif
27 endif
28
29 ON_ERROR := error_occurred=1
30
31 BREAK_ON_ERRORS = no
32
33 STARTING_MAKEFILE := $(firstword $(MAKEFILE_LIST))
34 ROOT_MAKEFILE := $(lastword $(MAKEFILE_LIST))
35 ROOT_DIR := $(dir $(ROOT_MAKEFILE))
36 ifeq ($(ROOT_DIR),)
37     ROOT_DIR := .
38 endif
39 ABS_STARTING_MAKEFILE := $(abspath $(STARTING_MAKEFILE))
40 ABS_ROOT_MAKEFILE := $(abspath $(ROOT_MAKEFILE))
41 ABS_STARTING_DIR := $(dir $(ABS_STARTING_MAKEFILE))
42 ABS_ROOT_DIR := $(dir $(ABS_ROOT_MAKEFILE))
43 STARTING_DIR := $(subst $(ABS_ROOT_DIR),,$(ABS_STARTING_DIR))
44 BUILD_DIR := $(ROOT_DIR)/.build
45 TEST_DIR := $(BUILD_DIR)/test
46 ERROR_FILE := $(BUILD_DIR)/error_occurred
47
48 MAKEFILE_INCLUDED=yes
49
50 # Helper function to process the newt element of a space separated path
51 # It works a bit like the traditional functional head tail
52 # so the CURRENT_PATH_ELEMENT will become the new head
53 # and the PATH_ELEMENTS are the rest that are still unprocessed
54 define NEXT_PATH_ELEMENT
55     $$(eval CURRENT_PATH_ELEMENT := $$(firstword  $$(PATH_ELEMENTS)))
56     $$(eval PATH_ELEMENTS := $$(wordlist  2,9999,$$(PATH_ELEMENTS)))
57 endef
58
59 # We change the / to spaces so that we more easily can work with the elements
60 # separately
61 PATH_ELEMENTS := $(subst /, ,$(STARTING_DIR))
62 # Initialize the path elements list for further processing
63 $(eval $(call NEXT_PATH_ELEMENT))
64
65 # This function sets the KEYBOARD; KEYMAP and SUBPROJECT to the correct
66 # variables depending on which directory you stand in.
67 # It's really a very simple if else chain, if you squint enough,
68 # but the makefile syntax makes it very verbose.
69 # If we are in a subfolder of keyboards
70 #
71 # *** No longer needed **
72 #
73 # ifeq ($(CURRENT_PATH_ELEMENT),keyboards)
74 #     $(eval $(call NEXT_PATH_ELEMENT))
75 #     KEYBOARD := $(CURRENT_PATH_ELEMENT)
76 #     $(eval $(call NEXT_PATH_ELEMENT))
77 #     # If we are in a subfolder of keymaps, or in other words in a keymap
78 #     # folder
79 #     ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
80 #         $(eval $(call NEXT_PATH_ELEMENT))
81 #         KEYMAP := $(CURRENT_PATH_ELEMENT)
82 #      # else if we are not in the keyboard folder itself
83 #     else ifneq ($(CURRENT_PATH_ELEMENT),)
84 #         # the we can assume it's a subproject, as no other folders
85 #         # should have make files in them
86 #         SUBPROJECT := $(CURRENT_PATH_ELEMENT)
87 #         $(eval $(call NEXT_PATH_ELEMENT))
88 #         # if we are inside a keymap folder of a subproject
89 #         ifeq ($(CURRENT_PATH_ELEMENT),keymaps)
90 #             $(eval $(call NEXT_PATH_ELEMENT))
91 #             KEYMAP := $(CURRENT_PATH_ELEMENT)
92 #         endif
93 #     endif
94 # endif
95
96 define GET_KEYBOARDS
97     All_RULES_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/rules.mk))
98     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
99     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/rules.mk))
100     All_RULES_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/rules.mk))
101
102     KEYMAPS_MK := $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/keymaps/*/rules.mk))
103     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/keymaps/*/rules.mk))
104     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/keymaps/*/rules.mk))
105     KEYMAPS_MK += $$(patsubst $(ROOT_DIR)/keyboards/%/rules.mk,%,$$(wildcard $(ROOT_DIR)/keyboards/*/*/*/*/keymaps/*/rules.mk))
106
107     KEYBOARDS := $$(sort $$(filter-out $$(KEYMAPS_MK), $$(All_RULES_MK)))
108 endef
109
110 $(eval $(call GET_KEYBOARDS))
111
112 # Only consider folders with makefiles, to prevent errors in case there are extra folders
113 #KEYBOARDS += $(patsubst $(ROOD_DIR)/keyboards/%/rules.mk,%,$(wildcard $(ROOT_DIR)/keyboards/*/*/rules.mk))
114
115 list-keyboards:
116         echo $(KEYBOARDS)
117         exit 0
118
119 define PRINT_KEYBOARD
120         $(info $(PRINTING_KEYBOARD))
121 endef
122
123 generate-keyboards-file:
124         $(foreach PRINTING_KEYBOARD,$(KEYBOARDS),$(eval $(call PRINT_KEYBOARD)))
125         exit 0
126
127 clean:
128         echo 'Deleting .build/ ...'
129         rm -rf $(BUILD_DIR)
130         echo 'Deleting *.bin and *.hex ...'
131         rm -f *.bin *.hex
132         echo 'Done.'
133         exit 0
134
135 #Compatibility with the old make variables, anything you specify directly on the command line
136 # always overrides the detected folders
137 ifdef keyboard
138     KEYBOARD := $(keyboard)
139 endif
140 ifdef keymap
141     KEYMAP := $(keymap)
142 endif
143
144 # Uncomment these for debugging
145 # $(info Keyboard: $(KEYBOARD))
146 # $(info Keymap: $(KEYMAP))
147 # $(info Subproject: $(SUBPROJECT))
148 # $(info Keyboards: $(KEYBOARDS))
149
150
151 # Set the default goal depending on where we are running make from
152 # this handles the case where you run make without any arguments
153 .DEFAULT_GOAL := all:all
154 ifneq ($(KEYMAP),)
155     .DEFAULT_GOAL := $(KEYBOARD):$(KEYMAP)
156 else ifneq ($(KEYBOARD),)
157      # Inside a keyboard folder, build all keymaps for all subprojects
158      # Note that this is different from the old behaviour, which would
159      # build only the default keymap of the default keyboard
160     .DEFAULT_GOAL := $(KEYBOARD):all
161 endif
162
163
164 # Compare the start of the RULE variable with the first argument($1)
165 # If the rules equals $1 or starts with $1:, RULE_FOUND is set to true
166 #     and $1 is removed from the RULE variable
167 # Otherwise the RULE_FOUND variable is set to false, and RULE left as it was
168 # The function is a bit tricky, since there's no built in $(startswith) function
169 define COMPARE_AND_REMOVE_FROM_RULE_HELPER
170     ifeq ($1,$$(RULE))
171         RULE:=
172         RULE_FOUND := true
173     else
174         STARTCOLON_REMOVED=$$(subst START$1:,,START$$(RULE))
175         ifneq ($$(STARTCOLON_REMOVED),START$$(RULE))
176             RULE_FOUND := true
177             RULE := $$(STARTCOLON_REMOVED)
178         else
179             RULE_FOUND := false
180         endif
181     endif
182 endef
183
184 # This makes it easier to call COMPARE_AND_REMOVE_FROM_RULE, since it makes it behave like
185 # a function that returns the value
186 COMPARE_AND_REMOVE_FROM_RULE = $(eval $(call COMPARE_AND_REMOVE_FROM_RULE_HELPER,$1))$(RULE_FOUND)
187
188
189 # Recursively try to find a match for the start of the rule to be checked
190 # $1 The list to be checked
191 # If a match is found, then RULE_FOUND is set to true
192 # and MATCHED_ITEM to the item that was matched
193 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER3
194     ifneq ($1,)
195         ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,$$(firstword $1)),true)
196             MATCHED_ITEM := $$(firstword $1)
197         else
198             $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$$(wordlist 2,9999,$1)))
199         endif
200     endif
201 endef
202
203 # A recursive helper function for finding the longest match
204 # $1 The list to be checked
205 # It works by always removing the currently matched item from the list
206 # and call itself recursively, until a match is found
207 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER2
208     # Stop the recursion when the list is empty
209     ifneq ($1,)
210         RULE_BEFORE := $$(RULE)
211         $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER3,$1))
212         # If a match is found in the current list, otherwise just return what we had before
213         ifeq ($$(RULE_FOUND),true)
214             # Save the best match so far and call itself recursively
215             BEST_MATCH := $$(MATCHED_ITEM)
216             BEST_MATCH_RULE := $$(RULE)
217             RULE_FOUND := false
218             RULE := $$(RULE_BEFORE)
219             $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$$(filter-out $$(MATCHED_ITEM),$1)))
220         endif
221      endif
222 endef
223
224
225 # Recursively try to find the longest match for the start of the rule to be checked
226 # $1 The list to be checked
227 # If a match is found, then RULE_FOUND is set to true
228 # and MATCHED_ITEM to the item that was matched
229 define TRY_TO_MATCH_RULE_FROM_LIST_HELPER
230     BEST_MATCH :=
231     $$(eval $$(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER2,$1))
232     ifneq ($$(BEST_MATCH),)
233         RULE_FOUND := true
234         RULE := $$(BEST_MATCH_RULE)
235         MATCHED_ITEM := $$(BEST_MATCH)
236     else
237         RULE_FOUND := false
238         MATCHED_ITEM :=
239     endif
240 endef
241
242 # Make it easier to call TRY_TO_MATCH_RULE_FROM_LIST
243 TRY_TO_MATCH_RULE_FROM_LIST = $(eval $(call TRY_TO_MATCH_RULE_FROM_LIST_HELPER,$1))$(RULE_FOUND)
244
245 define ALL_IN_LIST_LOOP
246     OLD_RULE$1 := $$(RULE)
247     $$(eval $$(call $1,$$(ITEM$1)))
248     RULE := $$(OLD_RULE$1)
249 endef
250
251 define PARSE_ALL_IN_LIST
252     $$(foreach ITEM$1,$2,$$(eval $$(call ALL_IN_LIST_LOOP,$1)))
253 endef
254
255 # The entry point for rule parsing
256 # parses a rule in the format <keyboard>:<keymap>:<target>
257 # but this particular function only deals with the first <keyboard> part
258 define PARSE_RULE
259     RULE := $1
260     COMMANDS :=
261     # If the rule starts with all, then continue the parsing from
262     # PARSE_ALL_KEYBOARDS
263     ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
264         $$(eval $$(call PARSE_ALL_KEYBOARDS))
265     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,test),true)
266         $$(eval $$(call PARSE_TEST))
267     # If the rule starts with the name of a known keyboard, then continue
268     # the parsing from PARSE_KEYBOARD
269     else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYBOARDS)),true)
270         $$(eval $$(call PARSE_KEYBOARD,$$(MATCHED_ITEM)))
271     # Otherwise use the KEYBOARD variable, which is determined either by
272     # the current directory you run make from, or passed in as an argument
273     else ifneq ($$(KEYBOARD),)
274         $$(eval $$(call PARSE_KEYBOARD,$$(KEYBOARD)))
275     else
276         $$(info make: *** No rule to make target '$1'. Stop.)
277         $$(info |)
278         $$(info |  QMK's make format recently changed to use folder locations and colons:)
279         $$(info |     make project_folder:keymap[:target])
280         $$(info |  Examples:)
281         $$(info |     make planck/rev4:default:dfu)
282         $$(info |     make planck:default)
283         $$(info |)
284     endif
285 endef
286
287 # $1 = Keyboard
288 # Parses a rule in the format <keymap>:<target>
289 # the keyboard is already known when entering this function
290 define PARSE_KEYBOARD
291     # If we want to compile the default subproject, then we need to
292     # include the correct makefile to determine the actual name of it
293     CURRENT_KB := $1
294
295     # KEYBOARD_FOLDERS := $$(subst /, , $(CURRENT_KB))
296
297     DEFAULT_FOLDER := $$(CURRENT_KB)
298
299     # We assume that every rules.mk will contain the full default value
300     $$(eval include $(ROOT_DIR)/keyboards/$$(CURRENT_KB)/rules.mk)
301     ifneq ($$(DEFAULT_FOLDER),$$(CURRENT_KB))
302         $$(eval include $(ROOT_DIR)/keyboards/$$(DEFAULT_FOLDER)/rules.mk)
303     endif
304     CURRENT_KB := $$(DEFAULT_FOLDER)
305
306     # 5/4/3/2/1
307     KEYBOARD_FOLDER_PATH_1 := $$(CURRENT_KB)
308     KEYBOARD_FOLDER_PATH_2 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_1)))
309     KEYBOARD_FOLDER_PATH_3 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_2)))
310     KEYBOARD_FOLDER_PATH_4 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_3)))
311     KEYBOARD_FOLDER_PATH_5 := $$(patsubst %/,%,$$(dir $$(KEYBOARD_FOLDER_PATH_4)))
312
313     KEYMAPS :=
314     # get a list of all keymaps
315     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/keymaps/*/.)))
316     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/keymaps/*/.)))
317     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/keymaps/*/.)))
318     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/keymaps/*/.)))
319     KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/keymaps/*/.)))
320     # this might be needed, but in a different form
321     #KEYMAPS := $$(sort $$(filter-out $$(KEYBOARD_FOLDER_1) $$(KEYBOARD_FOLDER_2) \
322         $$(KEYBOARD_FOLDER_3) $$(KEYBOARD_FOLDER_4) $$(KEYBOARD_FOLDER_5), $$(KEYMAPS)))
323
324     KEYBOARD_LAYOUTS :=
325     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/rules.mk)","")
326       LAYOUTS :=
327       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_5)/rules.mk)
328       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
329     endif
330     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/rules.mk)","")
331       LAYOUTS :=
332       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_4)/rules.mk)
333       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
334     endif
335     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/rules.mk)","")
336       LAYOUTS :=
337       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_3)/rules.mk)
338       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
339     endif
340     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/rules.mk)","")
341       LAYOUTS :=
342       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_2)/rules.mk)
343       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
344     endif
345     ifneq ("$$(wildcard $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/rules.mk)","")
346       LAYOUTS :=
347       $$(eval include $(ROOT_DIR)/keyboards/$$(KEYBOARD_FOLDER_PATH_1)/rules.mk)
348       KEYBOARD_LAYOUTS := $$(sort $$(LAYOUTS) $$(KEYBOARD_LAYOUTS))
349     endif
350
351     LAYOUT_KEYMAPS :=
352     $$(foreach LAYOUT,$$(KEYBOARD_LAYOUTS),$$(eval LAYOUT_KEYMAPS += $$(notdir $$(patsubst %/.,%,$$(wildcard $(ROOT_DIR)/layouts/*/$$(LAYOUT)/*/.)))))
353
354     KEYMAPS := $$(sort $$(KEYMAPS) $$(LAYOUT_KEYMAPS))
355
356     # if the rule after removing the start of it is empty (we haven't specified a kemap or target)
357     # compile all the keymaps
358     ifeq ($$(RULE),)
359         $$(eval $$(call PARSE_ALL_KEYMAPS))
360     # The same if all was specified
361     else ifeq ($$(call COMPARE_AND_REMOVE_FROM_RULE,all),true)
362         $$(eval $$(call PARSE_ALL_KEYMAPS))
363     # Try to match the specified keyamp with the list of known keymaps
364     else ifeq ($$(call TRY_TO_MATCH_RULE_FROM_LIST,$$(KEYMAPS)),true)
365         $$(eval $$(call PARSE_KEYMAP,$$(MATCHED_ITEM)))
366     # Otherwise try to match the keymap from the current folder, or arguments to the make command
367     else ifneq ($$(KEYMAP),)
368         $$(eval $$(call PARSE_KEYMAP,$$(KEYMAP)))
369     # Otherwise, make all keymaps, again this is consistent with how it works without
370     # any arguments
371     else
372         $$(eval $$(call PARSE_ALL_KEYMAPS))
373     endif
374 endef
375
376 # if we are going to compile all keyboards, match the rest of the rule
377 # for each of them
378 define PARSE_ALL_KEYBOARDS
379     $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYBOARD,$(KEYBOARDS)))
380 endef
381
382 # $1 Subproject
383 # When entering this, the keyboard and subproject are known, so now we need
384 # to determine which keymaps are going to get compiled
385 # define PARSE_SUBPROJECT
386
387 # endef
388
389 # If we want to parse all subprojects, but the keyboard doesn't have any,
390 # then use defaultsp instead
391 # define PARSE_ALL_SUBPROJECTS
392 #     ifeq ($$(SUBPROJECTS),)
393 #         $$(eval $$(call PARSE_SUBPROJECT,defaultsp))
394 #     else
395 #         $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_SUBPROJECT,$$(SUBPROJECTS)))
396 #     endif
397 # endef
398
399 # $1 Keymap
400 # This is the meat of compiling a keyboard, when entering this, everything is known
401 # keyboard, subproject, and keymap
402 # Note that we are not directly calling the command here, but instead building a list,
403 # which will later be processed
404 define PARSE_KEYMAP
405     CURRENT_KM = $1
406     # The rest of the rule is the target
407     # Remove the leading ":" from the target, as it acts as a separator
408     MAKE_TARGET := $$(patsubst :%,%,$$(RULE))
409     # We need to generate an unique indentifer to append to the COMMANDS list
410     CURRENT_KB_UNDER := $$(subst /,_,$$(CURRENT_KB))
411     COMMAND := COMMAND_KEYBOARD_$$(CURRENT_KB_UNDER)_KEYMAP_$$(CURRENT_KM)
412     # If we are compiling a keyboard without a subproject, we want to display just the name
413     # of the keyboard, otherwise keyboard/subproject
414     KB_SP := $$(CURRENT_KB)
415     # Format it in bold
416     KB_SP := $(BOLD)$$(KB_SP)$(NO_COLOR)
417     # Specify the variables that we are passing forward to submake
418     MAKE_VARS := KEYBOARD=$$(CURRENT_KB) KEYMAP=$$(CURRENT_KM)
419     # And the first part of the make command
420     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_keyboard.mk $$(MAKE_TARGET)
421     # The message to display
422     MAKE_MSG := $$(MSG_MAKE_KB)
423     # We run the command differently, depending on if we want more output or not
424     # The true version for silent output and the false version otherwise
425     $$(eval $$(call BUILD))
426 endef
427
428 define BUILD
429     MAKE_VARS += VERBOSE=$(VERBOSE) COLOR=$(COLOR)
430     COMMANDS += $$(COMMAND)
431     COMMAND_true_$$(COMMAND) := \
432         printf "$$(MAKE_MSG)" | \
433         $$(MAKE_MSG_FORMAT); \
434         LOG=$$$$($$(MAKE_CMD) $$(MAKE_VARS) SILENT=true 2>&1) ; \
435         if [ $$$$? -gt 0 ]; \
436             then $$(PRINT_ERROR_PLAIN); \
437         elif [ "$$$$LOG" != "" ] ; \
438             then $$(PRINT_WARNING_PLAIN); \
439         else \
440             $$(PRINT_OK); \
441         fi;
442     COMMAND_false_$$(COMMAND) := \
443         printf "$$(MAKE_MSG)\n\n"; \
444         $$(MAKE_CMD) $$(MAKE_VARS) SILENT=false; \
445         if [ $$$$? -gt 0 ]; \
446             then error_occurred=1; \
447         fi;
448 endef
449
450 # Just parse all the keymaps for a specific keyboard
451 define PARSE_ALL_KEYMAPS
452     $$(eval $$(call PARSE_ALL_IN_LIST,PARSE_KEYMAP,$$(KEYMAPS)))
453 endef
454
455 define BUILD_TEST
456     TEST_NAME := $1
457     MAKE_TARGET := $2
458     COMMAND := $1
459     MAKE_CMD := $$(MAKE) -r -R -C $(ROOT_DIR) -f build_test.mk $$(MAKE_TARGET)
460     MAKE_VARS := TEST=$$(TEST_NAME) FULL_TESTS="$$(FULL_TESTS)"
461     MAKE_MSG := $$(MSG_MAKE_TEST)
462     $$(eval $$(call BUILD))
463     ifneq ($$(MAKE_TARGET),clean)
464         TEST_EXECUTABLE := $$(TEST_DIR)/$$(TEST_NAME).elf
465         TESTS += $$(TEST_NAME)
466         TEST_MSG := $$(MSG_TEST)
467         $$(TEST_NAME)_COMMAND := \
468             printf "$$(TEST_MSG)\n"; \
469             $$(TEST_EXECUTABLE); \
470             if [ $$$$? -gt 0 ]; \
471                 then error_occurred=1; \
472             fi; \
473             printf "\n";
474     endif
475 endef
476
477 define PARSE_TEST
478     TESTS :=
479     TEST_NAME := $$(firstword $$(subst :, ,$$(RULE)))
480     TEST_TARGET := $$(subst $$(TEST_NAME),,$$(subst $$(TEST_NAME):,,$$(RULE)))
481     ifeq ($$(TEST_NAME),all)
482         MATCHED_TESTS := $$(TEST_LIST)
483     else
484         MATCHED_TESTS := $$(foreach TEST,$$(TEST_LIST),$$(if $$(findstring $$(TEST_NAME),$$(TEST)),$$(TEST),))
485     endif
486     $$(foreach TEST,$$(MATCHED_TESTS),$$(eval $$(call BUILD_TEST,$$(TEST),$$(TEST_TARGET))))
487 endef
488
489
490 # Set the silent mode depending on if we are trying to compile multiple keyboards or not
491 # By default it's on in that case, but it can be overridden by specifying silent=false
492 # from the command line
493 define SET_SILENT_MODE
494     ifdef SUB_IS_SILENT
495         SILENT_MODE := $(SUB_IS_SILENT)
496     else ifeq ($$(words $$(COMMANDS)),1)
497         SILENT_MODE := false
498     else
499         SILENT_MODE := true
500     endif
501 endef
502
503 include $(ROOT_DIR)/message.mk
504
505 ifeq ($(strip $(BREAK_ON_ERRORS)), yes)
506 HANDLE_ERROR = exit 1
507 else
508 HANDLE_ERROR = echo $$error_occurred > $(ERROR_FILE)
509 endif
510
511 # The empty line is important here, as it will force a new shell to be created for each command
512 # Otherwise the command line will become too long with a lot of keyboards and keymaps
513 define RUN_COMMAND
514 +error_occurred=0;\
515 $(COMMAND_$(SILENT_MODE)_$(COMMAND))\
516 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
517
518
519 endef
520 define RUN_TEST
521 +error_occurred=0;\
522 $($(TEST)_COMMAND)\
523 if [ $$error_occurred -gt 0 ]; then $(HANDLE_ERROR); fi;
524
525
526 endef
527
528 # Let's match everything, we handle all the rule parsing ourselves
529 .PHONY: %
530 %:
531         # Check if we have the CMP tool installed
532         cmp $(ROOT_DIR)/Makefile $(ROOT_DIR)/Makefile >/dev/null 2>&1; if [ $$? -gt 0 ]; then printf "$(MSG_NO_CMP)"; exit 1; fi;
533         # Check if the submodules are dirty, and display a warning if they are
534 ifndef SKIP_GIT
535         if [ ! -e lib/chibios ]; then git submodule sync lib/chibios && git submodule update --init lib/chibios; fi
536         if [ ! -e lib/chibios-contrib ]; then git submodule sync lib/chibios-contrib && git submodule update --init lib/chibios-contrib; fi
537         if [ ! -e lib/ugfx ]; then git submodule sync lib/ugfx && git submodule update --init lib/ugfx; fi
538         git submodule status --recursive 2>/dev/null | \
539         while IFS= read -r x; do \
540                 case "$$x" in \
541                         \ *) ;; \
542                         *) printf "$(MSG_SUBMODULE_DIRTY)";break;; \
543                 esac \
544         done
545 endif
546         rm -f $(ERROR_FILE) > /dev/null 2>&1
547         $(eval $(call PARSE_RULE,$@))
548         $(eval $(call SET_SILENT_MODE))
549         # Run all the commands in the same shell, notice the + at the first line
550         # it has to be there to allow parallel execution of the submake
551         # This always tries to compile everything, even if error occurs in the middle
552         # But we return the error code at the end, to trigger travis failures
553         # The sort at this point is to remove duplicates
554         $(foreach COMMAND,$(sort $(COMMANDS)),$(RUN_COMMAND))
555         if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
556         $(foreach TEST,$(sort $(TESTS)),$(RUN_TEST))
557         if [ -f $(ERROR_FILE) ]; then printf "$(MSG_ERRORS)" & exit 1; fi;
558
559 # These no longer work because of the colon system
560
561 # All should compile everything
562 # .PHONY: all
563 # all: all-keyboards test-all
564
565 # Define some shortcuts, mostly for compatibility with the old syntax
566 # .PHONY: all-keyboards
567 # all-keyboards: all\:all\:all
568
569 # .PHONY: all-keyboards-defaults
570 # all-keyboards-defaults: all\:default
571
572 # .PHONY: test
573 # test: test-all
574
575 # .PHONY: test-clean
576 # test-clean: test-all-clean
577
578 lib/%:
579         git submodule sync $?
580         git submodule update --init $?
581
582 git-submodule:
583         git submodule sync --recursive
584         git submodule update --init --recursive --progress
585
586 ifdef SKIP_VERSION
587 SKIP_GIT := yes
588 endif
589
590 # Generate the version.h file
591 ifndef SKIP_GIT
592     GIT_VERSION := $(shell git describe --abbrev=6 --dirty --always --tags 2>/dev/null || date +"%Y-%m-%d-%H:%M:%S")
593 else
594     GIT_VERSION := NA
595 endif
596 ifndef SKIP_VERSION
597 BUILD_DATE := $(shell date +"%Y-%m-%d-%H:%M:%S")
598 $(shell echo '#define QMK_VERSION "$(GIT_VERSION)"' > $(ROOT_DIR)/quantum/version.h)
599 $(shell echo '#define QMK_BUILDDATE "$(BUILD_DATE)"' >> $(ROOT_DIR)/quantum/version.h)
600 else
601 BUILD_DATE := NA
602 endif
603
604 include $(ROOT_DIR)/testlist.mk