2010-06-18 20:23:04 +04:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
|
|
*
|
|
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
|
|
* the License. You may obtain a copy of the License at
|
|
|
|
* http://www.mozilla.org/MPL/
|
|
|
|
*
|
|
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
|
|
* for the specific language governing rights and limitations under the
|
|
|
|
* License.
|
|
|
|
*
|
|
|
|
* The Original Code is mozilla.org code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
|
|
|
* the Mozilla Foundation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2010
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Boris Zbarsky <bzbarsky@mit.edu> (original author)
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
|
|
* the provisions above, a recipient may use your version of this file under
|
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
|
|
*
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* A class which manages pending restyles. This handles keeping track
|
|
|
|
* of what nodes restyles need to happen on and so forth.
|
|
|
|
*/
|
|
|
|
|
2010-06-18 23:35:52 +04:00
|
|
|
#ifndef mozilla_css_RestyleTracker_h
|
|
|
|
#define mozilla_css_RestyleTracker_h
|
|
|
|
|
2010-06-18 20:23:04 +04:00
|
|
|
#include "mozilla/dom/Element.h"
|
|
|
|
#include "nsDataHashtable.h"
|
2010-06-18 20:23:05 +04:00
|
|
|
#include "nsIFrame.h"
|
2010-06-18 20:23:04 +04:00
|
|
|
|
|
|
|
class nsCSSFrameConstructor;
|
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace css {
|
|
|
|
|
|
|
|
class RestyleTracker {
|
|
|
|
public:
|
|
|
|
typedef mozilla::dom::Element Element;
|
|
|
|
|
|
|
|
RestyleTracker(PRUint32 aRestyleBits,
|
|
|
|
nsCSSFrameConstructor* aFrameConstructor) :
|
2010-06-18 20:23:05 +04:00
|
|
|
mRestyleBits(aRestyleBits), mFrameConstructor(aFrameConstructor),
|
2011-10-17 18:59:28 +04:00
|
|
|
mHaveLaterSiblingRestyles(false)
|
2010-06-18 20:23:04 +04:00
|
|
|
{
|
|
|
|
NS_PRECONDITION((mRestyleBits & ~ELEMENT_ALL_RESTYLE_FLAGS) == 0,
|
|
|
|
"Why do we have these bits set?");
|
|
|
|
NS_PRECONDITION((mRestyleBits & ELEMENT_PENDING_RESTYLE_FLAGS) != 0,
|
|
|
|
"Must have a restyle flag");
|
|
|
|
NS_PRECONDITION((mRestyleBits & ELEMENT_PENDING_RESTYLE_FLAGS) !=
|
|
|
|
ELEMENT_PENDING_RESTYLE_FLAGS,
|
|
|
|
"Shouldn't have both restyle flags set");
|
|
|
|
NS_PRECONDITION((mRestyleBits & ~ELEMENT_PENDING_RESTYLE_FLAGS) != 0,
|
|
|
|
"Must have root flag");
|
|
|
|
NS_PRECONDITION((mRestyleBits & ~ELEMENT_PENDING_RESTYLE_FLAGS) !=
|
|
|
|
(ELEMENT_ALL_RESTYLE_FLAGS & ~ELEMENT_PENDING_RESTYLE_FLAGS),
|
|
|
|
"Shouldn't have both root flags");
|
|
|
|
}
|
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool Init() {
|
2010-06-18 20:23:04 +04:00
|
|
|
return mPendingRestyles.Init();
|
|
|
|
}
|
|
|
|
|
|
|
|
PRUint32 Count() const {
|
|
|
|
return mPendingRestyles.Count();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2010-06-18 20:23:05 +04:00
|
|
|
* Add a restyle for the given element to the tracker. Returns true
|
|
|
|
* if the element already had eRestyle_LaterSiblings set on it.
|
2010-06-18 20:23:04 +04:00
|
|
|
*/
|
2011-09-29 10:19:26 +04:00
|
|
|
bool AddPendingRestyle(Element* aElement, nsRestyleHint aRestyleHint,
|
2010-06-18 20:23:05 +04:00
|
|
|
nsChangeHint aMinChangeHint);
|
2010-06-18 20:23:04 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Process the restyles we've been tracking.
|
|
|
|
*/
|
2011-12-15 08:42:14 +04:00
|
|
|
void ProcessRestyles() {
|
|
|
|
// Fast-path the common case (esp. for the animation restyle
|
|
|
|
// tracker) of not having anything to do.
|
|
|
|
if (mPendingRestyles.Count()) {
|
|
|
|
DoProcessRestyles();
|
|
|
|
}
|
|
|
|
}
|
2010-06-18 20:23:04 +04:00
|
|
|
|
2010-06-18 20:23:05 +04:00
|
|
|
// Return our ELEMENT_HAS_PENDING_(ANIMATION_)RESTYLE bit
|
|
|
|
PRUint32 RestyleBit() const {
|
|
|
|
return mRestyleBits & ELEMENT_PENDING_RESTYLE_FLAGS;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Return our ELEMENT_IS_POTENTIAL_(ANIMATION_)RESTYLE_ROOT bit
|
|
|
|
PRUint32 RootBit() const {
|
|
|
|
return mRestyleBits & ~ELEMENT_PENDING_RESTYLE_FLAGS;
|
|
|
|
}
|
|
|
|
|
2010-06-18 20:23:04 +04:00
|
|
|
struct RestyleData {
|
|
|
|
nsRestyleHint mRestyleHint; // What we want to restyle
|
|
|
|
nsChangeHint mChangeHint; // The minimal change hint for "self"
|
|
|
|
};
|
|
|
|
|
2010-06-18 20:23:05 +04:00
|
|
|
/**
|
|
|
|
* If the given Element has a restyle pending for it, return the
|
|
|
|
* relevant restyle data. This function will clear everything other
|
|
|
|
* than a possible eRestyle_LaterSiblings hint for aElement out of
|
|
|
|
* our hashtable. The returned aData will never have an
|
|
|
|
* eRestyle_LaterSiblings hint in it.
|
|
|
|
*
|
|
|
|
* The return value indicates whether any restyle data was found for
|
|
|
|
* the element. If false is returned, then the state of *aData is
|
|
|
|
* undefined.
|
|
|
|
*/
|
2011-09-29 10:19:26 +04:00
|
|
|
bool GetRestyleData(Element* aElement, RestyleData* aData);
|
2010-06-18 20:23:05 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The document we're associated with.
|
|
|
|
*/
|
|
|
|
inline nsIDocument* Document() const;
|
|
|
|
|
2010-06-18 20:23:04 +04:00
|
|
|
struct RestyleEnumerateData : public RestyleData {
|
2010-07-31 07:44:45 +04:00
|
|
|
nsRefPtr<Element> mElement;
|
2010-06-18 20:23:04 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
private:
|
2010-06-18 20:23:05 +04:00
|
|
|
/**
|
2010-06-18 20:23:05 +04:00
|
|
|
* Handle a single mPendingRestyles entry. aRestyleHint must not
|
|
|
|
* include eRestyle_LaterSiblings; that needs to be dealt with
|
|
|
|
* before calling this function.
|
2010-06-18 20:23:05 +04:00
|
|
|
*/
|
2010-06-18 20:23:05 +04:00
|
|
|
inline void ProcessOneRestyle(Element* aElement,
|
|
|
|
nsRestyleHint aRestyleHint,
|
|
|
|
nsChangeHint aChangeHint);
|
2010-06-18 20:23:05 +04:00
|
|
|
|
2011-12-15 08:42:14 +04:00
|
|
|
/**
|
|
|
|
* The guts of our restyle processing.
|
|
|
|
*/
|
|
|
|
void DoProcessRestyles();
|
|
|
|
|
2010-06-18 20:23:04 +04:00
|
|
|
typedef nsDataHashtable<nsISupportsHashKey, RestyleData> PendingRestyleTable;
|
2010-06-18 20:23:05 +04:00
|
|
|
typedef nsAutoTArray< nsRefPtr<Element>, 32> RestyleRootArray;
|
2010-06-18 20:23:04 +04:00
|
|
|
// Our restyle bits. These will be a subset of ELEMENT_ALL_RESTYLE_FLAGS, and
|
|
|
|
// will include one flag from ELEMENT_PENDING_RESTYLE_FLAGS and one flag
|
|
|
|
// that's not in ELEMENT_PENDING_RESTYLE_FLAGS.
|
|
|
|
PRUint32 mRestyleBits;
|
|
|
|
nsCSSFrameConstructor* mFrameConstructor; // Owns us
|
2010-06-18 20:23:05 +04:00
|
|
|
// A hashtable that maps elements to RestyleData structs. The
|
|
|
|
// values only make sense if the element's current document is our
|
|
|
|
// document and it has our RestyleBit() flag set. In particular,
|
|
|
|
// said bit might not be set if the element had a restyle posted and
|
|
|
|
// then was moved around in the DOM.
|
2010-06-18 20:23:04 +04:00
|
|
|
PendingRestyleTable mPendingRestyles;
|
2010-06-18 20:23:05 +04:00
|
|
|
// An array that keeps track of our possible restyle roots. This
|
|
|
|
// maintains the invariant that if A and B are both restyle roots
|
|
|
|
// and A is an ancestor of B then A will come after B in the array.
|
|
|
|
// We maintain this invariant by checking whether an element has an
|
|
|
|
// ancestor with the restyle root bit set before appending it to the
|
|
|
|
// array.
|
|
|
|
RestyleRootArray mRestyleRoots;
|
|
|
|
// True if we have some entries with the eRestyle_LaterSiblings
|
|
|
|
// flag. We need this to avoid enumerating the hashtable looking
|
|
|
|
// for such entries when we can't possibly have any.
|
2011-09-29 10:19:26 +04:00
|
|
|
bool mHaveLaterSiblingRestyles;
|
2010-06-18 20:23:04 +04:00
|
|
|
};
|
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
inline bool RestyleTracker::AddPendingRestyle(Element* aElement,
|
2010-06-18 20:23:05 +04:00
|
|
|
nsRestyleHint aRestyleHint,
|
|
|
|
nsChangeHint aMinChangeHint)
|
2010-06-18 20:23:04 +04:00
|
|
|
{
|
|
|
|
RestyleData existingData;
|
|
|
|
existingData.mRestyleHint = nsRestyleHint(0);
|
|
|
|
existingData.mChangeHint = NS_STYLE_HINT_NONE;
|
|
|
|
|
2010-06-18 20:23:05 +04:00
|
|
|
// Check the RestyleBit() flag before doing the hashtable Get, since
|
|
|
|
// it's possible that the data in the hashtable isn't actually
|
|
|
|
// relevant anymore (if the flag is not set).
|
|
|
|
if (aElement->HasFlag(RestyleBit())) {
|
|
|
|
mPendingRestyles.Get(aElement, &existingData);
|
|
|
|
} else {
|
|
|
|
aElement->SetFlags(RestyleBit());
|
|
|
|
}
|
2010-06-18 20:23:04 +04:00
|
|
|
|
2011-09-29 10:19:26 +04:00
|
|
|
bool hadRestyleLaterSiblings =
|
2010-06-18 20:23:05 +04:00
|
|
|
(existingData.mRestyleHint & eRestyle_LaterSiblings) != 0;
|
2010-06-18 20:23:04 +04:00
|
|
|
existingData.mRestyleHint =
|
2010-06-18 20:23:05 +04:00
|
|
|
nsRestyleHint(existingData.mRestyleHint | aRestyleHint);
|
2010-06-18 20:23:04 +04:00
|
|
|
NS_UpdateHint(existingData.mChangeHint, aMinChangeHint);
|
|
|
|
|
|
|
|
mPendingRestyles.Put(aElement, existingData);
|
2010-06-18 20:23:05 +04:00
|
|
|
|
|
|
|
// We can only treat this element as a restyle root if we would
|
|
|
|
// actually restyle its descendants (so either call
|
|
|
|
// ReResolveStyleContext on it or just reframe it).
|
2010-06-18 20:23:05 +04:00
|
|
|
if ((aRestyleHint & (eRestyle_Self | eRestyle_Subtree)) ||
|
2010-06-18 20:23:05 +04:00
|
|
|
(aMinChangeHint & nsChangeHint_ReconstructFrame)) {
|
|
|
|
for (const Element* cur = aElement; !cur->HasFlag(RootBit()); ) {
|
|
|
|
nsIContent* parent = cur->GetFlattenedTreeParent();
|
|
|
|
// Stop if we have no parent or the parent is not an element or
|
|
|
|
// we're part of the viewport scrollbars (because those are not
|
|
|
|
// frametree descendants of the primary frame of the root
|
|
|
|
// element).
|
|
|
|
// XXXbz maybe the primary frame of the root should be the root scrollframe?
|
|
|
|
if (!parent || !parent->IsElement() ||
|
|
|
|
// If we've hit the root via a native anonymous kid and that
|
|
|
|
// this native anonymous kid is not obviously a descendant
|
|
|
|
// of the root's primary frame, assume we're under the root
|
|
|
|
// scrollbars. Since those don't get reresolved when
|
|
|
|
// reresolving the root, we need to make sure to add the
|
|
|
|
// element to mRestyleRoots.
|
|
|
|
(cur->IsInNativeAnonymousSubtree() && !parent->GetParent() &&
|
|
|
|
cur->GetPrimaryFrame() &&
|
|
|
|
cur->GetPrimaryFrame()->GetParent() != parent->GetPrimaryFrame())) {
|
|
|
|
mRestyleRoots.AppendElement(aElement);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
cur = parent->AsElement();
|
|
|
|
}
|
|
|
|
// At this point some ancestor of aElement (possibly aElement
|
|
|
|
// itself) is in mRestyleRoots. Set the root bit on aElement, to
|
|
|
|
// speed up searching for an existing root on its descendants.
|
|
|
|
aElement->SetFlags(RootBit());
|
|
|
|
}
|
|
|
|
|
|
|
|
mHaveLaterSiblingRestyles =
|
|
|
|
mHaveLaterSiblingRestyles || (aRestyleHint & eRestyle_LaterSiblings) != 0;
|
|
|
|
return hadRestyleLaterSiblings;
|
2010-06-18 20:23:04 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
} // namespace css
|
2010-06-18 23:18:02 +04:00
|
|
|
} // namespace mozilla
|
2010-06-18 20:23:04 +04:00
|
|
|
|
|
|
|
#endif /* mozilla_css_RestyleTracker_h */
|