#

# Copyright (c) 2018, 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.

#

ifndef _JDK_NATIVE_COMPILATION_GMK

_JDK_NATIVE_COMPILATION_GMK := 1

ifeq ($(_MAKEBASE_GMK), )

  $(error You must include MakeBase.gmk prior to including JdkNativeCompilation.gmk)

endif

include NativeCompilation.gmk

# Setup make rules for creating a native shared library with suitable defaults

# for the OpenJDK project.

#

# 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:

#   NAME The base name for the resulting binary, excluding decorations (like *.exe)

#   TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.

#   SUFFIX Override the default suffix for the output file

#   TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.

#   SRC one or more directory roots to scan for C/C++ files.

#   CFLAGS the compiler flags to be used, used both for C and C++.

#   CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.

#   LDFLAGS the linker flags to be used, used both for C and C++.

#   LIBS the libraries to link to

#   ARFLAGS the archiver flags to be used

#   OBJECT_DIR the directory where we store the object files

#   OUTPUT_DIR the directory where the resulting binary is put

#   INCLUDES only pick source from these directories

#   EXCLUDES do not pick source from these directories

#   INCLUDE_FILES only compile exactly these files!

#   EXCLUDE_FILES with these names

#   EXCLUDE_PATTERN exclude files matching any of these substrings

#   EXTRA_FILES List of extra files not in any of the SRC dirs

#   EXTRA_OBJECT_FILES List of extra object files to include when linking

#   VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run

#   RC_FLAGS flags for RC.

#   EMBED_MANIFEST if true, embed manifest on Windows.

#   MAPFILE mapfile

#   REORDER reorder file

#   USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the

#       mapfile for the output symbols file

#   CC the compiler to use, default is $(CC)

#   LD the linker to use, default is $(LD)

#   OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE

#   DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain

#   DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain

#       when compiling C code

#   DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified

#       toolchain when compiling C++ code

#   STRIP_SYMBOLS Set to false to override global strip policy and always leave

#       symbols in the binary, if the toolchain allows for it

#   DEBUG_SYMBOLS Set to false to disable generation of debug symbols

#   COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying

#   ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol

#       zipping

#   STRIPFLAGS Optionally change the flags given to the strip command

#   PRECOMPILED_HEADER Header file to use as precompiled header

#   PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH

SetupJdkLibrary = $(NamedParamsMacroTemplate)

define SetupJdkLibraryBody

  ifeq ($$($1_OUTPUT_DIR), )

    $1_OUTPUT_DIR := $$(call FindLibDirForModule, $$(MODULE))

  endif

  ifeq ($$($1_OBJECT_DIR), )

    $1_OBJECT_DIR := $$(SUPPORT_OUTPUTDIR)/native/$$(MODULE)/lib$$($1_NAME)

  endif

  ifeq ($$($1_VERSIONINFO_RESOURCE), )

    $1_VERSIONINFO_RESOURCE := $$(GLOBAL_VERSION_INFO_RESOURCE)

  else ifeq ($$($1_VERSIONINFO_RESOURCE), DISABLE)

    $1_VERSIONINFO_RESOURCE :=

  endif

  ifeq ($$($1_RC_FLAGS), )

    $1_RC_FLAGS :=  $(RC_FLAGS) \

        -D "JDK_FNAME=$$($1_NAME).dll" \

        -D "JDK_INTERNAL_NAME=$$($1_NAME)" \

        -D "JDK_FTYPE=0x2L"

  else ifeq ($$($1_RC_FLAGS), DISABLE)

    $1_RC_FLAGS :=

  endif

  $1_RC_FLAGS += $$($1_EXTRA_RC_FLAGS)

  # Since we reuse the rule name ($1), all our arguments will pass through.

  # We lose in transparency, but gain in brevity in this call...

  $$(eval $$(call SetupNativeCompilation, $1, ))

endef

# Setup make rules for creating a native executable with suitable defaults for

# the OpenJDK project.

#

# 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:

#   NAME The base name for the resulting binary, excluding decorations (like *.exe)

#   TYPE Type of binary (EXECUTABLE, LIBRARY or STATIC_LIBRARY). Default is LIBRARY.

#   SUFFIX Override the default suffix for the output file

