2018-03-23 06:47:37 +03:00
|
|
|
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
|
|
/* 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 RETAINEDDISPLAYLISTHELPERS_H_
|
|
|
|
#define RETAINEDDISPLAYLISTHELPERS_H_
|
|
|
|
|
|
|
|
#include "PLDHashTable.h"
|
|
|
|
|
|
|
|
struct DisplayItemKey {
|
2018-09-04 23:46:21 +03:00
|
|
|
bool operator==(const DisplayItemKey& aOther) const {
|
|
|
|
return mFrame == aOther.mFrame && mPerFrameKey == aOther.mPerFrameKey;
|
2018-03-23 06:47:37 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
nsIFrame* mFrame;
|
|
|
|
uint32_t mPerFrameKey;
|
|
|
|
};
|
|
|
|
|
|
|
|
class DisplayItemHashEntry : public PLDHashEntryHdr {
|
|
|
|
public:
|
|
|
|
typedef DisplayItemKey KeyType;
|
|
|
|
typedef const DisplayItemKey* KeyTypePointer;
|
|
|
|
|
|
|
|
explicit DisplayItemHashEntry(KeyTypePointer aKey) : mKey(*aKey) {}
|
Bug 1415980 - make hash keys movable and not copyable; r=erahm
Everything that goes in a PLDHashtable (and its derivatives, like
nsTHashtable) needs to inherit from PLDHashEntryHdr. But through a lack
of enforcement, copy constructors for these derived classes didn't
explicitly invoke the copy constructor for PLDHashEntryHdr (and the
compiler didn't invoke the copy constructor for us). Instead,
PLDHashTable explicitly copied around the bits that the copy constructor
would have.
The current setup has two problems:
1) Derived classes should be using move construction, not copy
construction, since anything that's shuffling hash table keys/entries
around will be using move construction.
2) Derived classes should take responsibility for transferring bits of
superclass state around, and not rely on something else to handle that.
The second point is not a huge problem for PLDHashTable (PLDHashTable
only has to copy PLDHashEntryHdr's bits in a single place), but future
hash table implementations that might move entries around more
aggressively would have to insert compensation code all over the
place. Additionally, if moving entries is implemented via memcpy (which
is quite common), PLDHashTable copying around bits *again* is
inefficient.
Let's fix all these problems in one go, by:
1) Explicitly declaring the set of constructors that PLDHashEntryHdr
implements (and does not implement). In particular, the copy
constructor is deleted, so any derived classes that attempt to make
themselves copyable will be detected at compile time: the compiler
will complain that the superclass type is not copyable.
This change on its own will result in many compiler errors, so...
2) Change any derived classes to implement move constructors instead of
copy constructors. Note that some of these move constructors are,
strictly speaking, unnecessary, since the relevant classes are moved
via memcpy in nsTHashtable and its derivatives.
2018-09-20 18:20:36 +03:00
|
|
|
DisplayItemHashEntry(DisplayItemHashEntry&&) = default;
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
~DisplayItemHashEntry() = default;
|
|
|
|
|
|
|
|
KeyType GetKey() const { return mKey; }
|
2018-09-04 23:46:21 +03:00
|
|
|
bool KeyEquals(KeyTypePointer aKey) const { return mKey == *aKey; }
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
static KeyTypePointer KeyToPointer(KeyType& aKey) { return &aKey; }
|
|
|
|
static PLDHashNumber HashKey(KeyTypePointer aKey) {
|
2019-05-29 17:34:34 +03:00
|
|
|
if (!aKey) {
|
|
|
|
return 0;
|
|
|
|
}
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
return mozilla::HashGeneric(aKey->mFrame, aKey->mPerFrameKey);
|
|
|
|
}
|
2018-09-04 23:46:21 +03:00
|
|
|
enum { ALLOW_MEMMOVE = true };
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
DisplayItemKey mKey;
|
|
|
|
};
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
template <typename T>
|
|
|
|
bool SpanContains(mozilla::Span<const T>& aSpan, T aItem) {
|
2018-03-23 06:47:37 +03:00
|
|
|
for (const T& i : aSpan) {
|
|
|
|
if (i == aItem) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
class OldListUnits {};
|
|
|
|
class MergedListUnits {};
|
2018-03-23 06:47:37 +03:00
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
template <typename Units>
|
|
|
|
struct Index {
|
2018-03-23 06:47:37 +03:00
|
|
|
Index() : val(0) {}
|
2019-04-16 02:16:30 +03:00
|
|
|
explicit Index(size_t aVal) : val(aVal) {
|
|
|
|
MOZ_RELEASE_ASSERT(aVal < std::numeric_limits<uint32_t>::max(),
|
|
|
|
"List index overflowed");
|
|
|
|
}
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
bool operator==(const Index<Units>& aOther) const {
|
|
|
|
return val == aOther.val;
|
|
|
|
}
|
|
|
|
|
2019-04-16 02:16:30 +03:00
|
|
|
uint32_t val;
|
2018-03-23 06:47:37 +03:00
|
|
|
};
|
|
|
|
typedef Index<OldListUnits> OldListIndex;
|
|
|
|
typedef Index<MergedListUnits> MergedListIndex;
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
template <typename T>
|
|
|
|
class DirectedAcyclicGraph {
|
2018-03-23 06:47:37 +03:00
|
|
|
public:
|
2018-09-04 20:19:36 +03:00
|
|
|
DirectedAcyclicGraph() = default;
|
2018-03-23 06:47:37 +03:00
|
|
|
DirectedAcyclicGraph(DirectedAcyclicGraph&& aOther)
|
2018-05-30 22:15:35 +03:00
|
|
|
: mNodesInfo(std::move(aOther.mNodesInfo)),
|
|
|
|
mDirectPredecessorList(std::move(aOther.mDirectPredecessorList)) {}
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
DirectedAcyclicGraph& operator=(DirectedAcyclicGraph&& aOther) {
|
2018-05-30 22:15:35 +03:00
|
|
|
mNodesInfo = std::move(aOther.mNodesInfo);
|
|
|
|
mDirectPredecessorList = std::move(aOther.mDirectPredecessorList);
|
2018-03-23 06:47:37 +03:00
|
|
|
return *this;
|
|
|
|
}
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
Index<T> AddNode(
|
|
|
|
mozilla::Span<const Index<T>> aDirectPredecessors,
|
|
|
|
const mozilla::Maybe<Index<T>>& aExtraPredecessor = mozilla::Nothing()) {
|
2018-03-23 06:47:37 +03:00
|
|
|
size_t index = mNodesInfo.Length();
|
2018-09-04 23:46:21 +03:00
|
|
|
mNodesInfo.AppendElement(NodeInfo(mDirectPredecessorList.Length(),
|
|
|
|
aDirectPredecessors.Length()));
|
|
|
|
if (aExtraPredecessor &&
|
|
|
|
!SpanContains(aDirectPredecessors, aExtraPredecessor.value())) {
|
2018-03-23 06:47:37 +03:00
|
|
|
mNodesInfo.LastElement().mDirectPredecessorCount++;
|
2018-09-04 23:46:21 +03:00
|
|
|
mDirectPredecessorList.SetCapacity(mDirectPredecessorList.Length() +
|
|
|
|
aDirectPredecessors.Length() + 1);
|
2018-03-23 06:47:37 +03:00
|
|
|
mDirectPredecessorList.AppendElements(aDirectPredecessors);
|
|
|
|
mDirectPredecessorList.AppendElement(aExtraPredecessor.value());
|
|
|
|
} else {
|
|
|
|
mDirectPredecessorList.AppendElements(aDirectPredecessors);
|
|
|
|
}
|
|
|
|
return Index<T>(index);
|
|
|
|
}
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
size_t Length() { return mNodesInfo.Length(); }
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
mozilla::Span<Index<T>> GetDirectPredecessors(Index<T> aNodeIndex) {
|
|
|
|
NodeInfo& node = mNodesInfo[aNodeIndex.val];
|
2018-09-04 23:46:21 +03:00
|
|
|
return mozilla::MakeSpan(mDirectPredecessorList)
|
|
|
|
.Subspan(node.mIndexInDirectPredecessorList,
|
|
|
|
node.mDirectPredecessorCount);
|
2018-03-23 06:47:37 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
template <typename OtherUnits>
|
|
|
|
void EnsureCapacityFor(const DirectedAcyclicGraph<OtherUnits>& aOther) {
|
|
|
|
mNodesInfo.SetCapacity(aOther.mNodesInfo.Length());
|
|
|
|
mDirectPredecessorList.SetCapacity(aOther.mDirectPredecessorList.Length());
|
|
|
|
}
|
|
|
|
|
|
|
|
void Clear() {
|
|
|
|
mNodesInfo.Clear();
|
|
|
|
mDirectPredecessorList.Clear();
|
|
|
|
}
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
struct NodeInfo {
|
2018-03-23 06:47:37 +03:00
|
|
|
NodeInfo(size_t aIndexInDirectPredecessorList,
|
|
|
|
size_t aDirectPredecessorCount)
|
|
|
|
: mIndexInDirectPredecessorList(aIndexInDirectPredecessorList),
|
|
|
|
mDirectPredecessorCount(aDirectPredecessorCount) {}
|
|
|
|
size_t mIndexInDirectPredecessorList;
|
|
|
|
size_t mDirectPredecessorCount;
|
|
|
|
};
|
|
|
|
|
|
|
|
nsTArray<NodeInfo> mNodesInfo;
|
|
|
|
nsTArray<Index<T>> mDirectPredecessorList;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct RetainedDisplayListBuilder;
|
|
|
|
class nsDisplayItem;
|
|
|
|
|
2018-09-04 23:46:21 +03:00
|
|
|
struct OldItemInfo {
|
2019-04-18 05:38:22 +03:00
|
|
|
explicit OldItemInfo(nsDisplayItem* aItem);
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
void AddedToMergedList(MergedListIndex aIndex) {
|
|
|
|
MOZ_ASSERT(!IsUsed());
|
|
|
|
mUsed = true;
|
|
|
|
mIndex = aIndex;
|
|
|
|
mItem = nullptr;
|
|
|
|
}
|
|
|
|
|
|
|
|
void AddedMatchToMergedList(RetainedDisplayListBuilder* aBuilder,
|
|
|
|
MergedListIndex aIndex);
|
|
|
|
void Discard(RetainedDisplayListBuilder* aBuilder,
|
|
|
|
nsTArray<MergedListIndex>&& aDirectPredecessors);
|
2018-09-04 23:46:21 +03:00
|
|
|
bool IsUsed() { return mUsed; }
|
2018-03-23 06:47:37 +03:00
|
|
|
|
|
|
|
bool IsDiscarded() {
|
|
|
|
MOZ_ASSERT(IsUsed());
|
|
|
|
return mDiscarded;
|
|
|
|
}
|
|
|
|
|
2018-04-24 03:59:11 +03:00
|
|
|
bool IsChanged();
|
|
|
|
|
2018-03-23 06:47:37 +03:00
|
|
|
nsDisplayItem* mItem;
|
2019-04-16 02:16:30 +03:00
|
|
|
nsTArray<MergedListIndex> mDirectPredecessors;
|
|
|
|
MergedListIndex mIndex;
|
2018-03-23 06:47:37 +03:00
|
|
|
bool mUsed;
|
|
|
|
bool mDiscarded;
|
2019-04-29 06:14:49 +03:00
|
|
|
bool mOwnsItem;
|
2018-03-23 06:47:37 +03:00
|
|
|
};
|
|
|
|
|
2019-04-18 05:38:22 +03:00
|
|
|
bool AnyContentAncestorModified(nsIFrame* aFrame,
|
|
|
|
nsIFrame* aStopAtFrame = nullptr);
|
|
|
|
|
2018-03-23 06:47:37 +03:00
|
|
|
#endif // RETAINEDDISPLAYLISTHELPERS_H_
|