solenv/gbuild/UnoApiTarget.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 # This file incorporates work covered by the following license notice:
  10 #
  11 #   Licensed to the Apache Software Foundation (ASF) under one or more
  12 #   contributor license agreements. See the NOTICE file distributed
  13 #   with this work for additional information regarding copyright
  14 #   ownership. The ASF licenses this file to you under the Apache
  15 #   License, Version 2.0 (the "License"); you may not use this file
  16 #   except in compliance with the License. You may obtain a copy of
  17 #   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18 #
  19
  20 # UnoApiTarget
  21
  22 gb_UnoApiTarget_UNOIDLWRITEDEPS := $(call gb_Executable_get_runtime_dependencies,unoidl-write)
  23 gb_UnoApiTarget_UNOIDLWRITECOMMAND := $(call gb_Executable_get_command,unoidl-write)
  24
  25 gb_UnoApiTarget_UNOIDLCHECKDEPS := $(call gb_Executable_get_runtime_dependencies,unoidl-check)
  26 gb_UnoApiTarget_UNOIDLCHECKCOMMAND := $(call gb_Executable_get_command,unoidl-check)
  27
  28 define gb_UnoApiTarget__command
  29 mkdir -p $(dir $(1)) \
  30 $(if $(UNOAPI_ENTITIES), \
  31         && RESPONSEFILE=$(call gb_var2file,$(shell $(gb_MKTEMP)),$(UNOAPI_ENTITIES))) \
  32 && $(gb_UnoApiTarget_UNOIDLWRITECOMMAND) \
  33         $(foreach rdb,$(UNOAPI_DEPRDBS),$(call gb_UnoApiTarget_get_target,$(rdb))) \
  34         $(SRCDIR)/$(gb_UnoApiTarget_REG_$(2)) $(if $(UNOAPI_ENTITIES),@$${RESPONSEFILE}) $(1) \
  35 $(if $(UNOAPI_ENTITIES),&& rm -f $${RESPONSEFILE}) \
  36 $(if $(UNOAPI_REFERENCE), \
  37         $(call gb_Output_announce,$(2),$(true),DBc,3) \
  38         && { $(gb_UnoApiTarget_UNOIDLCHECKCOMMAND) $(UNOAPI_REFERENCE) -- \
  39                         $(foreach rdb,$(UNOAPI_DEPRDBS),$(call gb_UnoApiTarget_get_target,$(rdb))) \
  40                         $(1) \
  41                 || { printf 'ERROR: Published UNO API must not be changed incompatibly!\n(If published UNO API shall be changed incompatibly after all, see\n<https://wiki.documentfoundation.org/Development/Incompatible_UNO_API_Changes>.)\n'; \
  42                      false; } })
  43 endef
  44
  45 $(call gb_UnoApiTarget_get_target,%) :
  46         $(call gb_Output_announce,$*,$(true),UNO,4)
  47         $(call gb_Trace_StartRange,$*,UNO)
  48         $(call gb_UnoApiTarget__command,$@,$*)
  49         $(call gb_Trace_EndRange,$*,UNO)
  50
  51 .PHONY : $(call gb_UnoApiTarget_get_clean_target,%)
  52 $(call gb_UnoApiTarget_get_clean_target,%) :
  53         $(call gb_Output_announce,$*,$(false),UNO,4)
  54         -$(call gb_Helper_abbreviate_dirs,\
  55                 rm -rf $(call gb_UnoApiTarget_get_target,$*))
  56
  57 define gb_UnoApiTarget_UnoApiTarget
  58 gb_UnoApiTarget_REG_$(1) := $(2)
  59 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_ENTITIES :=
  60 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_REFERENCE :=
  61 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_DEPRDBS :=
  62 $(call gb_UnoApiTarget_get_target,$(1)) : $(gb_UnoApiTarget_UNOIDLWRITEDEPS)
  63 $(call gb_UnoApiTarget_get_target,$(1)) : $(SRCDIR)/$(2) # may be dir, though
  64
  65 endef
  66
  67 define gb_UnoApiTarget_add_idlfile
  68 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_ENTITIES += $(subst /,.,$(2))$(if $(2),.)$(3)
  69 $(call gb_UnoApiTarget_get_target,$(1)) : $(SRCDIR)/$(gb_UnoApiTarget_REG_$(1))/$(2)/$(3).idl
  70
  71 endef
  72
  73 define gb_UnoApiTarget_add_idlfiles
  74 $(foreach idl,$(3),$(call gb_UnoApiTarget_add_idlfile,$(1),$(2),$(idl)))
  75
  76 endef
  77
  78 define gb_UnoApiTarget_set_reference_rdbfile
  79 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_REFERENCE := $(2)
  80 $(call gb_UnoApiTarget_get_target,$(1)) : $(2)
  81 $(call gb_UnoApiTarget_get_target,$(1)) : $(gb_UnoApiTarget_UNOIDLCHECKDEPS)
  82
  83 endef
  84
  85 define gb_UnoApiTarget_use_api
  86 $(call gb_UnoApiTarget_get_target,$(1)) : UNOAPI_DEPRDBS += $(2)
  87 $(call gb_UnoApiTarget_get_target,$(1)) : $(call gb_UnoApiTarget_get_target,$(2))
  88
  89 endef
  90
  91 # UnoApiHeadersTarget
  92
  93 # defined by platform
  94 #  gb_UnoApiHeadersTarget_select_variant
  95
  96 # Allow to redefine header variant.
  97 #
  98 # On iOS we use static linking because dynamic loading of own code
  99 # isn't allowed by the iOS App Store rules, and we want our code to be
 100 # eventually distributable there as part of apps.
 101 #
 102 # To avoid problems that this causes together with the lovely
 103 # intentional breaking of the One Definition Rule, for iOS we always
 104 # generate comprehensive headers for certain type RDBS. (The ODR
 105 # breakage doesn't harm, by accident or careful design, on platforms
 106 # where shared libraries are used.) To avoid generating the same headers
 107 # more than once, we are silently "redirecting" the target to point to
 108 # comprehensive headers instead.
 109 #
 110 # Example:
 111 # If gb_UnoApiHeadersTarget_select_variant is defined as
 112 #
 113 # ifeq ($(DISABLE_DYNLOADING),TRUE)
 114 # gb_UnoApiHeadersTarget_select_variant = $(if $(filter udkapi,$(1)),comprehensive,$(2))
 115 # else
 116 # gb_UnoApiHeadersTarget_select_variant = $(2)
 117 # endif
 118 #
 119 # then, for the DISABLE_DYNLOADING case, whenever a makefile uses
 120 # $(call gb_UnoApiHeadersTarget_get_target,udkapi) or $(call
 121 # gb_UnoApiHeadersTarget_get_dir,udkapi), it will get target or dir for
 122 # comprehensive headers instead.
 123 #
 124 # We are experimenting with static linking on Android, too. There for
 125 # technical reasons to get around silly limitations in the OS, sigh.
 126 #
 127 # gb_UnoApiHeadersTarget_select_variant api default-variant
 128 ifeq ($(origin gb_UnoApiHeadersTarget_select_variant),undefined)
 129 $(eval $(call gb_Output_error,gb_UnoApiHeadersTarget_select_variant must be defined by platform))
 130 endif
 131
 132 gb_UnoApiHeadersTarget_CPPUMAKERDEPS := $(call gb_Executable_get_runtime_dependencies,cppumaker)
 133 gb_UnoApiHeadersTarget_CPPUMAKERCOMMAND := $(call gb_Executable_get_command,cppumaker)
 134
 135 define gb_UnoApiHeadersTarget__command
 136         $(gb_UnoApiHeadersTarget_CPPUMAKERCOMMAND) \
 137                 -Gc $(4) -O$(3) $(call gb_UnoApiTarget_get_target,$(2)) \
 138                  $(UNOAPI_DEPS) && \
 139         touch $(1)
 140
 141 endef
 142
 143 $(call gb_UnoApiHeadersTarget_get_real_bootstrap_target,%) : \
 144                 $(gb_UnoApiHeadersTarget_CPPUMAKERDEPS)
 145         $(call gb_Output_announce,$*,$(true),HPB,3) \
 146         $(call gb_Trace_StartRange,$*,HPB)
 147         $(call gb_UnoApiHeadersTarget__command,$@,$*,$(call gb_UnoApiHeadersTarget_get_bootstrap_dir,$*))
 148         $(call gb_Trace_EndRange,$*,HPB)
 149
 150 $(call gb_UnoApiHeadersTarget_get_real_comprehensive_target,%) : \
 151                 $(gb_UnoApiHeadersTarget_CPPUMAKERDEPS)
 152         $(call gb_Output_announce,$*,$(true),HPC,3)
 153         $(call gb_Trace_StartRange,$*,HPC)
 154         $(call gb_UnoApiHeadersTarget__command,$@,$*,$(call gb_UnoApiHeadersTarget_get_comprehensive_dir,$*),-C)
 155         $(call gb_Trace_EndRange,$*,HPC)
 156
 157 $(call gb_UnoApiHeadersTarget_get_real_target,%) : \
 158                 $(gb_UnoApiHeadersTarget_CPPUMAKERDEPS)
 159         $(call gb_Output_announce,$*,$(true),HPP,3) \
 160         $(call gb_Trace_StartRange,$*,HPP)
 161         $(call gb_UnoApiHeadersTarget__command,$@,$*,$(call gb_UnoApiHeadersTarget_get_dir,$*),-L)
 162         $(call gb_Trace_EndRange,$*,HPP)
 163
 164 .PHONY : $(call gb_UnoApiHeadersTarget_get_clean_target,%)
 165 $(call gb_UnoApiHeadersTarget_get_clean_target,%) :
 166         $(call gb_Output_announce,$*,$(false),HPP,3)
 167         $(call gb_Helper_abbreviate_dirs,\
 168                 rm -rf \
 169                         $(call gb_UnoApiHeadersTarget_get_real_dir,$*) \
 170                         $(call gb_UnoApiHeadersTarget_get_real_bootstrap_dir,$*) \
 171                         $(call gb_UnoApiHeadersTarget_get_real_comprehensive_dir,$*) \
 172                         $(call gb_UnoApiHeadersTarget_get_real_target,$*) \
 173                         $(call gb_UnoApiHeadersTarget_get_real_bootstrap_target,$*)) \
 174                         $(call gb_UnoApiHeadersTarget_get_real_comprehensive_target,$*)
 175
 176 define gb_UnoApiHeadersTarget_UnoApiHeadersTarget
 177 $(call gb_UnoApiHeadersTarget_get_target,$(1)) : $(call gb_UnoApiTarget_get_target,$(1))
 178 $(call gb_UnoApiHeadersTarget_get_bootstrap_target,$(1)) : $(call gb_UnoApiTarget_get_target,$(1))
 179 $(call gb_UnoApiHeadersTarget_get_comprehensive_target,$(1)) : $(call gb_UnoApiTarget_get_target,$(1))
 180 $(call gb_UnoApiHeadersTarget_get_clean_target,$(1)) : $(call gb_UnoApiTarget_get_clean_target,$(1))
 181
 182 $(call gb_UnoApiHeadersTarget_get_target,$(1)) : UNOAPI_DEPS :=
 183 $(call gb_UnoApiHeadersTarget_get_bootstrap_target,$(1)) : UNOAPI_DEPS :=
 184 $(call gb_UnoApiHeadersTarget_get_comprehensive_target,$(1)) : UNOAPI_DEPS :=
 185
 186 # need dummy recipes so that header files are delivered in Package_inc;
 187 # otherwise make will consider the header to be up-to-date because it was
 188 # actually built by the recipe for gb_UnoApiHeadersTarget_get_target
 189 $(call gb_UnoApiHeadersTarget_get_real_dir,$(1))/%.hdl : \
 190                 $(call gb_Executable_get_target_for_build,cppumaker) \
 191                 | $(call gb_UnoApiHeadersTarget_get_real_target,$(1))
 192         touch $$@
 193
 194 $(call gb_UnoApiHeadersTarget_get_real_dir,$(1))/%.hpp : \
 195                 $(call gb_Executable_get_target_for_build,cppumaker) \
 196                 | $(call gb_UnoApiHeadersTarget_get_real_target,$(1))
 197         touch $$@
 198
 199 $(call gb_UnoApiHeadersTarget_get_real_bootstrap_dir,$(1))/%.hdl : \
 200                 $(call gb_Executable_get_target_for_build,cppumaker) \
 201                 | $(call gb_UnoApiHeadersTarget_get_real_bootstrap_target,$(1))
 202         touch $$@
 203
 204 $(call gb_UnoApiHeadersTarget_get_real_bootstrap_dir,$(1))/%.hpp : \
 205                 $(call gb_Executable_get_target_for_build,cppumaker) \
 206                 | $(call gb_UnoApiHeadersTarget_get_real_bootstrap_target,$(1))
 207         touch $$@
 208
 209 $(call gb_UnoApiHeadersTarget_get_real_comprehensive_dir,$(1))/%.hdl : \
 210                 $(call gb_Executable_get_target_for_build,cppumaker) \
 211                 | $(call gb_UnoApiHeadersTarget_get_real_comprehensive_target,$(1))
 212         touch $$@
 213
 214 $(call gb_UnoApiHeadersTarget_get_real_comprehensive_dir,$(1))/%.hpp : \
 215                 $(call gb_Executable_get_target_for_build,cppumaker) \
 216                 | $(call gb_UnoApiHeadersTarget_get_real_comprehensive_target,$(1))
 217         touch $$@
 218
 219 endef
 220
 221 # ensure that idl change triggers the dummy rule to rebuild the headers
 222 # call gb_UnoApiHeadersTarget_add_headerfile,unoapi,headerfile
 223 define gb_UnoApiHeadersTarget_add_headerfile
 224 $(call gb_UnoApiHeadersTarget_get_dir,$(1))/$(2) : \
 225         $(SRCDIR)/$(basename $(gb_UnoApiTarget_REG_$(1))/$(2)).idl
 226
 227 endef
 228
 229 # call gb_UnoApiHeadersTarget_add_headerfiles,unoapi,directory,headerfilenames
 230 define gb_UnoApiHeadersTarget_add_headerfiles
 231 $(foreach hdr,$(3),$(call gb_UnoApiHeadersTarget_add_headerfile,$(1),$(2)/$(hdr)))
 232 endef
 233
 234 define gb_UnoApiHeadersTarget__use_api_for_target
 235 $(call gb_UnoApiHeadersTarget_get_$(3),$(1)) : $(call gb_UnoApiTarget_get_target,$(2))
 236 $(call gb_UnoApiHeadersTarget_get_$(3),$(1)) : UNOAPI_DEPS += -X$(call gb_UnoApiTarget_get_target,$(2))
 237
 238 endef
 239
 240 define gb_UnoApiHeadersTarget__use_api
 241 $(call gb_UnoApiHeadersTarget__use_api_for_target,$(1),$(2),target)
 242 $(call gb_UnoApiHeadersTarget__use_api_for_target,$(1),$(2),bootstrap_target)
 243 $(call gb_UnoApiHeadersTarget__use_api_for_target,$(1),$(2),comprehensive_target)
 244
 245 endef
 246
 247 define gb_UnoApiHeadersTarget_use_api
 248 $(foreach rdb,$(2),$(call gb_UnoApiHeadersTarget__use_api,$(1),$(rdb)))
 249
 250 endef
 251
 252 # vim: set noet sw=4 ts=4: