vendorplugin.h is jvmfwk-internal (and no need for extern "C")

Change-Id: I954f789d5850e8016f5900812f9aa99be2416ce4

5 files changed, 256 insertions, 8 deletions

diff --git a/jvmfwk/Library_jvmfwk.mk b/jvmfwk/Library_jvmfwk.mk
index 5b99f5869acc..15f1a26fcb3a 100644
--- a/jvmfwk/Library_jvmfwk.mk
+++ b/jvmfwk/Library_jvmfwk.mk
@@ -19,6 +19,11 @@ $(eval $(call gb_Library_add_defs,jvmfwk,\
 ))
 endif
 
+$(eval $(call gb_Library_set_include,jvmfwk,\
+    -I$(SRCDIR)/jvmfwk/inc \
+    $$(INCLUDE) \
+))
+
 $(eval $(call gb_Library_use_api,jvmfwk,\
     udkapi \
 ))
diff --git a/jvmfwk/inc/vendorplugin.hxx b/jvmfwk/inc/vendorplugin.hxx
new file mode 100644
index 000000000000..02ea040d2b91
--- /dev/null
+++ b/jvmfwk/inc/vendorplugin.hxx
@@ -0,0 +1,247 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * 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/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+/** @HTML */
+#ifndef INCLUDED_JVMFWK_INC_VENDORPLUGIN_HXX
+#define INCLUDED_JVMFWK_INC_VENDORPLUGIN_HXX
+
+#include <jvmfwk/framework.h>
+#include <rtl/ustring.h>
+#include "jni.h"
+
+/**
+   @file
+   <p>
+   This API shall be implemented if one wants to support a Java Runtime
+   Environment (JRE) of a particular vendor. Because there is currently no
+   specification which rules the structure and location of JRE installations
+   and the format of version strings it is not possible to supply a general
+   implementation for all possible vendors. If an application determines exactly
+   what version a JRE must have then it relies on certain features and bug
+   fixes of that version. Because a version 1.4.2_1 from vendor X may contain
+   different fixes as the same version from vendor Y it is important to see
+   version an vendor as one entity. One without the other does not guarantee
+   the existence of a particular set of features or bug fixes. An implementation
+   of this API may support multiple vendors. </p>
+   <p>
+   Libraries which implement this interface will be dynamically loaded and
+   unloaded by the java framework (jvmfwk/framework.h). Therefore they must not
+   keep global variables.
+   </p>
+ */
+
+typedef enum
+{
+    JFW_PLUGIN_E_NONE,
+    JFW_PLUGIN_E_ERROR,
+    JFW_PLUGIN_E_INVALID_ARG,
+    JFW_PLUGIN_E_WRONG_VERSION_FORMAT,
+    JFW_PLUGIN_E_FAILED_VERSION,
+    JFW_PLUGIN_E_NO_JRE,
+    JFW_PLUGIN_E_WRONG_VENDOR,
+    JFW_PLUGIN_E_VM_CREATION_FAILED
+} javaPluginError;
+
+
+
+/** obtains information about installations of Java Runtime Environments (JREs).
+
+    <p>The function gathers information about available JREs which have the same
+    vendor as determined by the <code>sVendor</code> parameter. Only information
+    about those JREs which match the version requirements are returned. These
+    requirements are specified by the parameters <code>sMinVersion</code>,
+    <code>sMaxVersion</code> and <code>arExcludeList</code>.
+    </p>
+    <p>
+    The JavaInfo structures returned in <code>parJavaInfo</code> should be ordered
+    according to their version. The one, representing a JRE with the highest
+    version should be the first in the array. </p>
+    <p>
+    The function allocates memory for an array and all the JavaInfo objects returned
+    in <code>parJavaInfo</code>. The caller must free each JavaInfo object by calling
+    <code>jfw_freeJavaInfo</code> (#include "jvmfwk/framework.h"). The array is to be
+    freed by rtl_freeMemory.
+    In case an error occurred <code>parJavaInfo</code> need not be freed.
+    </p>
+    @param sVendor
+        [in] only JREs from this vendor are examined. This parameter always contains
+        a vendor string. That is, the string it is not empty.
+    @param sMinVersion
+        [in] represents the minimum version of a JRE. The string can be empty but
+        a null pointer is not allowed.
+    @param sMaxVersion
+        [in] represents the maximum version of a JRE. The string can be empty but
+        a null pointer is not allowed.
+    @param arExcludeList
+        [in] contains a list of &quot;bad&quot; versions. JREs which have one of these
+        versions must not be returned by this function. It can be NULL.
+    @param nSizeExcludeList
+        [in] the number of version strings contained in <code>arExcludeList</code>.
+    @param parJavaInfo
+        [out] if the function runs successfully then <code>parJavaInfo</code> contains
+        on return an array of pointers to <code>JavaInfo</code> objects.
+    @param nSizeJavaInfo
+       [out] the number of <code>JavaInfo</code> pointers contained in
+       <code>parJavaInfo</code>.
+
+    @return
+    JFW_PLUGIN_E_NONE the function ran successfully.</br>
+    JFW_PLUGIN_E_ERROR an error occurred during execution.</br>
+    JFW_PLUGIN_E_INVALID_ARG an argument was not valid. For example
+    <code>nSizeExcludeList</code> is greater null but <code>arExcludeList</code>
+    is NULL or NULL pointer were passed for at least on of the strings.</br>
+    JFW_PLUGIN_E_WRONG_VERSION_FORMAT the version strings in
+    <code>sMinVersion,sMaxVersion,arExcludeList</code> are not recognized as valid
+    version strings.
+ */
+javaPluginError jfw_plugin_getAllJavaInfos(
+    rtl_uString *sVendor,
+    rtl_uString *sMinVersion,
+    rtl_uString *sMaxVersion,
+    rtl_uString * * arExcludeList,
+    sal_Int32  nSizeExcludeList,
+    JavaInfo*** parJavaInfo,
+    sal_Int32 *nSizeJavaInfo);
+
+/** obtains information for a JRE at a given location.
+
+   <p>If the given location belongs to a JRE whoose vendor matches the
+   sVendor argument and the JRE has a version which meets the requirements as
+   specified by <code>sMinVersion, sMaxVersion, arExcludeList</code> then
+   this function shall return a JavaInfo object for this JRE if this implementation
+   supports this vendor.</p>
+
+   @param sLocation
+       [in] a file URL to the directory of the JRE.
+   @param sVendor
+      [in] a name of a vendor. This parameter always contains
+        a vendor string. That is, the string it is not empty.
+   @param sMinVersion
+       [in] represents the minimum version of a JRE.
+   @param sMaxVersion
+       [in] represents the maximum version of a JRE.
+   @param arExcludeList
+       [in] contains a list of &quot;bad&quot; versions. JREs which have one of these
+        versions must not be returned by this function. It can be NULL.
+   @param nSizeExcludeList
+       [in] the number of version strings contained in <code>arExcludeList</code>.
+   @param ppInfo
+       [out] if the function runs successfully then <code>ppInfo</code> contains
+        on return a pointer to a <code>JavaInfo</code> object.
+
+   @return
+   JFW_PLUGIN_E_NONE the function ran successfully.</br>
+   JFW_PLUGIN_E_ERROR an error occurred during execution.</br>
+   JFW_PLUGIN_E_INVALID_ARG an argument was not valid. For example
+    <code>nSizeExcludeList</code> is greater null but <code>arExcludeList</code>
+    is NULL, NULL pointer were passed for at least on of the strings, sLocation
+    is an empty string.</br>
+   JFW_PLUGIN_E_WRONG_VERSION_FORMAT the version strings in
+    <code>sMinVersion,sMaxVersion,arExcludeList</code> are not recognized as valid
+    version strings.
+   JFW_PLUGIN_E_FAILED_VERSION there is a JRE at the given location but it does not
+   meet the version requirements.
+   JFW_PLUGIN_E_NO_JRE no JRE could be detected at the given location. However, that
+   does not mean necessarily that there is no JRE. There could be a JRE but it has
+   a vendor which is not supported by this API implementation.
+ */
+javaPluginError jfw_plugin_getJavaInfoByPath(
+    rtl_uString *sLocation,
+    rtl_uString *sVendor,
+    rtl_uString *sMinVersion,
+    rtl_uString *sMaxVersion,
+    rtl_uString * *arExcludeList,
+    sal_Int32  nSizeExcludeList,
+    JavaInfo ** ppInfo);
+
+/** starts a Java Virtual Machine.
+
+    <p>The caller should provide all essential JavaVMOptions, such as the
+    class path (-Djava.class.path=xxx). It is assumed that the caller
+    knows what JRE is used. Hence the implementation does not need to check
+    the options for validity. If a user configured the application to
+    use specific options, such as -X..., then it is in his responsibility to
+    ensure that the application works properly. The function may add or modify
+    properties. For example, it may add to the class path property.
+    <p>
+    The function must ensure, that the VM does not abort the process
+    during instantiation.</p>
+    <p>
+    The function receives a <code>JavaInfo</code> object that was created
+    by the functions <code>jfw_plugin_getJavaInfoByPath</code> or
+    <code>jfw_plugin_getAllJavaInfos</code> from the same library. This can be
+    guaranteed if an application uses exactly one library for one vendor.
+    Therefore the functions which create the <code>JavaInfo</code> can store all
+    necessary information which are needed for starting the VM into that
+    structure. </p>
+
+    @param pInfo
+        [in] the JavaInfo object with information about the JRE.
+    @param arOptions
+        [in] the options which are passed into the JNI_CreateJavaVM function.
+        Can be NULL.
+    @param nSizeOptions
+        [in] the number of elements in <code>arOptions</code>.
+    @param ppVM
+        [out] the JavaVM pointer of the created VM.
+    @param ppEnv
+        [out] the JNIEnv pointer of the created VM.
+
+    @return
+    JFW_PLUGIN_E_NONE the function ran successfully.</br>
+    JFW_PLUGIN_E_ERROR an error occurred during execution.</br>
+    JFW_PLUGIN_E_WRONG_VENDOR the <code>JavaInfo</code> object was not created
+    in by this library and the VM cannot be started.</br>
+    JFW_PLUGIN_E_INVALID_ARG an argument was not valid. For example
+    <code>pInfo</code> or , <code>ppVM</code> or <code>ppEnv</code> are NULL.
+    </br>
+    JFW_PLUGIN_E_VM_CREATION_FAILED a VM could not be created. The error was caused
+    by the JRE.
+ */
+javaPluginError jfw_plugin_startJavaVirtualMachine(
+    const JavaInfo *pInfo,
+    const JavaVMOption *arOptions,
+    sal_Int32 nSizeOptions,
+    JavaVM ** ppVM,
+    JNIEnv ** ppEnv);
+
+
+
+/** checks if the installation of the jre still exists.
+
+    This function checks if the JRE described by pInfo still
+    exists. The check must be very quick because it is called by javaldx
+    (Linux, Solaris) at start up.
+
+    @param pInfo
+        [in]  the JavaInfo object with information about the JRE.
+    @param pp_exist
+        [out] the parameter is set to either sal_True or sal_False. The value is
+        only valid if the function returns JFW_E_NONE.
+
+   @return
+    JFW_PLUGIN_E_NONE the function ran successfully.</br>
+    JFW_PLUGIN_E_ERROR an error occurred during execution.</br>
+    JFW_PLUGIN_E_INVALID_ARG pInfo contains invalid data</br>
+ */
+javaPluginError jfw_plugin_existJRE(const JavaInfo *pInfo, sal_Bool *exist);
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/jvmfwk/plugins/sunmajor/pluginlib/sunjavaplugin.cxx b/jvmfwk/plugins/sunmajor/pluginlib/sunjavaplugin.cxx
index ab5153dd033f..d1e02ce35b3d 100644
--- a/jvmfwk/plugins/sunmajor/pluginlib/sunjavaplugin.cxx
+++ b/jvmfwk/plugins/sunmajor/pluginlib/sunjavaplugin.cxx
@@ -51,7 +51,7 @@
 
 #include "jni.h"
 #include "rtl/byteseq.hxx"
