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