mirror of
https://github.com/RYDE-WORK/ballistica.git
synced 2026-01-20 22:12:24 +08:00
455 lines
16 KiB
Makefile
455 lines
16 KiB
Makefile
# Copyright (c) 2011-2020 Eric Froemling
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
# ------------------------------------------------------------------------------
|
|
|
|
# This Makefile encompasses most high level functionality you should need when
|
|
# working with Ballistica. These build rules are also handy as reference or a
|
|
# starting point if you need specific funtionality beyond that exposed here.
|
|
# Targets in this top level Makefile do not expect -jX to be passed to them
|
|
# and generally handle spawning an appropriate number of child jobs themselves.
|
|
|
|
# Prefix used for output of docs/changelogs/etc targets for use in webpages.
|
|
DOCPREFIX = "ballisticacore_"
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# General #
|
|
# #
|
|
################################################################################
|
|
|
|
# List targets in this Makefile and basic descriptions for them.
|
|
help:
|
|
@tools/snippets makefile_target_list Makefile
|
|
|
|
PREREQS = .cache/checkenv .dir-locals.el \
|
|
.mypy.ini .pycheckers .pylintrc .style.yapf .clang-format \
|
|
.projectile .editorconfig
|
|
|
|
# Target that should be built before running most any other build.
|
|
# This installs tool config files, runs environment checks, etc.
|
|
prereqs: ${PREREQS}
|
|
|
|
prereqs-clean:
|
|
@rm -rf ${PREREQS} .irony
|
|
|
|
# Build all assets for all platforms.
|
|
assets: prereqs
|
|
@cd assets && make -j${CPUS}
|
|
|
|
# Build assets required for cmake builds (linux, mac)
|
|
assets-cmake: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} cmake
|
|
|
|
# Build assets required for WINDOWS_PLATFORM windows builds.
|
|
assets-windows: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} win-${WINDOWS_PLATFORM}
|
|
|
|
# Build assets required for Win32 windows builds.
|
|
assets-windows-Win32: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} win-Win32
|
|
|
|
# Build assets required for x64 windows builds.
|
|
assets-windows-x64: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} win-x64
|
|
|
|
# Build assets required for mac xcode builds
|
|
assets-mac: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} mac
|
|
|
|
# Build assets required for ios.
|
|
assets-ios: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} ios
|
|
|
|
# Build assets required for android.
|
|
assets-android: prereqs
|
|
@cd assets && $(MAKE) -j${CPUS} android
|
|
|
|
# Clean all assets.
|
|
assets-clean:
|
|
@cd assets && $(MAKE) clean
|
|
|
|
# Remove *ALL* files and directories that aren't managed by git
|
|
# (except for a few things such as localconfig.json).
|
|
clean:
|
|
@${CHECK_CLEAN_SAFETY}
|
|
@git clean -dfx ${ROOT_CLEAN_IGNORES}
|
|
|
|
# Show what clean would delete without actually deleting it.
|
|
clean-list:
|
|
@${CHECK_CLEAN_SAFETY}
|
|
@git clean -dnx ${ROOT_CLEAN_IGNORES}
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: list prereqs prereqs-clean assets assets-cmake assets-windows \
|
|
assets-windows-Win32 assets-windows-x64 \
|
|
assets-mac assets-ios assets-android assets-clean \
|
|
-clean-clean\
|
|
clean clean-list
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Prefab #
|
|
# #
|
|
################################################################################
|
|
|
|
# Prebuilt binaries for various platforms.
|
|
|
|
# Download/assemble/run a debug build for this platform.
|
|
prefab-debug:
|
|
@tools/snippets make_prefab debug
|
|
|
|
# Download/assemble/run a release build for this platform.
|
|
prefab-release:
|
|
@tools/snippets make_prefab release
|
|
|
|
# Download/assemble a debug build for this platform.
|
|
prefab-debug-build:
|
|
@tools/snippets make_prefab debug-build
|
|
|
|
# Download/assemble a release build for this platform.
|
|
prefab-release-build:
|
|
@tools/snippets make_prefab release-build
|
|
|
|
# Specific platform prefab targets:
|
|
|
|
prefab-mac-debug: prefab-mac-debug-build
|
|
@cd build/prefab/mac/debug && ./ballisticacore
|
|
|
|
prefab-mac-debug-build: prereqs assets-cmake \
|
|
build/prefab/mac/debug/ballisticacore
|
|
@${STAGE_ASSETS} -cmake build/prefab/mac/debug
|
|
|
|
build/prefab/mac/debug/ballisticacore: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
prefab-mac-release: prefab-mac-release-build
|
|
@cd build/prefab/mac/release && ./ballisticacore
|
|
|
|
prefab-mac-release-build: prereqs assets-cmake \
|
|
build/prefab/mac/release/ballisticacore
|
|
@${STAGE_ASSETS} -cmake build/prefab/mac/release
|
|
|
|
build/prefab/mac/release/ballisticacore: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
prefab-linux-debug: prefab-linux-debug-build
|
|
@cd build/prefab/linux/debug && ./ballisticacore
|
|
|
|
prefab-linux-debug-build: prereqs assets-cmake \
|
|
build/prefab/linux/debug/ballisticacore
|
|
@${STAGE_ASSETS} -cmake build/prefab/linux/debug
|
|
|
|
build/prefab/linux/debug/ballisticacore: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
prefab-linux-release: prefab-linux-release-build
|
|
@cd build/prefab/linux/release && ./ballisticacore
|
|
|
|
prefab-linux-release-build: prereqs assets-cmake \
|
|
build/prefab/linux/release/ballisticacore
|
|
@${STAGE_ASSETS} -cmake build/prefab/linux/release
|
|
|
|
build/prefab/linux/release/ballisticacore: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
PREFAB_WINDOWS_PLATFORM = x64
|
|
|
|
prefab-windows-debug: prefab-windows-debug-build
|
|
build/prefab/windows/debug/BallisticaCore.exe
|
|
|
|
prefab-windows-debug-build: prereqs assets-windows-${PREFAB_WINDOWS_PLATFORM} \
|
|
build/prefab/windows/debug/BallisticaCore.exe
|
|
@${STAGE_ASSETS} -win-$(PREFAB_WINDOWS_PLATFORM) build/prefab/windows/debug
|
|
|
|
build/prefab/windows/debug/BallisticaCore.exe: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
prefab-windows-release: prefab-windows-release-build
|
|
build/prefab/windows/release/BallisticaCore.exe
|
|
|
|
prefab-windows-release-build: prereqs \
|
|
assets-windows-${PREFAB_WINDOWS_PLATFORM} \
|
|
build/prefab/windows/release/BallisticaCore.exe
|
|
@${STAGE_ASSETS} -win-$(PREFAB_WINDOWS_PLATFORM) build/prefab/windows/release
|
|
|
|
build/prefab/windows/release/BallisticaCore.exe: .efrocachemap
|
|
@tools/snippets efrocache_get $@
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: prefab-debug prefab-debug-build prefab-release prefab-release-build \
|
|
prefab-mac-debug prefab-mac-debug-build prefab-mac-release \
|
|
prefab-mac-release-build prefab-linux-debug prefab-linux-debug-build \
|
|
prefab-linux-release prefab-linux-release-build prefab-windows-debug \
|
|
prefab-windows-debug-build prefab-windows-release prefab-windows-release-build
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Updating #
|
|
# #
|
|
################################################################################
|
|
|
|
# Update any project files that need it (does NOT build projects).
|
|
update: prereqs
|
|
@tools/update_project
|
|
|
|
# Don't update but fail if anything needs it.
|
|
update-check: prereqs
|
|
@tools/update_project --check
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: update update-check
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Formatting #
|
|
# #
|
|
################################################################################
|
|
|
|
# Run formatting on all files in the project considered 'dirty'.
|
|
format:
|
|
@$(MAKE) -j3 format-code format-scripts format-makefile
|
|
@echo Formatting complete!
|
|
|
|
# Same but always formats; ignores dirty state.
|
|
format-full:
|
|
@$(MAKE) -j3 format-code-full format-scripts-full format-makefile
|
|
@echo Formatting complete!
|
|
|
|
# Run formatting for compiled code sources (.cc, .h, etc.).
|
|
format-code: prereqs
|
|
@tools/snippets formatcode
|
|
|
|
# Same but always formats; ignores dirty state.
|
|
format-code-full: prereqs
|
|
@tools/snippets formatcode -full
|
|
|
|
# Runs formatting for scripts (.py, etc).
|
|
format-scripts: prereqs
|
|
@tools/snippets formatscripts
|
|
|
|
# Same but always formats; ignores dirty state.
|
|
format-scripts-full: prereqs
|
|
@tools/snippets formatscripts -full
|
|
|
|
# Runs formatting on the project Makefile.
|
|
format-makefile: prereqs
|
|
@tools/snippets formatmakefile
|
|
|
|
.PHONY: format format-full format-code format-code-full format-scripts \
|
|
format-scripts-full
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Checking #
|
|
# #
|
|
################################################################################
|
|
|
|
# Run all project checks. (static analysis)
|
|
check: update-check
|
|
@$(MAKE) -j3 cpplint pylint mypy
|
|
@echo ALL CHECKS PASSED!
|
|
|
|
# Same as check but no caching (all files are checked).
|
|
check-full: update-check
|
|
@$(MAKE) -j3 cpplint-full pylint-full mypy-full
|
|
@echo ALL CHECKS PASSED!
|
|
|
|
# Same as 'check' plus optional/slow extra checks.
|
|
check2: update-check
|
|
@$(MAKE) -j4 cpplint pylint mypy pycharm
|
|
@echo ALL CHECKS PASSED!
|
|
|
|
# Same as check2 but no caching (all files are checked).
|
|
check2-full: update-check
|
|
@$(MAKE) -j4 cpplint-full pylint-full mypy-full pycharm-full
|
|
@echo ALL CHECKS PASSED!
|
|
|
|
# Run Cpplint checks on all C/C++ code.
|
|
cpplint: prereqs
|
|
@tools/snippets cpplint
|
|
|
|
# Run Cpplint checks without caching (all files are checked).
|
|
cpplint-full: prereqs
|
|
@tools/snippets cpplint -full
|
|
|
|
# Run Pylint checks on all Python Code.
|
|
pylint: prereqs
|
|
@tools/snippets pylint
|
|
|
|
# Run Pylint checks without caching (all files are checked).
|
|
pylint-full: prereqs
|
|
@tools/snippets pylint -full
|
|
|
|
# Run Mypy checks on all Python code.
|
|
mypy: prereqs
|
|
@tools/snippets mypy
|
|
|
|
# Run Mypy checks without caching (all files are checked).
|
|
mypy-full: prereqs
|
|
@tools/snippets mypy -full
|
|
|
|
# Run Mypy checks on all Python code using daemon mode.
|
|
dmypy: prereqs
|
|
@tools/snippets dmypy
|
|
|
|
# Stop the mypy daemon
|
|
dmypy-stop: prereqs
|
|
@tools/snippets dmypy -stop
|
|
|
|
# Run PyCharm checks on all Python code.
|
|
pycharm: prereqs
|
|
@tools/snippets pycharm
|
|
|
|
# Run PyCharm checks without caching (all files are checked).
|
|
pycharm-full: prereqs
|
|
@tools/snippets pycharm -full
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: check check-full check2 check2-full \
|
|
cpplint cpplint-full pylint pylint-full mypy \
|
|
mypy-full pycharm pycharm-full
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Testing #
|
|
# #
|
|
################################################################################
|
|
|
|
# Run all tests. (live execution verification)
|
|
test: prereqs
|
|
@tools/snippets pytest -v tests
|
|
|
|
# Run tests with any caching disabled.
|
|
test-full: test
|
|
|
|
# Iterating on individual tests with extra debug output enabled.
|
|
test-assetmanager:
|
|
@tools/snippets pytest -o log_cli=true -o log_cli_level=debug -s -v \
|
|
tests/test_ba/test_assetmanager.py::test_assetmanager
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: test test-full
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Preflighting #
|
|
# #
|
|
################################################################################
|
|
|
|
# Format, update, check, & test the project. Do this before commits.
|
|
preflight:
|
|
@$(MAKE) format
|
|
@$(MAKE) update
|
|
@$(MAKE) -j4 cpplint pylint mypy test
|
|
@echo PREFLIGHT SUCCESSFUL!
|
|
|
|
# Same as 'preflight' without caching (all files are visited).
|
|
preflight-full:
|
|
@$(MAKE) format-full
|
|
@$(MAKE) update
|
|
@$(MAKE) -j4 cpplint-full pylint-full mypy-full test-full
|
|
@echo PREFLIGHT SUCCESSFUL!
|
|
|
|
# Same as 'preflight' plus optional/slow extra checks.
|
|
preflight2:
|
|
@$(MAKE) format
|
|
@$(MAKE) update
|
|
@$(MAKE) -j5 cpplint pylint mypy pycharm test
|
|
@echo PREFLIGHT SUCCESSFUL!
|
|
|
|
# Same as 'preflight2' but without caching (all files visited).
|
|
preflight2-full:
|
|
@$(MAKE) format-full
|
|
@$(MAKE) update
|
|
@$(MAKE) -j5 cpplint-full pylint-full mypy-full pycharm-full test-full
|
|
@echo PREFLIGHT SUCCESSFUL!
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY: preflight preflight-full preflight2 preflight2-full
|
|
|
|
|
|
################################################################################
|
|
# #
|
|
# Auxiliary #
|
|
# #
|
|
################################################################################
|
|
|
|
# This should give the cpu count on linux and mac; may need to expand this
|
|
# if using this on other platforms.
|
|
CPUS = $(shell getconf _NPROCESSORS_ONLN || echo 8)
|
|
PROJ_DIR = ${abspath ${CURDIR}}
|
|
VERSION = $(shell tools/version_utils version)
|
|
BUILD_NUMBER = $(shell tools/version_utils build)
|
|
BUILD_DIR = ${PROJ_DIR}/build
|
|
|
|
STAGE_ASSETS = ${PROJ_DIR}/tools/stage_assets
|
|
|
|
# Things to ignore when doing root level cleans.
|
|
ROOT_CLEAN_IGNORES = --exclude=assets/src_master \
|
|
--exclude=config/localconfig.json \
|
|
--exclude=.spinoffdata
|
|
|
|
CHECK_CLEAN_SAFETY = ${PROJ_DIR}/tools/snippets check_clean_safety
|
|
|
|
# Some tool configs that need filtering (mainly injecting projroot path).
|
|
TOOL_CFG_INST = tools/snippets tool_config_install
|
|
|
|
# Anything that affects tool-config generation.
|
|
TOOL_CFG_SRC = tools/efrotools/snippets.py config/config.json
|
|
|
|
.clang-format: config/toolconfigsrc/clang-format ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.style.yapf: config/toolconfigsrc/style.yapf ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.pylintrc: config/toolconfigsrc/pylintrc ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.projectile: config/toolconfigsrc/projectile ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.editorconfig: config/toolconfigsrc/editorconfig ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.dir-locals.el: config/toolconfigsrc/dir-locals.el ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.mypy.ini: config/toolconfigsrc/mypy.ini ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.pycheckers: config/toolconfigsrc/pycheckers ${TOOL_CFG_SRC}
|
|
${TOOL_CFG_INST} $< $@
|
|
|
|
.cache/checkenv: tools/snippets
|
|
@tools/snippets checkenv
|
|
@mkdir -p .cache
|
|
@touch .cache/checkenv
|
|
|
|
# Tell make which of these targets don't represent files.
|
|
.PHONY:
|