98b8d53c7ca9b3ee30e4884250ff747193847033
[WebKit-https.git] / JavaScriptCore / kjs / array_object.cpp
1 /*
2  *  Copyright (C) 1999-2000 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2003, 2007 Apple Inc. All rights reserved.
4  *  Copyright (C) 2003 Peter Kelly (pmk@post.com)
5  *  Copyright (C) 2006 Alexey Proskuryakov (ap@nypop.com)
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Lesser General Public
9  *  License as published by the Free Software Foundation; either
10  *  version 2 of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Lesser General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Lesser General Public
18  *  License along with this library; if not, write to the Free Software
19  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
20  *  USA
21  *
22  */
23
24 #include "config.h"
25 #include "array_object.h"
26 #include "array_object.lut.h"
27
28 #include "error_object.h"
29 #include "lookup.h"
30 #include "operations.h"
31 #include <stdio.h>
32 #include <wtf/Assertions.h>
33 #include <wtf/HashSet.h>
34
35 namespace KJS {
36
37 // ------------------------------ ArrayPrototype ----------------------------
38
39 const ClassInfo ArrayPrototype::info = {"Array", &ArrayInstance::info, &arrayTable};
40
41 /* Source for array_object.lut.h
42 @begin arrayTable 16
43   toString       ArrayProtoFunc::ToString       DontEnum|Function 0
44   toLocaleString ArrayProtoFunc::ToLocaleString DontEnum|Function 0
45   concat         ArrayProtoFunc::Concat         DontEnum|Function 1
46   join           ArrayProtoFunc::Join           DontEnum|Function 1
47   pop            ArrayProtoFunc::Pop            DontEnum|Function 0
48   push           ArrayProtoFunc::Push           DontEnum|Function 1
49   reverse        ArrayProtoFunc::Reverse        DontEnum|Function 0
50   shift          ArrayProtoFunc::Shift          DontEnum|Function 0
51   slice          ArrayProtoFunc::Slice          DontEnum|Function 2
52   sort           ArrayProtoFunc::Sort           DontEnum|Function 1
53   splice         ArrayProtoFunc::Splice         DontEnum|Function 2
54   unshift        ArrayProtoFunc::UnShift        DontEnum|Function 1
55   every          ArrayProtoFunc::Every          DontEnum|Function 1
56   forEach        ArrayProtoFunc::ForEach        DontEnum|Function 1
57   some           ArrayProtoFunc::Some           DontEnum|Function 1
58   indexOf        ArrayProtoFunc::IndexOf        DontEnum|Function 1
59   lastIndexOf    ArrayProtoFunc::LastIndexOf    DontEnum|Function 1
60   filter         ArrayProtoFunc::Filter         DontEnum|Function 1
61   map            ArrayProtoFunc::Map            DontEnum|Function 1
62 @end
63 */
64
65 // ECMA 15.4.4
66 ArrayPrototype::ArrayPrototype(ExecState*, ObjectPrototype* objProto)
67   : ArrayInstance(objProto, 0)
68 {
69 }
70
71 bool ArrayPrototype::getOwnPropertySlot(ExecState* exec, const Identifier& propertyName, PropertySlot& slot)
72 {
73   return getStaticFunctionSlot<ArrayProtoFunc, ArrayInstance>(exec, &arrayTable, this, propertyName, slot);
74 }
75
76 // ------------------------------ ArrayProtoFunc ----------------------------
77
78 ArrayProtoFunc::ArrayProtoFunc(ExecState* exec, int i, int len, const Identifier& name)
79   : InternalFunctionImp(static_cast<FunctionPrototype*>
80                         (exec->lexicalInterpreter()->builtinFunctionPrototype()), name)
81   , id(i)
82 {
83   put(exec, exec->propertyNames().length, jsNumber(len), DontDelete | ReadOnly | DontEnum);
84 }
85
86 static JSValue *getProperty(ExecState *exec, JSObject *obj, unsigned index)
87 {
88     PropertySlot slot;
89     if (!obj->getPropertySlot(exec, index, slot))
90         return NULL;
91     return slot.getValue(exec, obj, index);
92 }
93
94 // ECMA 15.4.4
95 JSValue* ArrayProtoFunc::callAsFunction(ExecState* exec, JSObject* thisObj, const List& args)
96 {
97   unsigned length = thisObj->get(exec, exec->propertyNames().length)->toUInt32(exec);
98
99   JSValue *result = 0; // work around gcc 4.0 bug in uninitialized variable warning
100   
101   switch (id) {
102   case ToLocaleString:
103   case ToString:
104
105     if (!thisObj->inherits(&ArrayInstance::info))
106       return throwError(exec, TypeError);
107
108     // fall through
109   case Join: {
110     static HashSet<JSObject*> visitedElems;
111     static const UString* empty = new UString("");
112     static const UString* comma = new UString(",");
113     bool alreadyVisited = !visitedElems.add(thisObj).second;
114     if (alreadyVisited)
115         return jsString(*empty);
116     UString separator = *comma;
117     UString str = *empty;
118
119     if (id == Join && !args[0]->isUndefined())
120         separator = args[0]->toString(exec);
121     for (unsigned int k = 0; k < length; k++) {
122         if (k >= 1)
123             str += separator;
124         if (str.isNull()) {
125             JSObject *error = Error::create(exec, GeneralError, "Out of memory");
126             exec->setException(error);
127             break;
128         }
129
130         JSValue* element = thisObj->get(exec, k);
131         if (element->isUndefinedOrNull())
132             continue;
133
134         bool fallback = false;
135         if (id == ToLocaleString) {
136             JSObject* o = element->toObject(exec);
137             JSValue* conversionFunction = o->get(exec, exec->propertyNames().toLocaleString);
138             if (conversionFunction->isObject() && static_cast<JSObject*>(conversionFunction)->implementsCall()) {
139                 List args;
140                 str += static_cast<JSObject*>(conversionFunction)->call(exec, o, args)->toString(exec);
141             } else {
142                 // try toString() fallback
143                 fallback = true;
144             }
145         }
146
147         if (id == ToString || id == Join || fallback)
148             str += element->toString(exec);
149
150         if (str.isNull()) {
151             JSObject *error = Error::create(exec, GeneralError, "Out of memory");
152             exec->setException(error);
153         }
154
155         if (exec->hadException())
156             break;
157     }
158     visitedElems.remove(thisObj);
159     result = jsString(str);
160     break;
161   }
162   case Concat: {
163     JSObject *arr = static_cast<JSObject *>(exec->lexicalInterpreter()->builtinArray()->construct(exec,List::empty()));
164     int n = 0;
165     JSValue *curArg = thisObj;
166     JSObject *curObj = static_cast<JSObject *>(thisObj);
167     List::const_iterator it = args.begin();
168     List::const_iterator end = args.end();
169     for (;;) {
170       if (curArg->isObject() &&
171           curObj->inherits(&ArrayInstance::info)) {
172         unsigned int k = 0;
173         // Older versions tried to optimize out getting the length of thisObj
174         // by checking for n != 0, but that doesn't work if thisObj is an empty array.
175         length = curObj->get(exec, exec->propertyNames().length)->toUInt32(exec);
176         while (k < length) {
177           if (JSValue *v = getProperty(exec, curObj, k))
178             arr->put(exec, n, v);
179           n++;
180           k++;
181         }
182       } else {
183         arr->put(exec, n, curArg);
184         n++;
185       }
186       if (it == end)
187         break;
188       curArg = *it;
189       curObj = static_cast<JSObject*>(curArg); // may be 0
190       ++it;
191     }
192     arr->put(exec, exec->propertyNames().length, jsNumber(n), DontEnum | DontDelete);
193
194     result = arr;
195     break;
196   }
197   case Pop:{
198     if (length == 0) {
199       thisObj->put(exec, exec->propertyNames().length, jsNumber(length), DontEnum | DontDelete);
200       result = jsUndefined();
201     } else {
202       result = thisObj->get(exec, length - 1);
203       thisObj->put(exec, exec->propertyNames().length, jsNumber(length - 1), DontEnum | DontDelete);
204     }
205     break;
206   }
207   case Push: {
208     for (int n = 0; n < args.size(); n++)
209       thisObj->put(exec, length + n, args[n]);
210     length += args.size();
211     thisObj->put(exec, exec->propertyNames().length, jsNumber(length), DontEnum | DontDelete);
212     result = jsNumber(length);
213     break;
214   }
215   case Reverse: {
216
217     unsigned int middle = length / 2;
218
219     for (unsigned int k = 0; k < middle; k++) {
220       unsigned lk1 = length - k - 1;
221       JSValue *obj2 = getProperty(exec, thisObj, lk1);
222       JSValue *obj = getProperty(exec, thisObj, k);
223
224       if (obj2) 
225         thisObj->put(exec, k, obj2);
226       else
227         thisObj->deleteProperty(exec, k);
228
229       if (obj)
230         thisObj->put(exec, lk1, obj);
231       else
232         thisObj->deleteProperty(exec, lk1);
233     }
234     result = thisObj;
235     break;
236   }
237   case Shift: {
238     if (length == 0) {
239       thisObj->put(exec, exec->propertyNames().length, jsNumber(length), DontEnum | DontDelete);
240       result = jsUndefined();
241     } else {
242       result = thisObj->get(exec, 0);
243       for(unsigned int k = 1; k < length; k++) {
244         if (JSValue *obj = getProperty(exec, thisObj, k))
245           thisObj->put(exec, k-1, obj);
246         else
247           thisObj->deleteProperty(exec, k-1);
248       }
249       thisObj->deleteProperty(exec, length - 1);
250       thisObj->put(exec, exec->propertyNames().length, jsNumber(length - 1), DontEnum | DontDelete);
251     }
252     break;
253   }
254   case Slice: {
255     // http://developer.netscape.com/docs/manuals/js/client/jsref/array.htm#1193713 or 15.4.4.10
256
257     // We return a new array
258     JSObject *resObj = static_cast<JSObject *>(exec->lexicalInterpreter()->builtinArray()->construct(exec,List::empty()));
259     result = resObj;
260     double begin = args[0]->toInteger(exec);
261     if (begin >= 0) {
262       if (begin > length)
263         begin = length;
264     } else {
265       begin += length;
266       if (begin < 0)
267         begin = 0;
268     }
269     double end;
270     if (args[1]->isUndefined())
271       end = length;
272     else {
273       end = args[1]->toInteger(exec);
274       if (end < 0) {
275         end += length;
276         if (end < 0)
277           end = 0;
278       } else {
279         if (end > length)
280           end = length;
281       }
282     }
283
284     int n = 0;
285     int b = static_cast<int>(begin);
286     int e = static_cast<int>(end);
287     for(int k = b; k < e; k++, n++) {
288       if (JSValue *v = getProperty(exec, thisObj, k))
289         resObj->put(exec, n, v);
290     }
291     resObj->put(exec, exec->propertyNames().length, jsNumber(n), DontEnum | DontDelete);
292     break;
293   }
294   case Sort:{
295 #if 0
296     printf("KJS Array::Sort length=%d\n", length);
297     for ( unsigned int i = 0 ; i<length ; ++i )
298       printf("KJS Array::Sort: %d: %s\n", i, thisObj->get(exec, i)->toString(exec).ascii() );
299 #endif
300     JSObject *sortFunction = NULL;
301     if (!args[0]->isUndefined())
302       {
303         sortFunction = args[0]->toObject(exec);
304         if (!sortFunction->implementsCall())
305           sortFunction = NULL;
306       }
307     
308     if (thisObj->classInfo() == &ArrayInstance::info) {
309       if (sortFunction)
310         ((ArrayInstance *)thisObj)->sort(exec, sortFunction);
311       else
312         ((ArrayInstance *)thisObj)->sort(exec);
313       result = thisObj;
314       break;
315     }
316
317     if (length == 0) {
318       thisObj->put(exec, exec->propertyNames().length, jsNumber(0), DontEnum | DontDelete);
319       result = thisObj;
320       break;
321     }
322
323     // "Min" sort. Not the fastest, but definitely less code than heapsort
324     // or quicksort, and much less swapping than bubblesort/insertionsort.
325     for ( unsigned int i = 0 ; i<length-1 ; ++i )
326       {
327         JSValue *iObj = thisObj->get(exec,i);
328         unsigned int themin = i;
329         JSValue *minObj = iObj;
330         for ( unsigned int j = i+1 ; j<length ; ++j )
331           {
332             JSValue *jObj = thisObj->get(exec,j);
333             double cmp;
334             if (jObj->isUndefined()) {
335               cmp = 1; // don't check minObj because there's no need to differentiate == (0) from > (1)
336             } else if (minObj->isUndefined()) {
337               cmp = -1;
338             } else if (sortFunction) {
339                 List l;
340                 l.append(jObj);
341                 l.append(minObj);
342                 cmp = sortFunction->call(exec, exec->dynamicInterpreter()->globalObject(), l)->toNumber(exec);
343             } else {
344               cmp = (jObj->toString(exec) < minObj->toString(exec)) ? -1 : 1;
345             }
346             if ( cmp < 0 )
347               {
348                 themin = j;
349                 minObj = jObj;
350               }
351           }
352         // Swap themin and i
353         if ( themin > i )
354           {
355             //printf("KJS Array::Sort: swapping %d and %d\n", i, themin );
356             thisObj->put( exec, i, minObj );
357             thisObj->put( exec, themin, iObj );
358           }
359       }
360 #if 0
361     printf("KJS Array::Sort -- Resulting array:\n");
362     for ( unsigned int i = 0 ; i<length ; ++i )
363       printf("KJS Array::Sort: %d: %s\n", i, thisObj->get(exec, i)->toString(exec).ascii() );
364 #endif
365     result = thisObj;
366     break;
367   }
368   case Splice: {
369     // 15.4.4.12 - oh boy this is huge
370     JSObject *resObj = static_cast<JSObject *>(exec->lexicalInterpreter()->builtinArray()->construct(exec,List::empty()));
371     result = resObj;
372     int begin = args[0]->toUInt32(exec);
373     if ( begin < 0 )
374       begin = maxInt( begin + length, 0 );
375     else
376       begin = minInt( begin, length );
377     unsigned int deleteCount = minInt( maxInt( args[1]->toUInt32(exec), 0 ), length - begin );
378
379     //printf( "Splicing from %d, deleteCount=%d \n", begin, deleteCount );
380     for(unsigned int k = 0; k < deleteCount; k++) {
381       if (JSValue *v = getProperty(exec, thisObj, k+begin))
382         resObj->put(exec, k, v);
383     }
384     resObj->put(exec, exec->propertyNames().length, jsNumber(deleteCount), DontEnum | DontDelete);
385
386     unsigned int additionalArgs = maxInt( args.size() - 2, 0 );
387     if ( additionalArgs != deleteCount )
388     {
389       if ( additionalArgs < deleteCount )
390       {
391         for ( unsigned int k = begin; k < length - deleteCount; ++k )
392         {
393           if (JSValue *v = getProperty(exec, thisObj, k+deleteCount))
394             thisObj->put(exec, k+additionalArgs, v);
395           else
396             thisObj->deleteProperty(exec, k+additionalArgs);
397         }
398         for ( unsigned int k = length ; k > length - deleteCount + additionalArgs; --k )
399           thisObj->deleteProperty(exec, k-1);
400       }
401       else
402       {
403         for ( unsigned int k = length - deleteCount; (int)k > begin; --k )
404         {
405           if (JSValue *obj = getProperty(exec, thisObj, k + deleteCount - 1))
406             thisObj->put(exec, k + additionalArgs - 1, obj);
407           else
408             thisObj->deleteProperty(exec, k+additionalArgs-1);
409         }
410       }
411     }
412     for ( unsigned int k = 0; k < additionalArgs; ++k )
413     {
414       thisObj->put(exec, k+begin, args[k+2]);
415     }
416     thisObj->put(exec, exec->propertyNames().length, jsNumber(length - deleteCount + additionalArgs), DontEnum | DontDelete);
417     break;
418   }
419   case UnShift: { // 15.4.4.13
420     unsigned int nrArgs = args.size();
421     for ( unsigned int k = length; k > 0; --k )
422     {
423       if (JSValue *v = getProperty(exec, thisObj, k - 1))
424         thisObj->put(exec, k+nrArgs-1, v);
425       else
426         thisObj->deleteProperty(exec, k+nrArgs-1);
427     }
428     for ( unsigned int k = 0; k < nrArgs; ++k )
429       thisObj->put(exec, k, args[k]);
430     result = jsNumber(length + nrArgs);
431     thisObj->put(exec, exec->propertyNames().length, result, DontEnum | DontDelete);
432     break;
433   }
434   case Filter:
435   case Map: {
436     JSObject *eachFunction = args[0]->toObject(exec);
437     
438     if (!eachFunction->implementsCall())
439       return throwError(exec, TypeError);
440     
441     JSObject *applyThis = args[1]->isUndefinedOrNull() ? exec->dynamicInterpreter()->globalObject() :  args[1]->toObject(exec);
442     JSObject *resultArray;
443     
444     if (id == Filter) 
445       resultArray = static_cast<JSObject *>(exec->lexicalInterpreter()->builtinArray()->construct(exec, List::empty()));
446     else {
447       List args;
448       args.append(jsNumber(length));
449       resultArray = static_cast<JSObject *>(exec->lexicalInterpreter()->builtinArray()->construct(exec, args));
450     }
451     
452     unsigned filterIndex = 0;
453     for (unsigned k = 0; k < length && !exec->hadException(); ++k) {
454       PropertySlot slot;
455
456       if (!thisObj->getPropertySlot(exec, k, slot))
457          continue;
458         
459       JSValue *v = slot.getValue(exec, thisObj, k);
460       
461       List eachArguments;
462       
463       eachArguments.append(v);
464       eachArguments.append(jsNumber(k));
465       eachArguments.append(thisObj);
466       
467       JSValue *result = eachFunction->call(exec, applyThis, eachArguments);
468       
469       if (id == Map)
470         resultArray->put(exec, k, result);
471       else if (result->toBoolean(exec)) 
472         resultArray->put(exec, filterIndex++, v);
473     }
474     
475     return resultArray;
476   }
477   case Every:
478   case ForEach:
479   case Some: {
480     //Documentation for these three is available at:
481     //http://developer-test.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Objects:Array:every
482     //http://developer-test.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Objects:Array:forEach
483     //http://developer-test.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Objects:Array:some
484     
485     JSObject *eachFunction = args[0]->toObject(exec);
486     
487     if (!eachFunction->implementsCall())
488       return throwError(exec, TypeError);
489     
490     JSObject *applyThis = args[1]->isUndefinedOrNull() ? exec->dynamicInterpreter()->globalObject() :  args[1]->toObject(exec);
491     
492     if (id == Some || id == Every)
493       result = jsBoolean(id == Every);
494     else
495       result = jsUndefined();
496     
497     for (unsigned k = 0; k < length && !exec->hadException(); ++k) {
498       PropertySlot slot;
499         
500       if (!thisObj->getPropertySlot(exec, k, slot))
501         continue;
502       
503       List eachArguments;
504       
505       eachArguments.append(slot.getValue(exec, thisObj, k));
506       eachArguments.append(jsNumber(k));
507       eachArguments.append(thisObj);
508       
509       bool predicateResult = eachFunction->call(exec, applyThis, eachArguments)->toBoolean(exec);
510       
511       if (id == Every && !predicateResult) {
512         result = jsBoolean(false);
513         break;
514       }
515       if (id == Some && predicateResult) {
516         result = jsBoolean(true);
517         break;
518       }
519     }
520     break;
521   }
522
523   case IndexOf: {
524     // JavaScript 1.5 Extension by Mozilla
525     // Documentation: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:indexOf
526
527     unsigned index = 0;
528     double d = args[1]->toInteger(exec);
529     if (d < 0)
530         d += length;
531     if (d > 0) {
532         if (d > length)
533             index = length;
534         else
535             index = static_cast<unsigned>(d);
536     }
537
538     JSValue* searchElement = args[0];
539     for (; index < length; ++index) {
540         JSValue* e = getProperty(exec, thisObj, index);
541         if (!e)
542             continue;
543         if (strictEqual(exec, searchElement, e))
544             return jsNumber(index);
545     }
546
547     return jsNumber(-1);
548   }
549   case LastIndexOf: {
550        // JavaScript 1.6 Extension by Mozilla
551       // Documentation: http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Array:lastIndexOf 
552
553     int index = length - 1;
554     double d = args[1]->toIntegerPreserveNaN(exec);
555
556     if (d < 0) {
557         d += length;
558         if (d < 0) 
559             return jsNumber(-1);
560     }
561     if (d < length)
562         index = static_cast<int>(d);
563           
564     JSValue* searchElement = args[0];
565     for (; index >= 0; --index) {
566         JSValue* e = getProperty(exec, thisObj, index);
567         if (!e)
568             continue;
569         if (strictEqual(exec, searchElement, e))
570             return jsNumber(index);
571     }
572           
573     return jsNumber(-1);
574 }
575   default:
576     ASSERT(0);
577     result = 0;
578     break;
579   }
580   return result;
581 }
582
583 // ------------------------------ ArrayObjectImp -------------------------------
584
585 ArrayObjectImp::ArrayObjectImp(ExecState *exec,
586                                FunctionPrototype *funcProto,
587                                ArrayPrototype *arrayProto)
588   : InternalFunctionImp(funcProto)
589 {
590   // ECMA 15.4.3.1 Array.prototype
591   put(exec, exec->propertyNames().prototype, arrayProto, DontEnum|DontDelete|ReadOnly);
592
593   // no. of arguments for constructor
594   put(exec, exec->propertyNames().length, jsNumber(1), ReadOnly|DontDelete|DontEnum);
595 }
596
597 bool ArrayObjectImp::implementsConstruct() const
598 {
599   return true;
600 }
601
602 // ECMA 15.4.2
603 JSObject *ArrayObjectImp::construct(ExecState *exec, const List &args)
604 {
605   // a single numeric argument denotes the array size (!)
606   if (args.size() == 1 && args[0]->isNumber()) {
607     uint32_t n = args[0]->toUInt32(exec);
608     if (n != args[0]->toNumber(exec))
609       return throwError(exec, RangeError, "Array size is not a small enough positive integer.");
610     return new ArrayInstance(exec->lexicalInterpreter()->builtinArrayPrototype(), n);
611   }
612
613   // otherwise the array is constructed with the arguments in it
614   return new ArrayInstance(exec->lexicalInterpreter()->builtinArrayPrototype(), args);
615 }
616
617 // ECMA 15.6.1
618 JSValue *ArrayObjectImp::callAsFunction(ExecState *exec, JSObject *, const List &args)
619 {
620   // equivalent to 'new Array(....)'
621   return construct(exec,args);
622 }
623
624 }