# -*- Mode: makefile-gmake; tab-width: 4; indent-tabs-mode: t -*-
#
#
# This file is part of the LibreOffice project.
#
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#

# Extension class

define gb_Extension_Extension
$(call gb_ExtensionTarget_ExtensionTarget,$(1),$(2))

$(call gb_Extension_get_target,$(1)) : $(call gb_ExtensionTarget_get_target,$(1))
$(call gb_Extension_get_clean_target,$(1)) : $(call gb_ExtensionTarget_get_clean_target,$(1))

$(call gb_Deliver_add_deliverable,$(call gb_Extension_get_target,$(1)),$(call gb_ExtensionTarget_get_target,$(1)),$(1))

$$(eval $$(call gb_Module_register_target,$(call gb_Extension_get_target,$(1)),$(call gb_Extension_get_clean_target,$(1))))
$(call gb_Helper_make_userfriendly_targets,$(1),Extension)

endef

define gb_Extension_add_file
$(call gb_ExtensionTarget_add_file,$(1),$(2),$(3))

endef

# Add several files at once
#
# This function avoids the need to specify each file's name twice. The
# files are added directly under specified path in the extension,
# without any subpath. If no path is specified, they are added directly
# to the root dir of the extension.
define gb_Extension_add_files
$(call gb_ExtensionTarget_add_files,$(1),$(2),$(3))

endef

# add a library from the solver; DO NOT use gb_Library_get_target
define gb_Extension_add_library
$(call gb_ExtensionTarget_add_library,$(1),$(2))

endef

define gb_Extension_add_libraries
$(call gb_ExtensionTarget_add_libraries,$(1),$(2))

endef

# add an executable from the solver
define gb_Extension_add_executable
$(call gb_ExtensionTarget_add_executable,$(1),$(2))

endef

define gb_Extension_add_executables
$(call gb_ExtensionTarget_add_executables,$(1),$(2))

endef

# localize .properties file
define gb_Extension_localize_properties
$(call gb_ExtensionTarget_localize_properties,$(1),$(2),$(3))

endef

# add an .xhp help file, to be localized and compiled
# $(1): extension identifier
# $(2): absolute path prefix of en-US source file without $(3) (resp. $(4))
#     suffix
# $(3): relative path of (target) .xhp file (e.g.,
#     com.sun.wiki-publisher/wiki.xhp)
# $(4): optional relative path of source .xhp file, when it differs from $(3)
#     (i.e., if $(4) is empty the en-US source file is $(2)/$(3), otherwise it
#     is $(2)/$(4))
define gb_Extension_add_helpfile
$(call gb_ExtensionTarget_add_helpfile,$(1),$(2),$(3),$(4))

endef

# add a list of .xhp help files, to be localized and compiled
# $(1): extension identifier
# $(2): absolute path prefix of en-US source files without $(3) suffixes
# $(3): list of relative paths of .xhp files (see gb_Extension_add_helpfile)
define gb_Extension_add_helpfiles
$(call gb_ExtensionTarget_add_helpfiles,$(1),$(2),$(3))

endef

# add a help.tree file, to be localized and compiled
# $(1): extension identifier
# $(2): absolute path prefix of en-US source file without $(3) (resp. $(4))
#     suffix
# $(3): relative path of (target) help.tree file (e.g.,
#     com.sun.wiki-publisher/help.tree)
# $(4): optional relative path of source help.tree file, when it differs from $(3)
#     (i.e., if $(4) is empty the en-US source file is $(2)/$(3), otherwise it
#     is $(2)/$(4))
define gb_Extension_add_helptreefile
$(call gb_ExtensionTarget_add_helptreefile,$(1),$(2),$(3),$(4),$(5))

endef

define gb_Extension_use_default_description
$(call gb_ExtensionTarget_use_default_description,$(1))

endef

define gb_Extension_use_default_license
$(call gb_ExtensionTarget_use_default_license,$(1))

endef

define gb_Extension_use_unpacked
$(call gb_ExtensionTarget_use_unpacked,$(1),$(2))

endef

define gb_Extension_use_package
$(call gb_ExtensionTarget_use_package,$(1),$(2))

endef

define gb_Extension_use_packages
$(call gb_ExtensionTarget_use_packages,$(1),$(2))

endef

define gb_Extension_add_package_dependency
$$(call gb_Output_error,\
 gb_Extension_add_package_dependency: use gb_Extension_use_package instead.)
endef

define gb_Extension_add_package_dependencies
$$(call gb_Output_error,\
 gb_Extension_add_package_dependencies: use gb_Extension_use_packages instead.)
endef

# vim: set noet sw=4 ts=4: