7228203d6da6bf1fb2a603586881d2b4545f2dcb
[nativez] / java.make
1 #
2 # Copyright (C) 2019 Michael Zucchi
3 #
4 # This is the copyright for java.make
5 #
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
10 #
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 # GNU General Public License for more details.
15 #
16 # You should have received a copy of the GNU General Public License
17 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 #
19
20 # General purpose modular java makefile that supports native library
21 # compilation directly.  Non-recrusve implementation.
22 #
23 # Uses metamake programming with some file conventions to implement
24 # auto-make-like features.
25
26 # Define modules
27 # --------------
28 # java_MODULES list of java modules to compile.  The sources must
29 #               exist in src/<module>/classes.  Resource files are
30 #               stored in src/<module>/classes.  Source-code
31 #               generators must exist in src/<module>/gen.  Native
32 #               libraries must exist in src/<module>/jni.
33
34 # Global variables
35
36 # JAVA_HOME             location of jdk.
37 # JAVAC                 java compiler to use.  Default is 'javac' on the path.
38 # JAVACFLAGS            javac flags applied to all invocations.
39 # JAR                   jar command.
40 # JARFLAGS              jar flags
41 # JMOD                  jmod command.
42 # JMODFLAGS             jmod flags.
43
44 # Module specific variables
45
46 # <module>_JDEPMOD      Lists modules which this one depends on.
47
48 # <module>_JAVACFLAGS   Extra module-specific flags for each command.
49 # <module>_JARFLAGS
50 # <module>_JMODFLAGS
51
52 # <module>_JAVA         Java sources.  If not set it is found from src/<module>/classes/(*.java)
53 # <module>_RESOURCES    .jar resources.  If not set it is found from src/<module>/classes/(not *.java)
54 # <module>_JAVA_GENERATED       Java generated sources.  These must be relative to the package name.
55
56 # Variables for use in fragments
57
58 # gen.make and jni.make can additionally make use of these variables
59
60 # <module>_gendir       Location for files used in Java generation process (per project).
61 # <module>_genjavadir   Location where _JAVA_GENERATED .java files will be created (per project).
62 # <module>_jnidir       Location for jni generated files (per target).
63 # <module>_objdir       Location for c objects (per target).
64 # <module>_incdir       Location for output includes, .jmod staging.
65 # <module>_libdir       Location for output libraries, .jmod staging.  May point to _bindir.
66 # <module>_bindir       Location for output commands, .jmod staging.
67
68 # Define libraries
69 # ----------------
70
71 # Each module can define one or more native libraries.
72
73 # These are compiled after the java sources have been compiled as that
74 # process also generates any native binding headers.
75
76 # <module>_JNI_LIBRARIES        list of libraries to build.
77 # library names match System.loadLibrary().
78
79 # Global variables
80
81 # <target>_LDFLAGS
82 # <target>_LDLIBS
83 # <target>_CPPFLAGS
84 # <target>_CFLAGS
85 # SO            shared library suffix
86 # LIB           shared library prefix
87
88 # Utility functions
89 #
90 # $(call library-path,<module>,<libname>) will resolve to the library file name.
91
92 # Per library variables.
93
94 # <library>_SOURCES     .c, .cc, .C - source files for library.  Paths are relative to src/<module>/jni.
95 # <library>_HEADERS     header files for jmod
96 # <library>_COMMANDS    commands/bin/scripts for jmod
97
98 # <library>_LDFLAGS     link flags
99 # <library>_LIBADD      extra objects to add to link line
100 # <library>_LDLIBS      link libraries
101 # <library>_CPPFLAGS    c pre-processor flags.  "-Isrc/<module>/jni -Ibin/include/<module>" is implicit.
102 # <library>_CCFLAGS     c compiler flags
103
104 # <library>_DEPENDENCIES        A list of other objects on which this library depends before linking.
105
106 # .c files have dependencies automatically generated
107
108 # Targets
109 # -------
110
111 # make gen              only generate java sources
112 # make clean            rm -rf bin
113 # make dist             create dist tar in bin/
114 # make | make jar       make all jars and jmods
115 # make bin              make everything but jars and mods
116
117 # Outputs
118 # -------
119
120 # All intermediate and output files are written to bin/
121
122 # This layout is enforced by javac
123 #  bin/include/<module>/        .h files from javac -h
124 #  bin/modules/<module>/        .class files from javac
125
126 # This layout is convenient for netbeans
127 #  bin/gen/<module>/gen/        .c, exe files for generator     free use
128 #  bin/gen/<module>/classes/    .java files from generator      <module>_JAVA_GENERATED
129
130 #  bin/status/                  marker files for makefile
131
132 #  bin/<module>/<module>.jar    .jar modular
133
134 # Native code
135
136 #  bin/<module>/<target>/lib    .so librareies for jmod         <module>_LIBRARIES = libname
137 #  bin/<module>/<target>/obj    .o, .d files for library        <libname>_SOURCES
138 #  bin/<module>/<target>/include .h files for jmod              <libname>_HEADERS
139 #  bin/<module>/<target>/<module>.jmod  .jmod module
140
141 # ######################################################################
142
143 E:=
144 S:=$(E) $(E)
145
146 # All modules with native code
147 java_JMODS=$(foreach module,$(java_MODULES),$(if $(wildcard src/$(module)/jni/jni.make),$(module)))
148 # Only modules with no native code
149 java_JARS=$(foreach module,$(java_MODULES),$(if $(wildcard src/$(module)/jni/jni.make),,$(module)))
150 # Modules with generated java source
151 java_JGEN=$(foreach module,$(java_MODULES),$(if $(wildcard src/$(module)/gen/gen.make),$(module)))
152
153 # Define some useful variables before including fragments
154 define java_variables=
155 $(1)_gendir:=bin/gen/$(1)/gen
156 $(1)_genjavadir:=bin/gen/$(1)/classes
157 $(1)_jnidir:=bin/$(1)/$(TARGET)/jni
158 $(1)_objdir:=bin/$(1)/$(TARGET)/obj
159 $(1)_incdir:=bin/$(1)/$(TARGET)/include
160 $(1)_libdir:=$$(if $$(filter windows-%,$(TARGET)),bin/$(1)/$(TARGET)/bin,bin/$(1)/$(TARGET)/lib)
161 $(1)_bindir:=bin/$(1)/$(TARGET)/bin
162 ifndef $(1)_JAVA
163 $(1)_JAVA := $$(shell find src/$(1)/classes -type f -name '*.java')
164 endif
165 ifndef $(1)_RESOURCES
166 $(1)_RESOURCES := $$(shell find src/$(1)/classes -type f \! -name '*.java')
167 endif
168 endef
169
170 $(foreach module,$(java_MODULES),$(eval $(call java_variables,$(module))))
171
172 # ######################################################################
173
174 all: jar
175 bin:
176 gen:
177
178 .PHONY: all clean jar bin gen
179 clean:
180         rm -rf bin
181
182 include $(patsubst %,src/%/gen/gen.make,$(java_JGEN))
183 include $(patsubst %,src/%/jni/jni.make,$(java_JMODS))
184
185 # ######################################################################
186 # Java
187 # ######################################################################
188
189 define java_targets=
190 # Rules for module $(1)
191 $(1)_JAVA_generated = $$(addprefix $$($(1)_genjavadir)/,$$($(1)_JAVA_GENERATED))
192
193 bin/status/$(1).data: $$($(1)_RESOURCES)
194 bin/status/$(1).classes: $(patsubst %,bin/status/%.classes,$($(1)_JDEPMOD)) $$($(1)_JAVA) $$($(1)_JAVA_generated)
195 jar $(1): bin/$(1)/$(1).jar $(if $(wildcard src/$(1)/jni/jni.make),bin/$(1)/$(TARGET)/$(1).jmod)
196 bin: bin/status/$(1).classes bin/status/$(1).data
197 sources: bin/$(1)/$(1)-sources.zip
198 gen: $$($(1)_JAVA_generated)
199
200 # Create modular jar
201 bin/$(1)/$(1).jar: bin/status/$(1).classes bin/status/$(1).data
202         @install -d $$(@D)
203         $(JAR) cf $$@ \
204           $(JARFLAGS) $$($(1)_JARFLAGS) \
205           -C bin/modules/$(1) .
206
207 # Create a jmod
208 bin/$(1)/$(TARGET)/$(1).jmod: bin/status/$(1).classes bin/status/$(1).data
209         rm -f $$@
210         @install -d $$(@D)
211         $$(JMOD) create \
212           $$(JMODFLAGS) $$($(1)_JMODFLAGS) \
213           --target-platform $(TARGET) \
214           --class-path bin/modules/$(1) \
215           $$(if $$(wildcard bin/$(1)/$(TARGET)/include),--header-files bin/$(1)/$(TARGET)/include) \
216           $$(if $$(wildcard src/$(1)/legal),--legal-notices src/$(1)/legal) \
217           $$(if $$(wildcard $$($(1)_bindir)),--cmds $$($(1)_bindir)) \
218           $$(if $$(wildcard $$($(1)_libdir)),--libs $$($(1)_libdir)) \
219           $$@
220
221 # Create an IDE source zip, paths have to match --module-source-path
222 bin/$(1)/$(1)-sources.zip: bin/status/$(1).classes
223         @install -d $$(@D)
224         jar -c -f $$@ -M \
225                 $$(patsubst src/$(1)/classes/%,-C src/$(1)/classes %,$$(filter src/$(1)/classes/%,$$($(1)_JAVA))) \
226                 $$(patsubst bin/gen/$(1)/classes/%,-C bin/gen/$(1)/classes %,$$(filter bin/gen/$(1)/classes/%,$$($(1)_JAVA)))
227
228 endef
229
230 #$(foreach module,$(java_MODULES),$(info $(call java_targets,$(module))))
231 $(foreach module,$(java_MODULES),$(eval $(call java_targets,$(module))))
232
233 # ######################################################################
234 # Global pattern rules
235
236 # Stage resources
237 bin/status/%.data:
238         @install -d $(@D)
239         for data in $(patsubst src/$*/classes/%,"%",$($*_RESOURCES)) ; do \
240                 install -vDC "src/$*/classes/$$data" "bin/modules/$*/$$data" || exit 1 ; \
241         done
242         touch $@
243
244 # Compile one module.  This only updates (javac -h) headers if they changed.
245 bin/status/%.classes:
246         @install -d $(@D)
247         $(JAVAC) \
248                 --module-source-path "src/*/classes:bin/gen/*/classes" \
249                 $(JAVACFLAGS) $($*_JAVACFLAGS) \
250                 -h bin/inc \
251                 -d bin/modules \
252                 -m $* \
253                 $($*_JAVA) $($*_JAVA_generated)
254         if [ -d bin/inc/$* ] ; then \
255                 install -DC -t bin/include/$* bin/inc/$*/*.h ; \
256         fi
257         touch $@
258
259 # ######################################################################
260 # C stuff
261 # ######################################################################
262
263 SUFFIXES=.c .C .cc
264 SO=$($(TARGET)_SO)
265 LIB=$($(TARGET)_LIB)
266
267 # functions to find cross-module stuff $(call library-path,modname,libname)
268 library-path=bin/$(1)/$(TARGET)/lib/$(LIB)$(2)$(SO)
269 library-dir=bin/$(1)/$(TARGET)/lib/
270
271 define jni_library=
272 # Rule for library $(2) in module $(1)
273 $(2)_OBJS = $(foreach sx,$(SUFFIXES),$(patsubst %$(sx), $($(1)_objdir)/%.o, $(filter %$(sx),$($(2)_SOURCES))))
274 $(2)_SRCS = $(addprefix src/$(1)/jni/,$($(2)_SOURCES))
275
276 $($(1)_libdir)/$(LIB)$(2)$(SO): $$($(2)_OBJS) $($(2)_LIBADD) $($(2)_DEPENDENCIES)
277         @install -d $$(@D)
278         $($(TARGET)_CC) -o $$@ -shared \
279                 $($(TARGET)_LDFLAGS) $($(2)_LDFLAGS) $$($(2)_OBJS) $($(2)_LIBADD) $($(TARGET)_LDLIBS) $($(2)_LDLIBS)
280
281 $($(1)_objdir)/%.o: src/$(1)/jni/%.c bin/status/$(1).classes
282         @install -d $$(@D)
283         $($(TARGET)_CC) -Isrc/$(1)/jni -Ibin/include/$(1) $($(TARGET)_CPPFLAGS) $($(2)_CPPFLAGS) \
284                 $($(TARGET)_CFLAGS) $($(2)_CFLAGS) -c -o $$@ $$<
285
286 $($(1)_incdir)/%.h: src/$(1)/jni/%.h
287         install -D $$< $$@
288
289 $($(1)_objdir)/%.d: src/$(1)/jni/%.c bin/status/$(1).classes
290         @install -d $$(@D)
291         @rm -f $$@
292         @$($(TARGET)_CC) -MM -MT "bin/$(1)/$(TARGET)/obj/$$*.o" -Isrc/$(1)/jni -Ibin/include/$(1) \
293                 $($(TARGET)_CPPFLAGS) $($(2)_CPPFLAGS) $$< -o $$@.d 2>/dev/null
294         @sed 's,\($$*\.o\) *:,\1 $$@ : ,g' $$@.d > $$@ ; rm $$@.d
295
296 bin jni $(1) bin/$(1)/$(TARGET)/$(1).jmod: $($(1)_libdir)/$(LIB)$(2)$(SO) \
297         $(addprefix $($(1)_incdir)/,$($(2)_HEADERS)) \
298         $(addprefix $($(1)_bindir)/,$($(2)_COMMANDS))
299
300 $(if $(filter clean dist gen,$(MAKECMDGOALS)),,-include $$($(2)_OBJS:.o=.d))
301 endef
302
303 #$(foreach module,$(java_JMODS),$(foreach library,$($(module)_JNI_LIBRARIES),$(info $(call jni_library,$(module),$(library)))))
304 $(foreach module,$(java_JMODS),$(foreach library,$($(module)_JNI_LIBRARIES),$(eval $(call jni_library,$(module),$(library)))))
305
306 # ######################################################################
307
308 dist:
309         @install -d bin
310         tar cfz bin/$(dist_NAME)-$(dist_VERSION).tar.gz \
311          --transform=s,^,$(dist_NAME)-$(dist_VERSION)/, \
312          config.make java.make Makefile src             \
313          $(dist_EXTRA)
314