Makefile

KOR_BASE ?= .

# Are we being included?
STANDALONE := $(if $(filter-out $(lastword $(MAKEFILE_LIST)),$(MAKEFILE_LIST)),,1)

ifeq (,$(STANDALONE))
  BASE_PREFIX = base-
else
  include $(KOR_BASE)/Makefile.defs
endif

# As we do not want to run parallel ninja invocations into the
# same directory (e.g. when invoked with `make mupdf k2pdfopt`),
# we disable parallelisation for this top-level Makefile.
.NOTPARALLEL:

DO_STRIP := $(if $(or $(EMULATE_READER),$(KODEBUG)),,1)
DO_STRIP := $(if $(or $(DO_STRIP),$(APPIMAGE),$(LINUX)),1,)

define build_info
$(info ************ Building for MACHINE: "$(MACHINE)" **********)
$(info ************ PATH: "$(PATH)" **********)
$(info ************ CHOST: "$(CHOST)" **********)
$(info ************ NINJA: $(strip $(NINJA) $(PARALLEL_JOBS:%=-j%) $(PARALLEL_LOAD:%=-l%)) **********)
$(info ************ MAKE: $(strip $(MAKE) $(PARALLEL_JOBS:%=-j%) $(PARALLEL_LOAD:%=-l%)) **********)
endef

PHONY += $(addprefix $(BASE_PREFIX),all clean distclean fetchthirdparty re reinstall test uninstall)
PHONY += bininfo bincheck buildstats info %-re setup skeleton test-data
SOUND += cache-key build/% $(OUTPUT_DIR)/% $(STAGING_DIR)/bincheck/%

# Main rules. {{{

$(BASE_PREFIX)all: $(BUILD_ENTRYPOINT)

$(BASE_PREFIX)clean:
	rm -rf $(OUTPUT_DIR)

$(BASE_PREFIX)distclean:
	rm -rf $(dir $(filter $(KOR_BASE)/build/%,$(OUTPUT_DIR))) $(wildcard $(THIRDPARTY_DIR)/*/build $(THIRDPARTY_DIR)/spec/*/build)

info:
	$(strip $(build_info))

$(BASE_PREFIX)re: $(BASE_PREFIX)clean
	$(MAKE) $(BASE_PREFIX)all

%-re:
	$(MAKE) $*-clean
	$(MAKE) $*

$(BASE_PREFIX)fetchthirdparty:
	git submodule init
	git submodule sync
	git submodule update --jobs 3 $(if $(CI),--depth 1)

$(BASE_PREFIX)reinstall: $(BASE_PREFIX)uninstall
	$(MAKE) $(BASE_PREFIX)all

