2007-03-22 10:30:00 -07:00
|
|
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
|
|
*
|
|
|
|
* ***** 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 Mozilla Communicator client code, released
|
|
|
|
* March 31, 1998.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* Netscape Communications Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either of 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 ***** */
|
|
|
|
|
|
|
|
#ifndef jsarray_h___
|
|
|
|
#define jsarray_h___
|
|
|
|
/*
|
|
|
|
* JS Array interface.
|
|
|
|
*/
|
|
|
|
#include "jsprvtd.h"
|
|
|
|
#include "jspubtd.h"
|
2009-02-21 13:33:50 -08:00
|
|
|
#include "jsobj.h"
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2009-02-23 15:31:02 -08:00
|
|
|
#define ARRAY_CAPACITY_MIN 7
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
extern JSBool
|
2010-07-14 23:19:36 -07:00
|
|
|
js_StringIsIndex(JSString *str, jsuint *indexp);
|
|
|
|
|
|
|
|
inline JSBool
|
|
|
|
js_IdIsIndex(jsid id, jsuint *indexp)
|
|
|
|
{
|
|
|
|
if (JSID_IS_INT(id)) {
|
|
|
|
jsint i;
|
|
|
|
i = JSID_TO_INT(id);
|
|
|
|
if (i < 0)
|
|
|
|
return JS_FALSE;
|
|
|
|
*indexp = (jsuint)i;
|
|
|
|
return JS_TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (JS_UNLIKELY(!JSID_IS_STRING(id)))
|
|
|
|
return JS_FALSE;
|
|
|
|
|
|
|
|
return js_StringIsIndex(JSID_TO_STRING(id), indexp);
|
|
|
|
}
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2010-07-14 23:19:36 -07:00
|
|
|
/* XML really wants to pretend jsvals are jsids. */
|
|
|
|
inline JSBool
|
|
|
|
js_IdValIsIndex(jsval id, jsuint *indexp)
|
|
|
|
{
|
|
|
|
if (JSVAL_IS_INT(id)) {
|
|
|
|
jsint i;
|
|
|
|
i = JSVAL_TO_INT(id);
|
|
|
|
if (i < 0)
|
|
|
|
return JS_FALSE;
|
|
|
|
*indexp = (jsuint)i;
|
|
|
|
return JS_TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!JSVAL_IS_STRING(id))
|
|
|
|
return JS_FALSE;
|
|
|
|
|
|
|
|
return js_StringIsIndex(JSVAL_TO_STRING(id), indexp);
|
|
|
|
}
|
|
|
|
|
|
|
|
extern js::Class js_ArrayClass, js_SlowArrayClass;
|
2008-02-18 13:01:47 -08:00
|
|
|
|
2009-12-30 13:49:26 -08:00
|
|
|
inline bool
|
|
|
|
JSObject::isDenseArray() const
|
2009-06-11 07:35:41 -07:00
|
|
|
{
|
2009-12-30 13:49:26 -08:00
|
|
|
return getClass() == &js_ArrayClass;
|
2009-06-11 07:35:41 -07:00
|
|
|
}
|
|
|
|
|
2010-04-05 18:32:16 -07:00
|
|
|
inline bool
|
|
|
|
JSObject::isSlowArray() const
|
|
|
|
{
|
|
|
|
return getClass() == &js_SlowArrayClass;
|
|
|
|
}
|
|
|
|
|
2009-12-30 13:49:26 -08:00
|
|
|
inline bool
|
|
|
|
JSObject::isArray() const
|
|
|
|
{
|
2010-04-05 18:32:16 -07:00
|
|
|
return isDenseArray() || isSlowArray();
|
2009-12-30 13:49:26 -08:00
|
|
|
}
|
2008-02-18 23:04:00 -08:00
|
|
|
|
2009-03-09 11:25:43 -07:00
|
|
|
/*
|
2010-03-31 22:13:51 -07:00
|
|
|
* Dense arrays are not native -- aobj->isNative() for a dense array aobj
|
2010-08-29 11:57:08 -07:00
|
|
|
* results in false, meaning aobj->map does not point to a js::Shape.
|
2009-03-09 11:25:43 -07:00
|
|
|
*
|
|
|
|
* But Array methods are called via aobj.sort(), e.g., and the interpreter and
|
|
|
|
* the trace recorder must consult the property cache in order to perform well.
|
|
|
|
* The cache works only for native objects.
|
|
|
|
*
|
|
|
|
* Therefore the interpreter (js_Interpret in JSOP_GETPROP and JSOP_CALLPROP)
|
|
|
|
* and js_GetPropertyHelper use this inline function to skip up one link in the
|
2009-04-05 21:17:22 -07:00
|
|
|
* prototype chain when obj is a dense array, in order to find a native object
|
|
|
|
* (to wit, Array.prototype) in which to probe for cached methods.
|
|
|
|
*
|
|
|
|
* Note that setting aobj.__proto__ for a dense array aobj turns aobj into a
|
|
|
|
* slow array, avoiding the neede to skip.
|
2009-03-09 11:25:43 -07:00
|
|
|
*
|
|
|
|
* Callers of js_GetProtoIfDenseArray must take care to use the original object
|
|
|
|
* (obj) for the |this| value of a getter, setter, or method call (bug 476447).
|
|
|
|
*/
|
|
|
|
static JS_INLINE JSObject *
|
2010-03-04 20:44:09 -08:00
|
|
|
js_GetProtoIfDenseArray(JSObject *obj)
|
2009-03-09 11:25:43 -07:00
|
|
|
{
|
2010-03-04 20:44:09 -08:00
|
|
|
return obj->isDenseArray() ? obj->getProto() : obj;
|
2009-03-09 11:25:43 -07:00
|
|
|
}
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
extern JSObject *
|
|
|
|
js_InitArrayClass(JSContext *cx, JSObject *obj);
|
|
|
|
|
2009-08-07 20:09:11 -07:00
|
|
|
extern bool
|
|
|
|
js_InitContextBusyArrayTable(JSContext *cx);
|
2009-06-30 17:19:42 -07:00
|
|
|
|
2009-09-08 15:59:14 -07:00
|
|
|
/*
|
|
|
|
* Creates a new array with the given length and proto (NB: NULL is not
|
|
|
|
* translated to Array.prototype), with len slots preallocated.
|
|
|
|
*/
|
|
|
|
extern JSObject * JS_FASTCALL
|
|
|
|
js_NewArrayWithSlots(JSContext* cx, JSObject* proto, uint32 len);
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
extern JSObject *
|
2010-07-22 18:45:21 -07:00
|
|
|
js_NewArrayObject(JSContext *cx, jsuint length, const js::Value *vector);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2008-02-18 13:01:47 -08:00
|
|
|
/* Create an array object that starts out already made slow/sparse. */
|
|
|
|
extern JSObject *
|
|
|
|
js_NewSlowArrayObject(JSContext *cx);
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
extern JSBool
|
|
|
|
js_GetLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
|
|
|
|
|
|
|
|
extern JSBool
|
2009-01-12 13:07:48 -08:00
|
|
|
js_SetLengthProperty(JSContext *cx, JSObject *obj, jsdouble length);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
|
|
|
extern JSBool
|
|
|
|
js_HasLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
|
|
|
|
|
2008-09-15 00:54:28 -07:00
|
|
|
extern JSBool JS_FASTCALL
|
|
|
|
js_IndexToId(JSContext *cx, jsuint index, jsid *idp);
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/*
|
|
|
|
* JS-specific merge sort function.
|
|
|
|
*/
|
|
|
|
typedef JSBool (*JSComparator)(void *arg, const void *a, const void *b,
|
|
|
|
int *result);
|
2010-07-14 23:19:36 -07:00
|
|
|
|
|
|
|
enum JSMergeSortElemType {
|
|
|
|
JS_SORTING_VALUES,
|
|
|
|
JS_SORTING_GENERIC
|
|
|
|
};
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
/*
|
|
|
|
* NB: vec is the array to be sorted, tmp is temporary space at least as big
|
|
|
|
* as vec. Both should be GC-rooted if appropriate.
|
|
|
|
*
|
2010-07-14 23:19:36 -07:00
|
|
|
* isValue should true iff vec points to an array of js::Value
|
|
|
|
*
|
2007-03-22 10:30:00 -07:00
|
|
|
* The sorted result is in vec. vec may be in an inconsistent state if the
|
|
|
|
* comparator function cmp returns an error inside a comparison, so remember
|
|
|
|
* to check the return value of this function.
|
|
|
|
*/
|
2010-07-14 23:19:36 -07:00
|
|
|
extern bool
|
2007-03-22 10:30:00 -07:00
|
|
|
js_MergeSort(void *vec, size_t nel, size_t elsize, JSComparator cmp,
|
2010-07-14 23:19:36 -07:00
|
|
|
void *arg, void *tmp, JSMergeSortElemType elemType);
|
2007-03-22 10:30:00 -07:00
|
|
|
|
2010-08-01 09:58:03 -07:00
|
|
|
/*
|
|
|
|
* The Array.prototype.sort fast-native entry point is exported for joined
|
|
|
|
* function optimization in js{interp,tracer}.cpp.
|
|
|
|
*/
|
|
|
|
namespace js {
|
|
|
|
extern JSBool
|
|
|
|
array_sort(JSContext *cx, uintN argc, js::Value *vp);
|
|
|
|
}
|
|
|
|
|
2008-02-18 13:01:47 -08:00
|
|
|
#ifdef DEBUG_ARRAYS
|
|
|
|
extern JSBool
|
2010-07-14 23:19:36 -07:00
|
|
|
js_ArrayInfo(JSContext *cx, JSObject *obj, uintN argc, js::Value *argv, js::Value *rval);
|
2008-02-18 13:01:47 -08:00
|
|
|
#endif
|
|
|
|
|
2010-07-14 23:19:36 -07:00
|
|
|
extern JSBool
|
|
|
|
js_ArrayCompPush(JSContext *cx, JSObject *obj, const js::Value &vp);
|
2009-02-06 11:19:06 -08:00
|
|
|
|
2008-08-20 14:47:01 -07:00
|
|
|
/*
|
2009-06-11 07:35:41 -07:00
|
|
|
* Fast dense-array-to-buffer conversion for use by canvas.
|
|
|
|
*
|
|
|
|
* If the array is a dense array, fill [offset..offset+count] values into
|
|
|
|
* destination, assuming that types are consistent. Return JS_TRUE if
|
|
|
|
* successful, otherwise JS_FALSE -- note that the destination buffer may be
|
|
|
|
* modified even if JS_FALSE is returned (e.g. due to finding an inappropriate
|
|
|
|
* type later on in the array). If JS_FALSE is returned, no error conditions
|
|
|
|
* or exceptions are set on the context.
|
|
|
|
*
|
|
|
|
* This method succeeds if each element of the array is an integer or a double.
|
|
|
|
* Values outside the 0-255 range are clamped to that range. Double values are
|
|
|
|
* converted to integers in this range by clamping and then rounding to
|
|
|
|
* nearest, ties to even.
|
2008-08-20 14:47:01 -07:00
|
|
|
*/
|
|
|
|
|
2008-08-20 23:46:31 -07:00
|
|
|
JS_FRIEND_API(JSBool)
|
2009-06-11 07:35:41 -07:00
|
|
|
js_CoerceArrayToCanvasImageData(JSObject *obj, jsuint offset, jsuint count,
|
|
|
|
JSUint8 *dest);
|
2008-08-20 14:47:01 -07:00
|
|
|
|
2009-03-03 21:58:56 -08:00
|
|
|
JSBool
|
|
|
|
js_PrototypeHasIndexedProperties(JSContext *cx, JSObject *obj);
|
2009-03-03 18:04:15 -08:00
|
|
|
|
2009-03-31 12:42:31 -07:00
|
|
|
/*
|
|
|
|
* Utility to access the value from the id returned by array_lookupProperty.
|
|
|
|
*/
|
2009-04-17 02:37:59 -07:00
|
|
|
JSBool
|
2010-07-14 23:19:36 -07:00
|
|
|
js_GetDenseArrayElementValue(JSContext *cx, JSObject *obj, jsid id,
|
|
|
|
js::Value *vp);
|
2009-03-31 12:42:31 -07:00
|
|
|
|
2009-07-29 09:58:19 -07:00
|
|
|
/* Array constructor native. Exposed only so the JIT can know its address. */
|
|
|
|
JSBool
|
2010-08-10 16:38:08 -07:00
|
|
|
js_Array(JSContext *cx, uintN argc, js::Value *vp);
|
2009-07-29 09:58:19 -07:00
|
|
|
|
2009-10-26 13:57:41 -07:00
|
|
|
/*
|
|
|
|
* Friend api function that allows direct creation of an array object with a
|
|
|
|
* given capacity. Non-null return value means allocation of the internal
|
|
|
|
* buffer for a capacity of at least |capacity| succeeded. A pointer to the
|
|
|
|
* first element of this internal buffer is returned in the |vector| out
|
|
|
|
* parameter. The caller promises to fill in the first |capacity| values
|
|
|
|
* starting from that pointer immediately after this function returns and
|
|
|
|
* without triggering GC (so this method is allowed to leave those
|
2010-08-29 11:57:08 -07:00
|
|
|
* uninitialized) and to set them to non-JS_ARRAY_HOLE-magic-why values, so
|
|
|
|
* that the resulting array has length and count both equal to |capacity|.
|
2010-07-14 23:19:36 -07:00
|
|
|
*
|
|
|
|
* FIXME: for some strange reason, when this file is included from
|
|
|
|
* dom/ipc/TabParent.cpp in MSVC, jsuint resolves to a slightly different
|
|
|
|
* builtin than when mozjs.dll is built, resulting in a link error in xul.dll.
|
|
|
|
* It would be useful to find out what is causing this insanity.
|
2009-10-26 13:57:41 -07:00
|
|
|
*/
|
|
|
|
JS_FRIEND_API(JSObject *)
|
2010-07-14 23:19:36 -07:00
|
|
|
js_NewArrayObjectWithCapacity(JSContext *cx, uint32_t capacity, jsval **vector);
|
2009-10-26 13:57:41 -07:00
|
|
|
|
2010-04-28 18:32:13 -07:00
|
|
|
/*
|
|
|
|
* Makes a fast clone of a dense array as long as the array only contains
|
|
|
|
* primitive values.
|
|
|
|
*
|
|
|
|
* If the return value is JS_FALSE then clone will not be set.
|
|
|
|
*
|
|
|
|
* If the return value is JS_TRUE then clone will either be set to the address
|
|
|
|
* of a new JSObject or to NULL if the array was not dense or contained values
|
|
|
|
* that were not primitives.
|
|
|
|
*/
|
|
|
|
JS_FRIEND_API(JSBool)
|
|
|
|
js_CloneDensePrimitiveArray(JSContext *cx, JSObject *obj, JSObject **clone);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Returns JS_TRUE if the given object is a dense array that contains only
|
|
|
|
* primitive values.
|
|
|
|
*/
|
|
|
|
JS_FRIEND_API(JSBool)
|
|
|
|
js_IsDensePrimitiveArray(JSObject *obj);
|
|
|
|
|
2007-03-22 10:30:00 -07:00
|
|
|
#endif /* jsarray_h___ */
|