js/src/jsarray.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   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 #ifndef jsarray_h___
  41 #define jsarray_h___
  42 /*
  43  * JS Array interface.
  44  */
  45 #include "jsprvtd.h"
  46 #include "jspubtd.h"
  47
  48 JS_BEGIN_EXTERN_C
  49
  50 /* Generous sanity-bound on length (in elements) of array initialiser. */
  51 #define ARRAY_INIT_LIMIT        JS_BIT(24)
  52
  53 extern JSBool
  54 js_IdIsIndex(jsval id, jsuint *indexp);
  55
  56 extern JSClass js_ArrayClass;
  57
  58 extern JSObject *
  59 js_InitArrayClass(JSContext *cx, JSObject *obj);
  60
  61 extern JSObject *
  62 js_NewArrayObject(JSContext *cx, jsuint length, jsval *vector);
  63
  64 #define JSSLOT_ARRAY_LENGTH     JSSLOT_PRIVATE
  65
  66 extern JSBool
  67 js_GetLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
  68
  69 extern JSBool
  70 js_SetLengthProperty(JSContext *cx, JSObject *obj, jsuint length);
  71
  72 extern JSBool
  73 js_HasLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
  74
  75 /*
  76  * Test whether an object is "array-like".  Currently this means whether obj
  77  * is an Array or an arguments object.  We would like an API, and probably a
  78  * way in the language, to bless other objects as array-like: having indexed
  79  * properties, and a 'length' property of uint32 value equal to one more than
  80  * the greatest index.
  81  */
  82 extern JSBool
  83 js_IsArrayLike(JSContext *cx, JSObject *obj, JSBool *answerp, jsuint *lengthp);
  84
  85 /*
  86  * JS-specific merge sort function.
  87  */
  88 typedef JSBool (*JSComparator)(void *arg, const void *a, const void *b,
  89                                int *result);
  90 /*
  91  * NB: vec is the array to be sorted, tmp is temporary space at least as big
  92  * as vec. Both should be GC-rooted if appropriate.
  93  *
  94  * The sorted result is in vec. vec may be in an inconsistent state if the
  95  * comparator function cmp returns an error inside a comparison, so remember
  96  * to check the return value of this function.
  97  */
  98 extern JSBool
  99 js_MergeSort(void *vec, size_t nel, size_t elsize, JSComparator cmp,
 100              void *arg, void *tmp);
 101
 102 JS_END_EXTERN_C
 103
 104 #endif /* jsarray_h___ */