[ES6] Implement Reflect.enumerate
[WebKit-https.git] / Source / JavaScriptCore / runtime / JSPropertyNameIterator.h
1 /*
2  * Copyright (C) 2015 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 JSPropertyNameIterator_h
27 #define JSPropertyNameIterator_h
28
29 #include "JSObject.h"
30 #include "JSPropertyNameEnumerator.h"
31
32 namespace JSC {
33
34 class JSPropertyNameIterator : public JSNonFinalObject {
35 public:
36     typedef JSNonFinalObject Base;
37
38     enum class EnumerationPhase : uint32_t {
39         IndexedNames,
40         StructureNames,
41         GenericNames,
42         Done
43     };
44
45     DECLARE_EXPORT_INFO;
46
47     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
48     {
49         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
50     }
51
52     static JSPropertyNameIterator* create(ExecState*, Structure*, JSObject*);
53
54     JSPropertyNameIterator* clone(ExecState*);
55     bool next(ExecState*, JSValue&);
56
57     static void visitChildren(JSCell*, SlotVisitor&);
58
59 private:
60     JSPropertyNameIterator(VM&, Structure*, JSObject*, JSPropertyNameEnumerator*);
61
62     void finishCreation(VM&, JSGlobalObject*);
63
64     static JSPropertyNameIterator* create(ExecState*, Structure*, JSObject*, JSPropertyNameEnumerator*);
65
66     WriteBarrier<JSObject> m_iteratedObject;
67     WriteBarrier<JSPropertyNameEnumerator> m_propertyNameEnumerator;
68     EnumerationPhase m_enumerationPhase;
69     uint32_t m_cursor;
70 };
71
72 }
73
74 #endif // JSPropertyNameIterator_h