Back to index

lightning-sunbird  0.9+nobinonly
jsarray.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator client code, released
00017  * March 31, 1998.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 1998
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #ifndef jsarray_h___
00041 #define jsarray_h___
00042 /*
00043  * JS Array interface.
00044  */
00045 #include "jsprvtd.h"
00046 #include "jspubtd.h"
00047 
00048 JS_BEGIN_EXTERN_C
00049 
00050 /* Generous sanity-bound on length (in elements) of array initialiser. */
00051 #define ARRAY_INIT_LIMIT        JS_BIT(24)
00052 
00053 extern JSBool
00054 js_IdIsIndex(jsval id, jsuint *indexp);
00055 
00056 extern JSClass js_ArrayClass;
00057 
00058 extern JSObject *
00059 js_InitArrayClass(JSContext *cx, JSObject *obj);
00060 
00061 extern JSObject *
00062 js_NewArrayObject(JSContext *cx, jsuint length, jsval *vector);
00063 
00064 extern JSBool
00065 js_GetLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
00066 
00067 extern JSBool
00068 js_SetLengthProperty(JSContext *cx, JSObject *obj, jsuint length);
00069 
00070 extern JSBool
00071 js_HasLengthProperty(JSContext *cx, JSObject *obj, jsuint *lengthp);
00072 
00073 /*
00074  * Test whether an object is "array-like".  Currently this means whether obj
00075  * is an Array or an arguments object.  We would like an API, and probably a
00076  * way in the language, to bless other objects as array-like: having indexed
00077  * properties, and a 'length' property of uint32 value equal to one more than
00078  * the greatest index.
00079  */
00080 extern JSBool
00081 js_IsArrayLike(JSContext *cx, JSObject *obj, JSBool *answerp, jsuint *lengthp);
00082 
00083 /*
00084  * JS-specific heap sort function.
00085  */
00086 typedef JSBool (*JSComparator)(void *arg, const void *a, const void *b,
00087                                int *result);
00088 
00089 extern JSBool
00090 js_HeapSort(void *vec, size_t nel, void *pivot, size_t elsize,
00091             JSComparator cmp, void *arg);
00092 
00093 JS_END_EXTERN_C
00094 
00095 #endif /* jsarray_h___ */