init java
authorNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 14:21:27 +0000 (16:21 +0200)
committerNiki Roo <niki@nikiroo.be>
Tue, 2 Jul 2024 14:21:27 +0000 (16:21 +0200)
Doxyfile
Makefile
README.md

index cd944e02c5466d44dcba7949cacbe700f5ea3375..f13376ffbd28cb955594e1b824bb56eb6ac92644 100644 (file)
--- a/Doxyfile
+++ b/Doxyfile
@@ -5,9 +5,9 @@ PROJECT_NAME           = "Program name"
 PROJECT_BRIEF          = "Small description"
 INPUT                  = src/xxx 
 STRIP_FROM_PATH        = src
-OPTIMIZE_OUTPUT_FOR_C  = YES
-OPTIMIZE_OUTPUT_JAVA   = NO
-FILE_PATTERNS          = *.h
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = YES
+FILE_PATTERNS          = *.java
 
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
index 790beea3a6d2827fa2cd1f954dfb320070ad34b9..2ac838d0dbbb62c2a782986671a5fba69822dc45 100644 (file)
--- a/Makefile
+++ b/Makefile
 #
-# Simple makefile that will forward all commands to src/xxx
-# > NAME: main program (for 'man' and 'run')
-# > NAMES: list of all the programs to compile
-# > TESTS: list of all test programs to compile and run
+# 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
-NAMES  = $(NAME) program2
-TESTS  = tests-program
+NAME  = program
+MAIN  = be/nikiroo/program/Main
+TEST  = be/nikiroo/tests/program/Test
+JAR_MISC    = -C ./ LICENSE -C ./ VERSION -C libs/ licenses
+JAR_FLAGS  += -C bin/ be -C bin/ org $(JAR_MISC)
+SJAR_FLAGS += -C src/ be -C src/ org $(JAR_MISC)
+
+PREFIX = /usr/local
+
+#
+# Special Options for this program: you can modify the previous var if needed
+# > OPTION=non-default-value (or OPTION=default-value by default)
+#
+ifeq ($(OPTION),non-default-value)
+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
 
 ################################################################################
 
-# You may override these when calling make
-PREFIX = /usr/local
-dstdir = bin
+JAVAC = javac
+JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
+JAVA = java
+JAVA_FLAGS += -cp ./bin/
+JAR = jar
+RJAR = java
+RJAR_FLAGS += -jar
 
-.PHONY: all build rebuild run clean mrpropre mrpropre love debug doc man \
-       test run-test run-test-more \
-       mess-build mess-run mess-clean mess-propre mess-doc mess-man \
-       mess-test mess-run-test mess-run-test-more \
-       $(NAMES) $(TESTS)
+ifeq ($(DEBUG),1)
+JAVAC_FLAGS += -Xlint:deprecation -g
+endif
 
-all: build
+.PHONY: all build run clean mrpropre mrpropre love debug doc man test run-test \
+       check_time jar sjar resources test-resources libs 
 
-build: mess-build $(NAMES)
+all: build jar sjar
 
-rebuild: mess-rebuild $(NAMES)
+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 $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java"; \
+               $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java"; \
+       done;
+       touch latest_bin
 
-test: mess-test $(TESTS)
+
+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
 
 # Main buildables
-$(NAMES) $(TESTS):
-       $(MAKE) -C src/$@ $(MAKECMDGOALS) --no-print-directory \
-               PREFIX=$(PREFIX) DEBUG=$(DEBUG) dstdir=$(abspath $(dstdir))
+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; \
+       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;
+       cp VERSION 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;
+       touch latest_ttt
 
 # Manual
-man: mess-man
+man: 
+       @echo
+       @echo ">>>>>>>>>> Manual of $(NAME): $(MAKECMDGOALS)..."
        @$(MAKE) -f man.d $(MAKECMDGOALS) NAME=$(NAME)
 
-# Doc
-doc: mess-doc
-       @$(MAKE) -f doc.d $(MAKECMDGOALS) NAME=$(NAME)
-
 # Run
-run: mess-run $(NAME)
+run: build
+       @echo
+       @echo ">>>>>>>>>> Running $(NAME)..."
+       $(JAVA) $(JAVA_FLAGS) $(MAIN)
 
 # Run main test
