Update Makefile
authorNiki Roo <niki@nikiroo.be>
Thu, 29 Mar 2018 13:00:04 +0000 (15:00 +0200)
committerNiki Roo <niki@nikiroo.be>
Thu, 29 Mar 2018 13:00:04 +0000 (15:00 +0200)
Makefile.base

index 3304c83c802f47d4d5ede0e5cb33c5a252bd0552..586c38e377fa9b0016081361d1c3d336b57ab5f2 100644 (file)
@@ -1,4 +1,13 @@
-# Required parameters (the commented out ones are supposed to change per project):
+# 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
+
+# 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
@@ -6,8 +15,12 @@
 #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
+#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"
+#ID_FOR_ANDROID = id of activity to launch for Android
+#RM_FOR_ANDROID = packages (if it ends with /) or classes to ignore for APK 
+#              generation
 
 JAVAC = javac
 JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
@@ -17,31 +30,38 @@ JAR = jar
 RJAR = java
 RJAR_FLAGS += -jar
 
-# Usual options:
-#      make            : to build the jar file
-#      make libs       : to update the libraries into src/
-#      make build      : to update the binaries (not the jar)
-#      make test       : to update the test binaries
-#      make build jar  : to update the binaries and jar file
-#      make clean      : to clean the directory of intermediate files
-#      make mrpropre   : to clean the directory of all outputs
-#      make run        : to run the program from the binaries
-#      make run-test   : to run the test program from the binaries
-#      make jrun       : to run the program from the jar file
-#      make install    : to install the application into $PREFIX
-
-# Note: build is actually slower than rebuild in most cases except when
-# small changes only are detected ; so we use rebuild by default
+all: build jar man
 
-all: build jar
+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 android    : to prepare the sources in android/ for Studio"
+       @echo " make apk        : to compile the APK file"
+       @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 resources test-resources install libs love 
+.PHONY: all clean mrproper mrpropre build run jrun jar sjar resources test-resources install libs love apk android ifman man
 
 bin:
        @mkdir -p bin
 
 jar: $(NAME).jar
 
+sjar: $(NAME)-sources.jar
+
 build: resources
        @echo Compiling program...
        @echo " src/$(MAIN)"
@@ -63,6 +83,8 @@ test: test-resources
 
 clean:
        rm -rf bin/
+       rm -rf android/.gradle android/build android/app/build android/app/build.gradle
+       [ ! -L android/app/src/main/java ] || rm -rf android/app/src
        @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 \
@@ -81,8 +103,12 @@ 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"
+       [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`.apk"
+       [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`-debug.apk"
 
 love:
        @echo " ...not war."
@@ -118,15 +144,17 @@ libs: bin
        done )
        @[ ! -d libs ] || touch bin/libs
 
-$(NAME).jar: resources
-       @[ -e bin/$(MAIN).class ] || echo You need to build the sources
-       @[ -e bin/$(MAIN).class ]
-       @echo Making JAR file...
+$(NAME)-sources.jar: libs
+       @echo Making sources JAR file...
        @echo > bin/manifest
        @[ "$(SJAR_FLAGS)" = "" ] || echo Creating $(NAME)-sources.jar...
        @[ "$(SJAR_FLAGS)" = "" ] || $(JAR) cfm $(NAME)-sources.jar bin/manifest $(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 ]
        @echo "Main-Class: `echo "$(MAIN)" | sed 's:/:.:g'`" > bin/manifest
        @echo >> bin/manifest
        $(JAR) cfm $(NAME).jar bin/manifest $(JAR_FLAGS)
@@ -160,4 +188,104 @@ install:
        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
+
+android: android/app/src
+
+android/app/src:
+       @[ -d android ] || echo No android/ directory found
+       @[ -d android ]
+       @[ -e android/local.properties ] || echo 'You need to create android/local.properties and add "sdk.dir=PATH_TO_SDK"'
+       @[ -e android/local.properties ]
+       @mkdir -p android/app/src/main
+       @echo Linking sources...
+       @( \
+               cd android/app/src/main; \
+               ln -s ../../../../src/AndroidManifest.xml .; \
+               ln -s ../../../../res .; \
+               ln -s ../../../../src ./java; \
+       )
+       @echo Fixing configuration...
+       @( \
+               cd android/app/src/main/java; \
+               excl="\\n";\
+               if [ "${RM_FOR_ANDROID}" != "" ]; then \
+                       echo Ignoring uneeded sources...; \
+                       for file in ${RM_FOR_ANDROID}; do \
+                               excl="$${excl}exclude '**/$${file}'\\n";\
+                       done; \
+               fi; \
+               cd ../../../ ; \
+               cat build.gradle.base \
+                       | sed 's:\(applicationId "\)":\1${ID_FOR_ANDROID}":' \
+                       | sed "s:\s*exclude '':$$excl:g" \
+               > build.gradle; \
+       )
+
+apk: libs ${NAME}.apk
+       @echo Building APK files...
+
+${NAME}.apk: ${NAME}-debug.apk
+
+${NAME}-debug.apk: android
+       @echo Starting gradlew assemble...
+       @( \
+               cd android/; \
+               bash gradlew assemble && ( \
+                       cd ..; \
+                       cp android/app/build/outputs/apk/release/app-release-unsigned.apk ${NAME}.apk; \
+                       cp android/app/build/outputs/apk/debug/app-debug.apk ${NAME}-debug.apk; \
+                       [ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`.apk"...; \
+                       [ ! -e VERSION ] || cp $(NAME).apk "$(NAME)-`cat VERSION`.apk"; \
+                       [ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`-debug.apk"...; \
+                       [ ! -e VERSION ] || cp $(NAME).apk "$(NAME)-`cat VERSION`-debug.apk"; \
+               ); \
+       )
+
+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;