Home | History | Annotate | Download | only in Shared 
      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 ImmutableDictionary_h
     27 #define ImmutableDictionary_h
     28 
     29 #include "APIObject.h"
     30 #include <wtf/HashMap.h>
     31 #include <wtf/PassRefPtr.h>
     32 #include <wtf/text/StringHash.h>
     33 #include <wtf/text/WTFString.h>
     34 
     35 namespace WebKit {
     36 
     37 class ImmutableArray;
     38 
     39 // ImmutableDictionary - An immutable dictionary type suitable for vending to an API.
     40 
     41 class ImmutableDictionary : public APIObject {
     42 public:
     43     static const Type APIType = TypeDictionary;
     44 
     45     typedef HashMap<String, RefPtr<APIObject> > MapType;
     46 
     47     static PassRefPtr<ImmutableDictionary> create()
     48     {
     49         return adoptRef(new ImmutableDictionary);
     50     }
     51     static PassRefPtr<ImmutableDictionary> adopt(MapType& map)
     52     {
     53         return adoptRef(new ImmutableDictionary(map));
     54     }
     55 
     56     virtual ~ImmutableDictionary();
     57 
     58     virtual bool isMutable() { return false; }
     59 
     60     template<typename T>
     61     T* get(const String& key)
     62     {
     63         RefPtr<APIObject> item = m_map.get(key);
     64         if (!item)
     65             return 0;
     66 
     67         if (item->type() != T::APIType)
     68             return 0;
     69 
     70         return static_cast<T*>(item.get());
     71     }
     72 
     73     APIObject* get(const String& key)
     74     {
     75         return m_map.get(key).get();
     76     }
     77 
     78     PassRefPtr<ImmutableArray> keys() const;
     79 
     80     size_t size() { return m_map.size(); }
     81 
     82     const MapType& map() { return m_map; }
     83 
     84 protected:
     85     ImmutableDictionary();
     86     ImmutableDictionary(MapType& map);
     87 
     88     virtual Type type() const { return APIType; }
     89 
     90     MapType m_map;
     91 };
     92 
     93 } // namespace WebKit
     94 
     95 #endif // ImmutableDictionary_h
     96