solenv/gbuild/ExternalPackage.mk

   1 # -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
   2 #
   3 # This file is part of the LibreOffice project.
   4 #
   5 # This Source Code Form is subject to the terms of the Mozilla Public
   6 # License, v. 2.0. If a copy of the MPL was not distributed with this
   7 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8 #
   9
  10 # ExternalPackage class
  11
  12 # This class extends Package to reliably deliver header files (and
  13 # possibly other kinds of files) from unpacked tarballs. The problem
  14 # with using Package is that the unpacked files' timestamps do not
  15 # depend on the extraction time; when the project's tarball is updated,
  16 # some header files might have been changed, but it is likely their
  17 # timestamps will be older than these of the headers delivered from the
  18 # previous version, so the delivered headers will not be updated.
  19 #
  20 # Uff, I hope this is at least partially understandable :-)
  21 #
  22 # Note: An ExternalPackage object can be used in functions that expect a
  23 # Package (e.g., gb_LinkTarget_use_package(s)).
  24
  25 $(dir $(call gb_ExternalPackage_get_target,%)).dir :
  26         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  27
  28 $(dir $(call gb_ExternalPackage_get_target,%))%/.dir :
  29         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  30
  31 $(call gb_ExternalPackage_get_target,%) :
  32         $(call gb_Output_announce,$*,$(true),EPK,2)
  33         touch $@
  34
  35 $(call gb_ExternalPackage_get_clean_target,%) :
  36         $(call gb_Output_announce,$*,$(false),EPK,2)
  37         rm -f $(call gb_ExternalPackage_get_target,$*)
  38
  39 # Get name of the Package used for delivering files for install to $(INSTDIR).
  40 gb_ExternalPackage_get_packagename = ExternalPackage/$(1)
  41
  42 # Create and register a new ExternalPackage
  43 #
  44 # The base directory of the package is the directory of the unpacked
  45 # tarball.
  46 #
  47 # gb_ExternalPackage_ExternalPackage name unpacked
  48 define gb_ExternalPackage_ExternalPackage
  49 $(call gb_ExternalPackage_ExternalPackage_internal,$(1),$(2))
  50
  51 $$(eval $$(call gb_Module_register_target,$(call gb_ExternalPackage_get_target,$(1)),$(call gb_ExternalPackage_get_clean_target,$(1))))
  52 $(call gb_Helper_make_userfriendly_targets,$(1),ExternalPackage)
  53
  54 endef
  55
  56 # Create a new ExternalPackage
  57 #
  58 # This function should only be used in implementations of other gbuild
  59 # classes.
  60 #
  61 # gb_ExternalPackage_ExternalPackage_internal name unpacked
  62 define gb_ExternalPackage_ExternalPackage_internal
  63 $(call gb_Package_Package_internal,$(1),$(call gb_UnpackedTarball_get_dir,$(2)))
  64 $(call gb_Package_use_unpacked,$(1),$(2))
  65
  66 ifneq ($(gb_RUNNABLE_INSTDIR),)
  67 $(call gb_ExternalPackage__ExternalPackage_package,$(1),$(call gb_ExternalPackage_get_packagename,$(1)),$(2))
  68 endif
  69
  70 $(call gb_ExternalPackage_get_target,$(1)) : $(call gb_Package_get_target,$(1))
  71 $(call gb_ExternalPackage_get_target,$(1)) :| $(dir $(call gb_ExternalPackage_get_target,$(1))).dir
  72 $(call gb_ExternalPackage_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(1))
  73
  74 gb_ExternalPackage_UNPACKED_$(1) := $(2)
  75
  76 endef
  77
  78 # gb_ExternalPackage__ExternalPackage_package package inst-package unpacked
  79 define gb_ExternalPackage__ExternalPackage_package
  80 $(call gb_Package_Package_internal,$(2),$(call gb_UnpackedTarball_get_dir,$(3)))
  81 $(call gb_Package_set_outdir,$(2),$(INSTDIR))
  82 $(call gb_Package_use_unpacked,$(2),$(3))
  83
  84 endef
  85
  86 # Set output dir for the package's files.
  87 #
  88 # Default is $(OUTDIR).
  89 #
  90 # gb_ExternalPackage_set_outdir package outdir
  91 define gb_ExternalPackage_set_outdir
  92 $(call gb_Package_set_outdir,$(1),$(2))
  93
  94 endef
  95
  96 # Mark a source file to be used outside of this module
  97 #
  98 # This results in the timestamp of the file being updated, so a possible
  99 # change is recognized properly by other files depending on it.
 100 #
 101 # gb_ExternalPackage_mark_generated_file package file
 102 define gb_ExternalPackage_mark_generated_file
 103 $(call gb_UnpackedTarball_get_dir,$(gb_ExternalPackage_UNPACKED_$(1)))/$(2) : \
 104                 $(call gb_ExternalProject_get_target,$(gb_ExternalPackage_PROJECT_$(1)))
 105 $(if $(suffix $(2)),\
 106         $(call gb_UnpackedTarbal__ensure_pattern_rule,$(gb_ExternalPackage_UNPACKED_$(1)),$(suffix $(2))),\
 107         $(call gb_UnpackedTarbal__make_file_rule,$(gb_ExternalPackage_UNPACKED_$(1)),$(2)) \
 108 )
 109
 110 endef
 111
 112 # Mark several source files to be used outside of this module
 113 #
 114 # gb_ExternalProject_mark_generated_files package file(s)
 115 define gb_ExternalPackage_mark_generated_files
 116 $(foreach file,$(2),$(call gb_ExternalProject_mark_generated_file,$(1),$(file)))
 117
 118 endef
 119
 120 # Add a file
 121 #
 122 # See gb_Package_add_file for details.
 123 #
 124 # gb_ExternalPackage_add_file package dest src
 125 define gb_ExternalPackage_add_file
 126 $(call gb_ExternalPackage_mark_generated_file,$(1),$(3))
 127 $(call gb_Package_add_file,$(1),$(2),$(3))
 128
 129 endef
 130
 131 # Add several files at once
 132 #
 133 # See gb_Package_add_files for details.
 134 #
 135 # gb_ExternalPackage_add_files package destdir file(s)
 136 define gb_ExternalPackage_add_files
 137 $(call gb_ExternalPackage_mark_generated_files,$(1),$(3))
 138 $(call gb_Package_add_files,$(1),$(2),$(3))
 139
 140 endef
 141
 142 # Add several files at once
 143 #
 144 # See gb_Package_add_files_with_dir for details.
 145 #
 146 # gb_ExternalPackage_add_files_with_dir package destdir file(s)
 147 define gb_ExternalPackage_add_files_with_dir
 148 $(call gb_ExternalPackage_mark_generated_files,$(1),$(3))
 149 $(call gb_Package_add_files_with_dir,$(1),$(2),$(3))
 150
 151 endef
 152
 153 define gb_ExternalPackage__add_file
 154 $(call gb_UnpackedTarball_mark_output_file,$(gb_ExternalPackage_UNPACKED_$(1)),$(2))
 155
 156 endef
 157
 158 # Add an unpacked file
 159 #
 160 # See gb_Package_add_file for details.
 161 #
 162 # gb_ExternalPackage_add_unpacked_file package dest src
 163 define gb_ExternalPackage_add_unpacked_file
 164 $(call gb_Package_add_file,$(1),$(2),$(3))
 165 $(call gb_ExternalPackage__add_file,$(1),$(3))
 166
 167 endef
 168
 169 define gb_ExternalPackage__add_files
 170 $(foreach file,$(2),$(call gb_ExternalPackage__add_file,$(1),$(file)))
 171
 172 endef
 173
 174 # Add several unpacked files at once
 175 #
 176 # See gb_Package_add_files for details.
 177 #
 178 # gb_ExternalPackage_add_unpacked_files package destdir file(s)
 179 define gb_ExternalPackage_add_unpacked_files
 180 $(call gb_Package_add_files,$(1),$(2),$(3))
 181 $(call gb_ExternalPackage__add_files,$(1),$(3))
 182
 183 endef
 184
 185 # Add several unpacked files at once
 186 #
 187 # See gb_Package_add_files_with_dir for details.
 188 #
 189 # gb_ExternalPackage_add_unpacked_files_with_dir package destdir file(s)
 190 define gb_ExternalPackage_add_unpacked_files_with_dir
 191 $(call gb_Package_add_files_with_dir,$(1),$(2),$(3))
 192 $(call gb_ExternalPackage__add_files,$(1),$(3))
 193
 194 endef
 195
 196 # Package files from build of an external project
 197 #
 198 # gb_ExternalPackage_use_external_project package external
 199 define gb_ExternalPackage_use_external_project
 200 $(call gb_Package_use_external_project,$(1),$(2))
 201
 202 ifneq ($(gb_RUNNABLE_INSTDIR),)
 203 $(call gb_Package_use_external_project,$(call gb_ExternalPackage_get_packagename,$(1)),$(2))
 204 endif
 205
 206 $(if $(gb_ExternalPackage_PROJECT_$(1)),$(call gb_Output_error,gb_ExternalPackage_use_external_project: only one project allowed))
 207 gb_ExternalPackage_PROJECT_$(1) := $(2)
 208
 209 endef
 210
 211 # gb_ExternalPackage__add_file_for_install package package-inst dest dest-inst src
 212 define gb_ExternalPackage__add_file_for_install
 213 $(call gb_ExternalPackage_add_file,$(1),$(3),$(5))
 214
 215 ifneq ($(gb_RUNNABLE_INSTDIR),)
 216 $(call gb_ExternalPackage_add_file,$(2),$(4),$(5))
 217 $(call gb_ExternalPackage_get_target,$(1)) : $(call gb_Package_get_target,$(2))
 218 $(call gb_ExternalPackage_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(2))
 219 endif
 220
 221 endef
 222
 223 # Add a (dynamic) library that is a part of the installation.
 224 #
 225 # This function is very similar to gb_ExternalPackage_add_file, except
 226 # that it also allows to deliver the library to its proper place in
 227 # $(INSTDIR).
 228 #
 229 # The last argument is the name under which the library was registered.
 230 # It is used to determine layer, if the library is not in layer OOO.
 231 #
 232 # gb_ExternalPackage_add_library_for_install package dest src library?
 233 define gb_ExternalPackage_add_library_for_install
 234 $(call gb_ExternalPackage__add_file_for_install,$(1),$(call gb_ExternalPackage_get_packagename,$(1)),$(2),$(if $(4),$(call gb_Library_get_instdir,$(4)),$(gb_Package_PROGRAMDIRNAME))/$(notdir $(2)),$(3))
 235
 236 endef
 237
 238 # Add several libraries for install at once.
 239 #
 240 # gb_ExternalPackage_add_libraries_for_install package destdir file(s)
 241 define gb_ExternalPackage_add_libraries_for_install
 242 $(foreach file,$(3),$(call gb_ExternalPackage_add_library_for_install,$(1),$(2)/$(notdir $(file)),$(file)))
 243
 244 endef
 245
 246 # Add a jar that is a part of the installation.
 247 #
 248 # This function works just like to gb_ExternalPackage_add_file, except
 249 # that it also allows to deliver the jar to its proper place in
 250 # $(INSTDIR).
 251 #
 252 # gb_ExternalPackage_add_jar_for_install package dest src
 253 define gb_ExternalPackage_add_jar_for_install
 254 $(call gb_ExternalPackage__add_file_for_install,$(1),$(call gb_ExternalPackage_get_packagename,$(1)),$(2),$(gb_Package_PROGRAMDIRNAME)/classes/$(notdir $(2)),$(3))
 255
 256 endef
 257
 258 # Add several jars for install at once.
 259 #
 260 # gb_ExternalPackage_add_jars_for_install package destdir file(s)
 261 define gb_ExternalPackage_add_jars_for_install
 262 $(foreach file,$(3),$(call gb_ExternalPackage_add_jar_for_install,$(1),$(2)/$(notdir $(file)),$(file)))
 263
 264 endef
 265
 266 # vim: set noet sw=4 ts=4: