gecko-dev/extensions/java/xpcom/nsJavaXPCOMBindingUtils.cpp

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (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.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Java XPCOM Bindings.
 *
 * The Initial Developer of the Original Code is
 * IBM Corporation.
 * Portions created by the Initial Developer are Copyright (C) 2004
 * IBM Corporation. All Rights Reserved.
 *
 * Contributor(s):
 *   Javier Pedemonte (jhpedemonte@gmail.com)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */


#include "nsJavaXPCOMBindingUtils.h"
#include "nsJavaXPTCStub.h"
#include "jni.h"
#include "nsIInterfaceInfoManager.h"
#include "pldhash.h"


/* Java JNI globals */
jclass classClass = nsnull;
jmethodID getNameMID = nsnull;

jclass objectClass = nsnull;
jmethodID hashCodeMID = nsnull;

jclass booleanClass = nsnull;
jclass booleanArrayClass = nsnull;
jmethodID booleanInitMID = nsnull;
jmethodID booleanValueMID = nsnull;

jclass charClass = nsnull;
jclass charArrayClass = nsnull;
jmethodID charInitMID = nsnull;
jmethodID charValueMID = nsnull;

jclass byteClass = nsnull;
jclass byteArrayClass = nsnull;
jmethodID byteInitMID = nsnull;
jmethodID byteValueMID = nsnull;

jclass shortClass = nsnull;
jclass shortArrayClass = nsnull;
jmethodID shortInitMID = nsnull;
jmethodID shortValueMID = nsnull;

jclass intClass = nsnull;
jclass intArrayClass = nsnull;
jmethodID intInitMID = nsnull;
jmethodID intValueMID = nsnull;

jclass longClass = nsnull;
jclass longArrayClass = nsnull;
jmethodID longInitMID = nsnull;
jmethodID longValueMID = nsnull;

jclass floatClass = nsnull;
jclass floatArrayClass = nsnull;
jmethodID floatInitMID = nsnull;
jmethodID floatValueMID = nsnull;

jclass doubleClass = nsnull;
jclass doubleArrayClass = nsnull;
jmethodID doubleInitMID = nsnull;
jmethodID doubleValueMID = nsnull;

jclass stringClass = nsnull;
jclass stringArrayClass = nsnull;

jclass nsISupportsClass = nsnull;

jclass exceptionClass = nsnull;

/**************************************
 *  Java<->XPCOM binding stores
 **************************************/
class JavaXPCOMBindingEntry : public PLDHashEntryHdr
{
public:
  jobject mJavaObject;
  void*   mXPCOMInstance;
};

static PLDHashTable *gJAVAtoXPCOMBindings = nsnull;
static PLDHashTable *gXPCOMtoJAVABindings = nsnull;

PR_STATIC_CALLBACK(PRBool)
InitJAVAtoXPCOMBindingEntry(PLDHashTable *table, PLDHashEntryHdr *entry,
                            const void *key)
{
  JavaXPCOMBindingEntry *e =
    NS_CONST_CAST(JavaXPCOMBindingEntry *,
                  NS_STATIC_CAST(const JavaXPCOMBindingEntry *, entry));

  e->mJavaObject = NS_CONST_CAST(jobject,
                                    NS_STATIC_CAST(const __jobject*, key));
  e->mXPCOMInstance = nsnull;

  return PR_TRUE;
}

PR_STATIC_CALLBACK(PRBool)
InitXPCOMtoJAVABindingEntry(PLDHashTable *table, PLDHashEntryHdr *entry,
                            const void *key)
{
  JavaXPCOMBindingEntry *e =
    NS_CONST_CAST(JavaXPCOMBindingEntry *,
                  NS_STATIC_CAST(const JavaXPCOMBindingEntry *, entry));

  e->mXPCOMInstance = NS_CONST_CAST(void*, key);
  e->mJavaObject = nsnull;

  return PR_TRUE;
}

void
AddJavaXPCOMBinding(JNIEnv* env, jobject aJavaObject, void* aXPCOMObject)
{
  jint hash = env->CallIntMethod(aJavaObject, hashCodeMID);

  JavaXPCOMBindingEntry *entry =
    NS_STATIC_CAST(JavaXPCOMBindingEntry*,
                   PL_DHashTableOperate(gJAVAtoXPCOMBindings,
                                        NS_INT32_TO_PTR(hash),
                                        PL_DHASH_ADD));
  entry->mXPCOMInstance = aXPCOMObject;

  entry =
    NS_STATIC_CAST(JavaXPCOMBindingEntry*,
                   PL_DHashTableOperate(gXPCOMtoJAVABindings, aXPCOMObject,
                                        PL_DHASH_ADD));
  entry->mJavaObject = aJavaObject;

  LOG("+ Adding Java<->XPCOM binding (Java=0x%08x | XPCOM=0x%08x)\n",
         hash, (int) aXPCOMObject);
}

nsISupports*
RemoveXPCOMBinding(JNIEnv* env, jobject aJavaObject)
{
  void* xpcomObj = GetMatchingXPCOMObject(env, aJavaObject);

  // Remove both instances from stores
  jint hash = env->CallIntMethod(aJavaObject, hashCodeMID);
  PL_DHashTableOperate(gJAVAtoXPCOMBindings, NS_INT32_TO_PTR(hash),
                       PL_DHASH_REMOVE);
  PL_DHashTableOperate(gXPCOMtoJAVABindings, xpcomObj, PL_DHASH_REMOVE);

  LOG("- Removing Java<->XPCOM binding (Java=0x%08x | XPCOM=0x%08x)\n",
      hash, (int) xpcomObj);

  nsISupports* inst = nsnull;
  if (IsXPTCStub(xpcomObj)) {
    GetXPTCStubAddr(xpcomObj)->QueryInterface(NS_GET_IID(nsISupports),
                                              (void**) &inst);
  } else {
    JavaXPCOMInstance* xpcomInst = (JavaXPCOMInstance*) xpcomObj;
    inst = xpcomInst->GetInstance();
    // XXX Getting some odd thread issues when calling this.  Addreffing for
    //  now to work around the errors.
    NS_ADDREF(inst);
    delete xpcomInst;
  }
  return inst;
}

void
RemoveJavaXPCOMBinding(JNIEnv* env, jobject aJavaObject, void* aXPCOMObject)
{
  // Remove both instances from stores
  jint hash = env->CallIntMethod(aJavaObject, hashCodeMID);
  PL_DHashTableOperate(gJAVAtoXPCOMBindings, NS_INT32_TO_PTR(hash),
                       PL_DHASH_REMOVE);
  PL_DHashTableOperate(gXPCOMtoJAVABindings, aXPCOMObject, PL_DHASH_REMOVE);

  LOG("- Removing Java<->XPCOM binding (Java=0x%08x | XPCOM=0x%08x)\n",
      hash, (int) aXPCOMObject);
}

void*
GetMatchingXPCOMObject(JNIEnv* env, jobject aJavaObject)
{
  jint hash = env->CallIntMethod(aJavaObject, hashCodeMID);

  JavaXPCOMBindingEntry *entry =
    NS_STATIC_CAST(JavaXPCOMBindingEntry*,
                   PL_DHashTableOperate(gJAVAtoXPCOMBindings,
                                        NS_INT32_TO_PTR(hash),
                                        PL_DHASH_LOOKUP));

  if (PL_DHASH_ENTRY_IS_BUSY(entry)) {
    LOG("< Get Java<->XPCOM binding (Java=0x%08x | XPCOM=0x%08x)\n",
           hash, (int) entry->mXPCOMInstance);
    return entry->mXPCOMInstance;
  }

  return nsnull;
}

jobject
GetMatchingJavaObject(JNIEnv* env, void* aXPCOMObject)
{
  JavaXPCOMBindingEntry *entry =
    NS_STATIC_CAST(JavaXPCOMBindingEntry*,
                   PL_DHashTableOperate(gXPCOMtoJAVABindings, aXPCOMObject,
                                        PL_DHASH_LOOKUP));

  if (PL_DHASH_ENTRY_IS_BUSY(entry)) {
    LOG("< Get Java<->XPCOM binding (Java=0x%08x | XPCOM=0x%08x)\n",
        env->CallIntMethod(entry->mJavaObject, hashCodeMID), (int) aXPCOMObject);
    return entry->mJavaObject;
  }

  return nsnull;
}


/******************************
 *  InitializeJavaGlobals
 ******************************/
PRBool
InitializeJavaGlobals(JNIEnv *env)
{
  jclass clazz;
  if (!(clazz = env->FindClass("java/lang/Class")) ||
      !(classClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("java/lang/Object")) ||
      !(objectClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("java/lang/Boolean")) ||
      !(booleanClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[Z")) ||
      !(booleanArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("java/lang/Character")) ||
      !(charClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[C")) ||
      !(charArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Byte")) ||
      !(byteClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[B")) ||
      !(byteArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Short")) ||
      !(shortClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[[S")) ||
      !(shortArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Integer")) ||
      !(intClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[I")) ||
      !(intArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Long")) ||
      !(longClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[J")))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Float")) ||
      !(floatClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[F")) ||
      !(floatArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }
  if (!(clazz = env->FindClass("java/lang/Double")) ||
      !(doubleClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[D")) ||
      !(doubleArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("java/lang/String")) ||
      !(stringClass = (jclass) env->NewGlobalRef(clazz)) ||
      !(clazz = env->FindClass("[Ljava/lang/String;")) ||
      !(stringArrayClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("org/mozilla/xpcom/nsISupports")) ||
      !(nsISupportsClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(clazz = env->FindClass("java/lang/Exception")) ||
      !(exceptionClass = (jclass) env->NewGlobalRef(clazz)))
  {
      return PR_FALSE;
  }

  if (!(hashCodeMID = env->GetMethodID(objectClass, "hashCode","()I"))) {
      return PR_FALSE;
  }

  if (!(booleanInitMID = env->GetMethodID(booleanClass,"<init>","(Z)V"))) {
      return PR_FALSE;
  }
  if (!(booleanValueMID = env->GetMethodID(booleanClass,"booleanValue","()Z"))) {
      return PR_FALSE;
  }

  if (!(charInitMID = env->GetMethodID(charClass,"<init>","(C)V"))) {
      return PR_FALSE;
  }
  if (!(charValueMID = env->GetMethodID(charClass,"charValue","()C"))) {
      return PR_FALSE;
  }

  if (!(byteInitMID = env->GetMethodID(byteClass,"<init>","(B)V"))) {
      return PR_FALSE;
  }
  if (!(byteValueMID = env->GetMethodID(byteClass,"byteValue","()B"))) {
      return PR_FALSE;
  }
  if (!(shortInitMID = env->GetMethodID(shortClass,"<init>","(S)V"))) {
      return PR_FALSE;
  }
  if (!(shortValueMID = env->GetMethodID(shortClass,"shortValue","()S"))) {
      return PR_FALSE;
  }

  if (!(intInitMID = env->GetMethodID(intClass,"<init>","(I)V"))) {
      return PR_FALSE;
  }
  if (!(intValueMID = env->GetMethodID(intClass,"intValue","()I"))) {
      return PR_FALSE;
  }

  if (!(longInitMID = env->GetMethodID(longClass,"<init>","(J)V"))) {
      return PR_FALSE;
  }
  if (!(longValueMID = env->GetMethodID(longClass,"longValue","()J"))) {
      return PR_FALSE;
  }

  if (!(floatInitMID = env->GetMethodID(floatClass,"<init>","(F)V"))) {
      return PR_FALSE;
  }
  if (!(floatValueMID = env->GetMethodID(floatClass,"floatValue","()F"))) {
      return PR_FALSE;
  }

  if (!(doubleInitMID = env->GetMethodID(doubleClass,"<init>","(D)V"))) {
      return PR_FALSE;
  }
  if (!(doubleValueMID = env->GetMethodID(doubleClass,"doubleValue","()D"))) {
      return PR_FALSE;
  }

  if (!(getNameMID = env->GetMethodID(classClass, "getName","()Ljava/lang/String;"))) {
      return PR_FALSE;
  }

  static PLDHashTableOps java_to_xpcom_hash_ops =
  {
    PL_DHashAllocTable,
    PL_DHashFreeTable,
    PL_DHashGetKeyStub,
    PL_DHashVoidPtrKeyStub,
    PL_DHashMatchEntryStub,
    PL_DHashMoveEntryStub,
    PL_DHashClearEntryStub,
    PL_DHashFinalizeStub,
    InitJAVAtoXPCOMBindingEntry
  };

  gJAVAtoXPCOMBindings = PL_NewDHashTable(&java_to_xpcom_hash_ops, nsnull,
                                          sizeof(JavaXPCOMBindingEntry), 16);
  if (!gJAVAtoXPCOMBindings) {
    return PR_FALSE;
  }

  static PLDHashTableOps xpcom_to_java_hash_ops =
  {
    PL_DHashAllocTable,
    PL_DHashFreeTable,
    PL_DHashGetKeyStub,
    PL_DHashVoidPtrKeyStub,
    PL_DHashMatchEntryStub,
    PL_DHashMoveEntryStub,
    PL_DHashClearEntryStub,
    PL_DHashFinalizeStub,
    InitXPCOMtoJAVABindingEntry
  };

  gXPCOMtoJAVABindings = PL_NewDHashTable(&xpcom_to_java_hash_ops, nsnull,
                                          sizeof(JavaXPCOMBindingEntry), 16);
  if (!gXPCOMtoJAVABindings) {
    return PR_FALSE;
  }

  return PR_TRUE;
}

/*************************
 *    FreeJavaGlobals
 *************************/
void
FreeJavaGlobals(JNIEnv* env)
{
  // XXX Need to write
}


/**********************************************************
 *    JavaXPCOMInstance
 *********************************************************/
JavaXPCOMInstance*
CreateJavaXPCOMInstance(nsISupports* aXPCOMObject, const nsIID* aIID)
{
  JavaXPCOMInstance* inst = nsnull;

  // Get interface info for class
  nsCOMPtr<nsIInterfaceInfoManager> iim = XPTI_GetInterfaceInfoManager();
  NS_ASSERTION(iim != nsnull, "Failed to get InterfaceInfoManager");
  if (iim) {
    nsCOMPtr<nsIInterfaceInfo> info;
    iim->GetInfoForIID(aIID, getter_AddRefs(info));

    // Wrap XPCOM object
    inst = new JavaXPCOMInstance(aXPCOMObject, info);
    NS_ADDREF(aXPCOMObject);
  }

  return inst;
}


void
ThrowXPCOMException(JNIEnv* env, int aFailureCode)
{
  // only throw this exception if one hasn't already been thrown
  jthrowable throwObj = env->ExceptionOccurred();
  if (throwObj != nsnull) {
    char exp_msg[32];
    sprintf(exp_msg, "\nInternal Gecko Error: %x", aFailureCode);
    env->ThrowNew(exceptionClass, exp_msg);
  }
}

nsresult
GetIIDForMethodParam(nsIInterfaceInfo *iinfo,
                                         const nsXPTMethodInfo *methodInfo,
                                         const nsXPTParamInfo &paramInfo,
                                         PRUint16 methodIndex,
                                         nsXPTCMiniVariant *dispatchParams,
                                         PRBool isFullVariantArray,
                                         nsID &result)
{
  nsresult rv;

  switch (paramInfo.GetType().TagPart())
  {
    case nsXPTType::T_INTERFACE:
      rv = iinfo->GetIIDForParamNoAlloc(methodIndex, &paramInfo, &result);
      break;

    case nsXPTType::T_INTERFACE_IS:
    {
      PRUint8 argnum;
      rv = iinfo->GetInterfaceIsArgNumberForParam(methodIndex, &paramInfo, &argnum);
      if (NS_FAILED(rv))
        return rv;

      const nsXPTParamInfo& arg_param = methodInfo->GetParam(argnum);
      const nsXPTType& arg_type = arg_param.GetType();

      // The xpidl compiler ensures this. We reaffirm it for safety.
      if (!arg_type.IsPointer() || arg_type.TagPart() != nsXPTType::T_IID)
        return NS_ERROR_UNEXPECTED;

      nsID *p = nsnull;
      if (isFullVariantArray) {
        p = (nsID *) ((nsXPTCVariant*) dispatchParams)[argnum].val.p;
      } else {
        p = (nsID *) dispatchParams[argnum].val.p;
      }
      if (!p)
        return NS_ERROR_UNEXPECTED;

      result = *p;
      break;
    }

    default:
      rv = NS_ERROR_UNEXPECTED;
  }
  return rv;
}