Makefile.base

   1 # Required parameters (the commented out ones are supposed to change per project):
   2
   3 #MAIN = path to main java source to compile
   4 #MORE = path to supplementary needed resources not linked from MAIN
   5 #NAME = name of project (used for jar output file)
   6 #PREFIX = usually /usr/local (where to install the program)
   7 #TEST = path to main test source to compile
   8 #JAR_FLAGS += a list of things to pack, each usually prefixed with "-C bin/"
   9 #SJAR_FLAGS += a list of things to pack, each usually prefixed with "-C src/", for *-sources.jar files
  10
  11 JAVAC = javac
  12 JAVAC_FLAGS += -encoding UTF-8 -d ./bin/ -cp ./src/
  13 JAVA = java
  14 JAVA_FLAGS += -cp ./bin/
  15 JAR = jar
  16 RJAR = java
  17 RJAR_FLAGS += -jar
  18
  19 # Usual options:
  20 #       make            : to build the jar file
  21 #       make libs       : to update the libraries into src/
  22 #       make build      : to update the binaries (not the jar)
  23 #       make test       : to update the test binaries
  24 #       make build jar  : to update the binaries and jar file
  25 #       make clean      : to clean the directory of intermediate files
  26 #       make mrpropre   : to clean the directory of all outputs
  27 #       make run        : to run the program from the binaries
  28 #       make run-test   : to run the test program from the binaries
  29 #       make jrun       : to run the program from the jar file
  30 #       make install    : to install the application into $PREFIX
  31
  32 # Note: build is actually slower than rebuild in most cases except when
  33 # small changes only are detected ; so we use rebuild by default
  34
  35 all: build jar
  36
  37 .PHONY: all clean mrproper mrpropre build run jrun jar resources install libs love
  38
  39 bin:
  40         @mkdir -p bin
  41
  42 jar: $(NAME).jar
  43
  44 build: resources
  45         @echo Compiling program...
  46         @echo " src/$(MAIN)"
  47         @$(JAVAC) $(JAVAC_FLAGS) "src/$(MAIN).java"
  48         @[ "$(MORE)" = "" ] || for sup in $(MORE); do \
  49                 echo "  src/$$sup" ;\
  50                 $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
  51         done
  52
  53 test:
  54         @[ -e bin/$(MAIN).class ] || echo You need to build the sources
  55         @[ -e bin/$(MAIN).class ]
  56         @echo Compiling test program...
  57         @[ "$(TEST)" != "" ] || echo No test sources defined.
  58         @[ "$(TEST)"  = "" ] || for sup in $(TEST); do \
  59                 echo "  src/$$sup" ;\
  60                 $(JAVAC) $(JAVAC_FLAGS) "src/$$sup.java" ; \
  61         done
  62
  63 clean:
  64         rm -rf bin/
  65         @echo Removing sources taken from libs...
  66         @for lib in libs/*-sources.jar; do \
  67                 basename "$$lib"; \
  68                 jar tf "$$lib" | while read -r ln; do \
  69                         [ -f "src/$$ln" ] && rm "src/$$ln"; \
  70                 done; \
  71                 jar tf "$$lib" | tac | while read -r ln; do \
  72                         [ -d "src/$$ln" ] && rmdir "src/$$ln" 2>/dev/null || true; \
  73                 done; \
  74         done
  75
  76 mrproper: mrpropre
  77
  78 mrpropre: clean
  79         rm -f $(NAME).jar
  80         rm -f $(NAME)-sources.jar
  81         [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`.jar"
  82         [ ! -e VERSION ] || rm -f "$(NAME)-`cat VERSION`-sources.jar"
  83
  84 love:
  85         @echo " ...not war."
  86
  87 resources: libs
  88         @echo Copying resources into bin/...
  89         @cd src && find . | grep -v '\.java$$' | while read -r ln; do \
  90                 if [ -f "$$ln" ]; then \
  91                         dir="`dirname "$$ln"`"; \
  92                         mkdir -p "../bin/$$dir" ; \
  93                         cp "$$ln" "../bin/$$ln" ; \
  94                 fi ; \
  95         done
  96
  97 libs: bin
  98         @[ -e bin/libs -o ! -d libs ] || echo Extracting sources from libs...
  99         @[ -e bin/libs -o ! -d libs ] || (cd src && for lib in ../libs/*-sources.jar; do \
 100                 basename "$$lib"; \
 101                 jar xf "$$lib"; \
 102         done )
 103         @[ ! -d libs ] || touch bin/libs
 104
 105 $(NAME).jar: resources
 106         @[ -e bin/$(MAIN).class ] || echo You need to build the sources
 107         @[ -e bin/$(MAIN).class ]
 108         @echo Making JAR file...
 109         @echo > bin/manifest
 110         @[ "$(SJAR_FLAGS)" = "" ] || echo Creating $(NAME)-sources.jar...
 111         @[ "$(SJAR_FLAGS)" = "" ] || $(JAR) cfm $(NAME)-sources.jar bin/manifest $(SJAR_FLAGS)
 112         @[ "$(SJAR_FLAGS)" = "" ] || [ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`-sources.jar"...
 113         @[ "$(SJAR_FLAGS)" = "" ] || [ ! -e VERSION ] || cp $(NAME)-sources.jar "$(NAME)-`cat VERSION`-sources.jar"
 114         @echo "Main-Class: `echo "$(MAIN)" | sed 's:/:.:g'`" > bin/manifest
 115         @echo >> bin/manifest
 116         $(JAR) cfm $(NAME).jar bin/manifest $(JAR_FLAGS)
 117         @[ ! -e VERSION ] || echo Copying to "$(NAME)-`cat VERSION`.jar"...
 118         @[ ! -e VERSION ] || cp $(NAME).jar "$(NAME)-`cat VERSION`.jar"
 119
 120 run:
 121         @[ -e bin/$(MAIN).class ] || echo You need to build the sources
 122         @[ -e bin/$(MAIN).class ]
 123         @echo Running "$(NAME)"...
 124         $(JAVA) $(JAVA_FLAGS) $(MAIN)
 125
 126 jrun:
 127         @[ -e $(NAME).jar ] || echo You need to build the jar
 128         @[ -e $(NAME).jar ]
 129         @echo Running "$(NAME).jar"...
 130         $(RJAR) $(RJAR_FLAGS) $(NAME).jar
 131
 132 run-test:
 133         @[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ] || echo You need to build the test sources
 134         @[ "$(TEST)" = "" -o -e "bin/$(TEST).class" ]
 135         @echo Running tests for "$(NAME)"...
 136         @[ "$(TEST)" != "" ] || echo No test sources defined.
 137         [ "$(TEST)"  = "" ] || $(JAVA) $(JAVA_FLAGS) $(TEST)
 138
 139 install:
 140         @[ -e $(NAME).jar ] || echo You need to build the jar
 141         @[ -e $(NAME).jar ]
 142         mkdir -p "$(PREFIX)/lib" "$(PREFIX)/bin"
 143         cp $(NAME).jar "$(PREFIX)/lib/"
 144         echo "#!/bin/sh" > "$(PREFIX)/bin/$(NAME)"
 145         echo "$(RJAR) $(RJAR_FLAGS) \"$(PREFIX)/lib/$(NAME).jar\" \"$$@\"" >> "$(PREFIX)/bin/$(NAME)"
 146         chmod a+rx "$(PREFIX)/bin/$(NAME)"
 147