xref: /AOO41X/main/odk/examples/DevelopersGuide/Components/JavaComponent/Makefile (revision 03c97e340010506c11d4ffaab7f577e5f7050fe6)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22#*************************************************************************
23#
24#  The Contents of this file are made available subject to the terms of
25#  the BSD license.
26#
27#  Copyright 2000, 2010 Oracle and/or its affiliates.
28#  All rights reserved.
29#
30#  Redistribution and use in source and binary forms, with or without
31#  modification, are permitted provided that the following conditions
32#  are met:
33#  1. Redistributions of source code must retain the above copyright
34#     notice, this list of conditions and the following disclaimer.
35#  2. Redistributions in binary form must reproduce the above copyright
36#     notice, this list of conditions and the following disclaimer in the
37#     documentation and/or other materials provided with the distribution.
38#  3. Neither the name of Sun Microsystems, Inc. nor the names of its
39#     contributors may be used to endorse or promote products derived
40#     from this software without specific prior written permission.
41#
42#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
45#  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
46#  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
47#  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
48#  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
49#  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
50#  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
51#  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
52#  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53#
54#**************************************************************************
55
56# Builds the SpreadSheet examples of the Developers Guide.
57
58PRJ=../../../..
59SETTINGS=$(PRJ)/settings
60
61include $(SETTINGS)/settings.mk
62include $(SETTINGS)/std.mk
63include $(SETTINGS)/dk.mk
64
65# Define non-platform/compiler specific settings
66
67COMP_NAME=JavaComponent
68OUT_COMP_CLASS = $(OUT_CLASS)/$(COMP_NAME)
69OUT_COMP_GEN = $(OUT_MISC)/$(COMP_NAME)
70COMP_RDB_NAME = $(COMP_NAME).uno.rdb
71COMP_RDB = $(OUT_COMP_GEN)/$(COMP_RDB_NAME)
72COMP_PACKAGE = $(OUT_BIN)/$(COMP_NAME).$(UNOOXT_EXT)
73COMP_PACKAGE_URL = $(subst \\,\,"$(COMP_PACKAGE_DIR)$(PS)$(COMP_NAME).$(UNOOXT_EXT)")
74COMP_JAR_NAME = $(COMP_NAME).uno.jar
75COMP_JAR = $(OUT_COMP_CLASS)/$(COMP_JAR_NAME)
76COMP_MANIFESTFILE = $(OUT_COMP_CLASS)/$(COMP_NAME).uno.Manifest
77COMP_UNOPKG_MANIFEST = $(OUT_COMP_CLASS)/$(COMP_NAME)/META-INF/manifest.xml
78COMP_COMPONENTS=$(COMP_NAME).components
79
80APP1_NAME=TestJavaComponent
81APP1_JAR=$(OUT_COMP_CLASS)/$(APP1_NAME).jar
82
83REGISTERFLAG = $(OUT_MISC)$(PS)devguide_$(COMP_NAME)_register_component.flag
84
85IDLFILES = XSomethingA.idl \
86    XSomethingB.idl \
87    SomethingA.idl \
88    SomethingB.idl
89
90# normally the idl file should be stored in a directory tree fitting the module
91# structure, for the example we know the module structure
92PACKAGE = com/sun/star/test
93
94COMPJAVAFILES  = \
95       TestComponentA.java \
96       TestComponentB.java  \
97       TestServiceProvider.java
98
99GENCLASSFILES = $(patsubst %.idl,$(OUT_COMP_CLASS)/$(PACKAGE)/%.class,$(IDLFILES))
100GENCLASSNAMES = $(patsubst %.idl,$(PACKAGE)/%.class,$(IDLFILES))
101GENTYPELIST = $(subst /,.,$(patsubst %.idl,-T$(PACKAGE)/% ,$(IDLFILES)))
102GENURDFILES = $(patsubst %.idl,$(OUT_COMP_GEN)/%.urd,$(IDLFILES))
103
104COMPCLASSFILES = $(patsubst %.java,$(OUT_COMP_CLASS)/%.class,$(COMPJAVAFILES))
105
106$(COMP_NAME)_CLASSFILES = $(patsubst %.java,%.class,$(COMPJAVAFILES))
107
108$(COMP_NAME)_CLASSFILES += $(subst $(OUT_COMP_CLASS)/,,$(GENCLASSFILES))
109
110SDK_CLASSPATH = $(subst $(EMPTYSTRING) $(PATH_SEPARATOR),$(PATH_SEPARATOR),$(CLASSPATH)\
111        $(PATH_SEPARATOR)$(OUT_COMP_CLASS))
112
113
114# Targets
115.PHONY: ALL
116ALL : \
117    JavaComponentExample
118
119include $(SETTINGS)/stdtarget.mk
120
121$(OUT_COMP_CLASS)/%.Manifest :
122    -$(MKDIR) $(subst /,$(PS),$(@D))
123    @echo UNO-Type-Path: $(basename $(notdir $*)).uno.jar> $@
124    @echo RegistrationClassName: TestServiceProvider>> $@
125
126$(OUT_COMP_GEN)/%.urd : %.idl
127    -$(MKDIR) $(subst /,$(PS),$(@D))
128    $(IDLC) -I. -I$(IDL_DIR) -O$(OUT_COMP_GEN) $^
129
130$(OUT_COMP_GEN)/%.rdb : $(GENURDFILES)
131    -$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
132    -$(MKDIR) $(subst /,$(PS),$(@D))
133    $(REGMERGE) $@ /UCR $(GENURDFILES)
134
135$(OUT_COMP_CLASS)/$(PACKAGE)/%.class : $(COMP_RDB)
136    -$(MKDIR) $(subst /,$(PS),$(@D))
137    $(JAVAMAKER) -BUCR -nD $(GENTYPELIST) -O$(OUT_COMP_CLASS) $(COMP_RDB) -X$(URE_TYPES) -X$(OFFICE_TYPES)
138
139$(OUT_COMP_CLASS)/%.class : %.java $(GENCLASSFILES)
140    -$(MKDIR) $(subst /,$(PS),$(@D))
141    $(SDK_JAVAC) $(JAVAC_FLAGS) -classpath "$(SDK_CLASSPATH)" -d $(OUT_COMP_CLASS) $<
142
143$(COMPCLASSFILES) : $(COMPJAVAFILES) $(GENCLASSFILES)
144    -$(MKDIR) $(subst /,$(PS),$(@D))
145    $(SDK_JAVAC) $(JAVAC_FLAGS) -classpath "$(SDK_CLASSPATH)" -d $(OUT_COMP_CLASS) $(COMPJAVAFILES)
146
147# rule for client/example application manifest file
148$(OUT_COMP_CLASS)/%.mf :
149    -$(MKDIR) $(subst /,$(PS),$(@D))
150    @echo Main-Class: com.sun.star.lib.loader.Loader> $@
151    $(ECHOLINE)>> $@
152    @echo Name: com/sun/star/lib/loader/Loader.class>> $@
153    @echo Application-Class: $*>> $@
154
155# rule for client/example application jar file
156# Note that the example needs the component files as well for local usage
157$(APP1_JAR) : $(OUT_COMP_CLASS)/$(APP1_NAME).mf $(OUT_COMP_CLASS)/$(APP1_NAME).class $(COMPCLASSFILES) $(GENCLASSFILES)
158    -$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
159    -$(MKDIR) $(subst /,$(PS),$(@D))
160    +cd $(subst /,$(PS),$(OUT_COMP_CLASS)) && $(SDK_JAR) cvfm $(@F) $(basename $(@F)).mf $(basename $(@F)).class $($(COMP_NAME)_CLASSFILES)
161    +$(SDK_JAR) uvf $@ $(SDK_JAVA_UNO_BOOTSTRAP_FILES)
162
163# rule for component jar file
164$(COMP_JAR) : $(COMP_MANIFESTFILE) $(COMPCLASSFILES)
165    -$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
166    -$(MKDIR) $(subst /,$(PS),$(@D))
167    cd $(subst /,$(PS),$(OUT_COMP_CLASS)) && $(SDK_JAR) cvfm $(@F) $(<F) $($(basename $(basename $(@F)))_CLASSFILES)
168
169# rule for component package manifest
170$(OUT_COMP_CLASS)/%/manifest.xml :
171    -$(MKDIR) $(subst /,$(PS),$(@D))
172    @echo $(OSEP)?xml version="$(QM)1.0$(QM)" encoding="$(QM)UTF-8$(QM)"?$(CSEP) > $@
173    @echo $(OSEP)!DOCTYPE manifest:manifest PUBLIC "$(QM)-//OpenOffice.org//DTD Manifest 1.0//EN$(QM)" "$(QM)Manifest.dtd$(QM)"$(CSEP) >> $@
174    @echo $(OSEP)manifest:manifest xmlns:manifest="$(QM)http://openoffice.org/2001/manifest$(QM)"$(CSEP) >> $@
175    @echo $(SQM)  $(SQM)$(OSEP)manifest:file-entry manifest:media-type="$(QM)application/vnd.sun.star.uno-typelibrary;type=RDB$(QM)" >> $@
176    @echo $(SQM)                       $(SQM)manifest:full-path="$(QM)$(subst /META-INF,,$(subst $(OUT_COMP_CLASS)/,,$(@D))).uno.rdb$(QM)"/$(CSEP) >> $@
177    @echo $(SQM)  $(SQM)$(OSEP)manifest:file-entry manifest:media-type="$(QM)application/vnd.sun.star.uno-components$(QM)">> $@
178    @echo $(SQM)                       $(SQM)manifest:full-path="$(QM)$(COMP_COMPONENTS)$(QM)"/$(CSEP)>> $@
179    @echo $(OSEP)/manifest:manifest$(CSEP) >> $@
180
181# rule for component pacakge file
182$(COMP_PACKAGE) : $(COMP_RDB) $(COMP_JAR) $(COMP_UNOPKG_MANIFEST) $(COMP_COMPONENTS)
183    -$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
184    -$(MKDIR) $(subst /,$(PS),$(@D))
185    $(COPY) $(subst /,$(PS),$(COMP_RDB)) $(subst /,$(PS),$(OUT_COMP_CLASS))
186    $(SDK_ZIP) $@ $(COMP_COMPONENTS)
187    cd $(subst /,$(PS),$(OUT_COMP_CLASS)) && $(SDK_ZIP) -u ../../bin/$(@F) $(COMP_RDB_NAME) $(COMP_JAR_NAME)
188    cd $(subst /,$(PS),$(OUT_COMP_CLASS)/$(subst .$(UNOOXT_EXT),,$(@F))) && $(SDK_ZIP) -u ../../../bin/$(@F) META-INF/manifest.xml
189    $(DEL) $(subst \\,\,$(subst /,$(PS),$(OUT_COMP_CLASS)/$(COMP_RDB_NAME)))
190
191$(REGISTERFLAG) : $(COMP_PACKAGE)
192ifeq "$(SDK_AUTO_DEPLOYMENT)" "YES"
193    -$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
194    -$(MKDIR) $(subst /,$(PS),$(@D))
195    $(DEPLOYTOOL) $(COMP_PACKAGE_URL)
196    @echo flagged > $(subst /,$(PS),$@)
197else
198    @echo --------------------------------------------------------------------------------
199    @echo  If you want to install your component automatically, please set the environment
200    @echo  variable SDK_AUTO_DEPLOYMENT = YES. But note that auto deployment is only
201    @echo  possible if no office instance is running.
202    @echo --------------------------------------------------------------------------------
203endif
204
205JavaComponentExample : $(REGISTERFLAG) $(APP1_JAR)
206    @echo --------------------------------------------------------------------------------
207    @echo Please use one of the following commands to execute the examples!
208    @echo -
209    @echo $(MAKE) $(APP1_NAME).run
210    @echo $(MAKE) $(APP1_NAME).local
211    @echo --------
212    @echo The Java components were installed if SDK_AUTO_DEPLOYMENT = YES.
213    @echo You can use this component inside your office installation, see the
214    @echo example description.
215    @echo --------------------------------------------------------------------------------
216
217%.run: $(OUT_COMP_CLASS)/%.jar
218    $(SDK_JAVA) -Dcom.sun.star.lib.loader.unopath="$(OFFICE_PROGRAM_PATH)" -jar $<
219
220%.local: $(OUT_COMP_CLASS)/%.jar
221    $(SDK_JAVA) -Dcom.sun.star.lib.loader.unopath="$(OFFICE_PROGRAM_PATH)" -jar $< local
222
223.PHONY: clean
224clean :
225    -$(DELRECURSIVE) $(subst /,$(PS),$(OUT_COMP_CLASS))
226    -$(DELRECURSIVE) $(subst /,$(PS),$(OUT_COMP_GEN))
227    -$(DEL) $(subst \\,\,$(subst /,$(PS),$(COMP_PACKAGE_URL)))
228    -$(DEL) $(subst \\,\,$(subst /,$(PS),$(REGISTERFLAG)))
229