runtime/JSArrayIterator.h

   1 /*
   2  * Copyright (C) 2013 Apple, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef JSArrayIterator_h
  27 #define JSArrayIterator_h
  28
  29 #include "JSObject.h"
  30
  31 namespace JSC {
  32
  33 enum ArrayIterationKind : uint32_t {
  34     ArrayIterateKey,
  35     ArrayIterateValue,
  36     ArrayIterateKeyValue
  37 };
  38
  39 class JSArrayIterator : public JSNonFinalObject {
  40 public:
  41     typedef JSNonFinalObject Base;
  42
  43     DECLARE_EXPORT_INFO;
  44
  45     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  46     {
  47         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
  48     }
  49
  50     static JSArrayIterator* create(ExecState* exec, Structure* structure, ArrayIterationKind kind, JSObject* iteratedObject)
  51     {
  52         VM& vm = exec->vm();
  53         JSArrayIterator* instance = new (NotNull, allocateCell<JSArrayIterator>(vm.heap)) JSArrayIterator(vm, structure);
  54         instance->finishCreation(vm, structure->globalObject(), kind, iteratedObject);
  55         return instance;
  56     }
  57
  58     ArrayIterationKind kind(ExecState*) const;
  59     JSValue iteratedValue(ExecState*) const;
  60     JSArrayIterator* clone(ExecState*);
  61
  62     using JSNonFinalObject::arrayStorageOrNull;
  63 private:
  64     JSArrayIterator(VM& vm, Structure* structure)
  65         : Base(vm, structure)
  66     {
  67     }
  68
  69     void finishCreation(VM&, JSGlobalObject*, ArrayIterationKind, JSObject* iteratedObject);
  70 };
  71
  72 }
  73
  74 #endif // !defined(JSArrayIterator_h)