src/third_party/WebKit/Source/core/dom/DOMStringMap.h

   1 /*
   2  * Copyright (C) 2010 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 DOMStringMap_h
  27 #define DOMStringMap_h
  28
  29 #include "bindings/core/v8/ExceptionState.h"
  30 #include "bindings/core/v8/ScriptWrappable.h"
  31 #include "bindings/core/v8/V8Binding.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/Noncopyable.h"
  34 #include "wtf/Vector.h"
  35 #include "wtf/text/WTFString.h"
  36
  37 namespace blink {
  38
  39 class Element;
  40
  41 class DOMStringMap : public NoBaseWillBeGarbageCollected<DOMStringMap>, public ScriptWrappable {
  42     WTF_MAKE_NONCOPYABLE(DOMStringMap);
  43     WTF_MAKE_FAST_ALLOCATED_WILL_BE_REMOVED;
  44     DECLARE_EMPTY_VIRTUAL_DESTRUCTOR_WILL_BE_REMOVED(DOMStringMap);
  45 public:
  46 #if !ENABLE(OILPAN)
  47     virtual void ref() = 0;
  48     virtual void deref() = 0;
  49 #endif
  50
  51     virtual void getNames(Vector<String>&) = 0;
  52     virtual String item(const String& name) = 0;
  53     virtual bool contains(const String& name) = 0;
  54     virtual void setItem(const String& name, const String& value, ExceptionState&) = 0;
  55     virtual bool deleteItem(const String& name) = 0;
  56     bool anonymousNamedSetter(const String& name, const String& value, ExceptionState& exceptionState)
  57     {
  58         setItem(name, value, exceptionState);
  59         return true;
  60     }
  61     DeleteResult anonymousNamedDeleter(const AtomicString& name)
  62     {
  63         bool knownProperty = deleteItem(name);
  64         return knownProperty ? DeleteSuccess : DeleteUnknownProperty;
  65     }
  66     void namedPropertyEnumerator(Vector<String>& names, ExceptionState&)
  67     {
  68         getNames(names);
  69     }
  70     bool namedPropertyQuery(const AtomicString&, ExceptionState&);
  71
  72     String anonymousIndexedGetter(uint32_t index)
  73     {
  74         return item(String::number(index));
  75     }
  76     bool anonymousIndexedSetter(uint32_t index, const String& value, ExceptionState& exceptionState)
  77     {
  78         return anonymousNamedSetter(String::number(index), value, exceptionState);
  79     }
  80     DeleteResult anonymousIndexedDeleter(uint32_t index)
  81     {
  82         return anonymousNamedDeleter(AtomicString::number(index));
  83     }
  84
  85     virtual Element* element() = 0;
  86
  87     virtual void trace(Visitor*) { }
  88
  89 protected:
  90     DOMStringMap()
  91     {
  92         ScriptWrappable::init(this);
  93     }
  94 };
  95
  96 } // namespace blink
  97
  98 #endif // DOMStringMap_h