← Back to branch summary

~mmach/netext73/webkit2gtk

« back to all changes in this revision

Viewing changes to Source/WTF/wtf/NakedRef.h

  • Committer: mmach
  • Date: 2023-06-16 17:21:37 UTC
  • Revision ID: netbit73@gmail.com-20230616172137-2rqx6yr96ga9g3kp
1

Show diffs side-by-side

added added

removed removed

Lines of Context:
Source/WTF/wtf/NakedRef.h
 
1
/*
 
2
 * Copyright (C) 2020 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. ``AS IS'' AND ANY
 
14
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
15
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 
16
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 
17
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
18
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
19
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 
20
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 
21
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 
22
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 
23
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
24
 */
 
25
 
 
26
#pragma once
 
27
 
 
28
#include <wtf/DumbPtrTraits.h>
 
29
#include <wtf/FastMalloc.h>
 
30
 
 
31
namespace WTF {
 
32
 
 
33
// The purpose of this class is to ensure that the wrapped pointer will never be
 
34
// used uninitialized.
 
35
 
 
36
template <typename T> class NakedRef {
 
37
    WTF_MAKE_FAST_ALLOCATED;
 
38
public:
 
39
    ALWAYS_INLINE NakedRef(T& ref) : m_ptr(&ref) { }
 
40
    ALWAYS_INLINE NakedRef(const NakedRef&) = delete;
 
41
    template<typename U> NakedRef(const NakedRef<U>&) = delete;
 
42
 
 
43
    ALWAYS_INLINE NakedRef(NakedRef&& other)
 
44
        : m_ptr(&other.leakRef())
 
45
    {
 
46
        ASSERT(m_ptr);
 
47
    }
 
48
 
 
49
    template<typename U>
 
50
    NakedRef(NakedRef<U>&& other)
 
51
        : m_ptr(&other.leakRef())
 
52
    {
 
53
        ASSERT(m_ptr);
 
54
    }
 
55
 
 
56
    ALWAYS_INLINE T* operator->() const { ASSERT(m_ptr); return m_ptr; }
 
57
    T* ptr() const RETURNS_NONNULL { ASSERT(m_ptr); return m_ptr; }
 
58
    T& get() const { return *m_ptr; }
 
59
    operator T&() const { ASSERT(m_ptr); return *m_ptr; }
 
60
    bool operator!() const { ASSERT(m_ptr); return !*m_ptr; }
 
61
 
 
62
    NakedRef copyRef() && = delete;
 
63
    NakedRef copyRef() const & WARN_UNUSED_RETURN { return NakedRef(*m_ptr); }
 
64
 
 
65
    NakedRef& operator=(T&);
 
66
    NakedRef& operator=(NakedRef&&);
 
67
    template<typename U> NakedRef& operator=(NakedRef<U>&&);
 
68
 
 
69
    // Use copyRef() and the move assignment operators instead.
 
70
    NakedRef& operator=(const NakedRef&) = delete;
 
71
    template<typename X> NakedRef& operator=(const NakedRef<X>&) = delete;
 
72
 
 
73
    template<typename U> void swap(NakedRef<U>&);
 
74
 
 
75
    T& leakRef() WARN_UNUSED_RETURN
 
76
    {
 
77
        ASSERT(m_ptr);
 
78
        T& result = *DumbPtrTraits<T>::exchange(m_ptr, nullptr);
 
79
        return result;
 
80
    }
 
81
 
 
82
private:
 
83
    T* m_ptr;
 
84
};
 
85
 
 
86
template<typename T> inline NakedRef<T>& NakedRef<T>::operator=(NakedRef&& reference)
 
87
{
 
88
    NakedRef movedReference = WTFMove(reference);
 
89
    swap(movedReference);
 
90
    return *this;
 
91
}
 
92
 
 
93
template<typename T> inline NakedRef<T>& NakedRef<T>::operator=(T& ref)
 
94
{
 
95
    NakedRef copiedReference = ref;
 
96
    swap(copiedReference);
 
97
    return *this;
 
98
}
 
99
 
 
100
template<typename T> template<typename U> inline NakedRef<T>& NakedRef<T>::operator=(NakedRef<U>&& other)
 
101
{
 
102
    NakedRef ref = WTFMove(other);
 
103
    swap(ref);
 
104
    return *this;
 
105
}
 
106
 
 
107
template<class T>
 
108
template<class U>
 
109
inline void NakedRef<T>::swap(NakedRef<U>& other)
 
110
{
 
111
    std::swap(m_ptr, other.m_ptr);
 
112
}
 
113
 
 
114
template<class T, class U> inline void swap(NakedRef<T>& a, NakedRef<U>& b)
 
115
{
 
116
    a.swap(b);
 
117
}
 
118
 
 
119
} // namespace WTF
 
120
 
 
121
using WTF::NakedRef;