1/*
2 * Copyright (C) 2004 Apple Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 *
8 * 1.  Redistributions of source code must retain the above copyright
9 *     notice, this list of conditions and the following disclaimer.
10 * 2.  Redistributions in binary form must reproduce the above copyright
11 *     notice, this list of conditions and the following disclaimer in the
12 *     documentation and/or other materials provided with the distribution.
13 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
14 *     its contributors may be used to endorse or promote products derived
15 *     from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#if !PLATFORM(IOS)
30
31#import <JavaVM/jni.h>
32
33/*!
34    The Java plug-in adds the following additional methods to facilitate JNI
35    access to Java VM via the plug-in.
36*/
37
38typedef enum {
39    WebJNIReturnTypeInvalid = 0,
40    WebJNIReturnTypeVoid,
41    WebJNIReturnTypeObject,
42    WebJNIReturnTypeBoolean,
43    WebJNIReturnTypeByte,
44    WebJNIReturnTypeChar,
45    WebJNIReturnTypeShort,
46    WebJNIReturnTypeInt,
47    WebJNIReturnTypeLong,
48    WebJNIReturnTypeFloat,
49    WebJNIReturnTypeDouble
50} WebJNIReturnType;
51
52@interface NSObject (WebJavaPlugIn)
53
54/*!
55    @method webPlugInGetApplet
56    @discusssion This returns the jobject representing the java applet to the
57    WebPlugInContainer.  It should always be called from the AppKit Main Thread.
58    This method is only implemented by the Java plug-in.
59*/
60- (jobject)webPlugInGetApplet;
61
62/*!
63    @method webPlugInCallJava:isStatic:returnType:method:arguments:callingURL:exceptionDescription:
64    @param object The Java instance that will receive the method call.
65    @param isStatic A flag that indicated whether the method is a class method.
66    @param returnType The return type of the Java method.
67    @param method The ID of the Java method to call.
68    @param args The arguments to use with the method invocation.
69    @param callingURL The URL of the page that contains the JavaScript that is calling Java.
70    @param exceptionDescription Pass in nil or the address of pointer to a string object.  If any exception
71    is thrown by Java the return value will be a description of the exception, otherwise nil.
72    @discussion Calls to Java from native code should not make direct
73    use of JNI.  Instead they should use this method to dispatch calls to the
74    Java VM.  This is required to guarantee that the correct thread will receive
75    the call.  webPlugInCallJava:isStatic:returnType:method:arguments:callingURL:exceptionDescription: must
76    always be called from the AppKit main thread.  This method is only implemented by the Java plug-in.
77    @result The result of the method invocation.
78*/
79- (jvalue)webPlugInCallJava:(jobject)object
80                   isStatic:(BOOL)isStatic
81                 returnType:(WebJNIReturnType)returnType
82                     method:(jmethodID)method
83                  arguments:(jvalue*)args
84                 callingURL:(NSURL *)url
85       exceptionDescription:(NSString **)exceptionString;
86
87@end
88#endif // PLATFORM(IOS)
89