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