gecko-dev/js/public/SweepingAPI.h
Steve Fink 975eedf5ec Bug 1345307 - Implement runtime-wide WeakCache, r=jonco
MozReview-Commit-ID: DX2nNCZrj6

--HG--
extra : rebase_source : a522dc02ac332bbc072845a3433af5a40ba16fe7
2017-03-07 12:55:37 -08:00

72 lines
2.1 KiB
C++

/* -*- 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_SweepingAPI_h
#define js_SweepingAPI_h
#include "js/HeapAPI.h"
namespace JS {
template <typename T> class WeakCache;
namespace shadow {
JS_PUBLIC_API(void)
RegisterWeakCache(JS::Zone* zone, JS::WeakCache<void*>* cachep);
JS_PUBLIC_API(void)
RegisterWeakCache(JSRuntime* rt, JS::WeakCache<void*>* cachep);
} // namespace shadow
// A WeakCache stores the given Sweepable container and links itself into a
// list of such caches that are swept during each GC. A WeakCache can be
// specific to a zone, or across a whole runtime, depending on which
// constructor is used.
template <typename T>
class WeakCache : public js::MutableWrappedPtrOperations<T, WeakCache<T>>,
private mozilla::LinkedListElement<WeakCache<T>>
{
friend class mozilla::LinkedListElement<WeakCache<T>>;
friend class mozilla::LinkedList<WeakCache<T>>;
WeakCache() = delete;
WeakCache(const WeakCache&) = delete;
using SweepFn = void (*)(T*);
SweepFn sweeper;
T cache;
public:
using Type = T;
template <typename U>
WeakCache(Zone* zone, U&& initial)
: cache(mozilla::Forward<U>(initial))
{
sweeper = GCPolicy<T>::sweep;
shadow::RegisterWeakCache(zone, reinterpret_cast<WeakCache<void*>*>(this));
}
template <typename U>
WeakCache(JSRuntime* rt, U&& initial)
: cache(mozilla::Forward<U>(initial))
{
sweeper = GCPolicy<T>::sweep;
shadow::RegisterWeakCache(rt, reinterpret_cast<WeakCache<void*>*>(this));
}
WeakCache(WeakCache&& other)
: sweeper(other.sweeper),
cache(mozilla::Move(other.cache))
{
}
const T& get() const { return cache; }
T& get() { return cache; }
void sweep() { sweeper(&cache); }
};
} // namespace JS
#endif // js_SweepingAPI_h