Image: make it Serializable
[nikiroo-utils.git] / Makefile.base
index 939658815593b027f05dd2a522a26fdf186327c1..70d6c0140497860286b3667aaba9c57bfbbb4ca0 100644 (file)
@@ -1,3 +1,10 @@
+# Makefile base template
+# 
+# Version:
+# - 1.0.0: add a version comment
+# - 1.1.0: add help, sjar
+# - 1.1.1: fix "jar" instead of ${JAR}
+
 # Required parameters (the commented out ones are supposed to change per project):
 
 #MAIN = path to main java source to compile
 #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/ -Xdiags:verbose
+JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
 JAVA = java
 JAVA_FLAGS += -cp ./bin/
 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
 
-.PHONY: all clean mrproper mrpropre build run jrun jar resources install libs love 
+help:
+       @echo "Usual options:"
+       @echo "=============="
+       @echo " make            : to build the jar file"
+       @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"
+
+.PHONY: all clean mrproper mrpropre build run jrun jar sjar resources test-resources install libs love 
 
 bin:
        @mkdir -p bin
 
 jar: $(NAME).jar
 
+sjar: $(NAME)-sources.jar
+
 build: resources
        @echo Compiling program...
        @echo " src/$(MAIN)"
@@ -50,7 +61,7 @@ build: resources
                $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
        done
 
-test: 
+test: test-resources
        @[ -e bin/$(MAIN).class ] || echo You need to build the sources
        @[ -e bin/$(MAIN).class ]
        @echo Compiling test program...
@@ -63,14 +74,16 @@ test:
 clean:
        rm -rf bin/
        @echo Removing sources taken from libs...
-       @for lib in libs/*-sources.jar; do \
-               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; \
+       @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
@@ -86,7 +99,18 @@ love:
 
 resources: libs
        @echo Copying resources into bin/...
-       @cd src && find . | grep -v '\.java$$' | while read -r ln; do \
+       @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" ; \
@@ -96,21 +120,25 @@ resources: libs
 
 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; do \
-               basename "$$lib"; \
-               jar xf "$$lib"; \
+       @[ -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).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)
@@ -134,7 +162,7 @@ run-test:
        @[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ]
        @echo Running tests for "$(NAME)"...
        @[ "$(TEST)" != "" ] || echo No test sources defined.
-       [ "$(TEST)"  = "" ] || $(JAVA) $(JAVA_FLAGS) $(TEST)
+       [ "$(TEST)"  = "" ] || ( clear ; $(JAVA) $(JAVA_FLAGS) $(TEST) $(TEST_PARAMS) )
 
 install:
        @[ -e $(NAME).jar ] || echo You need to build the jar
@@ -142,6 +170,6 @@ install:
        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)"
+       echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"\$$@\"" >> "$(PREFIX)/bin/$(NAME)"
        chmod a+rx "$(PREFIX)/bin/$(NAME)"