# Bootstrap the protoc plugin

# README.md for more details.

# Assumes that this is a submodule of
# git@github.com:SWI-Prolog/swipl-devel.git and that the swipl
# executable has been built (see ../../../CMAKE.md).

# Assumes that you have downloaded
# https://github.com/protocolbuffers/protobuf (or
# git@github.com:protocolbuffers/protobuf.git) and built it following
# the instructions. If you prefer to download (either by installing
# the package `protobuf-compiler` the main Ubuntu or Debian
# respository, or from
# https://developers.google.com/protocol-buffers/docs/downloads), that
# should work with some tweaking of things like PROTOC.

# Assumption: protoc and swipl are in your $PATH ... you can override
# these by setting PROTOC= or SWIPL= when envoking "make".

# This has been run on Ubuntu 20.0.4. It will probably run on other
# Linuxes.  It has not been tried on Windows, except to ensure that
# the C code compiles with MSVC.

# Many of the rules at the end of this Makefile are for development
# and will eventually be removed.

# For naming conventions - see README.md section "descriptor.proto and friends"

MAKEFLAGS=--warn-undefined-variables

include common.mk

.SUFFIXES: .proto .pl .py .wire .wiredump .wirerawdump .segment

.DELETE_ON_ERROR: # Any non-zero return code deletes the target file(s)

.PHONY: FORCE all all2 clean docs test_segment_messages bootstrap

.DEFAULT_GOAL=all

all: bootstrap

test: test_segment_messages $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.segment

all2: $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin.proto.wiredump \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin.proto.wire \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin.proto.parse \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin.proto.segment \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.wiredump \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.wire \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.parse \
     $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.segment \
     bootstrap

