Makefile

#
# This is free and unencumbered software released into the public domain.
# See ../LICENSE.unlicense
#
# vim: noet sw=4 ts=4
#

# ======================
# 
# No configuration here
# See build.mk
include defaults.mk
-include build.mk
#
# ======================

# As the build system gets more complex I want to avoid autoconf.  Perhaps
# instead create a config.h and makefile for each major OS+platform
# combination.  An optional configure script could put the right file in
# place.  Also consider autosetup.

vpath %.m src
vpath %.c runtime
vpath %.cpp runtime
vpath %.h runtime
vpath %.o runtime
vpath %.txt docs
vpath %.html docs/html

MERCURY_SOURCES=$(wildcard src/*.m)

# There are no C sources but we keep this in case we add some C code (eg
# a library interface.)  The tags target will need to be fixed if C sources
# are added.
C_SOURCES=

# NOTE that when we add alternative interpreters we'll need to seperate out
# the generic files, that includes updating pz_closure.h so it includes
# different files.
CXX_SOURCES=runtime/pz_main.cpp \
		runtime/pz.cpp \
		runtime/pz_builtin.cpp \
		runtime/pz_code.cpp \
		runtime/pz_data.cpp \
		runtime/pz_foreign.cpp \
		runtime/pz_generic_closure.cpp \
		runtime/pz_generic_builtin.cpp \
		runtime/pz_generic_run.cpp \
		runtime/pz_gc.cpp \
		runtime/pz_gc_alloc.cpp \
		runtime/pz_gc_collect.cpp \
		runtime/pz_gc_util.cpp \
		runtime/pz_instructions.cpp \
		runtime/pz_io.cpp \
		runtime/pz_library.cpp \
		runtime/pz_memory.cpp \
		runtime/pz_option.cpp \
		runtime/pz_read.cpp \
		runtime/pz_string.cpp \
		runtime/pz_generic.cpp \
		runtime/pz_generic_builder.cpp

C_CXX_SOURCES=$(C_SOURCES) $(CXX_SOURCES)
C_HEADERS=$(wildcard runtime/*.h)
OBJECTS=$(patsubst %.c,%.o,$(C_SOURCES)) $(patsubst %.cpp,%.o,$(CXX_SOURCES))

DOCS_HTML=docs/index.html \
	docs/getting_started.html \
	docs/user_guide.html \
	docs/plasma_ref.html \
	docs/contributing.html \
	docs/dev_howto_make_pr.html \
	docs/dev_compiler_internals.html \
	docs/dev_testing.html \
	docs/dev_style_mercury.html \
	docs/dev_style_c.html \
	docs/dev_mercury_grades.html \
	docs/dev_maintainers.html \
	docs/dev_bugtracking.html \
	docs/design_principles.html \
	docs/design_concept_map.html \
	docs/design_types.html \
	docs/design_ideas.html \
	docs/references.html \
	docs/pz_machine.html

# Extra development modules
ifeq ($(BUILD_TYPE),dev)
	CXX_SOURCES+= \
		runtime/pz_gc_debug.cpp \
		runtime/pz_trace.cpp
else
endif

ifneq ($(shell which $(ASCIIDOC)),)
	DOCS_TARGETS=$(DOCS_HTML)
else
	DOCS_TARGETS=.docs_warning
endif

CFLAGS=$(DEPFLAGS) $(C_CXX_FLAGS) $(C_ONLY_FLAGS)
CXXFLAGS=$(DEPFLAGS) $(C_CXX_FLAGS) $(CXX_ONLY_FLAGS)
$(shell mkdir -p $(DEPDIR)/runtime >/dev/null)

.SUFFIXES:

.PHONY: all
all : progs docs

.PHONY: progs
progs : \
	runtime/plzrun \
	src/plzasm \
	src/plzbuild \
	src/plzc \
	src/plzdisasm \
	src/plzgeninit \
	src/plzlnk

.PHONY: install
install: install_progs install_docs install_examples

.PHONY: install_dirs
install_dirs:
	$(INSTALL_DIR) $(DEST_DIR)$(BINDIR)
	$(INSTALL_DIR) $(DEST_DIR)$(DOCDIR)

.PHONY: install_progs
install_progs : install_dirs progs
	$(INSTALL_STRIP) runtime/plzrun $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzasm $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzbuild $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzc $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzdisasm $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzgeninit $(DEST_DIR)$(BINDIR)
	$(INSTALL_STRIP) src/plzlnk $(DEST_DIR)$(BINDIR)

.PHONY: install_docs
install_docs : install_dirs docs
	cd docs/ ; for FILE in $$(find -name '*.txt' -o -name '*.html' ); do \
		$(INSTALL) $$FILE $(DEST_DIR)$(DOCDIR); \
	done
	if [ -f docs/index.html ]; then \
		$(INSTALL_DIR) $(DEST_DIR)$(DOCDIR)/css; \
		$(INSTALL_DIR) $(DEST_DIR)$(DOCDIR)/images; \
		$(INSTALL) docs/css/asciidoc.css $(DEST_DIR)$(DOCDIR)/css; \
		$(INSTALL) docs/css/docs-offline.css $(DEST_DIR)$(DOCDIR)/css; \
		$(INSTALL) docs/images/favicon.ico $(DEST_DIR)$(DOCDIR)/images; \
		$(INSTALL) docs/images/sunt-200.png $(DEST_DIR)$(DOCDIR)/images; \
	fi

.PHONY: install_examples
install_examples : install_dirs
	$(INSTALL_DIR) $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/BUILD.plz $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/README.md $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/hello.p $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/fib.p $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/module_example.p $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/module_to_import.p $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/mr4.p $(DEST_DIR)$(DOCDIR)/examples
	$(INSTALL) examples/temperature.p $(DEST_DIR)$(DOCDIR)/examples

# .mer_progs must be real and not a phony target to make this work with
# make -j
src/plzasm : .mer_progs
	touch src/plzasm
src/plzbuild : .mer_progs
	touch src/plzbuild
src/plzc : .mer_progs
	touch src/plzc
src/plzdisasm : .mer_progs
	touch src/plzdisasm
src/plzgeninit : .mer_progs
	touch src/plzgeninit
src/plzlnk : .mer_progs 
	touch src/plzlnk
.mer_progs : $(MERCURY_SOURCES) runtime/pz_config.h $(C_HEADERS)
	rm -f src/*.err
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzasm)
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzbuild)
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzc)
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzdisasm)
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzgeninit)
	(cd src; $(MMC_MAKE) --cflags="$(C_CXX_FLAGS_BASE)" $(MCFLAGS) plzlnk)
	touch .mer_progs

# We need -rdynamic here so that the foreign code libraries can resolve
# symbols in the runtime's executable.
runtime/plzrun : $(OBJECTS)
	$(CXX) $(CFLAGS) -o $@ $^ -ldl -rdynamic

%.o : %.c runtime/pz_config.h
	$(CC) $(CFLAGS) -o $@ -c $<
	mv -f $(DEPDIR)/$(basename $*).Td $(DEPDIR)/$(basename $*).d

%.o : %.cpp runtime/pz_config.h
	$(CXX) $(CXXFLAGS) -o $@ -c $<
	mv -f $(DEPDIR)/$(basename $*).Td $(DEPDIR)/$(basename $*).d

runtime/pz_config.h : runtime/pz_config.h.in defaults.mk build.mk
	sed -e 's/@VERSION@/${VERSION}/' < $< > $@

$(DEPDIR)/%.d : ;
.PRECIOUS: $(DEPDIR)/%.d

.PHONY: test
test : test-old test-new

.PHONY: test-old
test-old : src/plzasm src/plzlnk src/plzc src/plzbuild runtime/plzrun
	(cd tests-old; ./run_tests.sh $(BUILD_TYPE))
.PHONY: test-new
test-new : src/plzasm src/plzlnk src/plzc src/plzbuild runtime/plzrun
	BUILD_TYPE=$(BUILD_TYPE) ./tests/run-tests.lua examples tests | ./tests/pretty.lua

.PHONY: tags
tags : src/tags runtime/tags
src/tags : $(MERCURY_SOURCES)
	(cd src; mtags *.m)
runtime/tags: $(CXX_SOURCES) $(C_HEADERS)
	(cd runtime; ctags *.cpp *.h)

.PHONY: docs
docs : $(DOCS_TARGETS)

.docs_warning :
	@echo
	@echo Warning: $(ASCIIDOC) not found, not building documentation.
	@echo --------------------------------------------------------
	@echo
	touch .docs_warning

%.html : %.txt docs/asciidoc.conf
	$(ASCIIDOC) --conf-file docs/asciidoc.conf  -o $@ $<

#
# Clean removes all intermediate files
#
.PHONY: clean
clean : localclean
	$(MAKE) -C examples clean
	$(MAKE) -C tests-old/pzt clean
	$(MAKE) -C tests-old/modules clean
	$(MAKE) -C tests-old/modules-invalid clean
	find tests -name *.pz -o \
			   -name *.out -o \
			   -name *.outs \
		| xargs -r rm
	find tests -name _build -o \
			   -name \*.dir \
		| xargs -r rm -r

#
# Realclean removes all generated files plus plasma-dump files.
#
.PHONY: realclean
realclean : localclean
	$(MAKE) -C examples realclean
	$(MAKE) -C tests-old/pzt realclean
	$(MAKE) -C tests-old/modules realclean
	$(MAKE) -C tests-old/modules-invalid realclean
	find tests -name *.so \
		| xargs -r rm
	rm -f src/tags 
	rm -f src/plzasm src/plzbuild src/plzc src/plzdisasm src/plzgeninit \
		src/plzlnk
	rm -rf src/Mercury
	rm -f .mer_progs
	rm -rf runtime/tags runtime/plzrun
	rm -rf $(DOCS_HTML)

.PHONY: localclean
localclean:
	for dir in \
		date0s \
		date3s \
		dates \
		err_dates \
		int0s \
		int2s \
		int3s \
		ints \
		module_deps ; \
	do \
		rm -rf src/Mercury/$$dir; \
	done
	for dir in cs os c_dates ; do \
		rm -rf src/Mercury/*/*/Mercury/$$dir; \
	done
	rm -rf src/*.err src/*.mh
	rm -rf runtime/*.o runtime/pz_config.h
	rm -rf examples/*.pz examples/*.diff examples/*.out
	rm -rf .docs_warning
	rm -rf $(DEPDIR)

# Nither formatting tool does a perfect job, but clang-format seems to be
# the best.
.PHONY: format
format: formatclangformat

.PHONY: formatclangformat
formatclangformat:
	$(CLANGFORMAT) -style=file -i $(C_SOURCES) $(CXX_SOURCES) $(C_HEADERS)

include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(C_CXX_SOURCES))))