cryptol/Makefile

HERE := $(dir $(lastword $(MAKEFILE_LIST)))

UNAME   := $(shell uname -s)
ARCH    := $(shell uname -m)

TESTS ?= issues regression renamer mono-binds
TEST_DIFF ?= meld

CABAL_BUILD_FLAGS   ?= -j
CABAL_INSTALL_FLAGS ?= $(CABAL_BUILD_FLAGS)

CABAL         := cabal
CABAL_BUILD   := $(CABAL) build $(CABAL_BUILD_FLAGS)
CABAL_INSTALL := $(CABAL) install $(CABAL_INSTALL_FLAGS)
CS            := $(HERE)/.cabal-sandbox
CS_BIN        := $(CS)/bin

# Used only for windows, to find the right Program Files.
PROGRAM_FILES = Program\ Files\ \(x86\)
# Windows installer tools; assumes running on Cygwin and using WiX 3.8
WiX      := /cygdrive/c/${PROGRAM_FILES}/WiX\ Toolset\ v3.8
CANDLE   := ${WiX}/bin/candle.exe
HEAT     := ${WiX}/bin/heat.exe
LIGHT    := ${WiX}/bin/light.exe

REV         ?= $(shell git rev-parse --short=7 HEAD || echo "unknown")
VERSION     := $(shell grep -i ^Version cryptol.cabal | awk '{ print $$2}')
SYSTEM_DESC ?= ${UNAME}-${ARCH}_${REV}
PKG         := cryptol-${VERSION}-${SYSTEM_DESC}

# Windows-specific stuff
ifneq (,$(findstring _NT,${UNAME}))
  DIST := ${PKG}.msi
  EXE_EXT := .exe
  adjust-path = '$(shell cygpath -w $1)'
  PREFIX ?= ${PROGRAM_FILES}/Galois/Cryptol\ ${VERSION}
  # split this up because `cabal copy` strips drive letters
  PREFIX_ABS    := /cygdrive/c/${PREFIX}
  # since Windows installs aren't overlapping like /usr/local, we
  # don't need this extra prefix
  PREFIX_SHARE  :=
  # goes under the share prefix
  PREFIX_DOC    := /doc
  PKG_PREFIX    := ${PKG}/${PREFIX}
else
  DIST := ${PKG}.tar.gz ${PKG}.zip
  EXE_EXT :=
  adjust-path = '$1'
  PREFIX ?= /usr/local
  PREFIX_ABS := ${PREFIX}
  PREFIX_SHARE := /share
  # goes under the share prefix
  PREFIX_DOC   := /doc/cryptol
  PKG_PREFIX   := ${PKG}${PREFIX}
endif

CRYPTOL_EXE  := ./dist/build/cryptol/cryptol${EXE_EXT}
ICRYPTOL_EXE := ./dist/build/cryptol/icryptol-kernel${EXE_EXT}

.PHONY: all
all: ${CRYPTOL_EXE}

.PHONY: run
run: ${CRYPTOL_EXE}
	CRYPTOLPATH=$(call adjust-path,$(CURDIR)/lib) ${CRYPTOL_EXE}

.PHONY: notebook
notebook: ${PKG}
	mkdir -p $(CURDIR)/.ipython
	IPYTHONDIR=$(CURDIR)/.ipython \
	PATH=$(call adjust-path,${CURDIR}/${PKG_BIN}):$$PATH \
	CRYPTOLPATH=$(call adjust-path,$(CURDIR)/lib) \
	${PKG_BIN}/icryptol --notebook-dir=$(call adjust-path,${PKG_EXNB})

.PHONY: docs
docs:
	(cd docs; make)

.PHONY: dist
dist: ${DIST}

.PHONY: tarball
tarball: ${PKG}.tar.gz

.PHONY: zip
zip: ${PKG}.zip

.PHONY: msi
msi: ${PKG}.msi

# TODO: piece this apart a bit more; if right now if something fails
# during initial setup, you have to invoke this target again manually
${CS}:
	$(CABAL) sandbox init

${CS_BIN}/alex: | ${CS}
	$(CABAL_INSTALL) alex

${CS_BIN}/happy: | ${CS} ${CS_BIN}/alex
	$(CABAL_INSTALL) happy