-#include "jvmfwk/vendorplugin.h"
+#include "vendorplugin.hxx"
 #include "util.hxx"
 #include "sunversion.hxx"
 #include "vendorlist.hxx"
@@ -200,7 +200,6 @@ extern "C" void JNICALL abort_handler()
 
 }
 
-extern "C"
 javaPluginError jfw_plugin_getAllJavaInfos(
     rtl_uString *sVendor,
     rtl_uString *sMinVersion,
@@ -330,7 +329,6 @@ javaPluginError jfw_plugin_getAllJavaInfos(
     return JFW_PLUGIN_E_NONE;
 }
 
-extern "C"
 javaPluginError jfw_plugin_getJavaInfoByPath(
     rtl_uString *path,
     rtl_uString *sVendor,
@@ -585,7 +583,6 @@ static void do_msvcr_magic(rtl_uString *jvm_dll)
     during instantiation.
     </p>
  */
-extern "C"
 javaPluginError jfw_plugin_startJavaVirtualMachine(
     const JavaInfo *pInfo,
     const JavaVMOption* arOptions,
@@ -782,7 +779,6 @@ javaPluginError jfw_plugin_startJavaVirtualMachine(
    return errorcode;
 }
 
-extern "C"
 javaPluginError jfw_plugin_existJRE(const JavaInfo *pInfo, sal_Bool *exist)
 {
     javaPluginError ret = JFW_PLUGIN_E_NONE;
diff --git a/jvmfwk/source/framework.cxx b/jvmfwk/source/framework.cxx
index cd7d55194d92..bdb75f7185fc 100644
--- a/jvmfwk/source/framework.cxx
+++ b/jvmfwk/source/framework.cxx
@@ -23,7 +23,7 @@
 #include "osl/thread.hxx"
 #include "osl/file.hxx"
 #include "jvmfwk/framework.h"
-#include "jvmfwk/vendorplugin.h"
+#include "vendorplugin.hxx"
 #include <cassert>
 #include <vector>
 #include <functional>
diff --git a/jvmfwk/source/framework.hxx b/jvmfwk/source/framework.hxx
index 808bff5d8dd8..0d0ba187936a 100644
--- a/jvmfwk/source/framework.hxx
+++ b/jvmfwk/source/framework.hxx
@@ -22,9 +22,9 @@
 #include "rtl/ustring.hxx"
 #include "rtl/byteseq.hxx"
 #include "jvmfwk/framework.h"
-#include "jvmfwk/vendorplugin.h"
+#include "vendorplugin.hxx"
 
-/** typedefs for functions from vendorplugin.h
+/** typedefs for functions from vendorplugin.hxx
  */
 typedef javaPluginError (*jfw_plugin_getAllJavaInfos_ptr)(
     rtl_uString * sVendor,