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.py
  15 gb_Gallery_INSTDIR := $(LIBO_SHARE_FOLDER)/gallery
  16
  17 define gb_Gallery__command
  18 $(call gb_Helper_abbreviate_dirs,\
  19         rm -f $(call gb_Gallery_get_workdir,$(2))/* && \
  20         RESPONSEFILE=$(call gb_var2file,$(shell $(call gb_MKTEMP)),$(GALLERY_FILES)) && \
  21         $(call gb_Helper_print_on_error,\
  22                 $(call gb_Executable_get_command,gengal,$(ICECREAM_RUN)) \
  23                         --build-tree \
  24                         --destdir $(GALLERY_BASEDIR) \
  25                         --name "$(GALLERY_NAME)" \
  26                         --path $(call gb_Gallery_get_workdir,$(2)) \
  27                         --filenames $(call gb_Helper_make_url,$$RESPONSEFILE) \
  28                         -env:UserInstallation=$(call gb_Helper_make_url,$(call gb_Gallery_get_workdir,$(2))/user),\
  29                 $@.log \
  30         ) && \
  31         rm $$RESPONSEFILE && \
  32         touch $@ \
  33 )
  34 endef
  35
  36 define gb_Gallery__command_str
  37 cp -f $(GALLERY_STRFILE) $@ && \
  38 $(call gb_ExternalExecutable_get_command,python) \
  39                 $(gb_Gallery_TRANSLATE) \
  40                 --ext "str" \
  41                 -d $(GALLERY_WORKDIR) \
  42                 $(GALLERY_ULFFILE)
  43 endef
  44
  45 gb_Gallery__get_final_target = $(WORKDIR)/Gallery/$(1).final
  46
  47 $(dir $(call gb_Gallery_get_target,$(1))).dir :
  48         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  49
  50 $(dir $(call gb_Gallery_get_target,$(1)))%/.dir :
  51         $(if $(wildcard $(dir $@)),,mkdir -p $(dir $@))
  52
  53 $(call gb_Gallery_get_target,%) : $(call gb_Executable_get_target,gengal) \
  54         | $(call gb_Executable_get_runtime_dependencies,gengal)
  55         $(call gb_Output_announce,$*,$(true),GAL,1)
  56         $(call gb_Trace_StartRange,$*,GAL)
  57         $(call gb_Gallery__command,$@,$*)
  58         $(call gb_Trace_EndRange,$*,GAL)
  59
  60 $(call gb_Gallery__get_final_target,%) :
  61         touch $@
  62
  63 # difficult to determine source dep for this one...
  64 $(call gb_Gallery_get_workdir,%).ulf : \
  65                 $(call gb_Executable_get_runtime_dependencies,ulfex)
  66         $(call gb_CustomTarget_ulfex__command,$@,$(GALLERY_ULFFILE),\
  67                 $(foreach lang,$(gb_TRANS_LANGS),\
  68                         $(gb_POLOCATION)/$(lang)/extras/source/gallery/share.po))
  69
  70 $(call gb_Gallery_get_workdir,%).str : $(gb_Gallery_TRANSLATE) \
  71                 $(call gb_ExternalExecutable_get_dependencies,python)
  72         $(call gb_Output_announce,$*,$(true),STR,1)
  73         $(call gb_Trace_StartRange,$*,STR)
  74         $(call gb_Gallery__command_str,$@,$*)
  75         $(call gb_Trace_EndRange,$*,STR)
  76
  77 .PHONY : $(call gb_Gallery_get_clean_target,%)
  78 $(call gb_Gallery_get_clean_target,%) :
  79         $(call gb_Output_announce,$*,$(false),GAL,1)
  80         $(call gb_Helper_abbreviate_dirs,\
  81                 rm -rf \
  82                         $(call gb_Gallery__get_final_target,$*) \
  83                         $(call gb_Gallery_get_target,$*) \
  84                         $(call gb_Gallery_get_target,$*).log \
  85                         $(call gb_Gallery_get_workdir,$*) \
  86         )
  87
  88 # the theme package
  89 gb_Gallery_get_packagename = Gallery/$(1)
  90 # the files package
  91 gb_Gallery_get_files_packagename = Gallery/Files/$(1)
  92
  93 # Create a gallery.
  94 #
  95 # basedir less one directory will be stripped from paths of the files when they are
  96 # inserted into the gallery.
  97 #
  98 # gb_Gallery_Gallery gallery basedir name
  99 define gb_Gallery_Gallery
 100 $(call gb_Gallery__Gallery_impl,$(1),$(call gb_Gallery_get_packagename,$(1)),$(2),$(3))
 101
 102 # setup the files package - we install all of these too
 103 $(call gb_Package_Package_internal,$(call gb_Gallery_get_files_packagename,$(1)),$(SRCDIR)/$(2))
 104 $(call gb_Gallery__get_final_target,$(1)) : $(call gb_Package_get_target,$(call gb_Gallery_get_files_packagename,$(1)))
 105 $(call gb_Gallery_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(call gb_Gallery_get_files_packagename,$(1)))
 106
 107 endef
 108
 109
 110 gb_Gallery_basedir = $(patsubst %/,%,$(dir $(SRCDIR)/$(1)))
 111
 112 # TODO: we process the same ulf file for every gallery. That does not
 113 # make sense.
 114 #
 115 # gb_Gallery__Gallery_impl gallery package basedir name
 116 define gb_Gallery__Gallery_impl
 117 $(call gb_Package_Package_internal,$(2),$(call gb_Gallery_get_workdir,$(1)))
 118 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).sdg,$(1).sdg)
 119 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).sdv,$(1).sdv)
 120 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).thm,$(1).thm)
 121 $(call gb_Package_add_file,$(2),$(gb_Gallery_INSTDIR)/$(1).str,$(1).str)
 122
 123 # strip URL, without / to help the internal gallery system
 124 $(call gb_Gallery_get_target,$(1)) : GALLERY_BASEDIR := $(call gb_Helper_make_url,$(call gb_Gallery_basedir,$(3)))
 125 $(call gb_Gallery_get_target,$(1)) : GALLERY_FILES :=
 126 $(call gb_Gallery_get_target,$(1)) : GALLERY_NAME := $(1)
 127 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_STRFILE := $(SRCDIR)/$(3)/$(1).str
 128 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_ULFFILE := $(call gb_Gallery_get_workdir,$(1))/$(1).ulf
 129 $(call gb_Gallery_get_workdir,$(1))/$(1).str : GALLERY_WORKDIR := $(call gb_Gallery_get_workdir,$(1))
 130 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : GALLERY_BASEDIR := $(3)
 131 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : GALLERY_ULFFILE := $(call gb_Gallery_basedir,$(3))/share/gallery_names.ulf
 132
 133 $(call gb_Gallery_get_workdir,$(1))/$(1).ulf : \
 134         $(call gb_Gallery_basedir,$(3))/share/gallery_names.ulf \
 135         $(call gb_Gallery_get_target,$(1)) # that rule pre-cleans our output directory
 136
 137 $(call gb_Gallery_get_workdir,$(1))/$(1).str : $(call gb_Gallery_get_workdir,$(1))/$(1).ulf
 138
 139 # order-only, the Gallery-Target also makes those files
 140 $(addprefix $(call gb_Gallery_get_workdir,$(1))/$(1),.sdg .sdv .thm): | $(call gb_Gallery_get_target,$(1))
 141 $(call gb_Gallery__get_final_target,$(1)) : $(call gb_Package_get_target,$(2))
 142
 143 $(call gb_Gallery_get_clean_target,$(1)) : $(call gb_Package_get_clean_target,$(2))
 144 $(call gb_Gallery_get_target,$(1)) :| $(dir $(call gb_Gallery_get_target,$(1))).dir \
 145         $(call gb_Gallery_get_workdir,$(1))/.dir
 146
 147 $$(eval $$(call gb_Module_register_target,$(call gb_Gallery__get_final_target,$(1)),$(call gb_Gallery_get_clean_target,$(1))))
 148 $(call gb_Helper_make_userfriendly_targets,$(1),Gallery,$(call gb_Gallery__get_final_target,$(1)))
 149
 150 endef
 151
 152 # Add a file to the gallery.
 153 #
 154 # The file is given by path relative to $(SRCDIR).
 155 #
 156 # gb_Gallery_add_file gallery file
 157 define gb_Gallery_add_file
 158 $(call gb_Gallery_get_target,$(1)) : $(SRCDIR)/$(3)
 159 $(call gb_Gallery_get_target,$(1)) : GALLERY_FILES += $(call gb_Helper_make_url,$(SRCDIR)/$(3))
 160 $(call gb_Package_add_file,$(call gb_Gallery_get_files_packagename,$(1)),$(2)/$(notdir $(3)),$(notdir $(3)))
 161
 162 endef
 163
 164 # Add several files to the gallery at once.
 165 #
 166 # The files are given by path relative to $(SRCDIR).
 167 #
 168 # gb_Gallery_add_files gallery file(s)
 169 define gb_Gallery_add_files
 170 $(foreach fname,$(3),$(call gb_Gallery_add_file,$(1),$(2),$(fname)))
 171
 172 endef
 173
 174 # vim: set noet sw=4 ts=4: