Source/JavaScriptCore/runtime/WeakMapData.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. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WeakMapData_h
  27 #define WeakMapData_h
  28
  29 #include "JSCell.h"
  30 #include "Structure.h"
  31 #include <wtf/HashFunctions.h>
  32 #include <wtf/HashMap.h>
  33 #include <wtf/MathExtras.h>
  34
  35 namespace JSC {
  36
  37 class WeakMapData : public JSCell {
  38 public:
  39     typedef JSCell Base;
  40
  41     static WeakMapData* create(VM& vm)
  42     {
  43         WeakMapData* weakMapData = new (NotNull, allocateCell<WeakMapData>(vm.heap)) WeakMapData(vm);
  44         weakMapData->finishCreation(vm);
  45         return weakMapData;
  46     }
  47
  48     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  49     {
  50         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
  51     }
  52
  53     static const bool needsDestruction = true;
  54     static const bool hasImmortalStructure = true;
  55
  56     void set(VM&, JSObject*, JSValue);
  57     JSValue get(JSObject*);
  58     bool remove(JSObject*);
  59     bool contains(JSObject*);
  60     void clear();
  61
  62     DECLARE_INFO;
  63
  64     static const unsigned StructureFlags = StructureIsImmortal | Base::StructureFlags;
  65
  66     typedef HashMap<JSObject*, WriteBarrier<Unknown>> MapType;
  67     MapType::const_iterator begin() const { return m_map.begin(); }
  68     MapType::const_iterator end() const { return m_map.end(); }
  69
  70     int size() const { return m_map.size(); }
  71
  72 private:
  73     WeakMapData(VM&);
  74     static void destroy(JSCell*);
  75     static void visitChildren(JSCell*, SlotVisitor&);
  76     void finishCreation(VM&);
  77
  78     class DeadKeyCleaner : public UnconditionalFinalizer, public WeakReferenceHarvester {
  79     public:
  80         DeadKeyCleaner(WeakMapData* target)
  81             : m_target(target)
  82         {
  83         }
  84     private:
  85         virtual void visitWeakReferences(SlotVisitor&) override;
  86         virtual void finalizeUnconditionally() override;
  87         int m_liveKeyCount;
  88         WeakMapData* m_target;
  89     };
  90     DeadKeyCleaner m_deadKeyCleaner;
  91     MapType m_map;
  92 };
  93
  94 }
  95
  96 #endif /* !defined(WeakMapData_h) */