solenv/gbuild/Gallery.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 # class Gallery
  11
  12 # Handles creation of image galleries.
  13
  14 gb_Gallery_TRANSLATE := $(SRCDIR)/solenv/bin/desktop-translate.pl
  15 gb_Gallery_INSTDIR := $(LIBO_SHARE_FOLDER)/gallery
  16
  17 # BRAND_BASE_DIR is for resource files
  18 define gb_Gallery__make_env_args
  19 "-env:BRAND_BASE_DIR=$(call gb_Helper_make_url,$(INSTROOT_FOR_BUILD))" \
  20 "-env:CONFIGURATION_LAYERS=xcsxcu:$(call gb_Helper_make_url,$(INSTROOT)/$(LIBO_SHARE_FOLDER)/registry)" \
  21 "-env:UNO_SERVICES=$(call gb_Helper_make_url,$(call gb_Rdb_get_target_for_build,ure/services)) \
  22         $(foreach item,$(gb_Gallery__UNO_COMPONENTS),\
  23                 $(call gb_Helper_make_url,$(call gb_ComponentTarget_get_target_for_build,$(item))))" \
  24 "-env:UNO_TYPES=$(foreach item,offapi udkapi,\
  25         $(call gb_Helper_make_url,$(call gb_UnoApi_get_target,$(item))))" \
  26 -env:URE_INTERNAL_LIB_DIR=$(call gb_Helper_make_url,$(INSTROOT_FOR_BUILD)/$(LIBO_URE_LIB_FOLDER_FOR_BUILD)) \
  27 -env:LO_LIB_DIR=$(call gb_Helper_make_url,$(INSTROOT_FOR_BUILD)/$(LIBO_LIB_FOLDER_FOR_BUILD))
  28 endef
  29
  30 define gb_Gallery__command
  31 $(call gb_Output_announce,$(2),$(true),GAL,1)
  32 $(call gb_Helper_abbreviate_dirs,\
  33         rm -f $(call gb_Gallery_get_workdir,$(2))/* && \
  34         RESPONSEFILE=$(call var2file,$(shell $(call gb_MKTEMP)),100,$(GALLERY_FILES)) && \
  35         $(call gb_Helper_print_on_error,\
  36                 $(if $(filter-out MACOSX WNT,$(OS_FOR_BUILD)),$(if $(ENABLE_HEADLESS),, \
  37                         SAL_USE_VCLPLUGIN=svp \
  38                 )) \
  39                 $(call gb_Executable_get_command,gengal,$(ICECREAM_RUN)) \
  40                         $(call gb_Gallery__make_env_args) \
  41                         --build-tree \
  42                         --destdir $(GALLERY_BASEDIR) \
  43                         --name "$(GALLERY_NAME)" \
  44                         --path $(call gb_Gallery_get_workdir,$(2)) \
  45                         --filenames $(call gb_Helper_make_url,$$RESPONSEFILE),\
  46                 $@.log \
  47         ) && \
  48         rm $$RESPONSEFILE && \
  49         touch $@ \
  50 )
  51 endef
  52
  53 define gb_Gallery__command_str
  54 $(call gb_Output_announce,$(2),$(true),STR,1)
  55 cp -f $(GALLERY_STRFILE) $@ && \
  56 $(PERL) $(gb_Gallery_TRANSLATE) \
  57                 --ext "str" --key "name" \
  58                 -d $(GALLERY_WORKDIR) \
  59                 $(GALLERY_ULFFILE)
  60 endef
  61
  62 gb_Gallery__get_final_target = $(WORKDIR)/Gallery/$(1).final
  63
  64 $(dir $(call gb_Gallery_get_target,$(1))).dir :
  65         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  66
  67 $(dir $(call gb_Gallery_get_target,$(1)))%/.dir :
  68         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  69
  70 $(call gb_Gallery_get_target,%) : \
  71                 $(call gb_Executable_get_runtime_dependencies,gengal)
  72         $(call gb_Gallery__command,$@,$*)
  73
  74 $(call gb_Gallery__get_final_target,%) :
  75         touch $@
  76
  77 # difficult to determine source dep for this one...
  78 $(call gb_Gallery_get_workdir,%).ulf : \
  79                 $(call gb_Executable_get_runtime_dependencies,ulfex)
  80         $(call gb_CustomTarget_ulfex__command,$@,$(GALLERY_ULFFILE),\
  81                 $(foreach lang,$(gb_TRANS_LANGS),\
  82                         $(gb_POLOCATION)/$(lang)/extras/source/gallery/share.po))
  83
  84 $(call gb_Gallery_get_workdir,%).str : $(gb_Gallery_TRANSLATE)
  85         $(call gb_Gallery__command_str,$@,$*)
  86
  87 # there must be a rule for these since they are targets due to Package
  88 $(call gb_Gallery_get_workdir,%).sdg :
  89         touch $@
  90 $(call gb_Gallery_get_workdir,%).sdv :
  91         touch $@
  92 $(call gb_Gallery_get_workdir,%).thm :
  93         touch $@
  94
  95 .PHONY : $(call gb_Gallery_get_clean_target,%)
  96 $(call gb_Gallery_get_clean_target,%) :
  97         $(call gb_Output_announce,$*,$(false),GAL,1)
  98         $(call gb_Helper_abbreviate_dirs,\
  99                 rm -rf \
 100                         $(call gb_Gallery__get_final_target,$*) \
 101                         $(call gb_Gallery_get_target,$*) \
 102                         $(call gb_Gallery_get_target,$*).log \
 103                         $(call gb_Gallery_get_workdir,$*) \
 104         )
 105
 106 # the theme package
 107 gb_Gallery_get_packagename = Gallery/$(1)
 108 # the files package
 109 gb_Gallery_get_files_packagename = Gallery/Files/$(1)
 110
 111 # Create a gallery.
 112 #
 113 # basedir less one directory will be stripped from paths of the files when they are
 114 # inserted into the gallery.
 115 #
 116 # gb_Gallery_Gallery gallery basedir name
 117 define gb_Gallery_Gallery
 118 $(call gb_Gallery__Gallery_impl,$(1),$(call gb_Gallery_get_packagename,$(1)),$(2),$(3))
 119
 120 # setup the files package - we install all of these too
 121 $(call gb_Package_Package_internal,$(call gb_Gallery_get_files_packagename,$(1)),$(SRCDIR)/$(2))
 122 $(call gb_Gallery__get_final_target,$(1)) : $(call gb_Package_get_target,$(call gb_Gallery_get_files_packagename,$(1)))
 123 $(call gb_Gallery_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(call gb_Gallery_get_files_packagename,$(1)))
 124
 125 endef
 126
 127
 128 gb_Gallery_basedir = $(patsubst %/,%,$(dir $(SRCDIR)/$(1)))
 129
 130 # TODO: we process the same ulf file for every gallery. That does not
 131 # make sense.
 132 #
 133 # gb_Gallery__Gallery_impl gallery package basedir name
 134 define gb_Gallery__Gallery_impl
 135 $(call gb_Package_Package_internal,$(2),$(call gb_Gallery_get_workdir,$(1)))
 136 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).sdg,$(1).sdg)
 137 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).sdv,$(1).sdv)
 138 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).thm,$(1).thm)
 139 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).str,$(1).str)
 140
 141 # strip URL, without / to help the internal gallery system
 142 $(call gb_Gallery_get_target,$(1)) : GALLERY_BASEDIR := $(call gb_Helper_make_url,$(call gb_Gallery_basedir,$(3)))
 143 $(call gb_Gallery_get_target,$(1)) : GALLERY_FILES :=
 144 $(call gb_Gallery_get_target,$(1)) : GALLERY_NAME := $(1)
 145 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_STRFILE := $(SRCDIR)/$(3)/$(1).str
 146 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_ULFFILE := $(call gb_Gallery_get_workdir,$(1))/$(1).ulf
 147 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_WORKDIR := $(call gb_Gallery_get_workdir,$(1))
 148 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : GALLERY_BASEDIR := $(3)
 149 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : GALLERY_ULFFILE := $(call gb_Gallery_basedir,$(3))/share/gallery_names.ulf
 150
 151 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : \
 152         $(call gb_Gallery_basedir,$(3))/share/gallery_names.ulf \
 153         $(call gb_Gallery_get_target,$(1)) # that rule pre-cleans our output directory
 154
 155 $(call gb_Gallery_get_workdir,$(1))/$(1).str : $(call gb_Gallery_get_workdir,$(1))/$(1).ulf
 156
 157 $(call gb_Gallery_get_workdir,$(1))/$(1).sdg \
 158 $(call gb_Gallery_get_workdir,$(1))/$(1).sdv \
 159 $(call gb_Gallery_get_workdir,$(1))/$(1).thm : $(call gb_Gallery_get_target,$(1))
 160 $(call gb_Gallery__get_final_target,$(1)) : $(call gb_Package_get_target,$(2))
 161
 162 $(call gb_Gallery_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(2))
 163 $(call gb_Gallery_get_target,$(1)) :| $(dir $(call gb_Gallery_get_target,$(1))).dir \
 164         $(call gb_Gallery_get_workdir,$(1))/.dir
 165
 166 $$(eval $$(call gb_Module_register_target,$(call gb_Gallery__get_final_target,$(1)),$(call gb_Gallery_get_clean_target,$(1))))
 167 $(call gb_Helper_make_userfriendly_targets,$(1),Gallery,$(call gb_Gallery__get_final_target,$(1)))
 168
 169 endef
 170
 171 # Add a file to the gallery.
 172 #
 173 # The file is given by path relative to $(SRCDIR).
 174 #
 175 # gb_Gallery_add_file gallery file
 176 define gb_Gallery_add_file
 177 $(call gb_Gallery_get_target,$(1)) : $(SRCDIR)/$(3)
 178 $(call gb_Gallery_get_target,$(1)) : GALLERY_FILES += $(call gb_Helper_make_url,$(SRCDIR)/$(3))
 179 $(call gb_Package_add_file,$(call gb_Gallery_get_files_packagename,$(1)),$(2)/$(notdir $(3)),$(notdir $(3)))
 180
 181 endef
 182
 183 # Add several files to the gallery at once.
 184 #
 185 # The files are given by path relative to $(SRCDIR).
 186 #
 187 # gb_Gallery_add_files gallery file(s)
 188 define gb_Gallery_add_files
 189 $(foreach fname,$(3),$(call gb_Gallery_add_file,$(1),$(2),$(fname)))
 190
 191 endef
 192
 193 # vim: set noet sw=4 ts=4: