np_sdk/mozsrc/jritypes.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: NPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Netscape Public License
   6  * Version 1.1 (the "License"); you may not use this file except in
   7  * compliance with the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/NPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the NPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the NPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /*******************************************************************************
  39  * Java Runtime Interface
  40  ******************************************************************************/
  41
  42 #ifndef JRITYPES_H
  43 #define JRITYPES_H
  44
  45 #include "jri_md.h"
  46 #include <stddef.h>
  47 #include <stdlib.h>
  48 #include <stdarg.h>
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 /*******************************************************************************
  55  * Types
  56  ******************************************************************************/
  57
  58 struct JRIEnvInterface;
  59
  60 typedef void*           JRIRef;
  61 typedef void*           JRIGlobalRef;
  62
  63 typedef jint            JRIFieldID;
  64 typedef jint            JRIMethodID;
  65
  66 /* synonyms: */
  67 typedef JRIGlobalRef    jglobal;
  68
  69 typedef union JRIValue {
  70     jbool                       z;
  71     jbyte                       b;
  72     jchar                       c;
  73     jshort                      s;
  74     jint                        i;
  75     jlong                       l;
  76     jfloat                      f;
  77     jdouble                     d;
  78     jref                        r;
  79 } JRIValue;
  80
  81 typedef enum JRIBoolean {
  82     JRIFalse            = 0,
  83     JRITrue                     = 1
  84 } JRIBoolean;
  85
  86 typedef enum JRIConstant {
  87     JRIUninitialized    = -1
  88 } JRIConstant;
  89
  90 /* convenience types (these must be distinct struct types for c++ overloading): */
  91 #if 0   /* now in jni.h */
  92 typedef struct jbooleanArrayStruct*             jbooleanArray;
  93 typedef struct jbyteArrayStruct*                jbyteArray;
  94 typedef struct jcharArrayStruct*                jcharArray;
  95 typedef struct jshortArrayStruct*               jshortArray;
  96 typedef struct jintArrayStruct*                 jintArray;
  97 typedef struct jlongArrayStruct*                jlongArray;
  98 typedef struct jfloatArrayStruct*               jfloatArray;
  99 typedef struct jdoubleArrayStruct*              jdoubleArray;
 100 typedef struct jobjectArrayStruct*              jobjectArray;
 101 #endif
 102 typedef struct jstringArrayStruct*              jstringArray;
 103 typedef struct jarrayArrayStruct*               jarrayArray;
 104
 105 #define JRIConstructorMethodName        "<init>"
 106
 107 /*******************************************************************************
 108  * Signature Construction Macros
 109  ******************************************************************************/
 110
 111 /*
 112 ** These macros can be used to construct signature strings. Hopefully their names
 113 ** are a little easier to remember than the single character they correspond to.
 114 ** For example, to specify the signature of the method:
 115 **
 116 **      public int read(byte b[], int off, int len);
 117 **
 118 ** you could write something like this in C:
 119 **
 120 **      char* readSig = JRISigMethod(JRISigArray(JRISigByte)
 121 **                                                               JRISigInt
 122 **                                                               JRISigInt) JRISigInt;
 123 **
 124 ** Of course, don't put commas between the types.
 125 */
 126 #define JRISigArray(T)          "[" T
 127 #define JRISigByte                      "B"
 128 #define JRISigChar                      "C"
 129 #define JRISigClass(name)       "L" name ";"
 130 #define JRISigFloat                     "F"
 131 #define JRISigDouble            "D"
 132 #define JRISigMethod(args)      "(" args ")"
 133 #define JRISigNoArgs            ""
 134 #define JRISigInt                       "I"
 135 #define JRISigLong                      "J"
 136 #define JRISigShort                     "S"
 137 #define JRISigVoid                      "V"
 138 #define JRISigBoolean           "Z"
 139
 140 /*******************************************************************************
 141  * Environments
 142  ******************************************************************************/
 143
 144 extern JRI_PUBLIC_API(const struct JRIEnvInterface**)
 145 JRI_GetCurrentEnv(void);
 146
 147 /*******************************************************************************
 148  * Specific Scalar Array Types
 149  ******************************************************************************/
 150
 151 /*
 152 ** The JRI Native Method Interface does not support boolean arrays. This
 153 ** is to allow Java runtime implementations to optimize boolean array
 154 ** storage. Using the ScalarArray operations on boolean arrays is bound
 155 ** to fail, so convert any boolean arrays to byte arrays in Java before
 156 ** passing them to a native method.
 157 */
 158
 159 #define JRI_NewByteArray(env, length, initialValues)    \
 160     JRI_NewScalarArray(env, length, JRISigByte, (jbyte*)(initialValues))
 161 #define JRI_GetByteArrayLength(env, array)      \
 162     JRI_GetScalarArrayLength(env, array)
 163 #define JRI_GetByteArrayElements(env, array)    \
 164     JRI_GetScalarArrayElements(env, array)
 165
 166 #define JRI_NewCharArray(env, length, initialValues)    \
 167     JRI_NewScalarArray(env, ((length) * sizeof(jchar)), JRISigChar, (jbyte*)(initialValues))
 168 #define JRI_GetCharArrayLength(env, array)      \
 169     JRI_GetScalarArrayLength(env, array)
 170 #define JRI_GetCharArrayElements(env, array)               \
 171     ((jchar*)JRI_GetScalarArrayElements(env, array))
 172
 173 #define JRI_NewShortArray(env, length, initialValues)   \
 174     JRI_NewScalarArray(env, ((length) * sizeof(jshort)), JRISigShort, (jbyte*)(initialValues))
 175 #define JRI_GetShortArrayLength(env, array)     \
 176     JRI_GetScalarArrayLength(env, array)
 177 #define JRI_GetShortArrayElements(env, array)              \
 178     ((jshort*)JRI_GetScalarArrayElements(env, array))
 179
 180 #define JRI_NewIntArray(env, length, initialValues)     \
 181     JRI_NewScalarArray(env, ((length) * sizeof(jint)), JRISigInt, (jbyte*)(initialValues))
 182 #define JRI_GetIntArrayLength(env, array)       \
 183     JRI_GetScalarArrayLength(env, array)
 184 #define JRI_GetIntArrayElements(env, array)                \
 185     ((jint*)JRI_GetScalarArrayElements(env, array))
 186
 187 #define JRI_NewLongArray(env, length, initialValues)    \
 188     JRI_NewScalarArray(env, ((length) * sizeof(jlong)), JRISigLong, (jbyte*)(initialValues))
 189 #define JRI_GetLongArrayLength(env, array)      \
 190     JRI_GetScalarArrayLength(env, array)
 191 #define JRI_GetLongArrayElements(env, array)               \
 192     ((jlong*)JRI_GetScalarArrayElements(env, array))
 193
 194 #define JRI_NewFloatArray(env, length, initialValues)   \
 195     JRI_NewScalarArray(env, ((length) * sizeof(jfloat)), JRISigFloat, (jbyte*)(initialValues))
 196 #define JRI_GetFloatArrayLength(env, array)     \
 197     JRI_GetScalarArrayLength(env, array)
 198 #define JRI_GetFloatArrayElements(env, array)              \
 199     ((jfloat*)JRI_GetScalarArrayElements(env, array))
 200
 201 #define JRI_NewDoubleArray(env, length, initialValues)  \
 202     JRI_NewScalarArray(env, ((length) * sizeof(jdouble)), JRISigDouble, (jbyte*)(initialValues))
 203 #define JRI_GetDoubleArrayLength(env, array)    \
 204     JRI_GetScalarArrayLength(env, array)
 205 #define JRI_GetDoubleArrayElements(env, array)             \
 206     ((jdouble*)JRI_GetScalarArrayElements(env, array))
 207
 208 /******************************************************************************/
 209 /*
 210 ** JDK Stuff -- This stuff is still needed while we're using the JDK
 211 ** dynamic linking strategy to call native methods.
 212 */
 213
 214 typedef union JRI_JDK_stack_item {
 215     /* Non pointer items */
 216     jint           i;
 217     jfloat         f;
 218     jint           o;
 219     /* Pointer items */
 220     void          *h;
 221     void          *p;
 222     unsigned char *addr;
 223 #ifdef IS_64
 224     double         d;
 225     long           l;           /* == 64bits! */
 226 #endif
 227 } JRI_JDK_stack_item;
 228
 229 typedef union JRI_JDK_Java8Str {
 230     jint x[2];
 231     jdouble d;
 232     jlong l;
 233     void *p;
 234     float f;
 235 } JRI_JDK_Java8;
 236
 237 /******************************************************************************/
 238 #ifdef __cplusplus
 239 }
 240 #endif
 241 #endif /* JRITYPES_H */
 242 /******************************************************************************/