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         $(call gb_Trace_MakeMark,$*,EPK)
  34         touch $@
  35
  36 $(call gb_ExternalPackage_get_clean_target,%) :
  37         $(call gb_Output_announce,$*,$(false),EPK,2)
  38         rm -f $(call gb_ExternalPackage_get_target,$*)
  39
  40 # Create and register a new ExternalPackage
  41 #
  42 # The base directory of the package is the directory of the unpacked
  43 # tarball.
  44 #
  45 # gb_ExternalPackage_ExternalPackage name unpacked
  46 define gb_ExternalPackage_ExternalPackage
  47 $(call gb_ExternalPackage_ExternalPackage_internal,$(1),$(2))
  48
  49 $$(eval $$(call gb_Module_register_target,$(call gb_ExternalPackage_get_target,$(1)),$(call gb_ExternalPackage_get_clean_target,$(1))))
  50 $(call gb_Helper_make_userfriendly_targets,$(1),ExternalPackage)
  51
  52 endef
  53
  54 # Create a new ExternalPackage
  55 #
  56 # This function should only be used in implementations of other gbuild
  57 # classes.
  58 #
  59 # gb_ExternalPackage_ExternalPackage_internal name unpacked
  60 define gb_ExternalPackage_ExternalPackage_internal
  61 $(call gb_Package_Package_internal,$(1),$(gb_UnpackedTarball_workdir)/$(2))
  62 $(call gb_Package_use_unpacked,$(1),$(2))
  63
  64 $(call gb_ExternalPackage_get_target,$(1)) : $(call gb_Package_get_target,$(1))
  65 $(call gb_ExternalPackage_get_target,$(1)) :| $(dir $(call gb_ExternalPackage_get_target,$(1))).dir
  66 $(call gb_ExternalPackage_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(1))
  67
  68 gb_ExternalPackage_UNPACKED_$(1) := $(2)
  69
  70 endef
  71
  72 # Set output dir for the package's files.
  73 #
  74 # Default is $(INSTROOT).
  75 #
  76 # gb_ExternalPackage_set_outdir package outdir
  77 define gb_ExternalPackage_set_outdir
  78 $(call gb_Package_set_outdir,$(1),$(2))
  79
  80 endef
  81
  82 # Mark a source file to be used outside of this module
  83 #
  84 # This results in the timestamp of the file being updated, so a possible
  85 # change is recognized properly by other files depending on it.
  86 #
  87 # gb_ExternalPackage_mark_generated_file package file
  88 define gb_ExternalPackage_mark_generated_file
  89 $(gb_UnpackedTarball_workdir)/$(gb_ExternalPackage_UNPACKED_$(1))/$(2) : \
  90                 $(call gb_ExternalProject_get_target,$(gb_ExternalPackage_PROJECT_$(1)))
  91 $(if $(suffix $(2)),\
  92         $(call gb_UnpackedTarbal__ensure_pattern_rule,$(gb_ExternalPackage_UNPACKED_$(1)),$(suffix $(2))),\
  93         $(call gb_UnpackedTarbal__make_file_rule,$(gb_ExternalPackage_UNPACKED_$(1)),$(2)) \
  94 )
  95
  96 endef
  97
  98 # Mark several source files to be used outside of this module
  99 #
 100 # gb_ExternalProject_mark_generated_files package file(s)
 101 define gb_ExternalPackage_mark_generated_files
 102 $(foreach file,$(2),$(call gb_ExternalPackage_mark_generated_file,$(1),$(file)))
 103
 104 endef
 105
 106 define gb_ExternalPackage_add_symbolic_link
 107 $(call gb_Package_add_symbolic_link,$(1),$(2),$(3))
 108
 109 endef
 110
 111 # Add a file
 112 #
 113 # See gb_Package_add_file for details.
 114 #
 115 # gb_ExternalPackage_add_file package dest src
 116 define gb_ExternalPackage_add_file
 117 $(if $(4),$(call gb_Output_error,gb_ExternalPackage_add_file: $(1) 4: $(4)))
 118 $(call gb_ExternalPackage_mark_generated_file,$(1),$(3))
 119 $(call gb_Package_add_file,$(1),$(2),$(3))
 120
 121 endef
 122
 123 # Add several files at once
 124 #
 125 # See gb_Package_add_files for details.
 126 #
 127 # gb_ExternalPackage_add_files package destdir file(s)
 128 define gb_ExternalPackage_add_files
 129 $(call gb_ExternalPackage_mark_generated_files,$(1),$(3))
 130 $(call gb_Package_add_files,$(1),$(2),$(3))
 131
 132 endef
 133
 134 # Add several files at once
 135 #
 136 # See gb_Package_add_files_with_dir for details.
 137 #
 138 # gb_ExternalPackage_add_files_with_dir package destdir file(s)
 139 define gb_ExternalPackage_add_files_with_dir
 140 $(call gb_ExternalPackage_mark_generated_files,$(1),$(3))
 141 $(call gb_Package_add_files_with_dir,$(1),$(2),$(3))
 142
 143 endef
 144
 145 define gb_ExternalPackage__add_file
 146 $(call gb_UnpackedTarball_mark_output_file,$(gb_ExternalPackage_UNPACKED_$(1)),$(2))
 147
 148 endef
 149
 150 # Add an unpacked file
 151 #
 152 # See gb_Package_add_file for details.
 153 #
 154 # gb_ExternalPackage_add_unpacked_file package dest src
 155 define gb_ExternalPackage_add_unpacked_file
 156 $(call gb_Package_add_file,$(1),$(2),$(3))
 157 $(call gb_ExternalPackage__add_file,$(1),$(3))
 158
 159 endef
 160
 161 define gb_ExternalPackage__add_files
 162 $(foreach file,$(2),$(call gb_ExternalPackage__add_file,$(1),$(file)))
 163
 164 endef
 165
 166 # Add several unpacked files at once
 167 #
 168 # See gb_Package_add_files for details.
 169 #
 170 # gb_ExternalPackage_add_unpacked_files package destdir file(s)
 171 define gb_ExternalPackage_add_unpacked_files
 172 $(call gb_Package_add_files,$(1),$(2),$(3))
 173 $(call gb_ExternalPackage__add_files,$(1),$(3))
 174
 175 endef
 176
 177 # Add several unpacked files at once
 178 #
 179 # See gb_Package_add_files_with_dir for details.
 180 #
 181 # gb_ExternalPackage_add_unpacked_files_with_dir package destdir file(s)
 182 define gb_ExternalPackage_add_unpacked_files_with_dir
 183 $(call gb_Package_add_files_with_dir,$(1),$(2),$(3))
 184 $(call gb_ExternalPackage__add_files,$(1),$(3))
 185
 186 endef
 187
 188 # Package files from unpacked tarball of an external project
 189 #
 190 # gb_ExternalPackage_use_unpacked package unpacked
 191 define gb_ExternalPackage_use_unpacked
 192 $(call gb_Package_use_unpacked,$(1),$(2))
 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 $(if $(gb_ExternalPackage_PROJECT_$(1)),$(call gb_Output_error,gb_ExternalPackage_use_external_project: only one project allowed))
 203 gb_ExternalPackage_PROJECT_$(1) := $(2)
 204
 205 endef
 206
 207 # vim: set noet sw=4 ts=4: