diff --git a/Redcraft.Utility/Source/Private/Testing/ContainersTesting.cpp b/Redcraft.Utility/Source/Private/Testing/ContainersTesting.cpp index c26d9b2..e855b53 100644 --- a/Redcraft.Utility/Source/Private/Testing/ContainersTesting.cpp +++ b/Redcraft.Utility/Source/Private/Testing/ContainersTesting.cpp @@ -13,6 +13,7 @@ void TestContainers() { TestArray(); TestStaticArray(); + TestArrayView(); } NAMESPACE_UNNAMED_BEGIN @@ -178,6 +179,68 @@ void TestStaticArray() } } +void TestArrayView() +{ + { + int32 ArrayA[] = { 0, 0, 0, 0 }; + TStaticArray ArrayB = { 4, 4, 4, 4 }; + TArray ArrayC = { 0, 1, 2, 3 }; + + TArrayView ViewA; + TArrayView ViewB(ArrayA); + TArrayView ViewC(ArrayB); + TArrayView ViewD(ViewC); + TArrayView ViewE(MoveTemp(ViewB)); + TArrayView ViewF(ArrayC); + + TArrayView ViewG; + TArrayView ViewH; + TArrayView ViewI; + + ViewG = ViewD; + ViewH = MoveTemp(ViewE); + ViewI = ArrayC; + + always_check(ViewC == ArrayB); + always_check(ViewD == ArrayB); + always_check(ViewG == ArrayB); + always_check(ViewF == ArrayC); + always_check(ViewI == ArrayC); + } + + { + int32 Array[] = { 0, 1, 2, 3 }; + + TArrayView View = Array; + + int32 First2[] = { 0, 1 }; + always_check(View.First<2>() == First2); + always_check(View.First(2) == First2); + + int32 Last2[] = { 2, 3 }; + always_check(View.Last<2>() == Last2); + always_check(View.Last(2) == Last2); + + int32 Subview2[] = { 1, 2 }; + always_check((View.Subview<1, 2>() == Subview2)); + always_check((View.Subview(1, 2) == Subview2)); + } + + { + int32 Array[] = { 0, 1, 2, 3 }; + + TArrayView View = Array; + + always_check(View.Num() == 4); + always_check(View.NumBytes() == 16); + + TArrayView ViewBytes = View.AsBytes(); + + always_check(ViewBytes.Num() == 16); + always_check(ViewBytes.NumBytes() == 16); + } +} + NAMESPACE_END(Testing) NAMESPACE_MODULE_END(Utility) diff --git a/Redcraft.Utility/Source/Public/Containers/Array.h b/Redcraft.Utility/Source/Public/Containers/Array.h index 5cda68a..b02e23d 100644 --- a/Redcraft.Utility/Source/Public/Containers/Array.h +++ b/Redcraft.Utility/Source/Public/Containers/Array.h @@ -139,8 +139,7 @@ public: NODISCARD friend FORCEINLINE ptrdiff operator-(const TArrayIterator& LHS, const TArrayIterator& RHS) { LHS.CheckThis(); RHS.CheckThis(); return LHS.Pointer - RHS.Pointer; } - NODISCARD FORCEINLINE explicit operator ElementType*() requires (!CConst) { CheckThis(); return Pointer; } - NODISCARD FORCEINLINE explicit operator const ElementType*() const { CheckThis(); return Pointer; } + NODISCARD FORCEINLINE explicit operator TObserverPtr() const { CheckThis(); return TObserverPtr(Pointer); } private: diff --git a/Redcraft.Utility/Source/Public/Containers/ArrayView.h b/Redcraft.Utility/Source/Public/Containers/ArrayView.h new file mode 100644 index 0000000..606f0e1 --- /dev/null +++ b/Redcraft.Utility/Source/Public/Containers/ArrayView.h @@ -0,0 +1,436 @@ +#pragma once + +#include "CoreTypes.h" +#include "Templates/Utility.h" +#include "Templates/TypeHash.h" +#include "Templates/Container.h" +#include "Containers/Iterator.h" +#include "TypeTraits/TypeTraits.h" +#include "Miscellaneous/Compare.h" +#include "Memory/ObserverPointer.h" +#include "Miscellaneous/AssertionMacros.h" + +NAMESPACE_REDCRAFT_BEGIN +NAMESPACE_MODULE_BEGIN(Redcraft) +NAMESPACE_MODULE_BEGIN(Utility) + +template +class TArrayView; + +NAMESPACE_PRIVATE_BEGIN + +template +class TArrayViewIterator +{ +public: + + using ElementType = T; + + FORCEINLINE constexpr TArrayViewIterator() = default; + +# if DO_CHECK + FORCEINLINE constexpr TArrayViewIterator(const TArrayViewIterator>& InValue) requires (CConst) + : Pointer(InValue.Pointer), FirstSentinel(InValue.FirstSentinel), EndSentinel(InValue.EndSentinel) + { } +# else + FORCEINLINE constexpr TArrayViewIterator(const TArrayViewIterator>& InValue) requires (CConst) + : Pointer(InValue.Pointer) + { } +# endif + + FORCEINLINE constexpr TArrayViewIterator(const TArrayViewIterator&) = default; + FORCEINLINE constexpr TArrayViewIterator(TArrayViewIterator&&) = default; + FORCEINLINE constexpr TArrayViewIterator& operator=(const TArrayViewIterator&) = default; + FORCEINLINE constexpr TArrayViewIterator& operator=(TArrayViewIterator&&) = default; + + NODISCARD friend FORCEINLINE constexpr bool operator==(const TArrayViewIterator& LHS, const TArrayViewIterator& RHS) { return LHS.Pointer == RHS.Pointer; } + + NODISCARD friend FORCEINLINE constexpr strong_ordering operator<=>(const TArrayViewIterator & LHS, const TArrayViewIterator & RHS) { return LHS.Pointer <=> RHS.Pointer; } + + NODISCARD FORCEINLINE constexpr ElementType& operator*() const { CheckThis(true); return *Pointer; } + NODISCARD FORCEINLINE constexpr ElementType* operator->() const { CheckThis(true); return Pointer; } + + NODISCARD FORCEINLINE constexpr ElementType& operator[](ptrdiff Index) const { TArrayViewIterator Temp = *this + Index; return *Temp; } + + FORCEINLINE constexpr TArrayViewIterator& operator++() { ++Pointer; CheckThis(); return *this; } + FORCEINLINE constexpr TArrayViewIterator& operator--() { --Pointer; CheckThis(); return *this; } + + FORCEINLINE constexpr TArrayViewIterator operator++(int) { TArrayViewIterator Temp = *this; ++Pointer; CheckThis(); return Temp; } + FORCEINLINE constexpr TArrayViewIterator operator--(int) { TArrayViewIterator Temp = *this; --Pointer; CheckThis(); return Temp; } + + FORCEINLINE constexpr TArrayViewIterator& operator+=(ptrdiff Offset) { Pointer += Offset; CheckThis(); return *this; } + FORCEINLINE constexpr TArrayViewIterator& operator-=(ptrdiff Offset) { Pointer -= Offset; CheckThis(); return *this; } + + NODISCARD friend FORCEINLINE constexpr TArrayViewIterator operator+(TArrayViewIterator Iter, ptrdiff Offset) { TArrayViewIterator Temp = Iter; Temp += Offset; return Temp; } + NODISCARD friend FORCEINLINE constexpr TArrayViewIterator operator+(ptrdiff Offset, TArrayViewIterator Iter) { TArrayViewIterator Temp = Iter; Temp += Offset; return Temp; } + + NODISCARD FORCEINLINE constexpr TArrayViewIterator operator-(ptrdiff Offset) const { TArrayViewIterator Temp = *this; Temp -= Offset; return Temp; } + + NODISCARD friend FORCEINLINE constexpr ptrdiff operator-(const TArrayViewIterator& LHS, const TArrayViewIterator& RHS) { LHS.CheckThis(); RHS.CheckThis(); return LHS.Pointer - RHS.Pointer; } + + NODISCARD FORCEINLINE constexpr explicit operator TObserverPtr() const { CheckThis(); return TObserverPtr(Pointer); } + +private: + + ElementType* Pointer = nullptr; + +# if DO_CHECK + ElementType* FirstSentinel = nullptr; + ElementType* EndSentinel = nullptr; +# endif + +# if DO_CHECK + FORCEINLINE constexpr TArrayViewIterator(ElementType* InPointer, ElementType* InFirstSentinel, ElementType* InEndSentinel) + : Pointer(InPointer), FirstSentinel(InFirstSentinel), EndSentinel(InEndSentinel) + { } +# else + FORCEINLINE constexpr TArrayViewIterator(ElementType* InPointer, ElementType* InFirstSentinel, ElementType* InEndSentinel) + : Pointer(InPointer) + { } +# endif + + FORCEINLINE constexpr void CheckThis(bool bExceptEnd = false) const + { + check_code + ({ + const bool bInLegalRange = FirstSentinel && EndSentinel && FirstSentinel <= Pointer && Pointer <= EndSentinel; + const bool bIsDereferenceable = Pointer != EndSentinel; + + checkf(bInLegalRange && (!bExceptEnd || bIsDereferenceable), TEXT("Read access violation. Please check IsValidIterator().")); + }); + } + + template + friend class TArrayViewIterator; + + template + friend class NAMESPACE_REDCRAFT::TArrayView; + +}; + +template +struct TEnableArrayNum { size_t ArrayNum; }; + +template <> +struct TEnableArrayNum { size_t ArrayNum; }; + +NAMESPACE_PRIVATE_END + +template +struct TStaticArray; + +template requires (!CConst && CDestructible && CInstantiableAllocator) +class TArray; + +inline constexpr size_t DynamicExtent = INDEX_NONE; + +/** + * The class template TArrayView describes an object that can refer to a contiguous sequence of objects with the first element of + * the sequence at position zero. A TArrayView can either have a static extent, in which case the number of elements in the sequence + * is known at compile-time and encoded in the type, or a dynamic extent. + */ +template +class TArrayView final : private NAMESPACE_PRIVATE::TEnableArrayNum +{ +private: + + using Impl = NAMESPACE_PRIVATE::TEnableArrayNum; + +public: + + using ElementType = T; + + using Iterator = NAMESPACE_PRIVATE::TArrayViewIterator; + + using ReverseIterator = TReverseIterator; + + static_assert(CContiguousIterator); + + static constexpr size_t Extent = InExtent; + + /** Constructs an empty array view. */ + FORCEINLINE constexpr TArrayView() requires (Extent == 0 || Extent == DynamicExtent) = default; + + /** Constructs an array view that is a view over the range ['InFirst', 'InFirst' + 'Count'). */ + template requires (CConvertibleTo(*)[], ElementType(*)[]>) + FORCEINLINE constexpr explicit (Extent != DynamicExtent) TArrayView(I InFirst, size_t InCount) : Pointer(static_cast[]>>(InFirst)) + { + checkf(Extent == DynamicExtent || Extent == InCount, TEXT("Illegal range count. Please check InCount.")); + + if constexpr (Extent == DynamicExtent) + { + Impl::ArrayNum = InCount; + } + } + + /** Constructs an array view that is a view over the range ['InFirst', 'InLast'). */ + template S> requires (CConvertibleTo(*)[], ElementType(*)[]>) + FORCEINLINE constexpr explicit (Extent != DynamicExtent) TArrayView(I InFirst, S InLast) : Pointer(static_cast[]>>(InFirst)) + { + checkf(Extent == DynamicExtent || Extent == InLast - InFirst, TEXT("Illegal range iterator. Please check InLast - InFirst.")); + + if constexpr (Extent == DynamicExtent) + { + Impl::ArrayNum = InLast - InFirst; + } + } + + /** Constructs an array view that is a view over the array 'InArray'. */ + template requires (Extent == DynamicExtent || N == Extent) + FORCEINLINE constexpr TArrayView(ElementType(&InArray)[N]) : Pointer(InArray) + { + if constexpr (Extent == DynamicExtent) + { + Impl::ArrayNum = N; + } + } + + /** Constructs an array view that is a view over the array 'InArray'. */ + template requires (CConvertibleTo) + FORCEINLINE constexpr TArrayView(TStaticArray& InArray) : TArrayView(InArray.GetData().Get(), InArray.Num()) { } + + /** Constructs an array view that is a view over the array 'InArray'. */ + template requires (CConvertibleTo) + FORCEINLINE constexpr TArrayView(const TStaticArray& InArray) : TArrayView(InArray.GetData().Get(), InArray.Num()) { } + + template + FORCEINLINE constexpr TArrayView(const TStaticArray&&) = delete; + + /** Constructs an array view that is a view over the array 'InArray'. */ + template requires (CConvertibleTo) + FORCEINLINE constexpr TArrayView(TArray& InArray) : TArrayView(InArray.GetData().Get(), InArray.Num()) { } + + /** Constructs an array view that is a view over the array 'InArray'. */ + template requires (CConvertibleTo) + FORCEINLINE constexpr TArrayView(const TArray& InArray) : TArrayView(InArray.GetData().Get(), InArray.Num()) { } + + template + FORCEINLINE constexpr TArrayView(const TArray&&) = delete; + + /** Converting constructor from another array view 'InValue'. */ + template requires ((Extent == DynamicExtent || N == DynamicExtent || N == Extent) && CConvertibleTo) + FORCEINLINE constexpr explicit (Extent != DynamicExtent && N == DynamicExtent) TArrayView(TArrayView InValue) : Pointer(InValue.GetData()) + { + checkf(Extent == DynamicExtent || Extent == InValue.Num(), TEXT("Illegal view extent. Please check InValue.Num().")); + + if constexpr (Extent == DynamicExtent) + { + Impl::ArrayNum = InValue.Num(); + } + } + + /** Defaulted copy constructor copies the size and data pointer. */ + FORCEINLINE constexpr TArrayView(const TArrayView&) = default; + + /** Assigns other to *this. This defaulted assignment operator performs a shallow copy of the data pointer and the size. */ + FORCEINLINE constexpr TArrayView& operator=(const TArrayView&) noexcept = default; + + /** Compares the contents of two array views. */ + NODISCARD friend constexpr bool operator==(TArrayView LHS, TArrayView RHS) requires (CWeaklyEqualityComparable) + { + if (LHS.Num() != RHS.Num()) return false; + + Iterator LHSIter = LHS.Begin(); + Iterator RHSIter = RHS.Begin(); + + while (LHSIter != LHS.End()) + { + if (*LHSIter != *RHSIter) return false; + + ++LHSIter; + ++RHSIter; + } + + check(RHSIter == RHS.End()); + + return true; + } + + /** Compares the contents of two array views. */ + NODISCARD friend constexpr auto operator<=>(TArrayView LHS, TArrayView RHS) requires (CSynthThreeWayComparable) + { + using OrderingType = TSynthThreeWayResult; + + if (LHS.Num() < RHS.Num()) return OrderingType::less; + if (LHS.Num() > RHS.Num()) return OrderingType::greater; + + Iterator LHSIter = LHS.Begin(); + Iterator RHSIter = RHS.Begin(); + + while (LHSIter != LHS.End()) + { + TSynthThreeWayResult Ordering = SynthThreeWayCompare(*LHSIter, *RHSIter); + + if (Ordering != OrderingType::equivalent) return Ordering; + + ++LHSIter; + ++RHSIter; + } + + check(RHSIter == RHS.End()); + + return OrderingType::equivalent; + } + + /** Obtains an array view that is a view over the first 'Count' elements of this array view. */ + template requires (Extent == DynamicExtent || Extent >= Count) + NODISCARD FORCEINLINE constexpr TArrayView First() const + { + checkf(Count <= Num(), TEXT("Illegal subview range. Please check Count.")); + + return TArrayView(Begin(), Count); + } + + /** Obtains an array view that is a view over the first 'Count' elements of this array view. */ + NODISCARD FORCEINLINE constexpr TArrayView First(size_t Count) const + { + checkf(Count <= Num(), TEXT("Illegal subview range. Please check Count.")); + + return TArrayView(Begin(), Count); + } + + /** Obtains an array view that is a view over the last 'Count' elements of this array view. */ + template requires (Extent == DynamicExtent || Extent >= Count) + NODISCARD FORCEINLINE constexpr TArrayView Last() const + { + checkf(Count <= Num(), TEXT("Illegal subview range. Please check Count.")); + + return TArrayView(End() - Count, Count); + } + + /** Obtains an array view that is a view over the last 'Count' elements of this array view. */ + NODISCARD FORCEINLINE constexpr TArrayView Last(size_t Count) const + { + checkf(Count <= Num(), TEXT("Illegal subview range. Please check Count.")); + + return TArrayView(End() - Count, Count); + } + + /** Obtains an array view that is a view over the 'Count' elements of this array view starting at 'Offset'. */ + template requires (Extent == DynamicExtent || Count == DynamicExtent || Extent >= Offset + Count) + NODISCARD FORCEINLINE constexpr auto Subview() const + { + checkf(Offset <= Num() && (Count == DynamicExtent || Offset + Count <= Num()), TEXT("Illegal subview range. Please check Offset and Count.")); + + constexpr size_t SubviewExtent = Count != DynamicExtent ? Count : (Extent != DynamicExtent ? Extent - Offset : DynamicExtent); + + if constexpr (Count != DynamicExtent) + { + return TArrayView(Begin() + Offset, Count); + } + else + { + return TArrayView(Begin() + Offset, Num() - Offset); + } + } + + /** Obtains an array view that is a view over the 'Count' elements of this array view starting at 'Offset'. */ + NODISCARD FORCEINLINE constexpr auto Subview(size_t Offset, size_t Count = DynamicExtent) const + { + checkf(Offset <= Num() && (Count == DynamicExtent || Offset + Count <= Num()), TEXT("Illegal subview range. Please check Offset and Count.")); + + if (Count != DynamicExtent) + { + return TArrayView(Begin() + Offset, Count); + } + else + { + return TArrayView(Begin() + Offset, Num() - Offset); + } + } + + /** Obtains an array view to the object representation of the elements of the array view. */ + NODISCARD FORCEINLINE constexpr auto AsBytes() + { + constexpr size_t BytesExtent = Extent != DynamicExtent ? sizeof(ElementType) * Extent : DynamicExtent; + + if constexpr (!CConst) + { + return TArrayView(reinterpret_cast(GetData().Get()), NumBytes()); + } + else + { + return TArrayView(reinterpret_cast(GetData().Get()), NumBytes()); + } + } + + /** Obtains an array view to the object representation of the elements of the array view. */ + NODISCARD FORCEINLINE constexpr auto AsBytes() const + { + constexpr size_t BytesExtent = Extent != DynamicExtent ? sizeof(ElementType) * Extent : DynamicExtent; + + return TArrayView(reinterpret_cast(GetData().Get()), NumBytes()); + } + + /** @return The pointer to the underlying element storage. */ + NODISCARD FORCEINLINE constexpr TObserverPtr GetData() const { return Pointer; } + + /** @return The iterator to the first or end element. */ + NODISCARD FORCEINLINE constexpr Iterator Begin() const { return Iterator(Pointer.Get() , Pointer.Get(), Pointer.Get() + Num()); } + NODISCARD FORCEINLINE constexpr Iterator End() const { return Iterator(Pointer.Get() + Num(), Pointer.Get(), Pointer.Get() + Num()); } + + /** @return The reverse iterator to the first or end element. */ + NODISCARD FORCEINLINE constexpr ReverseIterator RBegin() const { return ReverseIterator(End()); } + NODISCARD FORCEINLINE constexpr ReverseIterator REnd() const { return ReverseIterator(Begin()); } + + /** @return The number of elements in the container. */ + NODISCARD FORCEINLINE constexpr size_t Num() const { if constexpr (Extent == DynamicExtent) return Impl::ArrayNum; return Extent; } + + /** @return The number of bytes in the container. */ + NODISCARD FORCEINLINE constexpr size_t NumBytes() const { return Num() * sizeof(ElementType); } + + /** @return true if the container is empty, false otherwise. */ + NODISCARD FORCEINLINE constexpr bool IsEmpty() const { return Num() == 0; } + + /** @return true if the iterator is valid, false otherwise. */ + NODISCARD FORCEINLINE constexpr bool IsValidIterator(Iterator Iter) const { return Begin() <= Iter && Iter <= End(); } + + /** @return The reference to the requested element. */ + NODISCARD FORCEINLINE constexpr ElementType& operator[](size_t Index) const { checkf(Index < Num(), TEXT("Read access violation. Please check IsValidIterator().")); return Pointer[Index]; } + + /** @return The reference to the first or last element. */ + NODISCARD FORCEINLINE constexpr ElementType& Front() const { return *Begin(); } + NODISCARD FORCEINLINE constexpr ElementType& Back() const { return *(End() - 1); } + + /** Overloads the GetTypeHash algorithm for TArrayView. */ + NODISCARD friend FORCEINLINE constexpr size_t GetTypeHash(TArrayView A) requires (CHashable) + { + size_t Result = 0; + + for (Iterator Iter = A.Begin(); Iter != A.End(); ++Iter) + { + Result = HashCombine(Result, GetTypeHash(*Iter)); + } + + return Result; + } + + ENABLE_RANGE_BASED_FOR_LOOP_SUPPORT + +private: + + TObserverPtr Pointer; + +}; + +template +TArrayView(I, S) -> TArrayView>>; + +template +TArrayView(T(&)[N]) -> TArrayView; + +template +TArrayView(TStaticArray&) -> TArrayView; + +template +TArrayView(const TStaticArray&) -> TArrayView; + +template +TArrayView(TArray&) -> TArrayView; + +template +TArrayView(const TArray&) -> TArrayView; + +NAMESPACE_MODULE_END(Utility) +NAMESPACE_MODULE_END(Redcraft) +NAMESPACE_REDCRAFT_END diff --git a/Redcraft.Utility/Source/Public/Containers/Containers.h b/Redcraft.Utility/Source/Public/Containers/Containers.h index 77a0553..227edf2 100644 --- a/Redcraft.Utility/Source/Public/Containers/Containers.h +++ b/Redcraft.Utility/Source/Public/Containers/Containers.h @@ -4,3 +4,4 @@ #include "Containers/Iterator.h" #include "Containers/Array.h" #include "Containers/StaticArray.h" +#include "Containers/ArrayView.h" diff --git a/Redcraft.Utility/Source/Public/Containers/Iterator.h b/Redcraft.Utility/Source/Public/Containers/Iterator.h index ba206ab..d3e6d1c 100644 --- a/Redcraft.Utility/Source/Public/Containers/Iterator.h +++ b/Redcraft.Utility/Source/Public/Containers/Iterator.h @@ -7,6 +7,7 @@ #include "Templates/Noncopyable.h" #include "TypeTraits/TypeTraits.h" #include "Miscellaneous/Compare.h" +#include "Memory/ObserverPointer.h" #include "Miscellaneous/AssertionMacros.h" NAMESPACE_REDCRAFT_BEGIN @@ -117,7 +118,7 @@ concept CContiguousIterator = CRandomAccessIterator && CLValueReference, TRemoveReference>> && requires(I& Iter) { - static_cast>>(Iter); + static_cast[]>>(Iter); { AddressOf(*Iter) } -> CSameAs>>; }; @@ -416,8 +417,7 @@ public: NODISCARD friend FORCEINLINE constexpr ptrdiff operator-(const TCountedIterator& LHS, FDefaultSentinel) { CheckThis(); return -LHS.Num(); } NODISCARD friend FORCEINLINE constexpr ptrdiff operator-(FDefaultSentinel, const TCountedIterator& RHS) { CheckThis(); return RHS.Num(); } - NODISCARD FORCEINLINE constexpr explicit operator ElementType*() requires (CContiguousIterator && !CConst) { CheckThis(); return Current; } - NODISCARD FORCEINLINE constexpr explicit operator const ElementType*() const requires (CContiguousIterator) { CheckThis(); return Current; } + NODISCARD FORCEINLINE constexpr explicit operator TObserverPtr() const requires (CContiguousIterator) { CheckThis(); return TObserverPtr(Current); } NODISCARD FORCEINLINE constexpr const IteratorType& GetBase() const& { CheckThis(); return Current; } NODISCARD FORCEINLINE constexpr IteratorType GetBase() && { CheckThis(); return Current; } @@ -755,7 +755,7 @@ template FORCEINLINE constexpr decltype(auto) RBegin( template FORCEINLINE constexpr decltype(auto) RBegin(const T(& Container)[N]) { return TReverseIterator(End(Container)); } template FORCEINLINE constexpr decltype(auto) RBegin(const T(&& Container)[N]) { return TReverseIterator(End(Container)); } -/** Overloads the RBegin algorithm for T::rbegin(). */ +/** Overloads the RBegin algorithm for initializer_list. */ template FORCEINLINE constexpr decltype(auto) RBegin(initializer_list Container) { @@ -775,7 +775,7 @@ template FORCEINLINE constexpr decltype(auto) REnd( template FORCEINLINE constexpr decltype(auto) REnd(const T(& Container)[N]) { return TReverseIterator(Begin(Container)); } template FORCEINLINE constexpr decltype(auto) REnd(const T(&& Container)[N]) { return TReverseIterator(Begin(Container)); } -/** Overloads the REnd algorithm for T::end(). */ +/** Overloads the REnd algorithm for initializer_list. */ template FORCEINLINE constexpr decltype(auto) REnd(initializer_list Container) { diff --git a/Redcraft.Utility/Source/Public/Containers/StaticArray.h b/Redcraft.Utility/Source/Public/Containers/StaticArray.h index 5b350dc..5a0d453 100644 --- a/Redcraft.Utility/Source/Public/Containers/StaticArray.h +++ b/Redcraft.Utility/Source/Public/Containers/StaticArray.h @@ -6,6 +6,7 @@ #include "Templates/TypeHash.h" #include "Templates/Container.h" #include "Containers/Iterator.h" +#include "Containers/ArrayView.h" #include "TypeTraits/TypeTraits.h" #include "Miscellaneous/Compare.h" #include "Memory/ObserverPointer.h" @@ -15,93 +16,6 @@ NAMESPACE_REDCRAFT_BEGIN NAMESPACE_MODULE_BEGIN(Redcraft) NAMESPACE_MODULE_BEGIN(Utility) -NAMESPACE_PRIVATE_BEGIN - -template -class TStaticArrayIterator -{ -public: - - using ElementType = T; - - FORCEINLINE constexpr TStaticArrayIterator() = default; - -# if DO_CHECK - FORCEINLINE constexpr TStaticArrayIterator(const TStaticArrayIterator>& InValue) requires (CConst) - : Owner(InValue.Owner), Pointer(InValue.Pointer) - { } -# else - FORCEINLINE constexpr TStaticArrayIterator(const TStaticArrayIterator>& InValue) requires (CConst) - : Pointer(InValue.Pointer) - { } -# endif - - FORCEINLINE constexpr TStaticArrayIterator(const TStaticArrayIterator&) = default; - FORCEINLINE constexpr TStaticArrayIterator(TStaticArrayIterator&&) = default; - FORCEINLINE constexpr TStaticArrayIterator& operator=(const TStaticArrayIterator&) = default; - FORCEINLINE constexpr TStaticArrayIterator& operator=(TStaticArrayIterator&&) = default; - - NODISCARD friend FORCEINLINE constexpr bool operator==(const TStaticArrayIterator& LHS, const TStaticArrayIterator& RHS) { return LHS.Pointer == RHS.Pointer; } - - NODISCARD friend FORCEINLINE constexpr strong_ordering operator<=>(const TStaticArrayIterator & LHS, const TStaticArrayIterator & RHS) { return LHS.Pointer <=> RHS.Pointer; } - - NODISCARD FORCEINLINE constexpr ElementType& operator*() const { CheckThis(true); return *Pointer; } - NODISCARD FORCEINLINE constexpr ElementType* operator->() const { CheckThis(true); return Pointer; } - - NODISCARD FORCEINLINE constexpr ElementType& operator[](ptrdiff Index) const { TStaticArrayIterator Temp = *this + Index; return *Temp; } - - FORCEINLINE constexpr TStaticArrayIterator& operator++() { ++Pointer; CheckThis(); return *this; } - FORCEINLINE constexpr TStaticArrayIterator& operator--() { --Pointer; CheckThis(); return *this; } - - FORCEINLINE constexpr TStaticArrayIterator operator++(int) { TStaticArrayIterator Temp = *this; ++Pointer; CheckThis(); return Temp; } - FORCEINLINE constexpr TStaticArrayIterator operator--(int) { TStaticArrayIterator Temp = *this; --Pointer; CheckThis(); return Temp; } - - FORCEINLINE constexpr TStaticArrayIterator& operator+=(ptrdiff Offset) { Pointer += Offset; CheckThis(); return *this; } - FORCEINLINE constexpr TStaticArrayIterator& operator-=(ptrdiff Offset) { Pointer -= Offset; CheckThis(); return *this; } - - NODISCARD friend FORCEINLINE constexpr TStaticArrayIterator operator+(TStaticArrayIterator Iter, ptrdiff Offset) { TStaticArrayIterator Temp = Iter; Temp += Offset; return Temp; } - NODISCARD friend FORCEINLINE constexpr TStaticArrayIterator operator+(ptrdiff Offset, TStaticArrayIterator Iter) { TStaticArrayIterator Temp = Iter; Temp += Offset; return Temp; } - - NODISCARD FORCEINLINE constexpr TStaticArrayIterator operator-(ptrdiff Offset) const { TStaticArrayIterator Temp = *this; Temp -= Offset; return Temp; } - - NODISCARD friend FORCEINLINE constexpr ptrdiff operator-(const TStaticArrayIterator& LHS, const TStaticArrayIterator& RHS) { LHS.CheckThis(); RHS.CheckThis(); return LHS.Pointer - RHS.Pointer; } - - NODISCARD FORCEINLINE constexpr explicit operator ElementType*() requires (!CConst) { CheckThis(); return Pointer; } - NODISCARD FORCEINLINE constexpr explicit operator const ElementType*() const { CheckThis(); return Pointer; } - -private: - -# if DO_CHECK - const ArrayType* Owner = nullptr; -# endif - - ElementType* Pointer = nullptr; - -# if DO_CHECK - FORCEINLINE constexpr TStaticArrayIterator(const ArrayType* InContainer, ElementType* InPointer) - : Owner(InContainer), Pointer(InPointer) - { } -# else - FORCEINLINE constexpr TStaticArrayIterator(const ArrayType* InContainer, ElementType* InPointer) - : Pointer(InPointer) - { } -# endif - - FORCEINLINE constexpr void CheckThis(bool bExceptEnd = false) const - { - checkf(Owner && Owner->IsValidIterator(*this), TEXT("Read access violation. Please check IsValidIterator().")); - checkf(!(bExceptEnd && Owner->End() == *this), TEXT("Read access violation. Please check IsValidIterator().")); - } - - friend ArrayType; - - template - friend class TStaticArrayIterator; - -}; - -NAMESPACE_PRIVATE_END - /** TStaticArray is a container that encapsulates fixed size arrays. */ template struct TStaticArray final @@ -109,8 +23,8 @@ struct TStaticArray final using ElementType = T; - using Iterator = NAMESPACE_PRIVATE::TStaticArrayIterator; - using ConstIterator = NAMESPACE_PRIVATE::TStaticArrayIterator; + using Iterator = TArrayView< T, N>::Iterator; + using ConstIterator = TArrayView::Iterator; using ReverseIterator = TReverseIterator< Iterator>; using ConstReverseIterator = TReverseIterator; @@ -170,10 +84,10 @@ struct TStaticArray final NODISCARD FORCEINLINE constexpr TObserverPtr GetData() const { return TObserverPtr(_); } /** @return The iterator to the first or end element. */ - NODISCARD FORCEINLINE constexpr Iterator Begin() { return Iterator(this, _); } - NODISCARD FORCEINLINE constexpr ConstIterator Begin() const { return ConstIterator(this, _); } - NODISCARD FORCEINLINE constexpr Iterator End() { return Iterator(this, _ + Num()); } - NODISCARD FORCEINLINE constexpr ConstIterator End() const { return ConstIterator(this, _ + Num()); } + NODISCARD FORCEINLINE constexpr Iterator Begin() { return TArrayView< T, N>(*this).Begin(); } + NODISCARD FORCEINLINE constexpr ConstIterator Begin() const { return TArrayView(*this).Begin(); } + NODISCARD FORCEINLINE constexpr Iterator End() { return TArrayView< T, N>(*this).End(); } + NODISCARD FORCEINLINE constexpr ConstIterator End() const { return TArrayView(*this).End(); } /** @return The reverse iterator to the first or end element. */ NODISCARD FORCEINLINE constexpr ReverseIterator RBegin() { return ReverseIterator(End()); } @@ -183,7 +97,6 @@ struct TStaticArray final /** @return The number of elements in the container. */ NODISCARD FORCEINLINE constexpr size_t Num() const { return N; } - NODISCARD FORCEINLINE constexpr size_t Max() const { return N; } /** @return true if the container is empty, false otherwise. */ NODISCARD FORCEINLINE constexpr bool IsEmpty() const { return Num() == 0; } diff --git a/Redcraft.Utility/Source/Public/Templates/Function.h b/Redcraft.Utility/Source/Public/Templates/Function.h index 8fc4b9e..6e3a0e3 100644 --- a/Redcraft.Utility/Source/Public/Templates/Function.h +++ b/Redcraft.Utility/Source/Public/Templates/Function.h @@ -567,16 +567,16 @@ public: /** Remove the default initialization and disallow the construction of a TFunctionRef that does not store the function target. */ FORCEINLINE constexpr TFunctionRef() = delete; - FORCEINLINE constexpr TFunctionRef(const TFunctionRef& InValue) = default; - FORCEINLINE constexpr TFunctionRef(TFunctionRef&& InValue) = default; + FORCEINLINE constexpr TFunctionRef(const TFunctionRef&) = default; + FORCEINLINE constexpr TFunctionRef(TFunctionRef&&) = default; /** * We delete the assignment operators because we don't want it to be confused with being related to * regular C++ reference assignment - i.e. calling the assignment operator of whatever the reference * is bound to - because that's not what TFunctionRef does, nor is it even capable of doing that. */ - FORCEINLINE constexpr TFunctionRef& operator=(const TFunctionRef& InValue) = delete; - FORCEINLINE constexpr TFunctionRef& operator=(TFunctionRef&& InValue) = delete; + FORCEINLINE constexpr TFunctionRef& operator=(const TFunctionRef&) = delete; + FORCEINLINE constexpr TFunctionRef& operator=(TFunctionRef&&) = delete; /** Constructor which binds a TFunctionRef to a callable object. */ template requires (!CTFunctionRef> @@ -617,10 +617,10 @@ public: /** Default constructor. */ FORCEINLINE constexpr TFunction(nullptr_t = nullptr) { Impl::Invalidate(); } - FORCEINLINE TFunction(const TFunction& InValue) = default; - FORCEINLINE TFunction(TFunction&& InValue) = default; - FORCEINLINE TFunction& operator=(const TFunction& InValue) = default; - FORCEINLINE TFunction& operator=(TFunction&& InValue) = default; + FORCEINLINE TFunction(const TFunction&) = default; + FORCEINLINE TFunction(TFunction&&) = default; + FORCEINLINE TFunction& operator=(const TFunction&) = default; + FORCEINLINE TFunction& operator=(TFunction&&) = default; /** * Constructs an TFunction with initial content an function object of type TDecay, @@ -746,10 +746,10 @@ public: /** Default constructor. */ FORCEINLINE constexpr TUniqueFunction(nullptr_t = nullptr) { Impl::Invalidate(); } - FORCEINLINE TUniqueFunction(const TUniqueFunction& InValue) = delete; - FORCEINLINE TUniqueFunction(TUniqueFunction&& InValue) = default; - FORCEINLINE TUniqueFunction& operator=(const TUniqueFunction& InValue) = delete; - FORCEINLINE TUniqueFunction& operator=(TUniqueFunction&& InValue) = default; + FORCEINLINE TUniqueFunction(const TUniqueFunction&) = delete; + FORCEINLINE TUniqueFunction(TUniqueFunction&&) = default; + FORCEINLINE TUniqueFunction& operator=(const TUniqueFunction&) = delete; + FORCEINLINE TUniqueFunction& operator=(TUniqueFunction&&) = default; /** Constructor from TFunction to TUniqueFunction. */ FORCEINLINE TUniqueFunction(const TFunction& InValue) diff --git a/Redcraft.Utility/Source/Public/Testing/ContainersTesting.h b/Redcraft.Utility/Source/Public/Testing/ContainersTesting.h index 3fcfaf8..979cc3a 100644 --- a/Redcraft.Utility/Source/Public/Testing/ContainersTesting.h +++ b/Redcraft.Utility/Source/Public/Testing/ContainersTesting.h @@ -11,6 +11,7 @@ NAMESPACE_BEGIN(Testing) REDCRAFTUTILITY_API void TestContainers(); REDCRAFTUTILITY_API void TestArray(); REDCRAFTUTILITY_API void TestStaticArray(); +REDCRAFTUTILITY_API void TestArrayView(); NAMESPACE_END(Testing)