jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Vector.h>
30
31namespace AK {
32
33template<typename PtrType, int inline_capacity = 0>
34class NonnullPtrVector : public Vector<PtrType, inline_capacity> {
35 typedef typename PtrType::ElementType T;
36 typedef Vector<PtrType, inline_capacity> Base;
37
38public:
39 NonnullPtrVector()
40 {
41 }
42
43 NonnullPtrVector(Vector<PtrType>&& other)
44 : Base(static_cast<Base&&>(other))
45 {
46 }
47 NonnullPtrVector(const Vector<PtrType>& other)
48 : Base(static_cast<const Base&>(other))
49 {
50 }
51
52 using Base::size;
53
54 using Iterator = VectorIterator<NonnullPtrVector, T>;
55 Iterator begin() { return Iterator(*this, 0); }
56 Iterator end() { return Iterator(*this, size()); }
57
58 using ConstIterator = VectorIterator<const NonnullPtrVector, const T>;
59 ConstIterator begin() const { return ConstIterator(*this, 0); }
60 ConstIterator end() const { return ConstIterator(*this, size()); }
61
62 PtrType& ptr_at(int index) { return Base::at(index); }
63 const PtrType& ptr_at(int index) const { return Base::at(index); }
64
65 T& at(int index) { return *Base::at(index); }
66 const T& at(int index) const { return *Base::at(index); }
67 T& operator[](int index) { return at(index); }
68 const T& operator[](int index) const { return at(index); }
69 T& first() { return at(0); }
70 const T& first() const { return at(0); }
71 T& last() { return at(size() - 1); }
72 const T& last() const { return at(size() - 1); }
73
74private:
75 // NOTE: You can't use resize() on a NonnullFooPtrVector since making the vector
76 // bigger would require being able to default-construct NonnullFooPtrs.
77 // Instead, use shrink(new_size).
78 void resize(int) = delete;
79};
80
81}