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 ImmutableArray_h
27#define ImmutableArray_h
28
29#include "APIObject.h"
30#include <wtf/PassOwnArrayPtr.h>
31#include <wtf/PassRefPtr.h>
32#include <wtf/Vector.h>
33
34namespace WebKit {
35
36// ImmutableArray - An immutable array type suitable for vending to an API.
37
38class ImmutableArray : public APIObject {
39public:
40    static const Type APIType = TypeArray;
41
42    static PassRefPtr<ImmutableArray> create()
43    {
44        return adoptRef(new ImmutableArray);
45    }
46    static PassRefPtr<ImmutableArray> create(APIObject** entries, size_t size)
47    {
48        return adoptRef(new ImmutableArray(entries, size));
49    }
50    static PassRefPtr<ImmutableArray> adopt(Vector<RefPtr<APIObject> >& entries)
51    {
52        return adoptRef(new ImmutableArray(entries));
53    }
54
55    virtual ~ImmutableArray();
56
57    template<typename T>
58    T* at(size_t i) { if (m_entries[i]->type() != T::APIType) return 0; return static_cast<T*>(m_entries[i].get()); }
59
60    APIObject* at(size_t i) { return m_entries[i].get(); }
61    size_t size() { return m_entries.size(); }
62
63    virtual bool isMutable() { return false; }
64
65protected:
66    ImmutableArray();
67    ImmutableArray(APIObject** entries, size_t size);
68    ImmutableArray(Vector<RefPtr<APIObject> >& entries);
69
70    virtual Type type() const { return APIType; }
71
72    Vector<RefPtr<APIObject> > m_entries;
73};
74
75} // namespace WebKit
76
77#endif // ImmutableArray_h
78