hledger/Makefile

# hledger project makefile

SOURCEFILES:=*hs Commands/*hs Ledger/*hs
DOCFILES=HOME README NEWS CONTRIBUTORS SCREENSHOTS
TIME:=`date +"%Y%m%d%H%M"`

# patches since last release tag (as a haskell string literal)
PATCHES:=$(shell expr `darcs changes --count --from-tag=\\\\\.` - 1)

# optional flags described in README, turn em on if you've got the libs
OPTFLAGS=-DHAPPS -DVTY 

BUILDFLAGS=-DPATCHES=$(PATCHES) $(OPTFLAGS)

# command to run during "make ci"
#CICMD=web --debug -BE
CICMD=test

# executables to benchtest, prepend ./ if not in $PATH.  
BENCHEXES=hledger-0.4 hledger-0.5 ledger

# command to run during profiling
PROFCMD=-f 1000x1000x10.ledger balance

# document viewing commands
VIEWHTMLCMD=open
VIEWPSCMD=open

default: tag hledger

######################################################################
# BUILDING, DEBUGGING

# build the standard developer's binary, quickly
hledger: setversion
	ghc --make hledger.hs -o hledger $(BUILDFLAGS) # -O

# build the profiling-enabled binary. You may need to cabal install
# --reinstall -p some libs.
hledgerp: setversion
	ghc --make hledger.hs -prof -auto-all -o hledgerp #$(BUILDFLAGS) 

# build the coverage-enabled binary (untested)
hledgercov: setversion
	ghc --make hledger.hs -hpc -o hledgercov $(BUILDFLAGS) 

# build the fastest binary we can
hledgeropt: setversion
	ghc --make hledger.hs -o hledgeropt -O2 -fvia-C $(BUILDFLAGS)

# "continuous integration" testing - auto-recompile and run hledger test
# (or some other command) whenever a module changes. sp is from
# searchpath.org , you might need the patched version from
# http://joyful.com/repos/searchpath .
continuous ci: setversion
	sp --no-exts --no-default-map -o hledger ghc --make hledger.hs $(BUILDFLAGS) --run $(CICMD)

# build the benchmark runner. Requires tabular from hackage.
bench:
	ghc --make tools/bench.hs

# build the doctest runner
tools/doctest: tools/doctest.hs
	ghc --make tools/doctest.hs

# build the generateledger tool
generateledger: tools/generateledger.hs
	ghc --make tools/generateledger.hs

# get a debug prompt
ghci:
	ghci hledger.hs

# generate, save and display a standard profile
prof: sampleledgers hledgerp
	@echo "Profiling $(PROFCMD)"
	./hledgerp +RTS -p -RTS $(PROFCMD) >/dev/null
	mv hledgerp.prof profs/$(TIME)-orig.prof
	tools/simplifyprof.hs profs/$(TIME)-orig.prof >profs/$(TIME).prof
	(cd profs; rm -f latest*.prof; ln -s $(TIME)-orig.prof latest-orig.prof; ln -s $(TIME).prof latest.prof)
	echo; cat profs/latest.prof

# generate, save and display a graphical heap profile
heap: sampleledgers hledgerp
	@echo "Profiling heap with $(PROFCMD)"
	./hledgerp +RTS -hc -RTS $(PROFCMD) >/dev/null
	mv hledgerp.hp profs/$(TIME).hp
	(cd profs; rm -f latest.hp; ln -s $(TIME).hp latest.hp; \
		hp2ps $(TIME).hp; rm -f latest.ps; ln -s $(TIME).ps latest.ps)
	$(VIEWPSCMD) profs/latest.ps

# generate, save and display a code coverage report (untested)
coverage: sampleledgers hledgercov
	@echo "Generating coverage report with $(PROFCMD)"
	./hledgercov $(PROFCMD) >/dev/null
	hpc report hledgercov
	#hpc markup hledgercov

######################################################################
# TESTING

# run all tests
test: unittest doctest haddocktest

# run unit tests, without waiting for compilation
unittest:
	runghc hledger.hs test

# run doc tests
doctest: tools/doctest
	@tools/doctest AddCommand.hs
	@tools/doctest Tests.hs

# make sure we have no haddock errors
haddocktest:
	@make --quiet haddock

# run performance tests and save results in profs/. 
# Requires some tests defined in bench.tests and some executables defined above.
benchtest: sampleledgers bench.tests bench
	tools/bench -fbench.tests $(BENCHEXES) | tee profs/$(TIME).bench
	@(cd profs; rm -f latest.bench; ln -s $(TIME).bench latest.bench)

# generate standard sample ledgers
sampleledgers: sample.ledger 100x100x10.ledger 1000x1000x10.ledger 10000x1000x10.ledger \
	100000x1000x10.ledger 1000.ledger 10000.ledger 100000.ledger 1000x1000x10.ledger

sample.ledger:
	true # XXX should probably regenerate this

100x100x10.ledger: generateledger
	tools/generateledger 1000 1000 10 >$@

1000x1000x10.ledger: generateledger
	tools/generateledger 1000 1000 10 >$@

10000x1000x10.ledger: generateledger
	tools/generateledger 10000 1000 10 >$@

100000x1000x10.ledger: generateledger
	tools/generateledger 100000 1000 10 >$@

# keep for next benchmark report..
1000include.ledger:
	ghc -e 'putStr $$ unlines $$ replicate 1000 "!include sample.ledger"' >1000.ledger

10000include.ledger:
	ghc -e 'putStr $$ unlines $$ replicate 10000 "!include sample.ledger"' >10000.ledger

100000include.ledger:
	ghc -e 'putStr $$ unlines $$ replicate 100000 "!include sample.ledger"' >100000.ledger

######################################################################
# DOCUMENTATION

# website/ and website/api-doc/ always exist. website contains both
# generated files (UPPERCASE.html) and revision-controlled resource files
# (everything else).  website/api-doc contains only generated files.
cleandocs:
	rm -rf website/[A-Z]*.html website/api-doc/*

# rebuild all docs
docs: web pdf api-docs

# build the main hledger.org website
web:
	for d in $(DOCFILES); do pandoc -s -H website/header.html -A website/footer.html -r rst $$d >website/$$d.html; done
	cd website; rm -f index.html; ln -s HOME.html index.html

# generate pdf versions of main docs
pdf:
	-for d in $(DOCFILES); do rst2pdf $$d -o website/$$d.pdf; done

# generate api docs
# We munge haddock and hoogle into a rough but useful framed layout.
# For this to work the hoogle cgi must be built with base target "main".
api-docs: haddock hoogle
	echo "Converting api docs to frames" ; \
	sed -i -e 's%^></HEAD%><base target="main"></HEAD%' website/api-doc/modules-index.html ; \
	cp website/api-doc-frames.html website/api-doc/index.html ; \
	cp website/hoogle-small.html website/api-doc

# generate and view the api docs
view-api-docs: api-docs
	$(VIEWHTMLCMD) website/api-doc/index.html

MAIN=hledger.hs

# --ignore-all-exports means we are documenting internal implementation, not library api
HADDOCK=haddock -B `ghc --print-libdir` --no-warnings --ignore-all-exports $(subst -D,--optghc=-D,$(BUILDFLAGS))
haddock: hscolour $(MAIN)
	echo "Generating haddock api docs with source" ; \
	$(HADDOCK) -o website/api-doc -h --source-module=src-%{MODULE/./-}.html --source-entity=src-%{MODULE/./-}.html#%N $(filter-out %api-doc-dir hscolour,$^) && \
		cp website/api-doc/index.html website/api-doc/modules-index.html

HSCOLOUR=HsColour -css 
hscolour:
	echo "Generating colourised source" ; \
	for f in $(SOURCEFILES); do \
		$(HSCOLOUR) -anchor $$f -owebsite/api-doc/`echo "src/"$$f | sed -e's%/%-%g' | sed -e's%\.hs$$%.html%'` ; \
	done ; \
	cp website/api-doc/src-hledger.html website/api-doc/src-Main.html ; \
	HsColour -print-css >website/api-doc/hscolour.css

#set up the hoogle web interface
#uses a hoogle source tree configured with --datadir=., patched to fix haddock urls/target frame
HOOGLESRC=/usr/local/src/hoogle
HOOGLE=$(HOOGLESRC)/dist/build/hoogle/hoogle
HOOGLEVER=`$(HOOGLE) --version |tail -n 1 | sed -e 's/Version /hoogle-/'`
hoogle: hoogleindex
	echo "Configuring hoogle web interface" ; \
	if test -f $(HOOGLE) ; then \
		cd website/api-doc && \
		rm -f $(HOOGLEVER) && \
		ln -s . $(HOOGLEVER) && \
		cp -r $(HOOGLESRC)/src/res/ . && \
		cp -p $(HOOGLE) index.cgi && \
		touch log.txt && chmod 666 log.txt ; \
	else \
		echo "Could not find $(HOOGLE) in the hoogle source tree" ; \
	fi

#generate a hoogle index
hoogleindex: $(MAIN)
	echo "Generating hoogle index" ; \
	$(HADDOCK) -o website/api-doc --hoogle $^ && \
	cd website/api-doc && \
	hoogle --convert=main.txt --output=default.hoo

######################################################################
# RELEASING

# Places where hledger's version number makes an appearance:
#  hledger --version
#  hledger's cabal file
#  darcs tags
#  hackage tarball filenames
#  hackage pages
#
# Goals and constraints for our version number system:
# 1 automation, robustness, simplicity, platform independence
# 2 cabal versions must be all-numeric
# 3 release versions can be concise (without extra .0's)
# 4 releases should have a corresponding darcs tag
# 5 development builds should have a precise version appearing in --version
# 6 development builds should generate cabal packages with non-confusing versions
# 7 there should be a way to mark builds/releases as alpha or beta
# 8 it should be easy to darcs get the .0 release even after bugfix releases
# 9 avoid unnecessary compiling and linking
# 10 minimise rcs noise and syncing issues (commits, unrecorded changes)
#
# Current plan:
# - The release version looks like major.minor[.bugfix].  bugfix is 0 (and
#   may be elided) for a normal release, or 1..n for a bugfix release, or
#   98 meaning an alpha for the forthcoming release, or 99 meaning a beta.
# - The build version looks like major.minor.bugfix.patches, where patches
#   is the number of patches applied since the last release tag.
# - Set the release version in VERSION before "make" or "make release".
# - "make" updates version strings where needed, and defines PATCHES.
#   "make release" also records the version number changes and tags the
#   repo. (Todo: make cabal build set the version and PATCHES, also)
# - hledger --version shows the build version
# - The cabal package uses the release version
# - The release tag is the non-elided release version.

# run pre-release checks: cabal is happy, the code builds, tests pass..
check: setversion test
	cabal clean
	cabal check
	cabal configure -fvty -fhapps
	cabal build
	dist/build/hledger/hledger test 2>&1 | tail -1 | grep -q 'Errors: 0  Failures: 0'

# Build a cabal release, tag the repo and maybe upload to hackage.
# Don't forget to update VERSION if needed. Examples:
# releasing 0.5:          set VERSION to 0.5, make release hackageupload
# doing a bugfix release: set VERSION to 0.5.1, make release hackageupload
# building 0.6 alpha:     set VERSION to 0.5.98, make
# releasing 0.6 beta:     set VERSION to 0.5.99, make release
release: check setandrecordversion tagrelease sdist

# file where the current release version is defined
VERSIONFILE=VERSION

# two or three-part version string
VERSION:=`grep -v '^--' $(VERSIONFILE)`

# three-part version string
ifeq ($(shell ghc -e "length (filter (=='.') \"$(VERSION)\")"), 1)
VERSION3:=$(VERSION).0
else
VERSION3:=$(VERSION)
endif

# other files containing the version string
VERSIONFILES=hledger.cabal Version.hs

hledger.cabal: $(VERSIONFILE)
	perl -p -e "s/(^version: *) .*/\1 $(VERSION)/" -i $@

