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