1 /*

     2  * Copyright (C) 2004 Apple Computer, 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 Computer, 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 #import <JavaVM/jni.h>

    30 

    31 /*!

    32     The Java plug-in adds the following additional methods to facilitate JNI

    33     access to Java VM via the plug-in.

    34 */

    35 

    36 typedef enum {

    37     WebJNIReturnTypeInvalid = 0,

    38     WebJNIReturnTypeVoid,

    39     WebJNIReturnTypeObject,

    40     WebJNIReturnTypeBoolean,

    41     WebJNIReturnTypeByte,

    42     WebJNIReturnTypeChar,

    43     WebJNIReturnTypeShort,

    44     WebJNIReturnTypeInt,

    45     WebJNIReturnTypeLong,

    46     WebJNIReturnTypeFloat,

    47     WebJNIReturnTypeDouble

    48 } WebJNIReturnType;

    49 

    50 @interface NSObject (WebJavaPlugIn)

    51 

    52 /*!

    53     @method webPlugInGetApplet

    54     @discusssion This returns the jobject representing the java applet to the

    55     WebPlugInContainer.  It should always be called from the AppKit Main Thread.

    56     This method is only implemented by the Java plug-in.

    57 */

    58 - (jobject)webPlugInGetApplet;

    59 

    60 /*!

    61     @method webPlugInCallJava:isStatic:returnType:method:arguments:callingURL:exceptionDescription:

    62     @param object The Java instance that will receive the method call.

    63     @param isStatic A flag that indicated whether the method is a class method.

    64     @param returnType The return type of the Java method.

    65     @param method The ID of the Java method to call.

    66     @param args The arguments to use with the method invocation.

    67     @param callingURL The URL of the page that contains the JavaScript that is calling Java.

    68     @param exceptionDescription Pass in nil or the address of pointer to a string object.  If any exception

    69     is thrown by Java the return value will be a description of the exception, otherwise nil.

    70     @discussion Calls to Java from native code should not make direct

    71     use of JNI.  Instead they should use this method to dispatch calls to the 

    72     Java VM.  This is required to guarantee that the correct thread will receive

    73     the call.  webPlugInCallJava:isStatic:returnType:method:arguments:callingURL:exceptionDescription: must 

    74     always be called from the AppKit main thread.  This method is only implemented by the Java plug-in.

    75     @result The result of the method invocation.

    76 */

    77 - (jvalue)webPlugInCallJava:(jobject)object

    78                    isStatic:(BOOL)isStatic

    79                  returnType:(WebJNIReturnType)returnType

    80                      method:(jmethodID)method

    81                   arguments:(jvalue*)args

    82                  callingURL:(NSURL *)url

    83        exceptionDescription:(NSString **)exceptionString;

    84 

    85 @end