Version.hs: $(VERSIONFILE)
	perl -p -e "s/(^version *= *)\".*?\"/\1\"$(VERSION3)\"/" -i $@

# update the version string in local files. Triggered by "make".
setversion: $(VERSIONFILES)

# update the version string in local files, and record them (and
# $VERSIONFILE) if changed.  Be careful, will record all changes in those
# files (so prompts interactively). Triggered by "make release".
setandrecordversion: setversion
	darcs record -m "bump version" $(VERSIONFILE) $(VERSIONFILES)

tagrelease:
	darcs tag $(VERSION3)

sdist:
	cabal sdist

# display a hackage upload command reminder
hackageupload:
	@echo please do: cabal upload dist/hledger-$(VERSION).tar.gz -v3

# send unpushed patches to the mail list
send:
	darcs send http://joyful.com/repos/hledger --to=hledger@googlegroups.com --edit-description  

# push patches to the main repo with ssh
push:
	darcs push joyful.com:/repos/hledger

# sync latest profiles and benchtest results to the public site
pushprofs:
	rsync -azP profs/ joyful.com:/repos/hledger/profs/ #--delete 

# show project stats useful for release notes
stats: showlastreleasedate showreleaseauthors showloc showerrors showlocalchanges showreleasechanges bench

showreleaseauthors:
	@echo Patch authors since last release:
	@darcs changes --from-tag . |grep '^\w' |cut -c 31- |sort |uniq
	@echo

showloc:
	@echo Lines of non-test code:
	@sloccount `ls {,Ledger/}*.hs |grep -v Tests.hs` | grep haskell:
	@echo Lines of test code:
	@sloccount Tests.hs | grep haskell:
	@echo

showlastreleasedate:
	@echo Last release date:
	@darcs changes --from-tag . | tail -2
	@echo

showerrors:
	@echo Known errors:
	@awk '/^** errors/, /^** / && !/^** errors/' NOTES | grep '^\*\*\* ' | tail +1
	@echo

showlocalchanges:
	@echo Local changes:
	@-darcs push joyful.com:/repos/hledger --dry-run | grep '*' | tac
	@echo

showreleasechanges:
	@echo "Changes since last release: ("`darcs changes --from-tag . --count`")"
	@darcs changes --from-tag . | grep '*'
	@echo

######################################################################
# MISCELLANEOUS

tag: emacstags

emacstags:
	@rm -f TAGS; hasktags -e $(SOURCEFILES) hledger.cabal

clean:
	rm -f `find . -name "*.o" -o -name "*.hi" -o -name "*~" -o -name "darcs-amend-record*"`

Clean: clean cleandocs
	rm -f hledger TAGS tags