JavaContext.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_JavaContext_hxx
#define __ccxx_JavaContext_hxx

#include <commonc++/Common.h++>
#include <commonc++/Exception.h++>
#include <commonc++/String.h++>
#include <commonc++/JavaException.h++>

#include <jni.h>
#include <cstdarg>

namespace ccxx {

class JavaVirtualMachine; // fwd decl

struct JavaNativeMethod
{
  String signature;

  void *function;
};

class COMMONCPPJVM_API JavaContext
{
  friend class JavaVirtualMachine;

  public:

  JavaContext(JNIEnv *env);

  ~JavaContext();

  static String encodeType(const String &type);

  static bool parseSignature(const String &signature, String& method,
                             String& descriptor, bool &isStatic);

  jclass findClass(const String &name) throw(JavaException);

  jmethodID findMethod(jclass clazz, const String &signature)
    throw(JavaException);

  jobject createObject(jclass clazz, jmethodID constructor, ...)
    throw(JavaException);

  jobject createObjectVA(jclass clazz, jmethodID constructor, va_list args)
    throw(JavaException);

  void callVoidMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  jobject callObjectMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  String callStringMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  WString callWStringMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  bool callBooleanMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  byte_t callByteMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  char16_t callCharMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  int16_t callShortMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  int32_t callIntMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  int64_t callLongMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  float callFloatMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  double callDoubleMethod(jobject object, jmethodID method, ...)
    throw(JavaException);

  void callNonvirtualVoidMethod(jobject object, jclass clazz,
                                jmethodID method, ...)
    throw(JavaException);

  jobject callNonvirtualObjectMethod(jobject object, jclass clazz,
                                     jmethodID method, ...)
    throw(JavaException);

  bool callNonvirtualBooleanMethod(jobject object, jclass clazz,
                                   jmethodID method, ...)
    throw(JavaException);

  byte_t callNonvirtualByteMethod(jobject object, jclass clazz,
                                  jmethodID method, ...)
    throw(JavaException);

  char16_t callNonvirtualCharMethod(jobject object, jclass clazz,
                                    jmethodID method, ...)
    throw(JavaException);

  int16_t callNonvirtualShortMethod(jobject object, jclass clazz,
                                    jmethodID method, ...)
    throw(JavaException);

  int32_t callNonvirtualIntMethod(jobject object, jclass clazz,
                                  jmethodID method, ...)
    throw(JavaException);

  int64_t callNonvirtualLongMethod(jobject object, jclass clazz,
                                   jmethodID method, ...)
    throw(JavaException);

  float callNonvirtualFloatMethod(jobject object, jclass clazz,
                                  jmethodID method, ...)
    throw(JavaException);

  double callNonvirtualDoubleMethod(jobject object, jclass clazz,
                                    jmethodID method, ...)
    throw(JavaException);

  void callStaticVoidMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  jobject callStaticObjectMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  String callStaticStringMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  WString callStaticWStringMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  bool callStaticBooleanMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  byte_t callStaticByteMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  char16_t callStaticCharMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  int16_t callStaticShortMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  int32_t callStaticIntMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  int64_t callStaticLongMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  float callStaticFloatMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  double callStaticDoubleMethod(jclass clazz, jmethodID method, ...)
    throw(JavaException);

  bool checkException(bool verbose = false);

  void clearException() throw();

  jthrowable getException() throw();

  bool throwException(jclass exception, const String &message);

  jfieldID findField(jclass clazz, const String &signature)
    throw(JavaException);

  jobject getObjectField(jobject object, jfieldID field) throw(JavaException);

  bool getBooleanField(jobject object, jfieldID field) throw(JavaException);

  byte_t getByteField(jobject object, jfieldID field) throw(JavaException);

  char16_t getCharField(jobject object, jfieldID field) throw(JavaException);

  int16_t getShortField(jobject object, jfieldID field) throw(JavaException);

  int32_t getIntField(jobject object, jfieldID field) throw(JavaException);

  int64_t getLongField(jobject object, jfieldID field) throw(JavaException);

  float getFloatField(jobject object, jfieldID field) throw(JavaException);

  double getDoubleField(jobject object, jfieldID field) throw(JavaException);

  String getStringField(jobject object, jfieldID field) throw(JavaException);

  WString getWStringField(jobject object, jfieldID field) throw(JavaException);

  jobject getStaticObjectField(jclass clazz, jfieldID field)
    throw(JavaException);

  bool getStaticBooleanField(jclass clazz, jfieldID field)
    throw(JavaException);

  byte_t getStaticByteField(jclass clazz, jfieldID field) throw(JavaException);

  char16_t getStaticCharField(jclass clazz, jfieldID field)
    throw(JavaException);

  int16_t getStaticShortField(jclass clazz, jfieldID field)
    throw(JavaException);

  int32_t getStaticIntField(jclass clazz, jfieldID field) throw(JavaException);

  int64_t getStaticLongField(jclass clazz, jfieldID field)
    throw(JavaException);

