js/src/liveconnect/jsj_JavaArray.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator client code, released
  17  * March 31, 1998.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1998
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 /*
  41  * This file is part of the Java-vendor-neutral implementation of LiveConnect
  42  *
  43  * It contains the definition of the JavaScript JavaArray class.
  44  * Instances of JavaArray are used to reflect Java arrays.
  45  */
  46
  47 #include <stdlib.h>
  48 #include <string.h>
  49
  50 #include "jsj_private.h"      /* LiveConnect internals */
  51
  52 /* Shorthands for ASCII (7-bit) decimal and hex conversion. */
  53 #define JS7_ISDEC(c)    (((c) >= '0') && ((c) <= '9'))
  54 #define JS7_UNDEC(c)    ((c) - '0')
  55
  56 /*
  57  * Convert any jsval v to an integer jsval if ToString(v)
  58  * contains a base-10 integer that fits into 31 bits.
  59  * Otherwise return v.
  60  */
  61 static jsval
  62 try_convert_to_jsint(JSContext *cx, jsval idval)
  63 {
  64     const jschar *cp;
  65     JSString *jsstr;
  66
  67     jsstr = JS_ValueToString(cx, idval);
  68     if (!jsstr)
  69         return idval;
  70
  71     cp = JS_GetStringChars(jsstr);
  72     if (JS7_ISDEC(*cp)) {
  73         jsuint index = JS7_UNDEC(*cp++);
  74         jsuint oldIndex = 0;
  75         jsuint c = 0;
  76         if (index != 0) {
  77             while (JS7_ISDEC(*cp)) {
  78                 oldIndex = index;
  79                 c = JS7_UNDEC(*cp);
  80                 index = 10*index + c;
  81                 cp++;
  82             }
  83         }
  84         if (*cp == 0 &&
  85             (oldIndex < (JSVAL_INT_MAX / 10) ||
  86             (oldIndex == (JSVAL_INT_MAX / 10) && c < (JSVAL_INT_MAX % 10)))) {
  87             return INT_TO_JSVAL(index);
  88         }
  89     }
  90     return idval;
  91 }
  92
  93
  94 static JSBool
  95 access_java_array_element(JSContext *cx,
  96                           JNIEnv *jEnv,
  97                           JSObject *obj,
  98                           jsid id,
  99                           jsval *vp,
 100                           JSBool do_assignment)
 101 {
 102     jsval idval;
 103     jarray java_array;
 104     JavaClassDescriptor *class_descriptor;
 105     JavaObjectWrapper *java_wrapper;
 106     jsize array_length, index;
 107     JavaSignature *array_component_signature;
 108
 109     /* printf("In JavaArray_getProperty\n"); */
 110
 111     java_wrapper = JS_GetPrivate(cx, obj);
 112     if (!java_wrapper) {
 113         const char *property_name;
 114         if (JS_IdToValue(cx, id, &idval) && JSVAL_IS_STRING(idval) &&
 115             (property_name = JS_GetStringBytes(JSVAL_TO_STRING(idval))) != NULL) {
 116             if (!strcmp(property_name, "constructor")) {
 117                 if (vp)
 118                     *vp = JSVAL_VOID;
 119                 return JS_TRUE;
 120             }
 121         }
 122         JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 123                                                 JSJMSG_BAD_OP_JARRAY);
 124         return JS_FALSE;
 125     }
 126     class_descriptor = java_wrapper->class_descriptor;
 127     java_array = java_wrapper->java_obj;
 128
 129     JS_ASSERT(class_descriptor->type == JAVA_SIGNATURE_ARRAY);
 130
 131     JS_IdToValue(cx, id, &idval);
 132
 133     if (!JSVAL_IS_INT(idval))
 134         idval = try_convert_to_jsint(cx, idval);
 135
 136     if (!JSVAL_IS_INT(idval)) {
 137         /*
 138          * Usually, properties of JavaArray objects are indexed by integers, but
 139          * Java arrays also inherit all the methods of java.lang.Object, so a
 140          * string-valued property is also possible.
 141          */
 142         if (JSVAL_IS_STRING(idval)) {
 143             const char *member_name;
 144
 145             member_name = JS_GetStringBytes(JSVAL_TO_STRING(idval));
 146
 147             if (do_assignment) {
 148                 JSVersion version = JS_GetVersion(cx);
 149
 150                 if (!JSVERSION_IS_ECMA(version)) {
 151
 152                     JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 153                                         JSJMSG_CANT_WRITE_JARRAY, member_name);
 154                     return JS_FALSE;
 155                 } else {
 156                     if (vp)
 157                         *vp = JSVAL_VOID;
 158                     return JS_TRUE;
 159                 }
 160             } else {
 161                 if (!strcmp(member_name, "length")) {
 162                     array_length = jsj_GetJavaArrayLength(cx, jEnv, java_array);
 163                     if (array_length < 0)
 164                         return JS_FALSE;
 165                     if (vp)
 166                         *vp = INT_TO_JSVAL(array_length);
 167                     return JS_TRUE;
 168                 }
 169
 170                 /* Check to see if we're reflecting a Java array method */
 171                 return JavaObject_getPropertyById(cx, obj, id, vp);
 172             }
 173         }
 174
 175         JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 176                                             JSJMSG_BAD_INDEX_EXPR);
 177         return JS_FALSE;
 178     }
 179
 180     index = JSVAL_TO_INT(idval);
 181
 182 #if 0
 183     array_length = jsj_GetJavaArrayLength(cx, jEnv, java_array);
 184     if (array_length < 0)
 185         return JS_FALSE;
 186
 187     /* Just let Java throw an exception instead of checking array bounds here */
 188     if (index < 0 || index >= array_length) {
 189         char numBuf[12];
 190         sprintf(numBuf, "%d", index);
 191         JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 192                                             JSJMSG_BAD_JARRAY_INDEX, numBuf);
 193         return JS_FALSE;
 194     }
 195 #endif
 196
 197     array_component_signature = class_descriptor->array_component_signature;
 198
 199     if (!vp)
 200         return JS_TRUE;
 201
 202     if (do_assignment) {
 203         return jsj_SetJavaArrayElement(cx, jEnv, java_array, index,
 204                                        array_component_signature, *vp);
 205     } else {
 206         return jsj_GetJavaArrayElement(cx, jEnv, java_array, index,
 207                                        array_component_signature, vp);
 208     }
 209 }
 210
 211 static JSBool
 212 JavaArray_getPropertyById(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
 213 {
 214     JNIEnv *jEnv;
 215     JSJavaThreadState *jsj_env;
 216     JSBool result;
 217
 218     jsj_env = jsj_EnterJava(cx, &jEnv);
 219     if (!jEnv)
 220         return JS_FALSE;
 221     result = access_java_array_element(cx, jEnv, obj, id, vp, JS_FALSE);
 222     jsj_ExitJava(jsj_env);
 223     return result;
 224 }
 225
 226 static JSBool
 227 JavaArray_setPropertyById(JSContext *cx, JSObject *obj, jsval id, jsval *vp)
 228 {
 229     JNIEnv *jEnv;
 230     JSJavaThreadState *jsj_env;
 231     JSBool result;
 232
 233     jsj_env = jsj_EnterJava(cx, &jEnv);
 234     if (!jEnv)
 235         return JS_FALSE;
 236     result = access_java_array_element(cx, jEnv, obj, id, vp, JS_TRUE);
 237     jsj_ExitJava(jsj_env);
 238     return result;
 239 }
 240
 241 static JSBool
 242 JavaArray_lookupProperty(JSContext *cx, JSObject *obj, jsid id,
 243                          JSObject **objp, JSProperty **propp)
 244 {
 245     JNIEnv *jEnv;
 246     JSErrorReporter old_reporter;
 247     JSJavaThreadState *jsj_env;
 248
 249     jsj_env = jsj_EnterJava(cx, &jEnv);
 250     if (!jEnv)
 251         return JS_FALSE;
 252
 253     old_reporter = JS_SetErrorReporter(cx, NULL);
 254     if (access_java_array_element(cx, jEnv, obj, id, NULL, JS_FALSE)) {
 255         *objp = obj;
 256         *propp = (JSProperty*)1;
 257     } else {
 258         *objp = NULL;
 259         *propp = NULL;
 260     }
 261     JS_SetErrorReporter(cx, old_reporter);
 262     jsj_ExitJava(jsj_env);
 263     return JS_TRUE;
 264 }
 265
 266 static JSBool
 267 JavaArray_defineProperty(JSContext *cx, JSObject *obj, jsid id, jsval value,
 268                          JSPropertyOp getter, JSPropertyOp setter,
 269                          uintN attrs, JSProperty **propp)
 270 {
 271     jsval *vp = &value;
 272     if (propp)
 273         return JS_FALSE;
 274     if (attrs & ~(JSPROP_PERMANENT|JSPROP_ENUMERATE))
 275         return JS_FALSE;
 276
 277     return JavaArray_setPropertyById(cx, obj, id, vp);
 278 }
 279
 280 static JSBool
 281 JavaArray_getAttributes(JSContext *cx, JSObject *obj, jsid id,
 282                         JSProperty *prop, uintN *attrsp)
 283 {
 284     /* We don't maintain JS property attributes for Java class members */
 285     *attrsp = JSPROP_PERMANENT|JSPROP_ENUMERATE;
 286     return JS_FALSE;
 287 }
 288
 289 static JSBool
 290 JavaArray_setAttributes(JSContext *cx, JSObject *obj, jsid id,
 291                         JSProperty *prop, uintN *attrsp)
 292 {
 293     /* We don't maintain JS property attributes for Java class members */
 294     if (*attrsp != (JSPROP_PERMANENT|JSPROP_ENUMERATE)) {
 295         JS_ASSERT(0);
 296         return JS_FALSE;
 297     }
 298
 299     /* Silently ignore all setAttribute attempts */
 300     return JS_TRUE;
 301 }
 302
 303 static JSBool
 304 JavaArray_deleteProperty(JSContext *cx, JSObject *obj, jsid id, jsval *vp)
 305 {
 306     JSVersion version = JS_GetVersion(cx);
 307
 308     *vp = JSVAL_FALSE;
 309
 310     if (!JSVERSION_IS_ECMA(version)) {
 311         JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 312                                             JSJMSG_JARRAY_PROP_DELETE);
 313         return JS_FALSE;
 314     } else {
 315         /* Attempts to delete permanent properties are silently ignored
 316            by ECMAScript. */
 317         return JS_TRUE;
 318     }
 319 }
 320
 321 static JSBool
 322 JavaArray_defaultValue(JSContext *cx, JSObject *obj, JSType type, jsval *vp)
 323 {
 324     /* printf("In JavaArray_defaultValue()\n"); */
 325     return JavaObject_convert(cx, obj, JSTYPE_STRING, vp);
 326 }
 327
 328 static JSBool
 329 JavaArray_newEnumerate(JSContext *cx, JSObject *obj, JSIterateOp enum_op,
 330                        jsval *statep, jsid *idp)
 331 {
 332     JavaObjectWrapper *java_wrapper;
 333     JSJavaThreadState *jsj_env;
 334     JNIEnv *jEnv;
 335     jsize array_length, index;
 336     JSBool ok = JS_TRUE;
 337
 338     java_wrapper = JS_GetPrivate(cx, obj);
 339     /* Check for prototype object */
 340     if (!java_wrapper) {
 341         *statep = JSVAL_NULL;
 342         if (idp)
 343             *idp = INT_TO_JSVAL(0);
 344         return JS_TRUE;
 345     }
 346
 347     /* Get the Java per-thread environment pointer for this JSContext */
 348     jsj_env = jsj_EnterJava(cx, &jEnv);
 349     if (!jEnv)
 350         return JS_FALSE;
 351
 352     array_length = jsj_GetJavaArrayLength(cx, jEnv, java_wrapper->java_obj);
 353     if (array_length < 0) {
 354         jsj_ExitJava(jsj_env);
 355         return JS_FALSE;
 356     }
 357
 358     switch(enum_op) {
 359     case JSENUMERATE_INIT:
 360         *statep = INT_TO_JSVAL(0);
 361
 362         if (idp)
 363             *idp = INT_TO_JSVAL(array_length);
 364         break;
 365
 366     case JSENUMERATE_NEXT:
 367         index = JSVAL_TO_INT(*statep);
 368         if (index < array_length) {
 369             JS_ValueToId(cx, INT_TO_JSVAL(index), idp);
 370             index++;
 371             *statep = INT_TO_JSVAL(index);
 372             break;
 373         }
 374
 375         /* Fall through ... */
 376
 377     case JSENUMERATE_DESTROY:
 378         *statep = JSVAL_NULL;
 379         break;
 380
 381     default:
 382         JS_ASSERT(0);
 383         ok = JS_FALSE;
 384         break;
 385     }
 386
 387     jsj_ExitJava(jsj_env);
 388     return ok;
 389 }
 390
 391 static JSBool
 392 JavaArray_checkAccess(JSContext *cx, JSObject *obj, jsid id,
 393                       JSAccessMode mode, jsval *vp, uintN *attrsp)
 394 {
 395     switch (mode) {
 396     case JSACC_WATCH:
 397         JS_ReportErrorNumber(cx, jsj_GetErrorMessage, NULL,
 398                                             JSJMSG_JARRAY_PROP_WATCH);
 399         return JS_FALSE;
 400
 401     default:
 402         return JS_TRUE;
 403     }
 404 }
 405
 406 JSObjectOps JavaArray_ops = {
 407     /* Mandatory non-null function pointer members. */
 408     jsj_wrapper_newObjectMap,       /* newObjectMap */
 409     jsj_wrapper_destroyObjectMap,   /* destroyObjectMap */
 410     JavaArray_lookupProperty,
 411     JavaArray_defineProperty,
 412     JavaArray_getPropertyById,      /* getProperty */
 413     JavaArray_setPropertyById,      /* setProperty */
 414     JavaArray_getAttributes,
 415     JavaArray_setAttributes,
 416     JavaArray_deleteProperty,
 417     JavaArray_defaultValue,
 418     JavaArray_newEnumerate,
 419     JavaArray_checkAccess,
 420
 421     /* Optionally non-null members start here. */
 422     NULL,                           /* thisObject */
 423     NULL,                           /* dropProperty */
 424     NULL,                           /* call */
 425     NULL,                           /* construct */
 426     NULL,                           /* xdrObject */
 427     NULL,                           /* hasInstance */
 428     NULL,                           /* setProto */
 429     NULL,                           /* setParent */
 430     NULL,                           /* mark */
 431     NULL,                           /* clear */
 432     jsj_wrapper_getRequiredSlot,    /* getRequiredSlot */
 433     jsj_wrapper_setRequiredSlot     /* setRequiredSlot */
 434 };
 435
 436 static JSObjectOps *
 437 JavaArray_getObjectOps(JSContext *cx, JSClass *clazz)
 438 {
 439     return &JavaArray_ops;
 440 }
 441
 442 JSClass JavaArray_class = {
 443     "JavaArray", JSCLASS_HAS_PRIVATE,
 444     NULL, NULL, NULL, NULL,
 445     NULL, NULL, JavaObject_convert, JavaObject_finalize,
 446
 447     /* Optionally non-null members start here. */
 448     JavaArray_getObjectOps,
 449     NULL,
 450     NULL,
 451     NULL,
 452     NULL,
 453     NULL,
 454     NULL,
 455     0,
 456 };
 457
 458 extern JS_IMPORT_DATA(JSObjectOps) js_ObjectOps;
 459
 460
 461 /* Initialize the JS JavaArray class */
 462 JSBool
 463 jsj_init_JavaArray(JSContext *cx, JSObject *global_obj)
 464 {
 465     if (!JS_InitClass(cx, global_obj,
 466         0, &JavaArray_class, 0, 0,
 467         0, 0, 0, 0))
 468         return JS_FALSE;
 469
 470     return JS_TRUE;
 471 }
 472