Merge branch 'java' of git.nikiroo.be:workspace/template
authorNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 15:17:36 +0000 (17:17 +0200)
committerNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 15:17:36 +0000 (17:17 +0200)
1  2 
Makefile

diff --combined Makefile
index 0e715b9d04813fc191ffc76a04bc60c99ca2ad1c,2ac838d0dbbb62c2a782986671a5fba69822dc45..df7b7be1d54a0d9d8a31067ad0736622a606cce1
+++ b/Makefile
@@@ -1,47 -1,36 +1,36 @@@
  #
- # Java Makefile:
- # > NAME: name of project (used for jar output file)
- # > MAIN: path to main java source to compile
- # > MORE: path to supplementary needed resources not linked from MAIN
- # > TEST: path to main test source to compile
- # > JAR_FLAGS: a list of things to pack, each usually prefixed with "-C bin/"
- # > SJAR_FLAGS: like JAR_FLAGS, but for *-sources.jar
- # > PREFIX: usually /usr/local (where to install the program)
+ # Java makefile
+ # > NAME: main program name (for manual, jar, doc...)
+ # > MAIN: main source to compile without the 'src/' prefix nor the '.java' ext
+ # > MORE: more sources to compile to generate the full program
+ # > TEST: list of all test programs to compile and run (same format as MORE)
+ # > JAR_FLAGS : list of paths to include in the jar        file (`-C dir path`)
+ # > SJAR_FLAGS: list of paths to include in the source jar file (`-C dir path`)
+ # > PREFIX: the usual prefix to (un)install to -- you may of course override it
  #
 -NAME  = program
 -MAIN  = be/nikiroo/program/Main
 -TEST  = be/nikiroo/tests/program/Test
 +NAME  = nikiroo-utils
 +MAIN  = be/nikiroo/tests/utils/Test
 +TEST  = be/nikiroo/tests/utils/Test
- # Option for this program: UI=android (or UI=awt by default)
- ifeq ($(UI),android)
- MORE += be/nikiroo/utils/android/test/TestAndroid
- TEST += be/nikiroo/utils/android/ImageUtilsAndroid
- else
- MORE += be/nikiroo/utils/ui/ImageUtilsAwt
- MORE += be/nikiroo/utils/ui/ImageTextAwt
- TEST += be/nikiroo/utils/ui/test/TestUI
- endif
- JAR_MISC = -C ./ LICENSE -C ./ VERSION -C libs/ licenses
+ JAR_MISC    = -C ./ LICENSE -C ./ VERSION -C libs/ licenses
  JAR_FLAGS  += -C bin/ be -C bin/ org $(JAR_MISC)
- SJAR_FLAGS += -C src/ org -C src/ be $(JAR_MISC)
+ SJAR_FLAGS += -C src/ be -C src/ org $(JAR_MISC)
  
  PREFIX = /usr/local
  
- # 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
- # - 1.5.1: include binaries from libs/bin/ into the jar
- # - 1.6.0: rework the system without need of a ./configure.sh, add uninstall
+ #
+ # Special Options for this program: you can modify the previous var if needed
 -# > OPTION=non-default-value (or OPTION=default-value by default)
++# > UI=android (or UI=awt by default)
+ #
 -ifeq ($(OPTION),non-default-value)
 -MORE += be/nikiroo/utils/android/test/TestAndroid
 -TEST += be/nikiroo/utils/android/ImageUtilsAndroid
++ifeq ($(UI),android)
++MORE+= be/nikiroo/utils/android/ImageUtilsAndroid
++TEST += be/nikiroo/utils/android/test/TestAndroid
+ else    
+ MORE += be/nikiroo/utils/ui/ImageUtilsAwt 
+ MORE += be/nikiroo/utils/ui/ImageTextAwt
+ TEST += be/nikiroo/utils/ui/test/TestUI 
+ endif
  
+ ################################################################################
  
  JAVAC = javac
  JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
@@@ -51,171 -40,165 +40,165 @@@ JAR = ja
  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 uninstall  : to uninstall the application from $$PREFIX"
