1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
|
/*
* Copyright (C) 2025 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include <wtf/StdLibExtras.h>
namespace WTF {
// ValueOrReference<T> is just like const T&, except that it can also optionally hold T.
//
// When T has an efficient default constructor, use ValueOrReference<T>; otherwise use OptionalOrReference<T>.
//
// ValueOrReference<T> is an optimization when you need to return a value that is
// usually an existing reference, but sometimes a temporary, e.g.:
//
// ValueOrReference<String> append(const String& string LIFETIME_BOUND, std::optional<String&> suffix)
// {
// if (!suffix) [[likely]]
// return string; // existing reference -- ValueOrReference<T> avoids a copy
// return makeString(string, suffix.value()); // temporary -- ValueOrReference<T> holds T
// }
template<typename T> class ValueOrReference {
public:
ValueOrReference()
: m_reference(m_value)
{
}
ValueOrReference(ValueOrReference&& other)
: m_value(WTFMove(other.m_value))
, m_reference(&other.m_reference == &other.m_value ? m_value : other.m_reference)
{
}
ValueOrReference(const T& reference LIFETIME_BOUND)
: m_reference(reference)
{
}
ValueOrReference(T&& temporary)
: m_value(WTFMove(temporary))
, m_reference(m_value)
{
}
operator const T&() const LIFETIME_BOUND { return m_reference; }
const T& get() const LIFETIME_BOUND { return m_reference; }
const T* operator->() const LIFETIME_BOUND { return &m_reference; }
private:
T m_value;
const T& m_reference;
};
} // namespace WTF
using WTF::ValueOrReference;
|