runtime/JSWeakMap.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 JSWeakMap_h
  27 #define JSWeakMap_h
  28
  29 #include "JSObject.h"
  30
  31 namespace JSC {
  32
  33 class WeakMapData;
  34
  35 class JSWeakMap : public JSNonFinalObject {
  36 public:
  37     typedef JSNonFinalObject Base;
  38
  39     DECLARE_EXPORT_INFO;
  40
  41     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
  42     {
  43         return Structure::create(vm, globalObject, prototype, TypeInfo(ObjectType, StructureFlags), info());
  44     }
  45
  46     static JSWeakMap* create(VM& vm, Structure* structure)
  47     {
  48         JSWeakMap* instance = new (NotNull, allocateCell<JSWeakMap>(vm.heap)) JSWeakMap(vm, structure);
  49         instance->finishCreation(vm);
  50         return instance;
  51     }
  52
  53     static JSWeakMap* create(ExecState* exec, Structure* structure)
  54     {
  55         return create(exec->vm(), structure);
  56     }
  57
  58     WeakMapData* weakMapData() { return m_weakMapData.get(); }
  59
  60     JSValue get(CallFrame*, JSObject*);
  61     bool has(CallFrame*, JSObject*);
  62     bool remove(CallFrame*, JSObject*);
  63
  64     void set(CallFrame*, JSObject*, JSValue);
  65     void clear(CallFrame*);
  66
  67 private:
  68     static const unsigned StructureFlags = OverridesVisitChildren | Base::StructureFlags;
  69
  70     JSWeakMap(VM& vm, Structure* structure)
  71         : Base(vm, structure)
  72     {
  73     }
  74
  75     void finishCreation(VM&);
  76     static void visitChildren(JSCell*, SlotVisitor&);
  77
  78     WriteBarrier<WeakMapData> m_weakMapData;
  79 };
  80
  81 }
  82
  83 #endif // !defined(JSWeakMap_h)