runtime/JSMap.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 JSMap_h
  27 #define JSMap_h
  28
  29 #include "JSDestructibleObject.h"
  30 #include "JSObject.h"
  31 #include "MapData.h"
  32
  33 namespace JSC {
  34
  35 class JSMapIterator;
  36
  37 class JSMap : public JSDestructibleObject {
  38 public:
  39     typedef JSDestructibleObject Base;
  40
  41     friend class JSMapIterator;
  42
  43     // Our marking functions expect Entry to maintain this layout, and have all
  44     // fields be WriteBarrier<Unknown>
  45     class Entry {
  46     private:
  47         WriteBarrier<Unknown> m_key;
  48         WriteBarrier<Unknown> m_value;
  49
  50     public:
  51         const WriteBarrier<Unknown>& key() const
  52         {
  53             return m_key;
  54         }
  55
  56         const WriteBarrier<Unknown>& value() const
  57         {
  58             return m_value;
  59         }
  60
  61         void visitChildren(SlotVisitor& visitor)
  62         {
  63             visitor.append(&m_key);
  64             visitor.append(&m_value);
  65         }
  66
  67         void setKey(VM& vm, const JSCell* owner, JSValue key)
  68         {
  69             m_key.set(vm, owner, key);
  70         }
  71
  72         void setKeyWithoutWriteBarrier(JSValue key)
  73         {
  74             m_key.setWithoutWriteBarrier(key);
  75         }
  76
  77         void setValue(VM& vm, const JSCell* owner, JSValue value)
  78         {
  79             m_value.set(vm, owner, value);
  80         }
  81
  82         void clear()
  83         {
  84             m_key.clear();
  85             m_value.clear();
  86         }
  87     };
  88
  89     typedef MapDataImpl<Entry, JSMapIterator> MapData;
  90
  91     DECLARE_EXPORT_INFO;
  92
  93     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  94     {
  95         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
  96     }
  97
  98     static JSMap* create(VM& vm, Structure* structure)
  99     {
 100         JSMap* instance = new (NotNull, allocateCell<JSMap>(vm.heap)) JSMap(vm, structure);
 101         instance->finishCreation(vm);
 102         return instance;
 103     }
 104
 105     static JSMap* create(ExecState* exec, Structure* structure)
 106     {
 107         return create(exec->vm(), structure);
 108     }
 109
 110     bool has(ExecState*, JSValue);
 111     size_t size(ExecState*);
 112     JSValue get(ExecState*, JSValue);
 113     JS_EXPORT_PRIVATE void set(ExecState*, JSValue key, JSValue value);
 114     void clear(ExecState*);
 115     bool remove(ExecState*, JSValue);
 116
 117 private:
 118     JSMap(VM& vm, Structure* structure)
 119         : Base(vm, structure)
 120         , m_mapData(vm)
 121     {
 122     }
 123
 124     static void destroy(JSCell*);
 125     static void visitChildren(JSCell*, SlotVisitor&);
 126     static void copyBackingStore(JSCell*, CopyVisitor&, CopyToken);
 127
 128     MapData m_mapData;
 129 };
 130
 131 }
 132
 133 #endif // !defined(JSMap_h)