#   TOOLCHAIN Name of toolchain setup to use. Defaults to TOOLCHAIN_DEFAULT.

#   SRC one or more directory roots to scan for C/C++ files.

#   CFLAGS the compiler flags to be used, used both for C and C++.

#   CXXFLAGS the compiler flags to be used for c++, if set overrides CFLAGS.

#   LDFLAGS the linker flags to be used, used both for C and C++.

#   LIBS the libraries to link to

#   ARFLAGS the archiver flags to be used

#   OBJECT_DIR the directory where we store the object files

#   OUTPUT_DIR the directory where the resulting binary is put

#   INCLUDES only pick source from these directories

#   EXCLUDES do not pick source from these directories

#   INCLUDE_FILES only compile exactly these files!

#   EXCLUDE_FILES with these names

#   EXCLUDE_PATTERN exclude files matching any of these substrings

#   EXTRA_FILES List of extra files not in any of the SRC dirs

#   EXTRA_OBJECT_FILES List of extra object files to include when linking

#   VERSIONINFO_RESOURCE Input file for RC. Setting this implies that RC will be run

#   RC_FLAGS flags for RC.

#   EMBED_MANIFEST if true, embed manifest on Windows.

#   MAPFILE mapfile

#   REORDER reorder file

#   USE_MAPFILE_FOR_SYMBOLS if true and this is a STATIC_BUILD, just copy the

#       mapfile for the output symbols file

#   CC the compiler to use, default is $(CC)

#   LD the linker to use, default is $(LD)

#   OPTIMIZATION sets optimization level to NONE, LOW, HIGH, HIGHEST, HIGHEST_JVM, SIZE

#   DISABLED_WARNINGS_<toolchain> Disable the given warnings for the specified toolchain

#   DISABLED_WARNINGS_C_<toolchain> Disable the given warnings for the specified toolchain

#       when compiling C code

#   DISABLED_WARNINGS_CXX_<toolchain> Disable the given warnings for the specified

#       toolchain when compiling C++ code

#   STRIP_SYMBOLS Set to false to override global strip policy and always leave

#       symbols in the binary, if the toolchain allows for it

#   DEBUG_SYMBOLS Set to false to disable generation of debug symbols

#   COPY_DEBUG_SYMBOLS Set to false to override global setting of debug symbol copying

#   ZIP_EXTERNAL_DEBUG_SYMBOLS Set to false to override global setting of debug symbol

#       zipping

#   STRIPFLAGS Optionally change the flags given to the strip command

#   PRECOMPILED_HEADER Header file to use as precompiled header

#   PRECOMPILED_HEADER_EXCLUDE List of source files that should not use PCH

SetupJdkExecutable = $(NamedParamsMacroTemplate)

define SetupJdkExecutableBody

  $1_TYPE := EXECUTABLE

  ifeq ($$($1_OUTPUT_DIR), )

    $1_OUTPUT_DIR := $$(call FindExecutableDirForModule, $$(MODULE))

  endif

  ifeq ($$($1_OBJECT_DIR), )

    $1_OBJECT_DIR := $$(SUPPORT_OUTPUTDIR)/native/$$(MODULE)/$$($1_NAME)

  endif

  ifeq ($$($1_VERSIONINFO_RESOURCE), )

    $1_VERSIONINFO_RESOURCE := $$(GLOBAL_VERSION_INFO_RESOURCE)

  else ifeq ($$($1_VERSIONINFO_RESOURCE), DISABLE)

    $1_VERSIONINFO_RESOURCE :=

  endif

  ifeq ($$($1_RC_FLAGS), )

    $1_RC_FLAGS :=  $(RC_FLAGS) \

        -D "JDK_FNAME=$$($1_NAME).exe" \

        -D "JDK_INTERNAL_NAME=$$($1_NAME)" \

        -D "JDK_FTYPE=0x01L"

  else ifeq ($$($1_RC_FLAGS), DISABLE)

    $1_RC_FLAGS :=

  endif

  # Since we reuse the rule name ($1), all our arguments will pass through.

  # We lose in transparency, but gain in brevity in this call...

  $$(eval $$(call SetupNativeCompilation, $1))

endef

endif # _JDK_NATIVE_COMPILATION_GMK