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 Java Minimal component example of the SDK.
57 
58 PRJ=../../..
59 SETTINGS=$(PRJ)/settings
60 
61 include $(SETTINGS)/settings.mk
62 include $(SETTINGS)/std.mk
63 include $(SETTINGS)/dk.mk
64 
65 # Define non-platform/compiler specific settings
66 
67 # we use the sample directory name dor separating this example
68 # from others in the output directory
69 SAMPLE_NAME=MinimalComponent
70 SAMPLE_CLASS_OUT=$(OUT_CLASS)/$(SAMPLE_NAME)
71 SAMPLE_GEN_OUT=$(OUT_MISC)/$(SAMPLE_NAME)
72 
73 COMP_NAME=MinimalComponent
74 COMP_CLASS_OUT=$(SAMPLE_CLASS_OUT)/$(COMP_NAME)
75 COMP_GEN_OUT=$(SAMPLE_GEN_OUT)/$(COMP_NAME)
76 COMP_RDB_NAME=$(COMP_NAME).uno.rdb
77 COMP_RDB=$(COMP_GEN_OUT)/$(COMP_RDB_NAME)
78 COMP_PACKAGE=$(OUT_BIN)/$(COMP_NAME).$(UNOOXT_EXT)
79 COMP_PACKAGE_URL=$(subst \\,\,"$(COMP_PACKAGE_DIR)$(PS)$(COMP_NAME).$(UNOOXT_EXT)")
80 COMP_JAR_NAME=$(COMP_NAME).uno.jar
81 COMP_JAR=$(SAMPLE_CLASS_OUT)/$(COMP_JAR_NAME)
82 COMP_JAR_MANIFEST=$(COMP_GEN_OUT)/$(COMP_NAME).uno.Manifest
83 COMP_UNOPKG_MANIFEST = $(COMP_GEN_OUT)/META-INF/manifest.xml
84 COMP_REGISTERFLAG=$(COMP_GEN_OUT)$(PS)java_$(COMP_NAME)_register_component.flag
85 COMP_COMPONENTS=$(COMP_NAME).components
86 
87 APP1_NAME=TestMinimalComponent
88 APP1_CLASS_OUT=$(SAMPLE_CLASS_OUT)/$(APP1_NAME)
89 APP1_GEN_OUT=$(SAMPLE_GEN_OUT)/$(APP1_NAME)
90 APP1_JAR=$(SAMPLE_CLASS_OUT)/$(APP1_NAME).jar
91 APP1_JAR_MANIFEST=$(APP1_GEN_OUT)/$(APP1_NAME).mf
92 
93 IDLFILES = MinimalComponent.idl
94 
95 # normally the idl file should be stored in a directory tree fitting the module structure,
96 # for the example we know the module structure
97 PACKAGE = org/openoffice
98 
99 COMP_JAVAFILES  = MinimalComponent.java
100 COMP_CLASSFILES = $(patsubst %.java,$(COMP_CLASS_OUT)/%.class,$(COMP_JAVAFILES))
101 
102 GEN_CLASSFILES = $(patsubst %.idl,$(SAMPLE_CLASS_OUT)/$(PACKAGE)/%.class,$(IDLFILES))
103 GEN_TYPELIST = $(subst /,.,$(patsubst %.idl,-T$(PACKAGE)/% ,$(IDLFILES)))
104 GEN_URDFILES = $(patsubst %.idl,$(SAMPLE_GEN_OUT)/%.urd,$(IDLFILES))
105 
106 # the generated types are necessary for the component and the application jar
107 GEN_CLASSFILENAMES = $(subst $(SAMPLE_CLASS_OUT)/,,$(GEN_CLASSFILES))
108 
109 SDK_CLASSPATH = $(subst $(EMPTYSTRING) $(PATH_SEPARATOR),$(PATH_SEPARATOR),$(CLASSPATH)\
110 		$(PATH_SEPARATOR)$(SAMPLE_CLASS_OUT)\
111 		$(PATH_SEPARATOR)$(COMP_CLASS_OUT)\
112 		$(PATH_SEPARATOR)$(APP1_CLASS_OUT))
113 
114 
115 # Targets
116 .PHONY: ALL
117 ALL : JavaMinimalComponentExample
118 
119 include $(SETTINGS)/stdtarget.mk
120 
121 $(COMP_GEN_OUT)/%.Manifest :
122 	-$(MKDIR) $(subst /,$(PS),$(@D))
123 	@echo UNO-Type-Path: $(basename $*).uno.jar> $@
124 	@echo RegistrationClassName: $(basename $*)>> $@
125 
126 $(SAMPLE_GEN_OUT)/%.urd : %.idl
127 	-$(MKDIR) $(subst /,$(PS),$(@D))
128 	$(IDLC) -C -I. -I$(IDL_DIR) -O$(SAMPLE_GEN_OUT) $<
129 
130 $(COMP_GEN_OUT)/%.rdb : $(GEN_URDFILES)
131 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
132 	-$(MKDIR) $(subst /,$(PS),$(@D))
133 	$(REGMERGE) $@ /UCR $(GEN_URDFILES)
134 
135 $(GEN_CLASSFILES) : $(COMP_RDB)
136 	-$(MKDIR) $(subst /,$(PS),$(@D))
137 	$(JAVAMAKER) -BUCR -nD $(GEN_TYPELIST) -O$(SAMPLE_CLASS_OUT) $(COMP_RDB) -X$(URE_TYPES) -X$(OFFICE_TYPES)
138 
139 # component as well as application are dependent from the generated types
140 # rule for component class files
141 $(COMP_CLASS_OUT)/%.class : %.java $(GEN_CLASSFILES)
142 	-$(MKDIR) $(subst /,$(PS),$(@D))
143 	$(SDK_JAVAC) $(JAVAC_FLAGS) -classpath "$(SDK_CLASSPATH)" -d $(COMP_CLASS_OUT) $<
144 
145 # rule for example application class files
146 $(APP1_CLASS_OUT)/%.class : %.java $(GEN_CLASSFILES)
147 	-$(MKDIR) $(subst /,$(PS),$(@D))
148 	$(SDK_JAVAC) $(JAVAC_FLAGS) -classpath "$(SDK_CLASSPATH)" -d $(APP1_CLASS_OUT) $<
149 
150 # rule for client/example application manifest file
151 $(APP1_GEN_OUT)/%.mf :
152 	-$(MKDIR) $(subst /,$(PS),$(@D))
153 	@echo Main-Class: com.sun.star.lib.loader.Loader> $@
154 	$(ECHOLINE)>> $@
155 	@echo Name: com/sun/star/lib/loader/Loader.class>> $@
156 	@echo Application-Class: $*>> $@
157 
158 # rule for client/example application jar file
159 $(APP1_JAR) : $(APP1_JAR_MANIFEST) $(APP1_CLASS_OUT)/$(APP1_NAME).class $(GEN_CLASSFILES)
160 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
161 	-$(MKDIR) $(subst /,$(PS),$(@D))
162 	$(SDK_JAR) cvfm $@  $< -C $(APP1_CLASS_OUT) .
163 	+cd $(subst /,$(PS),$(SAMPLE_CLASS_OUT)) && $(SDK_JAR) uvf $(@F) $(GEN_CLASSFILENAMES)
164 	+$(SDK_JAR) uvf $@ $(SDK_JAVA_UNO_BOOTSTRAP_FILES)
165 
166 # rule for component jar file
167 $(COMP_JAR) : $(COMP_JAR_MANIFEST) $(COMP_CLASSFILES)
168 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
169 	-$(MKDIR) $(subst /,$(PS),$(@D))
170 	$(SDK_JAR) cvfm $@  $< -C $(COMP_CLASS_OUT) .
171 	+cd $(subst /,$(PS),$(SAMPLE_CLASS_OUT)) && $(SDK_JAR) uvf $(@F) $(GEN_CLASSFILENAMES)
172 
173 # rule for component package manifest
174 $(COMP_GEN_OUT)/%/manifest.xml :
175 	-$(MKDIR) $(subst /,$(PS),$(@D))
176 	@echo $(OSEP)?xml version="$(QM)1.0$(QM)" encoding="$(QM)UTF-8$(QM)"?$(CSEP) > $@
177 	@echo $(OSEP)!DOCTYPE manifest:manifest PUBLIC "$(QM)-//OpenOffice.org//DTD Manifest 1.0//EN$(QM)" "$(QM)Manifest.dtd$(QM)"$(CSEP)>> $@
178 	@echo $(OSEP)manifest:manifest xmlns:manifest="$(QM)http://openoffice.org/2001/manifest$(QM)"$(CSEP)>> $@
179 	@echo $(SQM)  $(SQM)$(OSEP)manifest:file-entry manifest:media-type="$(QM)application/vnd.sun.star.uno-typelibrary;type=RDB$(QM)">> $@
180 	@echo $(SQM)                       $(SQM)manifest:full-path="$(QM)$(subst /META-INF,,$(subst $(SAMPLE_GEN_OUT)/,,$(@D))).uno.rdb$(QM)"/$(CSEP)>> $@
181 	@echo $(SQM)  $(SQM)$(OSEP)manifest:file-entry manifest:media-type="$(QM)application/vnd.sun.star.uno-components$(QM)">> $@
182 	@echo $(SQM)                       $(SQM)manifest:full-path="$(QM)$(COMP_NAME).components$(QM)"/$(CSEP)>> $@
183 	@echo $(OSEP)/manifest:manifest$(CSEP) >> $@
184 
185 # rule for component package file
186 $(COMP_PACKAGE) : $(COMP_RDB) $(COMP_JAR) $(COMP_UNOPKG_MANIFEST) $(COMP_NAME).components
187 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
188 	-$(MKDIR) $(subst /,$(PS),$(@D))
189 	$(SDK_ZIP) $@ $(COMP_NAME).components
190 	cd $(subst /,$(PS),$(COMP_GEN_OUT)) && $(SDK_ZIP) -u ../../../bin/$(@F) $(COMP_RDB_NAME)
191 	cd $(subst /,$(PS),$(SAMPLE_CLASS_OUT)) && $(SDK_ZIP) -u ../../bin/$(@F) $(COMP_JAR_NAME)
192 	cd $(subst /,$(PS),$(COMP_GEN_OUT)) && $(SDK_ZIP) -u ../../../bin/$(@F) META-INF/manifest.xml
193 
194 $(COMP_REGISTERFLAG) : $(COMP_PACKAGE)
195 ifeq "$(SDK_AUTO_DEPLOYMENT)" "YES"
196 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$@))
197 	-$(MKDIR) $(subst /,$(PS),$(@D))
198 	$(DEPLOYTOOL) $(COMP_PACKAGE_URL)
199 	@echo flagged > $(subst /,$(PS),$@)
200 else
201 	@echo --------------------------------------------------------------------------------
202 	@echo  If you want to install your component automatically, please set the environment
203 	@echo  variable SDK_AUTO_DEPLOYMENT = YES. But note that auto deployment is only
204 	@echo  possible if no office instance is running.
205 	@echo --------------------------------------------------------------------------------
206 endif
207 
208 JavaMinimalComponentExample : $(COMP_REGISTERFLAG) $(APP1_JAR)
209 	@echo --------------------------------------------------------------------------------
210 	@echo Please use the following command to execute the example!
211 	@echo -
212 	@echo $(MAKE) $(APP1_NAME).run
213 	@echo ------
214 	@echo The $(COMP_NAME) component was installed if SDK_AUTO_DEPLOYMENT = YES.
215 	@echo You can use this component inside your office installation, see the example
216 	@echo description.
217 	@echo --------------------------------------------------------------------------------
218 
219 %.run: $(SAMPLE_CLASS_OUT)/%.jar
220 	$(SDK_JAVA) -Dcom.sun.star.lib.loader.unopath="$(OFFICE_PROGRAM_PATH)" -jar $<
221 
222 .PHONY: clean
223 clean :
224 	-$(DELRECURSIVE) $(subst /,$(PS),$(SAMPLE_CLASS_OUT))
225 	-$(DELRECURSIVE) $(subst /,$(PS),$(SAMPLE_GEN_OUT))
226 	-$(DEL) $(subst \\,\,$(subst /,$(PS),$(COMP_PACKAGE_URL)))
227