CRYPTOL_SRC := \
  $(shell find src cryptol \
            \( -name \*.hs -or -name \*.x -or -name \*.y \) \
            -and \( -not -name \*\#\* \) -print) \
  $(shell find lib -name \*.cry)

ICRYPTOL_SRC := \
  $(shell find cryptol notebook \
            \( -name \*.hs -or -name \*.x -or -name \*.y \) \
            -and \( -not -name \*\#\* \) -print)

src/GitRev.hs: .git/index
	sh configure

print-%:
	@echo $* = $($*)

# /usr/share/cryptol on POSIX, installdir/cryptol on Windows
DATADIR := ${PREFIX_ABS}${PREFIX_SHARE}

dist/setup-config: cryptol.cabal | ${CS_BIN}/alex ${CS_BIN}/happy
	$(CABAL_INSTALL) --only-dependencies
	$(CABAL) configure                            \
          --prefix=$(call adjust-path,${PREFIX_ABS})  \
          --datasubdir=cryptol

${CRYPTOL_EXE} ${ICRYPTOL_EXE}: $(CRYPTOL_SRC) $(ICRYPTOL_SRC) src/GitRev.hs dist/setup-config
	$(CABAL_BUILD)


PKG_BIN       := ${PKG_PREFIX}/bin
PKG_SHARE     := ${PKG_PREFIX}${PREFIX_SHARE}
PKG_CRY       := ${PKG_SHARE}/cryptol
PKG_ICRY      := ${PKG_SHARE}/icryptol
PKG_DOC       := ${PKG_SHARE}${PREFIX_DOC}
PKG_EXAMPLES  := ${PKG_DOC}/examples
PKG_EXNB      := ${PKG_EXAMPLES}/notebook
PKG_EXCONTRIB := ${PKG_EXAMPLES}/contrib

PKG_EXAMPLE_FILES := docs/ProgrammingCryptol/aes/AES.cry       \
                     docs/ProgrammingCryptol/enigma/Enigma.cry \
                     examples/DES.cry                          \
                     examples/Cipher.cry                       \
                     examples/DEStest.cry                      \
                     examples/Test.cry                         \
                     examples/SHA1.cry                         \

PKG_EXNB_FILES := examples/notebook/AES.ipynb

PKG_EXCONTRIB_FILES := examples/contrib/mkrand.cry \
                       examples/contrib/RC4.cry    \
                       examples/contrib/simon.cry  \
                       examples/contrib/speck.cry

PROFILE_CRYPTOL_SRC := notebook/profile_cryptol/ipython_config.py \
                       notebook/profile_cryptol/static/base/images/ipynblogo.png \
                       notebook/profile_cryptol/static/custom/custom.css \
                       notebook/profile_cryptol/static/custom/custom.js
notebook/profile.tar: ${PROFILE_CRYPTOL_SRC}
	(cd notebook && tar -cvf profile.tar profile_cryptol)

${PKG}: ${CRYPTOL_EXE} ${ICRYPTOL_EXE} \
        notebook/icryptol notebook/profile.tar \
        docs/*.md docs/*.pdf LICENSE \
        ${PKG_EXAMPLE_FILES} ${PKG_EXCONTRIB_FILES}
	$(CABAL) copy --destdir=${PKG}
# script not included in the copy
	cp notebook/icryptol ${PKG_BIN}
# don't want to bundle the cryptol library in the binary distribution
	rm -rf ${PKG_PREFIX}/lib
	mkdir -p ${PKG_CRY}
	mkdir -p ${PKG_ICRY}
	mkdir -p ${PKG_DOC}
	mkdir -p ${PKG_EXAMPLES}
	mkdir -p ${PKG_EXNB}
	mkdir -p ${PKG_EXCONTRIB}
	cp docs/*.md ${PKG_DOC}
	cp docs/*.pdf ${PKG_DOC}
	cp LICENSE ${PKG_DOC}
	for EXAMPLE in ${PKG_EXAMPLE_FILES}; do \
          cp $$EXAMPLE ${PKG_EXAMPLES}; done
	for EXAMPLE in ${PKG_EXNB_FILES}; do \
          cp $$EXAMPLE ${PKG_EXNB}; done
	for EXAMPLE in ${PKG_EXCONTRIB_FILES}; do \
          cp $$EXAMPLE ${PKG_EXCONTRIB}; done
	cp -r notebook/profile.tar ${PKG_ICRY}

${PKG}.tar.gz: ${PKG}
	tar -czvf $@ $<

${PKG}.zip: ${PKG}
	zip -r $@ $<

${PKG}.msi: ${PKG} win32/cryptol.wxs
	${HEAT} dir ${PKG_PREFIX} -o allfiles.wxs -nologo -var var.pkg \
          -ag -wixvar -cg ALLFILES -srd -dr INSTALLDIR -sfrag
	${CANDLE} -ext WixUIExtension -ext WixUtilExtension            \
          -dversion=${VERSION} -dpkg=${PKG_PREFIX} win32/cryptol.wxs
	${CANDLE} -ext WixUIExtension -ext WixUtilExtension            \
          -dversion=${VERSION} -dpkg=${PKG_PREFIX} allfiles.wxs
	${LIGHT} -ext WixUIExtension -ext WixUtilExtension             \
	  -sval -o $@ cryptol.wixobj allfiles.wixobj
	rm -f allfiles.wxs
	rm -f *.wixobj
	rm -f *.wixpdb

${CS_BIN}/cryptol-test-runner: \
  ${PKG}                       \
  $(CURDIR)/tests/Main.hs      \
  $(CURDIR)/tests/cryptol-test-runner.cabal
	$(CABAL_INSTALL) ./tests

.PHONY: test
test: ${CS_BIN}/cryptol-test-runner
	( cd tests &&                                                      \
	echo "Testing on $(UNAME)-$(ARCH)" &&                              \
	$(realpath $(CS_BIN)/cryptol-test-runner)                          \
	  $(foreach t,$(TESTS),-d $t)                                      \
	  -c $(call adjust-path,${CURDIR}/${PKG_BIN}/cryptol${EXE_EXT})    \
	  -r output                                                        \
	  -T --hide-successes                                              \
	  -T --jxml=$(call adjust-path,$(CURDIR)/results.xml)              \
	  $(if $(TEST_DIFF),-p $(TEST_DIFF),)                              \
	)

.PHONY: clean
clean:
	cabal clean
	rm -f src/GitRev.hs
	rm -f $(CS_BIN)/cryptol-test-suite
	rm -rf cryptol-${VERSION}*/
	rm -rf cryptol-${VERSION}*.tar.gz
	rm -rf cryptol-${VERSION}*.zip
	rm -rf cryptol-${VERSION}*.msi
	rm -rf .ipython

.PHONY: squeaky
squeaky: clean
	-$(CABAL) sandbox delete
	(cd docs; make clean)
	rm -rf dist
	rm -rf tests/dist