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