$(BASE_PREFIX)uninstall:
	rm -vrf $(filter-out $(CMAKE_DIR) $(OUTPUT_DIR)/thirdparty,$(wildcard $(OUTPUT_DIR)/*))
	$(MAKE) rm-install-stamps

# }}}

# CMake build interface. {{{

setup $(BUILD_ENTRYPOINT): $(CMAKE_KOVARS) $(CMAKE_TCF) $(MESON_CROSS_TOOLCHAIN) $(MESON_HOST_TOOLCHAIN)
	$(strip $(build_info))
	$(CMAKE) $(CMAKE_FLAGS) -S $(KOR_BASE)/cmake -B $(CMAKE_DIR)

define write_file
$(if $(DRY_RUN),: write $1,$(file >$1,$2))
endef

$(CMAKE_KOVARS): $(KOR_BASE)/Makefile.defs | $(CMAKE_DIR)/
	$(call write_file,$@,$(cmake_koreader_vars))

$(CMAKE_TCF): $(KOR_BASE)/Makefile.defs | $(CMAKE_DIR)/
	$(call write_file,$@,$(if $(EMULATE_READER),$(cmake_toolchain),$(cmake_cross_toolchain)))

$(CMAKE_DIR)/meson_%.ini: $(KOR_BASE)/Makefile.defs | $(CMAKE_DIR)/
	$(call write_file,$@,$(meson_$*))

# Forward unknown targets to the CMake build system.
LEFTOVERS = $(filter-out $(PHONY) $(SOUND),$(MAKECMDGOALS))
.PHONY: $(LEFTOVERS)
$(BASE_PREFIX)all $(LEFTOVERS): skeleton $(BUILD_ENTRYPOINT)
	$(and $(DRY_RUN),$(wildcard $(BUILD_ENTRYPOINT)),+)cd $(CMAKE_DIR) && $(strip $(NINJA) $(NINJAFLAGS) $(patsubst $(BASE_PREFIX)all,all,$@))

# }}}

# Output skeleton. {{{

CR3GUI_DATADIR = $(THIRDPARTY_DIR)/kpvcrlib/crengine/cr3gui/data

define SKELETON
$(CMAKE_DIR)/
$(OUTPUT_DIR)/cache/
$(OUTPUT_DIR)/clipboard/
$(OUTPUT_DIR)/data/
$(OUTPUT_DIR)/data/dict
$(OUTPUT_DIR)/data/tessdata
$(OUTPUT_DIR)/ffi
$(OUTPUT_DIR)/fonts/
$(STAGING_DIR)/
endef

skeleton: $(strip $(SKELETON))

$(OUTPUT_DIR)/data/%: $(CR3GUI_DATADIR)/% | $(OUTPUT_DIR)/data/
	$(SYMLINK) $(CR3GUI_DATADIR)/$* $@

$(CR3GUI_DATADIR)/%:
	mkdir $@

$(OUTPUT_DIR)/ffi: | $(OUTPUT_DIR)/
	$(SYMLINK) $(KOR_BASE)/ffi $@

$(OUTPUT_DIR)/:
	mkdir -p $@

$(OUTPUT_DIR)/%/:
	mkdir -p $@

# }}}

# Testsuite support. {{{

ifneq (,$(EMULATE_READER))

download-all: test-data

$(OUTPUT_DIR)/spec/base: | $(OUTPUT_DIR)/spec/
	$(SYMLINK) $(KOR_BASE)/spec $@

$(OUTPUT_DIR)/spec/config.lua: | $(OUTPUT_DIR)/spec/
	$(SYMLINK) $(KOR_BASE)/test-runner/busted_config.lua $@

$(OUTPUT_DIR)/spec/meson.build: | $(OUTPUT_DIR)/spec/
	$(SYMLINK) $(KOR_BASE)/test-runner/meson.build $@

$(OUTPUT_DIR)/spec/runtests: | $(OUTPUT_DIR)/spec/
	$(SYMLINK) $(KOR_BASE)/test-runner/runtests $@

$(BASE_PREFIX)test: $(BASE_PREFIX)all test-data
	$(RUNTESTS) $(OUTPUT_DIR) base $T

define test_data_common
$(OUTPUT_DIR)/spec/config.lua
$(OUTPUT_DIR)/spec/meson.build
$(OUTPUT_DIR)/spec/runtests
endef

skeleton: $(strip $(test_data_common))

define test_data_base
$(OUTPUT_DIR)/data/tessdata/eng.traineddata
$(OUTPUT_DIR)/fonts/droid/DroidSansMono.ttf
$(OUTPUT_DIR)/spec/base
endef

test-data: $(strip $(test_data_common) $(test_data_base))

TESSDATA_FILE = $(THIRDPARTY_DIR)/tesseract/build/downloads/eng.traineddata
TESSDATA_FILE_URL = https://github.com/tesseract-ocr/tessdata/raw/4.1.0/$(notdir $(TESSDATA_FILE))
TESSDATA_FILE_SHA1 = 007b522901a665bc2037428602d4d527f5ead7ed

$(OUTPUT_DIR)/data/tessdata/eng.traineddata: $(TESSDATA_FILE) | $(OUTPUT_DIR)/data/tessdata
	$(SYMLINK) $(TESSDATA_FILE) $@

$(TESSDATA_FILE):
	mkdir -p $(dir $(TESSDATA_FILE))
	$(call wget_and_validate,$(TESSDATA_FILE),$(TESSDATA_FILE_URL),$(TESSDATA_FILE_SHA1))

DROID_FONT = $(THIRDPARTY_DIR)/fonts/build/downloads/DroidSansMono.ttf
DROID_FONT_URL = https://github.com/koreader/koreader-fonts/raw/master/droid/$(notdir $(DROID_FONT))
DROID_FONT_SHA1 = 0b75601f8ef8e111babb6ed11de6573f7178ce44

$(OUTPUT_DIR)/fonts/droid/DroidSansMono.ttf: $(DROID_FONT) | $(OUTPUT_DIR)/fonts/
	$(SYMLINK) $(dir $(DROID_FONT)) $(OUTPUT_DIR)/fonts/droid

$(DROID_FONT):
	mkdir -p $(dir $(DROID_FONT))
	$(call wget_and_validate,$(DROID_FONT),$(DROID_FONT_URL),$(DROID_FONT_SHA1))

endif

# }}}

# CI helpers. {{{

define cache_key_cmd
git -C $(KOR_BASE) ls-files -z
--cached --ignored --exclude-from=$(abspath $1)
| xargs -0 git -C $(KOR_BASE) ls-tree @
endef

cache-key: $(KOR_BASE)/Makefile $(KOR_BASE)/cache-key.base
	$(strip $(call cache_key_cmd,$(KOR_BASE)/cache-key.base)) | tee $@

# }}}

# Dump/check binaries runtime path and dependencies. {{{

define BINARY_PATHS
$(filter-out
  $(addprefix $(OUTPUT_DIR)/,cmake spec staging thirdparty),
    $(wildcard $(OUTPUT_DIR)/*))
endef

bininfo:
	@$(KOR_BASE)/utils/bininfo.py $(BINARY_PATHS)

ifneq (,$(filter bincheck,$(MAKECMDGOALS)))

BINCHECK_DEPS :=
BINCHECK_LD_PATH :=

# Preload.
ifeq (,$(USE_LUAJIT_LIB))
  # When not using the luajit library, preload
  # luajit so the LUA API' symbols are available.
  BINCHECK_DEPS += $(OUTPUT_DIR)/luajit
  BINCHECK_LD_PATH += $(OUTPUT_DIR)/luajit
endif

# Stubs for platform libraries.
ifneq (,$(POCKETBOOK))
  BINCHECK_DEPS += $(STAGING_DIR)/bincheck/libinkview.so
endif
ifneq (,$(KINDLE))
  BINCHECK_DEPS += $(STAGING_DIR)/bincheck/liblipc.so
endif

# Library directories.
BINCHECK_LD_PATH += $(STAGING_DIR)/bincheck $(OUTPUT_DIR)/libs

# Sysroot.
define sysroot_libdir
  $(dir $(abspath $(or
    $(filter /%,$(shell $(CC) -print-file-name=$1)),
    $(error could not find library directory for `$1`))))
endef
ifneq (,$(EMULATE_READER))
  ifeq (,$(DARWIN))
    BINCHECK_LD_PATH += $(call sysroot_libdir,libc.so)
  endif
else ifneq (,$(ANDROID))
  BINCHECK_LD_PATH += $(call sysroot_libdir,libc.so)
  BINCHECK_LD_PATH += $(call sysroot_libdir,libc++_shared.so)
else
  BINCHECK_LD_PATH += $(call sysroot_libdir,libc.so.6)
endif

bincheck: $(BINCHECK_DEPS)
	$(KOR_BASE)/utils/bincheck.py $(if $(GLIBC_VERSION_MAX),--glibc-version-max $(GLIBC_VERSION_MAX) )'$(subst $(empty) $(empty),:,$(strip $(BINCHECK_LD_PATH)))' $(BINARY_PATHS)

endif

$(STAGING_DIR)/bincheck/%.so: $(KOR_BASE)/utils/bincheck/%.c | $(STAGING_DIR)/bincheck/
	$(CC) $(DYNLIB_LDFLAGS) -o $@ $<

# }}}

# }}}

# Dump build timings for last ninja invocation. {{{

# Show external project tasks with a duration of 1s or more (descending order).
define buildstats_jq_script
  sort_by(-.dur) | .[] | select(.dur >= 1e6) | (.dur*1e-5 | round | ./10), "\n",
  (.name | sub("(.*[/ ])?(?<p>[^/]*)/stamp/(?<t>[^/]*)$$"; "\(.p) \(.t)")), "\n"
endef

buildstats: $(CMAKE_DIR)/.ninja_log
	ninjatracing $< | jq -j '$(strip $(buildstats_jq_script))' | \
	    xargs -n3 printf '%6.2fs %s %s\n' | \
	    git column --mode=row

# }}}

# vim: foldmethod=marker foldlevel=0