|
Packit |
f0b94e |
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
Packit |
f0b94e |
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
Packit |
f0b94e |
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
Packit |
f0b94e |
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
Packit |
f0b94e |
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#ifndef DISPLAYLISTCLIPSTATE_H_
|
|
Packit |
f0b94e |
#define DISPLAYLISTCLIPSTATE_H_
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "DisplayItemClip.h"
|
|
Packit |
f0b94e |
#include "DisplayItemClipChain.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#include "mozilla/DebugOnly.h"
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
class nsIFrame;
|
|
Packit |
f0b94e |
class nsIScrollableFrame;
|
|
Packit |
f0b94e |
class nsDisplayListBuilder;
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
namespace mozilla {
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* All clip coordinates are in appunits relative to the reference frame
|
|
Packit |
f0b94e |
* for the display item we're building.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
class DisplayListClipState {
|
|
Packit |
f0b94e |
public:
|
|
Packit |
f0b94e |
DisplayListClipState()
|
|
Packit |
f0b94e |
: mClipChainContentDescendants(nullptr),
|
|
Packit |
f0b94e |
mClipChainContainingBlockDescendants(nullptr),
|
|
Packit |
f0b94e |
mCurrentCombinedClipChain(nullptr),
|
|
Packit |
f0b94e |
mCurrentCombinedClipChainIsValid(false) {}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Returns intersection of mClipChainContainingBlockDescendants and
|
|
Packit |
f0b94e |
* mClipChainContentDescendants, allocated on aBuilder's arena.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
const DisplayItemClipChain* GetCurrentCombinedClipChain(
|
|
Packit |
f0b94e |
nsDisplayListBuilder* aBuilder);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
const DisplayItemClipChain* GetClipChainForContainingBlockDescendants()
|
|
Packit |
f0b94e |
const {
|
|
Packit |
f0b94e |
return mClipChainContainingBlockDescendants;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
const DisplayItemClipChain* GetClipChainForContentDescendants() const {
|
|
Packit |
f0b94e |
return mClipChainContentDescendants;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
const ActiveScrolledRoot* GetContentClipASR() const {
|
|
Packit |
f0b94e |
return mClipChainContentDescendants ? mClipChainContentDescendants->mASR
|
|
Packit |
f0b94e |
: nullptr;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
class AutoSaveRestore;
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
class AutoClipContainingBlockDescendantsToContentBox;
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
class AutoClipMultiple;
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
enum { ASSUME_DRAWING_RESTRICTED_TO_CONTENT_RECT = 0x01 };
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
private:
|
|
Packit |
f0b94e |
void Clear() {
|
|
Packit |
f0b94e |
mClipChainContentDescendants = nullptr;
|
|
Packit |
f0b94e |
mClipChainContainingBlockDescendants = nullptr;
|
|
Packit |
f0b94e |
mCurrentCombinedClipChain = nullptr;
|
|
Packit |
f0b94e |
mCurrentCombinedClipChainIsValid = false;
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void SetClipChainForContainingBlockDescendants(
|
|
Packit |
f0b94e |
const DisplayItemClipChain* aClipChain) {
|
|
Packit |
f0b94e |
mClipChainContainingBlockDescendants = aClipChain;
|
|
Packit |
f0b94e |
InvalidateCurrentCombinedClipChain(aClipChain ? aClipChain->mASR : nullptr);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Intersects the given clip rect (with optional aRadii) with the current
|
|
Packit |
f0b94e |
* mClipContainingBlockDescendants and sets mClipContainingBlockDescendants to
|
|
Packit |
f0b94e |
* the result, stored in aClipOnStack.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
void ClipContainingBlockDescendants(nsDisplayListBuilder* aBuilder,
|
|
Packit |
f0b94e |
const nsRect& aRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii,
|
|
Packit |
f0b94e |
DisplayItemClipChain& aClipChainOnStack);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void ClipContentDescendants(nsDisplayListBuilder* aBuilder,
|
|
Packit |
f0b94e |
const nsRect& aRect, const nscoord* aRadii,
|
|
Packit |
f0b94e |
DisplayItemClipChain& aClipChainOnStack);
|
|
Packit |
f0b94e |
void ClipContentDescendants(nsDisplayListBuilder* aBuilder,
|
|
Packit |
f0b94e |
const nsRect& aRect, const nsRect& aRoundedRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii,
|
|
Packit |
f0b94e |
DisplayItemClipChain& aClipChainOnStack);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void InvalidateCurrentCombinedClipChain(
|
|
Packit |
f0b94e |
const ActiveScrolledRoot* aInvalidateUpTo);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Clips containing-block descendants to the frame's content-box,
|
|
Packit |
f0b94e |
* taking border-radius into account.
|
|
Packit |
f0b94e |
* If aFlags contains ASSUME_DRAWING_RESTRICTED_TO_CONTENT_RECT then
|
|
Packit |
f0b94e |
* we assume display items will not draw outside the content rect, so
|
|
Packit |
f0b94e |
* clipping is only required if there is a border-radius. This is an
|
|
Packit |
f0b94e |
* optimization to reduce the amount of clipping required.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
void ClipContainingBlockDescendantsToContentBox(
|
|
Packit |
f0b94e |
nsDisplayListBuilder* aBuilder, nsIFrame* aFrame,
|
|
Packit |
f0b94e |
DisplayItemClipChain& aClipChainOnStack, uint32_t aFlags);
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* All content descendants (i.e. following placeholder frames to their
|
|
Packit |
f0b94e |
* out-of-flows if necessary) should be clipped by
|
|
Packit |
f0b94e |
* mClipChainContentDescendants. Null if no clipping applies.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
const DisplayItemClipChain* mClipChainContentDescendants;
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* All containing-block descendants (i.e. frame descendants), including
|
|
Packit |
f0b94e |
* display items for the current frame, should be clipped by
|
|
Packit |
f0b94e |
* mClipChainContainingBlockDescendants.
|
|
Packit |
f0b94e |
* Null if no clipping applies.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
const DisplayItemClipChain* mClipChainContainingBlockDescendants;
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* The intersection of mClipChainContentDescendants and
|
|
Packit |
f0b94e |
* mClipChainContainingBlockDescendants.
|
|
Packit |
f0b94e |
* Allocated in the nsDisplayListBuilder arena. Null if none has been
|
|
Packit |
f0b94e |
* allocated or both mClipChainContentDescendants and
|
|
Packit |
f0b94e |
* mClipChainContainingBlockDescendants are null.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
const DisplayItemClipChain* mCurrentCombinedClipChain;
|
|
Packit |
f0b94e |
bool mCurrentCombinedClipChainIsValid;
|
|
Packit |
f0b94e |
};
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* A class to automatically save and restore the current clip state. Also
|
|
Packit |
f0b94e |
* offers methods for modifying the clip state. Only one modification is allowed
|
|
Packit |
f0b94e |
* to be in scope at a time using one of these objects; multiple modifications
|
|
Packit |
f0b94e |
* require nested objects. The interface is written this way to prevent
|
|
Packit |
f0b94e |
* dangling pointers to DisplayItemClips.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
class DisplayListClipState::AutoSaveRestore {
|
|
Packit |
f0b94e |
public:
|
|
Packit |
f0b94e |
explicit AutoSaveRestore(nsDisplayListBuilder* aBuilder);
|
|
Packit |
f0b94e |
void Restore() {
|
|
Packit |
f0b94e |
mState = mSavedState;
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mRestored = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
~AutoSaveRestore() { Restore(); }
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void Clear() {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
mState.Clear();
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = false;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void SetClipChainForContainingBlockDescendants(
|
|
Packit |
f0b94e |
const DisplayItemClipChain* aClipChain) {
|
|
Packit |
f0b94e |
mState.SetClipChainForContainingBlockDescendants(aClipChain);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Intersects the given clip rect (with optional aRadii) with the current
|
|
Packit |
f0b94e |
* mClipContainingBlockDescendants and sets mClipContainingBlockDescendants to
|
|
Packit |
f0b94e |
* the result, stored in aClipOnStack.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
void ClipContainingBlockDescendants(const nsRect& aRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii = nullptr) {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
NS_ASSERTION(!mClipUsed, "mClip already used");
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContainingBlockDescendants(mBuilder, aRect, aRadii, mClipChain);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void ClipContentDescendants(const nsRect& aRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii = nullptr) {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
NS_ASSERTION(!mClipUsed, "mClip already used");
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContentDescendants(mBuilder, aRect, aRadii, mClipChain);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
void ClipContentDescendants(const nsRect& aRect, const nsRect& aRoundedRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii = nullptr) {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
NS_ASSERTION(!mClipUsed, "mClip already used");
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContentDescendants(mBuilder, aRect, aRoundedRect, aRadii,
|
|
Packit |
f0b94e |
mClipChain);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Clips containing-block descendants to the frame's content-box,
|
|
Packit |
f0b94e |
* taking border-radius into account.
|
|
Packit |
f0b94e |
* If aFlags contains ASSUME_DRAWING_RESTRICTED_TO_CONTENT_RECT then
|
|
Packit |
f0b94e |
* we assume display items will not draw outside the content rect, so
|
|
Packit |
f0b94e |
* clipping is only required if there is a border-radius. This is an
|
|
Packit |
f0b94e |
* optimization to reduce the amount of clipping required.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
void ClipContainingBlockDescendantsToContentBox(
|
|
Packit |
f0b94e |
nsDisplayListBuilder* aBuilder, nsIFrame* aFrame, uint32_t aFlags = 0) {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
NS_ASSERTION(!mClipUsed, "mClip already used");
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContainingBlockDescendantsToContentBox(aBuilder, aFrame,
|
|
Packit |
f0b94e |
mClipChain, aFlags);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
protected:
|
|
Packit |
f0b94e |
nsDisplayListBuilder* mBuilder;
|
|
Packit |
f0b94e |
DisplayListClipState& mState;
|
|
Packit |
f0b94e |
DisplayListClipState mSavedState;
|
|
Packit |
f0b94e |
DisplayItemClipChain mClipChain;
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
bool mClipUsed;
|
|
Packit |
f0b94e |
bool mRestored;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
};
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
class DisplayListClipState::AutoClipContainingBlockDescendantsToContentBox
|
|
Packit |
f0b94e |
: public AutoSaveRestore {
|
|
Packit |
f0b94e |
public:
|
|
Packit |
f0b94e |
AutoClipContainingBlockDescendantsToContentBox(nsDisplayListBuilder* aBuilder,
|
|
Packit |
f0b94e |
nsIFrame* aFrame,
|
|
Packit |
f0b94e |
uint32_t aFlags = 0)
|
|
Packit |
f0b94e |
: AutoSaveRestore(aBuilder) {
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContainingBlockDescendantsToContentBox(aBuilder, aFrame,
|
|
Packit |
f0b94e |
mClipChain, aFlags);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
};
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Do not use this outside of nsFrame::BuildDisplayListForChild, use
|
|
Packit |
f0b94e |
* multiple AutoSaveRestores instead. We provide this class just to ensure
|
|
Packit |
f0b94e |
* BuildDisplayListForChild is as efficient as possible.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
class DisplayListClipState::AutoClipMultiple : public AutoSaveRestore {
|
|
Packit |
f0b94e |
public:
|
|
Packit |
f0b94e |
explicit AutoClipMultiple(nsDisplayListBuilder* aBuilder)
|
|
Packit |
f0b94e |
: AutoSaveRestore(aBuilder)
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
,
|
|
Packit |
f0b94e |
mExtraClipUsed(false)
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
{
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
/**
|
|
Packit |
f0b94e |
* Intersects the given clip rect (with optional aRadii) with the current
|
|
Packit |
f0b94e |
* mClipContainingBlockDescendants and sets mClipContainingBlockDescendants to
|
|
Packit |
f0b94e |
* the result, stored in aClipOnStack.
|
|
Packit |
f0b94e |
*/
|
|
Packit |
f0b94e |
void ClipContainingBlockDescendantsExtra(const nsRect& aRect,
|
|
Packit |
f0b94e |
const nscoord* aRadii) {
|
|
Packit |
f0b94e |
NS_ASSERTION(!mRestored, "Already restored!");
|
|
Packit |
f0b94e |
NS_ASSERTION(!mExtraClipUsed, "mExtraClip already used");
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
mExtraClipUsed = true;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
mState.ClipContainingBlockDescendants(mBuilder, aRect, aRadii,
|
|
Packit |
f0b94e |
mExtraClipChain);
|
|
Packit |
f0b94e |
}
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
protected:
|
|
Packit |
f0b94e |
DisplayItemClipChain mExtraClipChain;
|
|
Packit |
f0b94e |
#ifdef DEBUG
|
|
Packit |
f0b94e |
bool mExtraClipUsed;
|
|
Packit |
f0b94e |
#endif
|
|
Packit |
f0b94e |
};
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
} // namespace mozilla
|
|
Packit |
f0b94e |
|
|
Packit |
f0b94e |
#endif /* DISPLAYLISTCLIPSTATE_H_ */
|