.PHONY: bootstrap
# The *_pb.qlf files aren't used (just the *_pb.pl files)
# but are generated for the "--undefined" check.
bootstrap: $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor_pb.qlf $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin_pb.qlf
	$(RM) $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor_pb.qlf $(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/plugin_pb.qlf

%_pb.pl: %.proto protoc-gen-swipl
	@# PATH=".:$$PATH" $(PROTOC) $(PROTOC_I) --swipl_out=. $<
	@# TODO: s/OUT_PARAMETER/all/ ? (see comment in protoc-gen-swipl
	@#                              with Request.parameter)
	PATH=$(PATH_WITH_SWIPL) $(PROTOC) $(PROTOC_I) --swipl_out='OUT_PARAMETER':. \
		--plugin=protoc-gen-swipl=$(realpath protoc-gen-swipl) $<

$(PROTOC_GEN_PROLOG_PB)/%_pb.pl: $(PROTOC_INCLUDE)/%.proto protoc-gen-swipl
	PATH=$(PATH_WITH_SWIPL) $(PROTOC) -I$(PROTOC_INCLUDE) --swipl_out=$(PROTOC_GEN_PROLOG_PB) \
		--plugin=protoc-gen-swipl=$(realpath protoc-gen-swipl) $(subst $(PROTOC_INCLUDE)/,,$<)

%.qlf: %.pl
	@# --undefined is for double-checking
	$(SWIPL) --undefined=error --verbose=false -o $*.qlf -c <$*.pl

# Protobuf code generator for Python  # TODO: delete when no longer needed

# TODO: should put the *_pb2.py files in a different directory
$(PROTOC_GEN_PROLOG_PB)/%_pb2.py: $(PROTOC_INCLUDE)/%.proto
	$(PROTOC) $(PROTOC_I) -I$(PROTOC_INCLUDE) --python_out=$(PROTOC_GEN_PROLOG_PB) \
		$(subst $(PROTOC_INCLUDE)/,,$<)

# Make a binary protobuf msg file (see $(DESCRIPTOR_PROTO)) with a
# FileDescriptorSet message, describing the .proto and all its
# dependencies:
$(PROTOC_GEN_PROLOG_PB)/%.proto.wire: $(PROTOC_INCLUDE)/%.proto
	$(PROTOC) -I$(PROTOC_INCLUDE) --include_imports --descriptor_set_out=$@ \
		$(subst $(PROTOC_INCLUDE)/,,$<)

# Run the protobuf_segment_messages test.
# See also rules descriptor.proto.wirerawdump, descriptor.proto.wiredump
test_segment_messages: $(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.wire tests.pl FORCE
	$(SWIPL) -g "test_segment_messages('$(PROTOC_GEN_PROLOG_PB)/google/protobuf/descriptor.proto.wire')" -g halt tests.pl

%.proto.wiredump: %.proto.wire
	$(PROTOC) -I$(PROTOC_INCLUDE) \
		--decode=google.protobuf.FileDescriptorSet \
		google/protobuf/descriptor.proto \
		<$*.proto.wire >$@

%.proto.segment: descriptor_proto.pl descriptor_proto_expand.pl %.proto.wire
	$(SWIPL) descriptor_proto.pl <$*.proto.wire >$@

%.proto.parse: %.proto.wiredump parse_descriptor_proto_dump.pl
	$(SWIPL) -g "parse_wiredump('$*.proto.wiredump')" \
		-g halt parse_descriptor_proto_dump.pl >$@

%.proto.wirerawdump: %.proto.wire
	$(PROTOC) --decode_raw <$*.proto.wire >$@

clean:
	$(RM) -r foo *.tmp *.o *.pb.cc *.pb.h *_pb2.py *_pb.pl *_pb0.pl doc/ ../TAGS \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/*.proto.parse \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/*.proto.segment \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/*.proto.wire \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/*.proto.wiredump \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/*.proto.wirerawdump \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*_pb2.py \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*.proto.parse \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*.proto.segment \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*.proto.wire \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*.proto.wiredump \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*.proto.wirerawdump \
		$(PROTOC_GEN_PROLOG_PB)/google/protobuf/compiler/*_pb2.py \
		__pycache__
	git clean -ndxf  # Should find nothing.

# For testing: this is what the build does.

.PHONY: ctest_protobufs
ctest_protobufs:
	@# The top level runs protobufs:protobufs:
	@# $(SWIPL) "-p" "foreign=" "-f" "none" "--no-packs" "-s" ../test_protobufs.pl "-g" "test_protobufs" "-t" "halt"
	@# And ../CMakeLists.txt runs the others
	@# The following command runs everything (assuming that directory "build" exists):
	cd ../../../build && cmake -G Ninja .. && ninja && ctest  -j5 -R protobufs

.PHONY: test_protobufs
test_protobufs:
	cd .. && $(SWIPL) -g run_tests -t halt test_protobufs.pl

# For looking at the generated documentation.  This assumes that
# you're working in ~/src/contrib-protobufs and that there's also
# ~/src/swipl-devel (and you might wish to stash
# ~/src/swipl-devel/packages/protobufs somewhere).
# Also, cmake doesn't seem to play nicely with symlinks,
# so we can't just do
#    ln -s $(HOME)/src/contrib-protobufs $(HOME)/src/swipl-devel/packages/protobufs

.PHONY: rebuild rebuild_clean rebuild other_tests

rebuild_clean:  # TODO: rename as dist_clean
	cd ../../.. && git clean -dxf
	$(MAKE) rebuild

rebuild:
	cd ../../.. && \
		mkdir -p build && \
		cd build && \
		cmake -G Ninja .. && \
		ninja && \
		ctest -j8
	@# gio open $(HOME)/src/swipl-devel/build/packages/protobufs/protobufs.html

rebuild0: # same as rebuild but without the test
	cd ../../.. && \
		mkdir -p build && \
		cd build && \
		cmake -G Ninja .. && \
		ninja

# Generate the documentation from ../protobufs.pl
# The result is in ../doc/protobufs.html
docs:
	cd .. && $(SWIPL) -g 'use_module(library(doc_files))' \
		-g 'doc_save(.,[])' -g halt protobufs.pl

.PHONY: tar
tar: # TODO: remove this
	$(MAKE) clean
	$(MAKE) -C ../interop clean
	$(MAKE) -C ../demo clean
	cd ../../.. && tar --create --bzip2 --file ~/Downloads/contrib-protobufs-$$(date +%Y-%m-%d-%H-%M).tbz2 packages/protobufs
	-$(MAKE)
	-$(MAKE) -C ../demo
	-$(MAKE) -C ../interop
	$(MAKE) etags

.PHONY: etags
etags:	../TAGS
../TAGS: ../*.pl ./*.pl ../interop/*.pl
	etags -l prolog -o $@ ../*.pl ./*.pl ../interop/*.pl

.PHONY: tkdiff
tkdiff:
	git difftool --tool=tkdiff --no-prompt
