[fanfix.git] / Makefile.base

# Makefile base template
# 
# Version:
# - 1.0.0: add a version comment
# - 1.1.0: add 'help', 'sjar'
# - 1.2.0: add 'apk'
# - 1.2.1: improve 'apk' and add 'android'
# - 1.3.0: add 'man' for man(ual) pages
# - 1.4.0: remove android stuff (not working anyway)
# - 1.5.0: include sources and readme/changelog in jar

# Required parameters (the commented out ones are supposed to be per project):

#MAIN = path to main java source to compile
#MORE = path to supplementary needed resources not linked from MAIN
#NAME = name of project (used for jar output file)
#PREFIX = usually /usr/local (where to install the program)
#TEST = path to main test source to compile
#JAR_FLAGS += a list of things to pack, each usually prefixed with "-C bin/"
#SJAR_FLAGS += a list of things to pack, each usually prefixed with "-C src/",
#		for *-sources.jar files
#TEST_PARAMS = any parameter to pass to the test runnable when "test-run"

JAVAC = javac
JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
JAVA = java
JAVA_FLAGS += -cp ./bin/
JAR = jar
RJAR = java
RJAR_FLAGS += -jar

all: build jar man

help:
	@echo "Usual options:"
	@echo "=============="
	@echo "	make		: to build the jar file and man pages IF possible"
	@echo "	make help	: to get this help screen"
	@echo "	make libs	: to update the libraries into src/"
	@echo "	make build	: to update the binaries (not the jar)"
	@echo "	make test	: to update the test binaries"
	@echo "	make build jar	: to update the binaries and jar file"
	@echo "	make sjar	: to create the sources jar file"
	@echo "	make clean	: to clean the directory of intermediate files"
	@echo "	make mrpropre	: to clean the directory of all outputs"
	@echo "	make run	: to run the program from the binaries"
	@echo "	make run-test	: to run the test program from the binaries"
	@echo "	make jrun	: to run the program from the jar file"
	@echo "	make install	: to install the application into $$PREFIX"
	@echo " make ifman	: to make the manual pages (if pandoc is found)"
	@echo " make man	: to make the manual pages (requires pandoc)"

.PHONY: all clean mrproper mrpropre build run jrun jar sjar resources test-resources install libs ifman man love

bin:
	@mkdir -p bin

jar: $(NAME).jar

sjar: $(NAME)-sources.jar

