Makefile

include $(BUILD_HELPER_DIR)/tools.mak

DEFAULT_TARGETS := module doc_files
export DEFAULT_TARGETS

GENERATED_DIR := $(ROOT_DIR)/generated
export GENERATED_DIR

COMMAND_LOG := $(ROOT_DIR)/commands.log
export COMMAND_LOG

DOCS_DIR := $(ROOT_DIR)/docs
export DOCS_DIR

STATIC_DOCS_DIR := $(DOCS_DIR)/_static
export STATIC_DOCS_DIR

ifeq (,$(PRINT))
_hide_cmds := @
endif

# We only add root files if we are building the 'all' target (nothing on the command line)
ifeq (,$(MAKECMDGOALS))
ROOT_FILES := \
	$(ROOT_DIR)/README.rst \

endif

all: $(DRIVERS) $(ROOT_FILES)

define per_driver_per_target
$1_$2: start
	@echo
	@echo "Making $1"
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1 MKDIR
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1 $2
endef

define per_driver_all
$1: start
	@echo
	@echo "Making $1"
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1 MKDIR
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1
endef

$(foreach d,$(ALL_DRIVERS),$(eval $(call per_driver_all,$(d))))
$(foreach d,$(ALL_DRIVERS),\
   $(foreach t,$(DEFAULT_TARGETS),\
      $(eval $(call per_driver_per_target,$(d),$(t)))))

define per_target
$1:
	$(foreach d,$(DRIVERS),make --no-print-directory -f src/$(d)/$(d).mak DRIVER=$(d) $1 &&)  echo
endef

$(foreach t,$(DEFAULT_TARGETS),$(eval $(call per_target,$(t))))

define per_driver_installers
$1_installers: start
	@echo
	@echo "Making $1 installers"
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1 MKDIR
	$(_hide_cmds)make --no-print-directory -s -f src/$1/$1.mak DRIVER=$1 installers
endef

$(foreach d,$(ALL_DRIVERS),$(eval $(call per_driver_installers,$(d))))
installers: $(foreach d,$(ALL_DRIVERS), $(d)_installers)

SUPPRESS_ERROR_OUTPUT ?= 2> /dev/null

# We need to ensure generated exists for Travis CI builds
clean: start
	@echo 'Cleaning...'
	-$(_hide_cmds)rm -Rf $(GENERATED_DIR)/ $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)find $(ROOT_DIR)/build -path '*/__pycache__/*' -exec rm {} \; $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)find $(ROOT_DIR)/build -name __pycache__ -exec rmdir {} \; $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)find $(ROOT_DIR)/build -name '*.pyc' -exec rm {} \; $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)rm $(foreach d,$(DRIVERS), $(ROOT_DIR)/docs/$(d)/*) $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)rm $(foreach d,$(DRIVERS), $(ROOT_DIR)/docs/$(d)/.readthedocs.yaml) $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)rm -Rf $(ROOT_DIR)/.coverage $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)rm -Rf $(ROOT_DIR)/README.rst $(SUPPRESS_ERROR_OUTPUT) ||:
	-$(_hide_cmds)mkdir $(GENERATED_DIR) $(SUPPRESS_ERROR_OUTPUT) ||:

start:
	-@echo "# This is the list of commands that make invoked in order to build nimi-python. If" > $(COMMAND_LOG)
	-@echo "# you want to reproduce the build but don't have GNU Make setup in your system, you" >> $(COMMAND_LOG)
	-@echo "# can use the commands in this log file." >> $(COMMAND_LOG)


# From https://stackoverflow.com/questions/14760124/how-to-split-in-gnu-makefile-list-of-files-into-separate-lines
DRIVER_ALL_TARGETS_HELP := echo Drivers: $(addprefix  && echo - ,$(ALL_DRIVERS))
TARGETS_HELP := echo Targets: $(addprefix  && echo - ,$(DEFAULT_TARGETS))
PER_DRIVER_PER_TARGET := \
   $(foreach d,$(ALL_DRIVERS),\
      $(foreach t,$(DEFAULT_TARGETS),\
         $(d)_$(t)))
DRIVER_TARGETS_HELP := echo Per driver, per target: $(addprefix  && echo - ,$(PER_DRIVER_PER_TARGET))
help:
	@echo 'Supported targets:'
	@echo '* help'
	@echo '* clean'
	@echo '* print-<VARIABLE> (only top level variables)'
	@echo '* printvar VAR=<VARIABLE> (per driver print variable)'
	@echo ''
	@echo 'Any/multiple target(s) listed below:'
	@$(DRIVER_ALL_TARGETS_HELP)
	@echo ''
	@$(TARGETS_HELP)
	@echo ''
	@$(DRIVER_TARGETS_HELP)
	@echo ''

# From https://stackoverflow.com/questions/16467718/how-to-print-out-a-variable-in-makefile
print-%: ; $(info $* is $(flavor $*) variable set to [$($*)]) @true

# Per driver variable printing
per_driver_variable_print = make --no-print-directory -f src/$1/$1.mak DRIVER=$1 print-$2
.PHONY:
printvar:
	$(_hide_cmds)$(foreach d,$(DRIVERS),$(call per_driver_variable_print,$(d),$(VAR)) && ) echo


PYTHON_CMD ?= python

.PHONY: help Makefile

# For the global files, instead of trying to keep track of which files from the driver builds matter for any target,
# we just say that if anything from any driver built, we will rebuld the global files
export DRIVER_FILE_BUILT = $(GENERATED_DIR)/driver_file_built

GLOBAL_FILES_STARTED_FILE = $(GENERATED_DIR)/printed_global_files
$(GLOBAL_FILES_STARTED_FILE): $(DRIVER_FILE_BUILT)
	@echo
	@echo "Making Global Files"
	@touch $(GLOBAL_FILES_STARTED_FILE)

# Executes a command, then logs it to $(COMMAND_LOG).
# $1 is the command.
# We need our own copy that does not touch DRIVER_FILE_BUILT
define global_log_command
	$1
	@echo '$1' >> $(COMMAND_LOG)
endef

$(ROOT_DIR)/README.rst: $(GLOBAL_FILES_STARTED_FILE)
	$(call trace_to_console, "Creating Root",$(notdir $@))
	$(_hide_cmds)$(call global_log_command,cat $(STATIC_DOCS_DIR)/status_project.inc \
                                               $(STATIC_DOCS_DIR)/about.inc \
                                               $(DOCS_DIR)/*/status.inc \
                                               $(STATIC_DOCS_DIR)/installation.inc \
                                               $(STATIC_DOCS_DIR)/contributing.inc \
                                               $(STATIC_DOCS_DIR)/nidmm_usage.inc \
                                               $(STATIC_DOCS_DIR)/support.inc \
                                               $(STATIC_DOCS_DIR)/documentation.inc \
                                               $(STATIC_DOCS_DIR)/license.inc > $@)

# Any step that any driver build does that would invalidate unit testing, flake8 or generated html
# needs to delete this file. This will trigger a tox run.
TOX_RUN_DONE := $(GENERATED_DIR)/tox_run_done
export TOX_RUN_DONE

test: $(TOX_RUN_DONE)

$(TOX_RUN_DONE):
	@echo
	$(call trace_to_console, "Running tox",$@)
	$(_hide_cmds)$(call make_with_tracking_file,$@,tox)