-       @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 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"
+ ifeq ($(DEBUG),1)
+ JAVAC_FLAGS += -Xlint:deprecation -g
+ endif
+ .PHONY: all build run clean mrpropre mrpropre love debug doc man test run-test \
+       check_time jar sjar resources test-resources libs 
+ all: build jar sjar
+ check_time:
+       @echo
+       @echo ">>>>>>>>>> Checking lastest sources/build times..."
+       @cp -a `find src  -type f -printf "%T@ %p\n" \
+               | sort -n | cut -d' ' -f 2- | tail -n 1` latest_src
+       @cp -a `find libs -type f -printf "%T@ %p\n" \
+               | sort -n | cut -d' ' -f 2- | tail -n 1` latest_lib
+       @cp -a `find . \( -wholename VERSION -o -name '*.md' -o \
+                   \( -wholename './src/*' -a ! -name '*.java' \
+                       -a ! -wholename '*/test/*' \)\
+               \) \
+               -type f -printf "%T@ %p\n" 2>/dev/null \
+               | sort -n | cut -d' ' -f 2- | tail -n 1` latest_rsc
+       
+       @ls latest_??? \
+               --time-style=+@%Y-%m-%d\ %H:%M:%S -lt | cut -f2- -d@
+ build: check_time resources latest_bin
+ latest_bin: latest_src
+       @echo
+       @echo ">>>>>>>>>> Building sources..."
+       $(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
+               echo $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java"; \
+               $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java"; \
+       done;
+       touch latest_bin
  
- 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 \
-                               if [ -d "src/$$ln" ]; then \
-                                       rmdir "src/$$ln" 2>/dev/null || true; \
-                               fi; \
-                       done; \
-               fi \
-       done
  
- mrproper: mrpropre
- mrpropre: clean man
-       rm -f $(NAME).jar
-       rm -f $(NAME)-sources.jar
-       [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`.jar"
-       [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`-sources.jar"
+ test: build test-resources latest_tst
+ latest_tst: latest_src
+       @echo
+       @echo ">>>>>>>>>> Building all tests: $(TEST)..."
+       @if [ "$(TEST)" = "" ]; then \
+               echo No test sources defined.; \
+       else \
+               for tst in $(TEST); do \
+                       echo $(JAVAC) $(JAVAC_FLAGS) "src/$$tst.java"; \
+                       $(JAVAC) $(JAVAC_FLAGS) "src/$$tst.java"; \
+               done; \
+       fi;
+       touch latest_tst
  
- love:
-       @echo " ...not war."
- resources: libs
-       @echo Copying resources and documentation into bin/...
-       @if ! cp *.md bin/ 2>/dev/null; then \
-               if [ -e VERSION ]; then \
-                       cp VERSION bin/no-documentation.md; \
-               else \
-                       echo > bin/no-documentation.md; \
+ # Main buildables
+ jar: libs resources $(NAME).jar
+ $(NAME).jar: latest_bin
+       @echo
+       @echo ">>>>>>>>>> Generating $@..."
+       @if [ -d libs/bin/ ]; then \
+               echo cp -r libs/bin/* bin/; \
+               cp -r libs/bin/* bin/; \
+       fi;
+       cp -r src/* bin/
+       @echo "Main-Class: `echo "$(MAIN)" | sed 's:/:.:g'`" > bin/manifest
+       @echo >> bin/manifest
+       $(JAR) cfm $(NAME).jar bin/manifest -C ./ *.md $(JAR_FLAGS)
+       @if [ -e VERSION ]; then \
+               echo cp $(NAME).jar "$(NAME)-`cat VERSION`.jar"; \
+               cp $(NAME).jar "$(NAME)-`cat VERSION`.jar"; \
+       fi;
+ sjar: libs $(NAME)-sources.jar
+ $(NAME)-sources.jar: latest_src
+       @echo
+       @echo ">>>>>>>>>> Generating $@..."
+       @echo > bin/manifest
+       $(JAR) cfm $(NAME)-sources.jar \
+               bin/manifest -C ./ *.md $(SJAR_FLAGS);
+       @if [ -e VERSION ]; then \
+               echo cp $(NAME)-sources.jar \
+                       "$(NAME)-`cat VERSION`-sources.jar"; \
+               cp $(NAME)-sources.jar \
+                       "$(NAME)-`cat VERSION`-sources.jar"; \
+       fi;
+ # Requisites
+ libs: check_time latest_lib
+ latest_lib: bin/libs
+ bin/libs: 
+       @echo
+       @echo ">>>>>>>>>> Extracting sources from 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 \
+                       echo cd src \&\& jar xf "$$lib"; \
+                       jar xf "$$lib"; \
                fi; \
-       fi
+       done;
+       mkdir -p bin
+       touch bin/libs
+ resources: check_time libs latest_rsc
+ latest_rsc: bin/VERSION
+ bin/VERSION:
+       @echo
+       @echo ">>>>>>>>>> Copying resources and documentation into bin/..."
+       mkdir -p bin
+       @if ! ls *.md 2>/dev/null 2>&1; then \
+                       echo touch bin/no-documentation.md; \
+                       touch bin/no-documentation.md; \
+       else \
+               echo cp *.md bin/; \
+               cp *.md bin/; \
+       fi;
        @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" ; \
+                       echo cp "$$ln" "../bin/$$ln" ; \
                        cp "$$ln" "../bin/$$ln" ; \
                fi ; \
-       done
-       @[ ! -e VERSION ] || cp VERSION bin/
+       done;
+       cp VERSION bin/
  
- test-resources: resources
-       @echo Copying test resources into bin/...
+ test-resources: check_time resources latest_tsc
+ latest_tsc: latest_ttt
+ latest_ttt:
+       @echo
+       @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" ; \
+                       echo cp "$$ln" "../bin/$$ln" ; \
                        cp "$$ln" "../bin/$$ln" ; \
                fi ; \
-       done
- libs: bin
-       @if [ ! -e bin/libs -a -d libs ]; then \
-               echo Extracting sources from 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; \
-       fi;
-       @[ ! -d libs ] || touch bin/libs
- $(NAME)-sources.jar: libs
-       @echo Making sources JAR file...
-       @echo > bin/manifest
-       @if [ "$(SJAR_FLAGS)" = "" ]; then \
-               echo No sources JAR file defined, skipping; \
-       else \
-               echo Creating $(NAME)-sources.jar...; \
-               $(JAR) cfm $(NAME)-sources.jar \
-                       bin/manifest -C ./ *.md $(SJAR_FLAGS); \
-               if [ -e VERSION ]; then \
-                       echo Copying to "$(NAME)-`cat VERSION`-sources.jar"...;\
-                       cp $(NAME)-sources.jar \
-                               "$(NAME)-`cat VERSION`-sources.jar"; \
-               fi; \
-       fi;
+       done;
+       touch latest_ttt
  
- $(NAME).jar: resources
-       @if [ -d libs/bin/ ]; then \
-               echo "Copying additional binaries from libs/bin/ into bin/...";\
-               cp -r libs/bin/* bin/; \
-       fi;
-       @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"
+ # Manual
+ man: 
+       @echo
+       @echo ">>>>>>>>>> Manual of $(NAME): $(MAKECMDGOALS)..."
+       @$(MAKE) -f man.d $(MAKECMDGOALS) NAME=$(NAME)
  
- run: 
-       @echo Running "$(NAME)"...
+ # Run
+ run: build
+       @echo
+       @echo ">>>>>>>>>> Running $(NAME)..."
        $(JAVA) $(JAVA_FLAGS) $(MAIN)
  
- jrun: 
-       @echo Running "$(NAME).jar"...
-       $(RJAR) $(RJAR_FLAGS) $(NAME).jar
+ # Run main test
  run-test: 
-       @echo Running tests for "$(NAME)"...
+       @echo
+       @echo ">>>>>>>>>> Running tests: $(TEST)..."
        @[ "$(TEST)" != "" ] || echo No test sources defined.
        @if [ "`whereis tput`" = "tput:" ]; then \
        ok='"[ ok ]"'; \
        [ "$(TEST)"  = "" ] || ( \
                clear; \
                for test in $(TEST); do \
+                       echo $(JAVA) $(JAVA_FLAGS) \
+                               "$$test" "$$cols" "$$ok" "$$ko"; \
                        $(JAVA) $(JAVA_FLAGS) "$$test" "$$cols" "$$ok" "$$ko"; \
                done; \
        );
-               
  
- install: man
-       @[ -e $(NAME).jar ] || echo You need to build the jar
-       @[ -e $(NAME).jar ]
+ # Doc/misc
+ doc: 
+       @echo
+       @echo ">>>>>>>>>> Generating documentation for $(NAME)..."
+       doxygen
+ love:
+       @echo " ...not war."
+ debug:
+       $(MAKE) $(MAKECMDGOALS) PREFIX=$(PREFIX) NAME=$(NAME) DEBUG=1
+ # Clean
+ clean: 
+       @echo
+       @echo ">>>>>>>>>> Cleaning $(NAME)..."
+       rm -rf bin/
+       @for lib in libs/*-sources.jar libs/*-sources.patch.jar; do \
+               if [ "$$lib" != 'libs/*-sources.jar' \
+                               -a "$$lib" != 'libs/*-sources.patch.jar' ]; \
+               then \
+                       echo Cleaning `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 \
+                               if [ -d "src/$$ln" ]; then \
+                                       rmdir "src/$$ln" 2>/dev/null || true; \
+                               fi; \
+                       done; \
+               fi; \
+       done;
+       rm -f latest_???
+ mrproper: mrpropre
+ mrpropre: clean man
+       @echo
+       @echo ">>>>>>>>>> Calling Mr Propre..."
+       rm -f $(NAME).jar
+       rm -f $(NAME)-sources.jar
+       rm -f "$(NAME)-`cat VERSION`.jar"
+       rm -f "$(NAME)-`cat VERSION`-sources.jar"
+       rm -rf doc/html doc/latex doc/man
+       rmdir doc 2>/dev/null || true
+ # Install/uninstall
+ install: jar man
+       @echo
+       @echo ">>>>>>>>>> Installing $(NAME) into $(PREFIX)..."
        mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin"
        cp $(NAME).jar "$(PREFIX)/lib/"
        ( \
        ) > "$(PREFIX)/bin/$(NAME)"
        chmod a+rx "$(PREFIX)/bin/$(NAME)"
  
  uninstall: man
-       rm "$(PREFIX)/bin/$(NAME)"
-       rm "$(PREFIX)/lib/$(NAME).jar"
+       @echo
+       @echo ">>>>>>>>>> Uninstalling $(NAME) from $(PREFIX)..."
+       rm -f "$(PREFIX)/bin/$(NAME)"
+       rm -f "$(PREFIX)/lib/$(NAME).jar"
        rmdir "$(PREFIX)/bin" 2>/dev/null
- man: 
-       @$(MAKE) -f man.d $(MAKECMDGOALS) NAME=$(NAME)
+       rmdir "$(PREFIX)/lib" 2>/dev/null