-run-test: mess-run-test $(TESTS)
-run-test-more: mess-run-test-more $(TESTS)
+run-test: 
+       @echo
+       @echo ">>>>>>>>>> Running tests: $(TEST)..."
+       @[ "$(TEST)" != "" ] || echo No test sources defined.
+       @if [ "`whereis tput`" = "tput:" ]; then \
+       ok='"[ ok ]"'; \
+       ko='"[ !! ]"'; \
+       cols=80; \
+       else \
+       ok="`tput bold`[`tput setf 2` OK `tput init``tput bold`]`tput init`"; \
+       ko="`tput bold`[`tput setf 4` !! `tput init``tput bold`]`tput init`"; \
+       cols="`tput cols`"; \
+       fi; \
+       [ "$(TEST)"  = "" ] || ( \
+               clear; \
+               for test in $(TEST); do \
+                       echo $(JAVA) $(JAVA_FLAGS) \
+                               "$$test" "$$cols" "$$ok" "$$ko"; \
+                       $(JAVA) $(JAVA_FLAGS) "$$test" "$$cols" "$$ok" "$$ko"; \
+               done; \
+       );
 
-# Misc
+# 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: mess-clean doc man $(TESTS) $(NAMES)
-mrproper: mrpropre
-mrpropre: mess-propre $(TESTS) $(NAMES) doc man
-
-# Install/uninstall
-install: mess-install $(NAMES) man
-uninstall: mess-uninstall $(NAMES) man
-
-# Messages
-mess-build:
-       @echo
-       @echo ">>>>>>>>>> Building $(NAMES) in $(dstdir)..."
-mess-rebuild:
-       @echo
-       @echo ">>>>>>>>>> Reilding $(NAMES) in $(dstdir)..."
-mess-run:
+clean: 
        @echo
-       @echo ">>>>>>>>>> Running $(NAME)..."
-mess-clean:
-       @echo
-       @echo ">>>>>>>>>> Cleaning $(NAMES) $(TESTS)..."
-mess-propre:
+       @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..."
-mess-doc:
-       @echo
-       @echo ">>>>>>>>>> Documentation of $(NAME): $(MAKECMDGOALS)..."
-mess-man:
-       @echo
-       @echo ">>>>>>>>>> Manual of $(NAME): $(MAKECMDGOALS)..."
-mess-test:
-       @echo
-       @echo ">>>>>>>>>> Building all tests in $(dstdir): $(TESTS)..."
-mess-run-test:
-       @echo
-       @echo ">>>>>>>>>> Running tests: $(TESTS)..."
-mess-run-test-more:
-       @echo
-       @echo ">>>>>>>>>> Running more tests: $(TESTS)..."
-mess-install:
+       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)..."
-mess-uninstall:
+       mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin"
+       cp $(NAME).jar "$(PREFIX)/lib/"
+       ( \
+       echo "#!/bin/sh"; \
+       echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"\$$@\"" \
+       ) > "$(PREFIX)/bin/$(NAME)"
+       chmod a+rx "$(PREFIX)/bin/$(NAME)"
+
+
+uninstall: man
        @echo
        @echo ">>>>>>>>>> Uninstalling $(NAME) from $(PREFIX)..."
+       rm -f "$(PREFIX)/bin/$(NAME)"
+       rm -f "$(PREFIX)/lib/$(NAME).jar"
+       rmdir "$(PREFIX)/bin" 2>/dev/null
+       rmdir "$(PREFIX)/lib" 2>/dev/null
 
index 2e797e49019e9048cd6cc97e40bcb1ae535a2f13..d29095cf5a5063e13688a557fd17e2cba6c8d3bf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,12 +14,22 @@ Long description multiple paragraphs are ok.
 
 - **--help** (or **-h**): information about the syntax
 
+### Supported platforms
+
+Any platform with at lest Java 1.6 on it should be ok.
+
+It has been tested on Linux (xxx), and YYY (yyy), but feel free to inform us if you try it on another system.
+
+If you have any problems to compile it with a supported Java version (1.6+), please contact us.
+
 ## Compilation
 
 Just run `make`.  
 
 You can also use those make targets:
 
+- `make jar`: build the jar file
+- `make sjar`: build the source jar file
 - `make doc`: build the Doxygen documentation (`doxygen` required)
 - `make man`: build the man page (`pandoc` required)
 - `make install PREFIX=/usr/local`: install the program into PREFIX (default is `/usr/local`) and the manual if built
@@ -28,7 +38,6 @@ You can also use those make targets:
 - `make mrpropre`: clear everything, including the main executable and the documentation
 - `make test`: build the unit tests (`check` required)
 - `make run-test`: start the unit tests
-- `make run-test-more`: start the extra unit tests (can be long)
 
 ## Author