Makefile

#***************************************************************************
# Copyright (c) 2021 for information on the respective copyright owner
# see the NOTICE file and/or the following repository:
#     https://github.com/boschglobal/automotive-bus-schema
#
# SPDX-License-Identifier: Apache-2.0
#***************************************************************************


###############
## Builder Images
export CONTAINER_REPO ?= ghcr.io
export CONTAINER_PREFIX ?= boschglobal/automotive-bus-schema-
export CONTAINER_TAG ?= main
FLATC_BUILDER_IMAGE ?= $(CONTAINER_REPO)/$(CONTAINER_PREFIX)flatc-builder:$(CONTAINER_TAG)
PYTHON_BUILDER_IMAGE ?= $(CONTAINER_REPO)/$(CONTAINER_PREFIX)python-builder:$(CONTAINER_TAG)
GCC_BUILDER_IMAGE ?= $(CONTAINER_REPO)/$(CONTAINER_PREFIX)gcc-builder:$(CONTAINER_TAG)
BUILDER_DOCKER_IMAGES = flatc-builder python-builder gcc-builder



###############
## Build parameters.
SCHEMA_LIB = automotive_bus_schema
PLATFORM = linux64
DIST_DIR = $(shell pwd -P)/dist
OUT_DIR = $(shell pwd -P)/dist/$(PACKAGE_NAME)
# Flatbuffers
FBS_OUT_DIR = $(OUT_DIR)/flatbuffers
FBS_SCHEMA_DIR = $(shell pwd -P)/schemas
FBS_SCHEMA_SOURCES = $(shell ls $(FBS_SCHEMA_DIR)/**/*.fbs)
# FlatC
FLATC = flatc
FLATC_OPTIONS =
FLATCC = flatcc
# FlatCC
FLATCC_SRC_RUNTIME_DIR = /usr/local/src/flatcc/src/runtime
FLATCC_SRC_INCLUDE_DIR = /usr/local/include/flatcc
FLATCC_SRC_LICENSE_DIR = /usr/local/src/flatcc
FLATCC_DIST_RUNTIME_DIR = $(FBS_OUT_DIR)/c/$(SCHEMA_LIB)/flatcc/src
FLATCC_DIST_INCLUDE_DIR = $(FBS_OUT_DIR)/c/$(SCHEMA_LIB)/flatcc/include/flatcc
# MsgPack
MPK_OUT_DIR = $(OUT_DIR)/msgpack
MPK_SCHEMA_DIR = $(shell pwd -P)/schemas
MPK_SCHEMA_SOURCES = $(shell ls $(MPK_SCHEMA_DIR)/**/*.yaml)
# Python (for creating a Python Package)
PYTHON_SRC_DIR = $(FBS_OUT_DIR)/python
PYTHON_DIST_DIR = $(DIST_DIR)/python


###############
## Packaging.
PACKAGE_NAME = automotive-bus-schema
PACKAGE_FILENAME = $(PACKAGE_NAME).tar.gz
PACKAGE_VERSION ?= devel


default: build


builders:
	for d in $(BUILDER_DOCKER_IMAGES) ;\
	do \
		docker build -f docker/$$d/Dockerfile \
			--tag $(CONTAINER_REPO)/$(CONTAINER_PREFIX)$$d:$(CONTAINER_TAG) ./docker/$$d ;\
	done;

build:
	@docker run -it --rm \
		--volume $$(pwd):/tmp/repo \
		--env PACKAGE_VERSION=$(PACKAGE_VERSION) \
		--workdir /tmp/repo \
		$(FLATC_BUILDER_IMAGE) \
		/bin/bash -c "make fbs"
	@docker run -it --rm \
		--volume $$(pwd):/tmp/repo \
		--env PIP_EXTRA_INDEX_URL=$(PIP_EXTRA_INDEX_URL) \
		--env PACKAGE_VERSION=$(PACKAGE_VERSION) \
		--workdir /tmp/repo \
		$(PYTHON_BUILDER_IMAGE) \
		/bin/bash -c "make python; make msgpack"

	@echo ""
	@echo "Generated files:"
	@echo "---------------"
	@ls -R $(FBS_OUT_DIR)
	@ls -R $(MPK_OUT_DIR)