build: resources
	@echo Compiling program...
	@echo "	src/$(MAIN)"
	@$(JAVAC) $(JAVAC_FLAGS) "src/$(MAIN).java"
	@[ "$(MORE)" = "" ] || for sup in $(MORE); do \
		echo "	src/$$sup" ;\
		$(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
	done

test: test-resources
	@[ -e bin/$(MAIN).class ] || echo You need to build the sources
	@[ -e bin/$(MAIN).class ]
	@echo Compiling test program...
	@[ "$(TEST)" != "" ] || echo No test sources defined.
	@[ "$(TEST)"  = "" ] || for sup in $(TEST); do \
		echo "	src/$$sup" ;\
		$(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
	done

clean:
	rm -rf bin/
	@echo Removing sources taken from libs...
	@for lib in libs/*-sources.jar libs/*-sources.patch.jar; do \
		if [ "$$lib" != 'libs/*-sources.jar' -a "$$lib" != 'libs/*-sources.patch.jar' ]; then \
			basename "$$lib"; \
			jar tf "$$lib" | while read -r ln; do \
				[ -f "src/$$ln" ] && rm "src/$$ln"; \
			done; \
			jar tf "$$lib" | tac | while read -r ln; do \
				[ -d "src/$$ln" ] && rmdir "src/$$ln" 2>/dev/null || true; \
			done; \
		fi \
	done

mrproper: mrpropre

mrpropre: clean
	rm -f $(NAME).jar
	rm -f $(NAME)-sources.jar
	rm -f $(NAME).apk
	rm -f $(NAME)-debug.apk
	[ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`.jar"
	[ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`-sources.jar"

love:
	@echo "	...not war."

resources: libs
	@echo Copying resources into bin/...
	@cd src && find . | grep -v '\.java$$' | grep -v '/test/' | while read -r ln; do \
		if [ -f "$$ln" ]; then \
			dir="`dirname "$$ln"`"; \
			mkdir -p "../bin/$$dir" ; \
			cp "$$ln" "../bin/$$ln" ; \
		fi ; \
	done
	@cp VERSION bin/

test-resources: resources
	@echo Copying test resources into bin/...
	@cd src && find . | grep -v '\.java$$' | grep '/test/' | while read -r ln; do \
		if [ -f "$$ln" ]; then \
			dir="`dirname "$$ln"`"; \
			mkdir -p "../bin/$$dir" ; \
			cp "$$ln" "../bin/$$ln" ; \
		fi ; \
	done

libs: bin
	@[ -e bin/libs -o ! -d libs ] || echo Extracting sources from libs...
	@[ -e bin/libs -o ! -d libs ] || (cd src && for lib in ../libs/*-sources.jar ../libs/*-sources.patch.jar; do \
		if [ "$$lib" != '../libs/*-sources.jar' -a "$$lib" != '../libs/*-sources.patch.jar' ]; then \
			basename "$$lib"; \
			jar xf "$$lib"; \
		fi \
	done )
	@[ ! -d libs ] || touch bin/libs

$(NAME)-sources.jar: libs
	@ls *.md >/dev/null || cp VERSION README.md
	@echo Making sources JAR file...
	@echo > bin/manifest
	@[ "$(SJAR_FLAGS)" != "" ] || echo No sources JAR file defined, skipping
	@[ "$(SJAR_FLAGS)"  = "" ] || echo Creating $(NAME)-sources.jar...
	@[ "$(SJAR_FLAGS)"  = "" ] || $(JAR) cfm $(NAME)-sources.jar bin/manifest -C ./ *.md $(SJAR_FLAGS)
	@[ "$(SJAR_FLAGS)"  = "" ] || [ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`-sources.jar"...
	@[ "$(SJAR_FLAGS)"  = "" ] || [ ! -e VERSION ] || cp $(NAME)-sources.jar "$(NAME)-`cat VERSION`-sources.jar"

$(NAME).jar: resources
	@[ -e bin/$(MAIN).class ] || echo You need to build the sources
	@[ -e bin/$(MAIN).class ]
	@ls *.md >/dev/null || cp VERSION README.md
	@echo "Copying documentation into bin/..."
	@cp -r *.md bin/ || cp VERSION bin/no-documentation.md
	@echo "Copying sources into bin/..."
	@cp -r src/* bin/
	@echo "Making jar..."
	@echo "Main-Class: `echo "$(MAIN)" | sed 's:/:.:g'`" > bin/manifest
	@echo >> bin/manifest
	$(JAR) cfm $(NAME).jar bin/manifest -C ./ *.md $(JAR_FLAGS)
	@[ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`.jar"...
	@[ ! -e VERSION ] || cp $(NAME).jar "$(NAME)-`cat VERSION`.jar"

run: 
	@[ -e bin/$(MAIN).class ] || echo You need to build the sources
	@[ -e bin/$(MAIN).class ]
	@echo Running "$(NAME)"...
	$(JAVA) $(JAVA_FLAGS) $(MAIN)

jrun:
	@[ -e $(NAME).jar ] || echo You need to build the jar
	@[ -e $(NAME).jar ]
	@echo Running "$(NAME).jar"...
	$(RJAR) $(RJAR_FLAGS) $(NAME).jar

run-test: 
	@[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ] || echo You need to build the test sources
	@[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ]
	@echo Running tests for "$(NAME)"...
	@[ "$(TEST)" != "" ] || echo No test sources defined.
	[ "$(TEST)"  = "" ] || ( clear ; $(JAVA) $(JAVA_FLAGS) $(TEST) $(TEST_PARAMS) )

install:
	@[ -e $(NAME).jar ] || echo You need to build the jar
	@[ -e $(NAME).jar ]
	mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin"
	cp $(NAME).jar "$(PREFIX)/lib/"
	echo "#!/bin/sh" > "$(PREFIX)/bin/$(NAME)"
	echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"\$$@\"" >> "$(PREFIX)/bin/$(NAME)"
	chmod a+rx "$(PREFIX)/bin/$(NAME)"
	if [ -e "man/man1/$(NAME).1" ]; then \
		cp -r man/ "$(PREFIX)"/share/; \
	fi

ifman:
	@if pandoc -v >/dev/null 2>&1; then \
		make man; \
	else \
		echo "man pages not generated: "'`'"pandoc' required"; \
	fi

man: 
	@echo Checking for possible manual pages...
	@if [ -e README.md ]; then \
		echo Sources found for man pages; \
		if pandoc -v >/dev/null 2>&1; then \
			ls README*.md 2>/dev/null \
					| grep 'README\(-..\|\)\.md' \
					| while read man; do \
				echo "	Processing page $$lang..."; \
				lang="`echo "$$man" \
					| sed 's:README\.md:en:' \
					| sed 's:README-\(.*\)\.md:\1:'`"; \
				mkdir -p man/"$$lang"/man1; \
				( \
					echo ".TH \"${NAME}\" 1 `\
						date +%Y-%m-%d\
						` \"version `cat VERSION`\""; \
					echo; \
					UNAME="`echo "${NAME}" \
						| sed 's:\(.*\):\U\1:g'`"; \
					( \
						cat "$$man" | head -n1 \
	| sed 's:.*(README\(-fr\|\)\.md).*::g'; \
						cat "$$man" | tail -n+2; \
					) | sed 's:^#\(#.*\):\1:g' \
	| sed 's:^\(#.*\):\U\1:g;s:# *'"$$UNAME"':# NAME\n'"${NAME}"' \\- :g' \
	| sed 's:--:——:g' \
	| pandoc -f markdown -t man | sed 's:——:--:g' ; \
				) > man/"$$lang"/man1/"${NAME}.1"; \
			done; \
			mkdir -p "man/man1"; \
			cp man/en/man1/"${NAME}".1 man/man1/; \
		else \
			echo "man pages generation: pandoc required" >&2; \
			false; \
		fi; \
	fi;
Commit	Line	Data
ae78e517 NR	1	# Makefile base template
	2	#
	3	# Version:
	4	# - 1.0.0: add a version comment
53282dec NR	5	# - 1.1.0: add 'help', 'sjar'
	6	# - 1.2.0: add 'apk'
	7	# - 1.2.1: improve 'apk' and add 'android'
bf70d1a2	8	# - 1.3.0: add 'man' for man(ual) pages
71d3a52c	9	# - 1.4.0: remove android stuff (not working anyway)
cecce42e	10	# - 1.5.0: include sources and readme/changelog in jar
ae78e517	11
53282dec	12	# Required parameters (the commented out ones are supposed to be per project):
08fe2e33 NR	13
	14	#MAIN = path to main java source to compile
	15	#MORE = path to supplementary needed resources not linked from MAIN
	16	#NAME = name of project (used for jar output file)
	17	#PREFIX = usually /usr/local (where to install the program)
	18	#TEST = path to main test source to compile
	19	#JAR_FLAGS += a list of things to pack, each usually prefixed with "-C bin/"
53282dec NR	20	#SJAR_FLAGS += a list of things to pack, each usually prefixed with "-C src/",
53282dec NR	21	# for *-sources.jar files
a6395bef	22	#TEST_PARAMS = any parameter to pass to the test runnable when "test-run"
08fe2e33 NR	23
08fe2e33 NR	24	JAVAC = javac
614574c4	25	JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
08fe2e33 NR	26	JAVA = java
	27	JAVA_FLAGS += -cp ./bin/
	28	JAR = jar
	29	RJAR = java
	30	RJAR_FLAGS += -jar
	31
bf70d1a2	32	all: build jar man
08fe2e33	33
ae78e517 NR	34	help:
	35	@echo "Usual options:"
	36	@echo "=============="
bf70d1a2	37	@echo " make : to build the jar file and man pages IF possible"
ae78e517 NR	38	@echo " make help : to get this help screen"
	39	@echo " make libs : to update the libraries into src/"
	40	@echo " make build : to update the binaries (not the jar)"
	41	@echo " make test : to update the test binaries"
	42	@echo " make build jar : to update the binaries and jar file"
	43	@echo " make sjar : to create the sources jar file"
	44	@echo " make clean : to clean the directory of intermediate files"
	45	@echo " make mrpropre : to clean the directory of all outputs"
	46	@echo " make run : to run the program from the binaries"
	47	@echo " make run-test : to run the test program from the binaries"
	48	@echo " make jrun : to run the program from the jar file"
9b05b757	49	@echo " make install : to install the application into $$PREFIX"
bf70d1a2 NR	50	@echo " make ifman : to make the manual pages (if pandoc is found)"
bf70d1a2 NR	51	@echo " make man : to make the manual pages (requires pandoc)"
ae78e517	52
71d3a52c	53	.PHONY: all clean mrproper mrpropre build run jrun jar sjar resources test-resources install libs ifman man love
08fe2e33 NR	54
	55	bin:
	56	@mkdir -p bin
	57
	58	jar: $(NAME).jar
	59
ae78e517 NR	60	sjar: $(NAME)-sources.jar
ae78e517 NR	61
08fe2e33 NR	62	build: resources
	63	@echo Compiling program...
	64	@echo " src/$(MAIN)"
	65	@$(JAVAC) $(JAVAC_FLAGS) "src/$(MAIN).java"
	66	@[ "$(MORE)" = "" ] \|\| for sup in $(MORE); do \
	67	echo " src/$$sup" ;\
	68	$(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
	69	done
	70
a6395bef	71	test: test-resources
08fe2e33 NR	72	@[ -e bin/$(MAIN).class ] \|\| echo You need to build the sources
	73	@[ -e bin/$(MAIN).class ]
	74	@echo Compiling test program...
	75	@[ "$(TEST)" != "" ] \|\| echo No test sources defined.
	76	@[ "$(TEST)" = "" ] \|\| for sup in $(TEST); do \
	77	echo " src/$$sup" ;\
	78	$(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
	79	done
	80
	81	clean:
	82	rm -rf bin/
	83	@echo Removing sources taken from libs...
3871aa4e NR	84	@for lib in libs/-sources.jar libs/-sources.patch.jar; do \
	85	if [ "$$lib" != 'libs/-sources.jar' -a "$$lib" != 'libs/-sources.patch.jar' ]; then \
	86	basename "$$lib"; \
	87	jar tf "$$lib" \| while read -r ln; do \
	88	[ -f "src/$$ln" ] && rm "src/$$ln"; \
	89	done; \
	90	jar tf "$$lib" \| tac \| while read -r ln; do \
	91	[ -d "src/$$ln" ] && rmdir "src/$$ln" 2>/dev/null \|\| true; \
	92	done; \
	93	fi \
08fe2e33 NR	94	done
	95
	96	mrproper: mrpropre
	97
	98	mrpropre: clean
	99	rm -f $(NAME).jar
dd56a893	100	rm -f $(NAME)-sources.jar
9b05b757 NR	101	rm -f $(NAME).apk
9b05b757 NR	102	rm -f $(NAME)-debug.apk
dd56a893 NR	103	[ ! -e VERSION ] \|\| rm -f "$(NAME)-`cat VERSION`.jar"
dd56a893 NR	104	[ ! -e VERSION ] \|\| rm -f "$(NAME)-`cat VERSION`-sources.jar"
08fe2e33 NR	105
	106	love:
	107	@echo " ...not war."
	108
	109	resources: libs
	110	@echo Copying resources into bin/...
a6395bef NR	111	@cd src && find . \| grep -v '\.java$$' \| grep -v '/test/' \| while read -r ln; do \
	112	if [ -f "$$ln" ]; then \
	113	dir="`dirname "$$ln"`"; \
	114	mkdir -p "../bin/$$dir" ; \
	115	cp "$$ln" "../bin/$$ln" ; \
	116	fi ; \
	117	done
39c3c689	118	@cp VERSION bin/
a6395bef NR	119
	120	test-resources: resources
	121	@echo Copying test resources into bin/...
	122	@cd src && find . \| grep -v '\.java$$' \| grep '/test/' \| while read -r ln; do \
08fe2e33 NR	123	if [ -f "$$ln" ]; then \
	124	dir="`dirname "$$ln"`"; \
	125	mkdir -p "../bin/$$dir" ; \
	126	cp "$$ln" "../bin/$$ln" ; \
	127	fi ; \
	128	done
	129
	130	libs: bin
	131	@[ -e bin/libs -o ! -d libs ] \|\| echo Extracting sources from libs...
c1873e56	132	@[ -e bin/libs -o ! -d libs ] \|\| (cd src && for lib in ../libs/-sources.jar ../libs/-sources.patch.jar; do \
9119671d NR	133	if [ "$$lib" != '../libs/-sources.jar' -a "$$lib" != '../libs/-sources.patch.jar' ]; then \
	134	basename "$$lib"; \
	135	jar xf "$$lib"; \
	136	fi \
08fe2e33 NR	137	done )
	138	@[ ! -d libs ] \|\| touch bin/libs
	139
ae78e517	140	$(NAME)-sources.jar: libs
cecce42e	141	@ls *.md >/dev/null \|\| cp VERSION README.md
ae78e517	142	@echo Making sources JAR file...
dd56a893	143	@echo > bin/manifest
cecce42e NR	144	@[ "$(SJAR_FLAGS)" != "" ] \|\| echo No sources JAR file defined, skipping
	145	@[ "$(SJAR_FLAGS)" = "" ] \|\| echo Creating $(NAME)-sources.jar...
	146	@[ "$(SJAR_FLAGS)" = "" ] \|\| $(JAR) cfm $(NAME)-sources.jar bin/manifest -C ./ *.md $(SJAR_FLAGS)
	147	@[ "$(SJAR_FLAGS)" = "" ] \|\| [ ! -e VERSION ] \|\| echo Copying to "$(NAME)-`cat VERSION`-sources.jar"...
	148	@[ "$(SJAR_FLAGS)" = "" ] \|\| [ ! -e VERSION ] \|\| cp $(NAME)-sources.jar "$(NAME)-`cat VERSION`-sources.jar"
ae78e517 NR	149
	150	$(NAME).jar: resources
	151	@[ -e bin/$(MAIN).class ] \|\| echo You need to build the sources
	152	@[ -e bin/$(MAIN).class ]
cecce42e NR	153	@ls *.md >/dev/null \|\| cp VERSION README.md
	154	@echo "Copying documentation into bin/..."
	155	@cp -r *.md bin/ \|\| cp VERSION bin/no-documentation.md
	156	@echo "Copying sources into bin/..."
	157	@cp -r src/* bin/
	158	@echo "Making jar..."
08fe2e33 NR	159	@echo "Main-Class: `echo "$(MAIN)" \| sed 's:/:.:g'`" > bin/manifest
08fe2e33 NR	160	@echo >> bin/manifest
cecce42e	161	$(JAR) cfm $(NAME).jar bin/manifest -C ./ *.md $(JAR_FLAGS)
dd56a893	162	@[ ! -e VERSION ] \|\| echo Copying to "$(NAME)-`cat VERSION`.jar"...
d3c15421	163	@[ ! -e VERSION ] \|\| cp $(NAME).jar "$(NAME)-`cat VERSION`.jar"
08fe2e33 NR	164
	165	run:
	166	@[ -e bin/$(MAIN).class ] \|\| echo You need to build the sources
	167	@[ -e bin/$(MAIN).class ]
	168	@echo Running "$(NAME)"...
	169	$(JAVA) $(JAVA_FLAGS) $(MAIN)
	170
	171	jrun:
	172	@[ -e $(NAME).jar ] \|\| echo You need to build the jar
	173	@[ -e $(NAME).jar ]
	174	@echo Running "$(NAME).jar"...
	175	$(RJAR) $(RJAR_FLAGS) $(NAME).jar
	176
	177	run-test:
	178	@[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ] \|\| echo You need to build the test sources
	179	@[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ]
	180	@echo Running tests for "$(NAME)"...
	181	@[ "$(TEST)" != "" ] \|\| echo No test sources defined.
a6395bef	182	[ "$(TEST)" = "" ] \|\| ( clear ; $(JAVA) $(JAVA_FLAGS) $(TEST) $(TEST_PARAMS) )
08fe2e33 NR	183
	184	install:
	185	@[ -e $(NAME).jar ] \|\| echo You need to build the jar
	186	@[ -e $(NAME).jar ]
	187	mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin"
	188	cp $(NAME).jar "$(PREFIX)/lib/"
	189	echo "#!/bin/sh" > "$(PREFIX)/bin/$(NAME)"
fe999aa4	190	echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"\$$@\"" >> "$(PREFIX)/bin/$(NAME)"
08fe2e33	191	chmod a+rx "$(PREFIX)/bin/$(NAME)"
a1a900a5 NR	192	if [ -e "man/man1/$(NAME).1" ]; then \
	193	cp -r man/ "$(PREFIX)"/share/; \
	194	fi
08fe2e33	195
bf70d1a2 NR	196	ifman:
	197	@if pandoc -v >/dev/null 2>&1; then \
	198	make man; \
	199	else \
	200	echo "man pages not generated: "'`'"pandoc' required"; \
	201	fi
	202
	203	man:
	204	@echo Checking for possible manual pages...
	205	@if [ -e README.md ]; then \
	206	echo Sources found for man pages; \
	207	if pandoc -v >/dev/null 2>&1; then \
	208	ls README*.md 2>/dev/null \
	209	\| grep 'README\(-..\\|\)\.md' \
	210	\| while read man; do \
	211	echo " Processing page $$lang..."; \
	212	lang="`echo "$$man" \
	213	\| sed 's:README\.md:en:' \
	214	\| sed 's:README-\(.*\)\.md:\1:'`"; \
	215	mkdir -p man/"$$lang"/man1; \
	216	( \
	217	echo ".TH \"${NAME}\" 1 `\
	218	date +%Y-%m-%d\
	219	` \"version `cat VERSION`\""; \
	220	echo; \
	221	UNAME="`echo "${NAME}" \
	222	\| sed 's:\(.*\):\U\1:g'`"; \
	223	( \
	224	cat "$$man" \| head -n1 \
	225	\| sed 's:.(README\(-fr\\|\)\.md).::g'; \
	226	cat "$$man" \| tail -n+2; \
	227	) \| sed 's:^#\(#.*\):\1:g' \
	228	\| sed 's:^\(#.\):\U\1:g;s:# '"$$UNAME"':# NAME\n'"${NAME}"' \\- :g' \
5783289e NR	229	\| sed 's:--:——:g' \
5783289e NR	230	\| pandoc -f markdown -t man \| sed 's:——:--:g' ; \
bf70d1a2 NR	231	) > man/"$$lang"/man1/"${NAME}.1"; \
	232	done; \
	233	mkdir -p "man/man1"; \
	234	cp man/en/man1/"${NAME}".1 man/man1/; \
	235	else \
	236	echo "man pages generation: pandoc required" >&2; \
	237	false; \
	238	fi; \
	239	fi;
	240