diff options
Diffstat (limited to 'include/jvmaccess/classpath.hxx')
-rw-r--r-- | include/jvmaccess/classpath.hxx | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/include/jvmaccess/classpath.hxx b/include/jvmaccess/classpath.hxx new file mode 100644 index 000000000000..1cc8d83ab348 --- /dev/null +++ b/include/jvmaccess/classpath.hxx @@ -0,0 +1,139 @@ +/* -*- 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 . + */ + +#ifndef INCLUDED_JVMACCESS_CLASSPATH_HXX +#define INCLUDED_JVMACCESS_CLASSPATH_HXX + +#include "jvmaccessdllapi.h" +#include "sal/config.h" +#include "com/sun/star/uno/Reference.hxx" + +#include "jni.h" + +namespace com { namespace sun { namespace star { namespace uno { + class XComponentContext; +} } } } + +namespace jvmaccess { + +/** + Helper functions for class path handling. +*/ +class JVMACCESS_DLLPUBLIC ClassPath { +public: + /** + translates a class path into a java.net.URL[] instance. + + @param context + a component context; must not be null. + + @param environment + a JNI environment; must not be null. + + @param classPath + a list of zero or more internal (see the + com.sun.star.uri.ExternalUriReferenceTranslator service) URI references, + where any space characters (U+0020) are ignored (and, in particular, + separate adjacent URI references). Any vnd.sun.star.expand URL + references in the list are expanded using the + com.sun.star.util.theMacroExpander singleton of the given context. + + @returns + a local reference to a java.net.URL[] instance containing the external + (see the com.sun.star.uri.ExternalUriReferenceTranslator service) + equivalents of all the URI references in the given classPath. If null, a + (still pending) JNI exception occurred. + + @throws com::sun::star::uno::RuntimeException + */ + static inline ::jobjectArray + translateToUrls( + ::com::sun::star::uno::Reference< + ::com::sun::star::uno::XComponentContext > const & context, + ::JNIEnv * environment, OUString const & classPath) + { + return + static_cast< ::jobjectArray >( + doTranslateToUrls(context, environment, classPath)); + } + + /** + loads a class via a java.net.URLClassLoader. + + @param context + a component context; must not be null. + + @param environment + a JNI environment; must not be null. + + @param classPath + a list of zero or more internal (see the + com.sun.star.uri.ExternalUriReferenceTranslator service) URI references, + where any space characters (U+0020) are ignored (and, in particular, + separate adjacent URI references). Any vnd.sun.star.expand URL + references in the list are expanded using the + com.sun.star.util.theMacroExpander singleton of the given context. + + @param name + the Java binary name of the class to load. + + @returns + a local reference to a java.lang.Class instance. If null, a (still + pending) JNI exception occurred. + + @throws com::sun::star::uno::RuntimeException + */ + static inline ::jclass loadClass( + ::com::sun::star::uno::Reference< + ::com::sun::star::uno::XComponentContext > const & context, + ::JNIEnv * environment, OUString const & classPath, + OUString const & name) + { + return + static_cast< ::jclass >( + doLoadClass(context, environment, classPath, name)); + } + +private: + ClassPath(); // not defined + ClassPath(ClassPath &); // not defined + ~ClassPath(); // not defined + void operator =(ClassPath &); // not defined + + // Functions that replace JNIEnv, jobjectArray, and jclass with void *, so + // that their mangled C++ names do not depend on the JDK version used at + // compile time: + + static void * doTranslateToUrls( + ::com::sun::star::uno::Reference< + ::com::sun::star::uno::XComponentContext > const & context, + void * environment, OUString const & classPath); + + static void * doLoadClass( + ::com::sun::star::uno::Reference< + ::com::sun::star::uno::XComponentContext > const & context, + void * environment, OUString const & classPath, + OUString const & name); +}; + +} + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |