#
# Copyright (c) 2011, 2019, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.  Oracle designates this
# particular file as subject to the "Classpath" exception as provided
# by Oracle in the LICENSE file that accompanied this code.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#

# Setup make rules for creating an RMI compilation.
#
# Parameter 1 is the name of the rule. This name is used as variable prefix,
# and the targets generated are listed in a variable by that name.
#
# Remaining parameters are named arguments. These include:
#   CLASSES:=List of classes to generate stubs for
#   CLASSES_DIR:=Directory where to look for classes
#   STUB_CLASSES_DIR:=Directory in where to put stub classes
#   RUN_V11:=Set to run rmic with -v1.1
#   RUN_V12:=Set to run rmic with -v1.2
#   KEEP_GENERATED:=Set to keep generated sources around
#   STUB_SOURCES_DIR:=Directory to put generated sources in
SetupRMICompilation = $(NamedParamsMacroTemplate)
define SetupRMICompilationBody

  $1_DEP_FILE := $$($1_STUB_CLASSES_DIR)/_the.$1_rmic.generated

  $1_CLASSES_SLASH := $$(subst .,/,$$($1_CLASSES))
  $1_CLASS_FILES := $$(addprefix $$($1_CLASSES_DIR)/,$$(addsuffix .class,$$($1_CLASSES_SLASH)))
  $1_STUB_FILES := $$(addprefix $$($1_STUB_CLASSES_DIR)/,$$(addsuffix _Stub.class,$$($1_CLASSES_SLASH)))
  $1_TARGETS := $$($1_STUB_FILES)
  $1_ARGS :=
  ifneq (,$$($1_RUN_V11))
    $1_SKEL_FILES := $$(addprefix $$($1_STUB_CLASSES_DIR)/,$$(addsuffix _Skel.class,$$($1_CLASSES_SLASH)))
    $1_TARGETS += $$($1_SKEL_FILES)
    $1_ARGS += -v1.1
  endif
  ifneq (,$$($1_RUN_V12))
    $1_ARGS += -v1.2
  endif

  $1_TIE_BASE_FILES := $$(foreach f,$$($1_CLASSES_SLASH),$$(dir $$f)_$$(notdir $$f))
  $1_TIE_FILES := $$(addprefix $$($1_STUB_CLASSES_DIR)/org/omg/stub/,$$(addsuffix _Tie.class,$$($1_TIE_BASE_FILES)))
  $1_TIE_STDPKG_FILES := $$(addprefix $$($1_STUB_CLASSES_DIR)/,$$(addsuffix _Tie.class,$$($1_TIE_BASE_FILES)))

  ifneq ($$($1_KEEP_GENERATED), )
    $1_ARGS += -keepgenerated
    $1_JAVA_TARGETS := $$(subst .class,.java,$$($1_TARGETS))
    ifneq ($$($1_STUB_SOURCES_DIR), )
      # This is where the java files are created by rmic
      $1_JAVA_TARGETS_REL := $$(subst $$($1_STUB_CLASSES_DIR),, $$($1_JAVA_TARGETS))
      # This is where the caller wants the java files
      $1_JAVA_TARGETS := $$(addprefix $$($1_STUB_SOURCES_DIR), $$($1_JAVA_TARGETS_REL))
    endif
    $1_TARGETS += $$($1_JAVA_TARGETS)
  endif

  $1_DOLLAR_SAFE_CLASSES := $$(subst $$$$,\$$$$,$$($1_CLASSES))

  $$($1_TARGETS): $$($1_DEP_FILE) $$($1_CLASS_FILES)

  $$($1_DEP_FILE): $$($1_CLASS_FILES)
	$$(call LogInfo, Running rmic $$($1_ARGS) for $$($1_DOLLAR_SAFE_CLASSES))
	$$(call MakeDir, $$($1_STUB_CLASSES_DIR))
	$(RMIC) $$($1_ARGS) -classpath "$$($1_CLASSES_DIR)" \
	    -d $$($1_STUB_CLASSES_DIR) $$($1_DOLLAR_SAFE_CLASSES); \
	$$(if $$($1_STUB_SOURCES_DIR), \
	  $$(foreach f, $$($1_JAVA_TARGETS_REL), \
	    $(MKDIR) -p $$(dir $$($1_STUB_SOURCES_DIR)/$$f) ; \
	    $(MV) $$($1_STUB_CLASSES_DIR)/$$f $$($1_STUB_SOURCES_DIR)/$$f ; \
	  ) \
	) \
	$(TOUCH) $$@


  $1 := $$($1_TARGETS) $$($1_DEP_FILE)

endef