diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | ad18d877ddd2a44d98fa12ccd3dbbcf4d0ac4299 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /js/public/GCVector.h | |
parent | 15477ed9af4859dacb069040b5d4de600803d3bc (diff) | |
download | aura-central-ad18d877ddd2a44d98fa12ccd3dbbcf4d0ac4299.tar.gz |
Add m-esr52 at 52.6.0
Diffstat (limited to 'js/public/GCVector.h')
-rw-r--r-- | js/public/GCVector.h | 249 |
1 files changed, 249 insertions, 0 deletions
diff --git a/js/public/GCVector.h b/js/public/GCVector.h new file mode 100644 index 000000000..2668e65b2 --- /dev/null +++ b/js/public/GCVector.h @@ -0,0 +1,249 @@ +/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- + * vim: set ts=8 sts=4 et sw=4 tw=99: + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#ifndef js_GCVector_h +#define js_GCVector_h + +#include "mozilla/Vector.h" + +#include "js/GCPolicyAPI.h" +#include "js/RootingAPI.h" +#include "js/TracingAPI.h" +#include "js/Vector.h" + +namespace JS { + +// A GCVector is a Vector with an additional trace method that knows how +// to visit all of the items stored in the Vector. For vectors that contain GC +// things, this is usually more convenient than manually iterating and marking +// the contents. +// +// Most types of GC pointers as keys and values can be traced with no extra +// infrastructure. For structs and non-gc-pointer members, ensure that there is +// a specialization of GCPolicy<T> with an appropriate trace method available +// to handle the custom type. Generic helpers can be found in +// js/public/TracingAPI.h. +// +// Note that although this Vector's trace will deal correctly with moved items, +// it does not itself know when to barrier or trace items. To function properly +// it must either be used with Rooted, or barriered and traced manually. +template <typename T, + size_t MinInlineCapacity = 0, + typename AllocPolicy = js::TempAllocPolicy> +class GCVector +{ + mozilla::Vector<T, MinInlineCapacity, AllocPolicy> vector; + + public: + explicit GCVector(AllocPolicy alloc = AllocPolicy()) + : vector(alloc) + {} + + GCVector(GCVector&& vec) + : vector(mozilla::Move(vec.vector)) + {} + + GCVector& operator=(GCVector&& vec) { + vector = mozilla::Move(vec.vector); + return *this; + } + + size_t length() const { return vector.length(); } + bool empty() const { return vector.empty(); } + size_t capacity() const { return vector.capacity(); } + + T* begin() { return vector.begin(); } + const T* begin() const { return vector.begin(); } + + T* end() { return vector.end(); } + const T* end() const { return vector.end(); } + + T& operator[](size_t i) { return vector[i]; } + const T& operator[](size_t i) const { return vector[i]; } + + T& back() { return vector.back(); } + const T& back() const { return vector.back(); } + + bool initCapacity(size_t cap) { return vector.initCapacity(cap); } + bool reserve(size_t req) { return vector.reserve(req); } + void shrinkBy(size_t amount) { return vector.shrinkBy(amount); } + bool growBy(size_t amount) { return vector.growBy(amount); } + bool resize(size_t newLen) { return vector.resize(newLen); } + + void clear() { return vector.clear(); } + + template<typename U> bool append(U&& item) { return vector.append(mozilla::Forward<U>(item)); } + + template<typename... Args> + bool + emplaceBack(Args&&... args) { + return vector.emplaceBack(mozilla::Forward<Args>(args)...); + } + + template<typename U> + void infallibleAppend(U&& aU) { + return vector.infallibleAppend(mozilla::Forward<U>(aU)); + } + void infallibleAppendN(const T& aT, size_t aN) { + return vector.infallibleAppendN(aT, aN); + } + template<typename U> void + infallibleAppend(const U* aBegin, const U* aEnd) { + return vector.infallibleAppend(aBegin, aEnd); + } + template<typename U> void infallibleAppend(const U* aBegin, size_t aLength) { + return vector.infallibleAppend(aBegin, aLength); + } + + template<typename U, size_t O, class BP> + bool appendAll(const mozilla::Vector<U, O, BP>& aU) { return vector.appendAll(aU); } + template<typename U, size_t O, class BP> + bool appendAll(const GCVector<U, O, BP>& aU) { return vector.append(aU.begin(), aU.length()); } + + bool appendN(const T& val, size_t count) { return vector.appendN(val, count); } + + template<typename U> bool append(const U* aBegin, const U* aEnd) { + return vector.append(aBegin, aEnd); + } + template<typename U> bool append(const U* aBegin, size_t aLength) { + return vector.append(aBegin, aLength); + } + + void popBack() { return vector.popBack(); } + T popCopy() { return vector.popCopy(); } + + size_t sizeOfExcludingThis(mozilla::MallocSizeOf mallocSizeOf) const { + return vector.sizeOfExcludingThis(mallocSizeOf); + } + + size_t sizeOfIncludingThis(mozilla::MallocSizeOf mallocSizeOf) const { + return vector.sizeOfIncludingThis(mallocSizeOf); + } + + static void trace(GCVector* vec, JSTracer* trc) { vec->trace(trc); } + + void trace(JSTracer* trc) { + for (auto& elem : vector) + GCPolicy<T>::trace(trc, &elem, "vector element"); + } +}; + +} // namespace JS + +namespace js { + +template <typename Outer, typename T, size_t Capacity, typename AllocPolicy> +class GCVectorOperations +{ + using Vec = JS::GCVector<T, Capacity, AllocPolicy>; + const Vec& vec() const { return static_cast<const Outer*>(this)->get(); } + + public: + const AllocPolicy& allocPolicy() const { return vec().allocPolicy(); } + size_t length() const { return vec().length(); } + bool empty() const { return vec().empty(); } + size_t capacity() const { return vec().capacity(); } + const T* begin() const { return vec().begin(); } + const T* end() const { return vec().end(); } + const T& back() const { return vec().back(); } + + JS::Handle<T> operator[](size_t aIndex) const { + return JS::Handle<T>::fromMarkedLocation(&vec().operator[](aIndex)); + } +}; + +template <typename Outer, typename T, size_t Capacity, typename AllocPolicy> +class MutableGCVectorOperations + : public GCVectorOperations<Outer, T, Capacity, AllocPolicy> +{ + using Vec = JS::GCVector<T, Capacity, AllocPolicy>; + const Vec& vec() const { return static_cast<const Outer*>(this)->get(); } + Vec& vec() { return static_cast<Outer*>(this)->get(); } + + public: + const AllocPolicy& allocPolicy() const { return vec().allocPolicy(); } + AllocPolicy& allocPolicy() { return vec().allocPolicy(); } + const T* begin() const { return vec().begin(); } + T* begin() { return vec().begin(); } + const T* end() const { return vec().end(); } + T* end() { return vec().end(); } + const T& back() const { return vec().back(); } + T& back() { return vec().back(); } + + JS::Handle<T> operator[](size_t aIndex) const { + return JS::Handle<T>::fromMarkedLocation(&vec().operator[](aIndex)); + } + JS::MutableHandle<T> operator[](size_t aIndex) { + return JS::MutableHandle<T>::fromMarkedLocation(&vec().operator[](aIndex)); + } + + bool initCapacity(size_t aRequest) { return vec().initCapacity(aRequest); } + bool reserve(size_t aRequest) { return vec().reserve(aRequest); } + void shrinkBy(size_t aIncr) { vec().shrinkBy(aIncr); } + bool growBy(size_t aIncr) { return vec().growBy(aIncr); } + bool resize(size_t aNewLength) { return vec().resize(aNewLength); } + bool growByUninitialized(size_t aIncr) { return vec().growByUninitialized(aIncr); } + void infallibleGrowByUninitialized(size_t aIncr) { vec().infallibleGrowByUninitialized(aIncr); } + bool resizeUninitialized(size_t aNewLength) { return vec().resizeUninitialized(aNewLength); } + void clear() { vec().clear(); } + void clearAndFree() { vec().clearAndFree(); } + template<typename U> bool append(U&& aU) { return vec().append(mozilla::Forward<U>(aU)); } + template<typename... Args> bool emplaceBack(Args&&... aArgs) { + return vec().emplaceBack(mozilla::Forward<Args...>(aArgs...)); + } + template<typename U, size_t O, class BP> + bool appendAll(const mozilla::Vector<U, O, BP>& aU) { return vec().appendAll(aU); } + template<typename U, size_t O, class BP> + bool appendAll(const JS::GCVector<U, O, BP>& aU) { return vec().appendAll(aU); } + bool appendN(const T& aT, size_t aN) { return vec().appendN(aT, aN); } + template<typename U> bool append(const U* aBegin, const U* aEnd) { + return vec().append(aBegin, aEnd); + } + template<typename U> bool append(const U* aBegin, size_t aLength) { + return vec().append(aBegin, aLength); + } + template<typename U> void infallibleAppend(U&& aU) { + vec().infallibleAppend(mozilla::Forward<U>(aU)); + } + void infallibleAppendN(const T& aT, size_t aN) { vec().infallibleAppendN(aT, aN); } + template<typename U> void infallibleAppend(const U* aBegin, const U* aEnd) { + vec().infallibleAppend(aBegin, aEnd); + } + template<typename U> void infallibleAppend(const U* aBegin, size_t aLength) { + vec().infallibleAppend(aBegin, aLength); + } + void popBack() { vec().popBack(); } + T popCopy() { return vec().popCopy(); } + template<typename U> T* insert(T* aP, U&& aVal) { + return vec().insert(aP, mozilla::Forward<U>(aVal)); + } + void erase(T* aT) { vec().erase(aT); } + void erase(T* aBegin, T* aEnd) { vec().erase(aBegin, aEnd); } +}; + +template <typename T, size_t N, typename AP> +class RootedBase<JS::GCVector<T,N,AP>> + : public MutableGCVectorOperations<JS::Rooted<JS::GCVector<T,N,AP>>, T,N,AP> +{}; + +template <typename T, size_t N, typename AP> +class MutableHandleBase<JS::GCVector<T,N,AP>> + : public MutableGCVectorOperations<JS::MutableHandle<JS::GCVector<T,N,AP>>, T,N,AP> +{}; + +template <typename T, size_t N, typename AP> +class HandleBase<JS::GCVector<T,N,AP>> + : public GCVectorOperations<JS::Handle<JS::GCVector<T,N,AP>>, T,N,AP> +{}; + +template <typename T, size_t N, typename AP> +class PersistentRootedBase<JS::GCVector<T,N,AP>> + : public MutableGCVectorOperations<JS::PersistentRooted<JS::GCVector<T,N,AP>>, T,N,AP> +{}; + +} // namespace js + +#endif // js_GCVector_h |