Remove ImmutableArray::isMutable
[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/Forward.h>
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/Vector.h>
33
34 namespace WebKit {
35
36 // ImmutableArray - An immutable array type suitable for vending to an API.
37
38 class ImmutableArray FINAL : public TypedAPIObject<APIObject::TypeArray> {
39 public:
40     static PassRefPtr<ImmutableArray> create();
41     static PassRefPtr<ImmutableArray> create(Vector<RefPtr<APIObject>> elements);
42
43     static PassRefPtr<ImmutableArray> createStringArray(const Vector<String>&);
44
45     virtual ~ImmutableArray();
46
47     template<typename T>
48     T* at(size_t i) const
49     {
50         if (m_elements[i]->type() != T::APIType)
51             return nullptr;
52
53         return static_cast<T*>(m_elements[i].get());
54     }
55
56     APIObject* at(size_t i) const { return m_elements[i].get(); }
57     size_t size() const { return m_elements.size(); }
58
59     const Vector<RefPtr<APIObject>>& elements() const { return m_elements; }
60     Vector<RefPtr<APIObject>>& elements() { return m_elements; }
61
62 protected:
63     ImmutableArray(Vector<RefPtr<APIObject>> elements);
64
65     Vector<RefPtr<APIObject>> m_elements;
66 };
67
68 } // namespace WebKit
69
70 #endif // ImmutableArray_h