$(FBS_SCHEMA_SOURCES):
	@echo $@
	# Setup the directory structure.
	mkdir -p $(FBS_OUT_DIR)/c/$(SCHEMA_LIB)/$$(basename $$(dirname $@))
	mkdir -p $(FBS_OUT_DIR)/cpp/$(SCHEMA_LIB)/$$(basename $$(dirname $@))
	mkdir -p $(FBS_OUT_DIR)/fbs/$$(basename $$(dirname $@))
	mkdir -p $(FBS_OUT_DIR)/fbs/$$(basename $$(dirname $@))
	mkdir -p $(FBS_OUT_DIR)/fbs/$$(basename $$(dirname $@))
	mkdir -p $(FBS_OUT_DIR)/go
	mkdir -p $(FBS_OUT_DIR)/lua

	# Generate Flatbuffers code.
	$(FLATCC) -a $(FLATC_OPTIONS) -o $(FBS_OUT_DIR)/c/$(SCHEMA_LIB)/$$(basename $$(dirname $@)) $@
	$(FLATC) --cpp $(FLATC_OPTIONS) --filename-suffix '' -o $(FBS_OUT_DIR)/cpp/$(SCHEMA_LIB)/$$(basename $$(dirname $@)) $@
	cd $(FBS_OUT_DIR)/go; $(FLATC) --go $(FLATC_OPTIONS) $@
	$(FLATC) --python $(FLATC_OPTIONS) -o $(FBS_OUT_DIR)/python $@
	cd $(FBS_OUT_DIR)/lua; $(FLATC) --lua $(FLATC_OPTIONS) $@
	# Copy over the original Flatbuffer schemas.
	cp $@ $(FBS_OUT_DIR)/fbs/$$(basename $$(dirname $@))

fbs: $(FBS_SCHEMA_SOURCES)
	mkdir -p $(FLATCC_DIST_RUNTIME_DIR)
	cp $(FLATCC_SRC_RUNTIME_DIR)/builder.c $(FLATCC_DIST_RUNTIME_DIR)
	cp $(FLATCC_SRC_RUNTIME_DIR)/emitter.c $(FLATCC_DIST_RUNTIME_DIR)
	cp $(FLATCC_SRC_RUNTIME_DIR)/refmap.c $(FLATCC_DIST_RUNTIME_DIR)
	cp $(FLATCC_SRC_LICENSE_DIR)/LICENSE $(FLATCC_DIST_RUNTIME_DIR)
	mkdir -p $(FLATCC_DIST_INCLUDE_DIR)
	cp -r $(FLATCC_SRC_INCLUDE_DIR)/* $(FLATCC_DIST_INCLUDE_DIR)

$(MPK_SCHEMA_SOURCES):
	@echo $@
	mkdir -p $(MPK_OUT_DIR)/$$(basename $$(dirname $@))
	cp $@ $(MPK_OUT_DIR)/$$(basename $$(dirname $@))

msgpack: $(MPK_SCHEMA_SOURCES)

python:
	mkdir -p $(PYTHON_DIST_DIR)
	cp -r $(PYTHON_SRC_DIR)/* $(PYTHON_DIST_DIR)
	cp -r templates/python/* $(PYTHON_DIST_DIR)
	cd $(PYTHON_DIST_DIR) && python3 setup.py sdist bdist_wheel

dist_package:
	mkdir -p $(DIST_DIR)
	mkdir -p $(OUT_DIR)
	echo $(PACKAGE_VERSION) > $(OUT_DIR)/VERSION

	tar -czf $(DIST_DIR)/$(PACKAGE_FILENAME) -C $(DIST_DIR) $(PACKAGE_NAME)

dist:
	@docker run -it --rm \
		--volume $$(pwd):/tmp/repo \
		--env PIP_EXTRA_INDEX_URL=$(PIP_EXTRA_INDEX_URL) \
		--env PACKAGE_VERSION=$(PACKAGE_VERSION) \
		--workdir /tmp/repo \
		$(PYTHON_BUILDER_IMAGE) \
		/bin/bash -c "make dist_package"

	@echo ""
	@echo "Distribution package files:"
	@echo "--------------------------"
	@ls -1sh $(DIST_DIR)/*.*
	@ls -1sh $(PYTHON_DIST_DIR)/dist/*.*


clean:
	-@rm -rf $(DIST_DIR)

.PHONY: default build fbs msgpack python dist dist_package builders clean $(FBS_SCHEMA_SOURCES) $(MPK_SCHEMA_SOURCES)