  float getStaticFloatField(jclass clazz, jfieldID field)
    throw(JavaException);

  double getStaticDoubleField(jclass clazz, jfieldID field)
    throw(JavaException);

  String getStaticStringField(jclass clazz, jfieldID field)
    throw(JavaException);

  WString getStaticWStringField(jclass clazz, jfieldID field)
    throw(JavaException);

  void setObjectField(jobject object, jfieldID field, jobject value)
    throw(JavaException);

  void setBooleanField(jobject object, jfieldID field, bool value)
    throw(JavaException);

  void setByteField(jobject object, jfieldID field, byte_t value)
    throw(JavaException);

  void setCharField(jobject object, jfieldID field, char16_t value)
    throw(JavaException);

  void setShortField(jobject object, jfieldID field, int16_t value)
    throw(JavaException);

  void setIntField(jobject object, jfieldID field, int32_t value)
    throw(JavaException);

  void setLongField(jobject object, jfieldID field, int64_t value)
    throw(JavaException);

  void setFloatField(jobject object, jfieldID field, float value)
    throw(JavaException);

  void setDoubleField(jobject object, jfieldID field, double value)
    throw(JavaException);

  void setStringField(jobject object, jfieldID field, const String &value)
    throw(JavaException);

  void setWStringField(jobject object, jfieldID field, const WString &value)
    throw(JavaException);

  void setStaticObjectField(jclass clazz, jfieldID field, jobject value)
    throw(JavaException);

  void setStaticBooleanField(jclass clazz, jfieldID field, bool value)
    throw(JavaException);

  void setStaticByteField(jclass clazz, jfieldID field, byte_t value)
    throw(JavaException);

  void setStaticCharField(jclass clazz, jfieldID field, char16_t value)
    throw(JavaException);

  void setStaticShortField(jclass clazz, jfieldID field, int16_t value)
    throw(JavaException);

  void setStaticIntField(jclass clazz, jfieldID field, int32_t value)
    throw(JavaException);

  void setStaticLongField(jclass clazz, jfieldID field, int64_t value)
    throw(JavaException);

  void setStaticFloatField(jclass clazz, jfieldID field, float value)
    throw(JavaException);

  void setStaticDoubleField(jclass clazz, jfieldID field, double value)
    throw(JavaException);

  jbyteArray createByteArray(uint_t length)
    throw(JavaException);

  void setObjectArrayElement(jobjectArray array, uint_t index, jobject value)
    throw(JavaException);

  jobject getObjectArrayElement(jobjectArray array, uint_t index)
    throw(JavaException);

  uint_t getArrayLength(jarray array) throw(JavaException);

  jobject createDirectByteBuffer(byte_t *buf, size_t size)
    throw(JavaException);

  void *getDirectBufferRegion(jobject buf, uint64_t &size);

  jobject createLocalRef(jobject object) throw(JavaException);

  void deleteLocalRef(jobject ref);

  void ensureLocalCapacity(uint_t capacity) throw(JavaException);

  jobject createGlobalRef(jobject object) throw(JavaException);

  void deleteGlobalRef(jobject ref);

  String decodeString(jstring str) throw(JavaException);

  WString decodeWString(jstring str) throw(JavaException);

  jstring encodeString(const String &str) throw(JavaException);

  jstring encodeWString(const WString &str) throw(JavaException);

  uint_t getStringLength(jstring str);

  void *getArrayData(jarray array, uint_t &length, bool *isCopy = NULL)
    throw(JavaException);

  void releaseArrayData(jarray array, void *data);

  jbyteArray createByteArray(const byte_t *data, size_t length)
    throw(JavaException);

  jarray createObjectArray(jclass type, uint_t length,
                           jobject initialValue = NULL)
    throw(JavaException);

  bool isSameObject(jobject object1, jobject object2);

  bool isInstanceOf(jobject object, jclass clazz);

  bool isAssignableFrom(jclass clazz1, jclass clazz2);

  jclass getClassForObject(jobject object);

  jclass getSuperclass(jclass clazz);

  void enterMonitor(jobject object) throw(JavaException);

  void exitMonitor(jobject object) throw(JavaException);

  void registerNativeMethods(jclass clazz, const JavaNativeMethod methods[])
    throw(JavaException);

  void unregisterNativeMethods(jclass clazz);

  void pushLocalFrame(uint_t capacity = 8) throw(JavaException);

  void popLocalFrame();

  inline bool isVerbose() const throw()
  { return(_verbose); }

  private:

  void attach(JavaVirtualMachine *jvm, JNIEnv* env, bool verbose) throw();
  void detach() throw();
  inline bool isAttached() const throw()
  { return(_env != NULL); }

  inline JNIEnv *getEnv() const throw()
  { return(_env); }

  JavaVirtualMachine *_jvm;
  JNIEnv *_env;
  bool _verbose;
};

}; // namespace ccxx

#endif // __ccxx_JavaContext_hxx

/* end of header file */