/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- * * The contents of this file are subject to the Netscape Public License * Version 1.0 (the "NPL"); you may not use this file except in * compliance with the NPL. You may obtain a copy of the NPL at * http://www.mozilla.org/NPL/ * * Software distributed under the NPL is distributed on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL * for the specific language governing rights and limitations under the * NPL. * * The Initial Developer of this code under the NPL is Netscape * Communications Corporation. Portions created by Netscape are * Copyright (C) 1998 Netscape Communications Corporation. All Rights * Reserved. */ #include "nsContainerFrame.h" #include "nsIContent.h" #include "nsIPresContext.h" #include "nsIRenderingContext.h" #include "nsISpaceManager.h" #include "nsIStyleContext.h" #include "nsRect.h" #include "nsPoint.h" #include "nsGUIEvent.h" #include "nsStyleConsts.h" #include "nsIView.h" #include "nsVoidArray.h" #include "nsISizeOfHandler.h" #include "nsHTMLIIDs.h" #ifdef NS_DEBUG #undef NOISY #else #undef NOISY #endif NS_IMETHODIMP nsContainerFrame::SizeOf(nsISizeOfHandler* aHandler) const { aHandler->Add(sizeof(*this)); nsContainerFrame::SizeOfWithoutThis(aHandler); return NS_OK; } NS_IMETHODIMP nsContainerFrame::SetInitialChildList(nsIPresContext& aPresContext, nsIAtom* aListName, nsIFrame* aChildList) { NS_PRECONDITION(nsnull == mFirstChild, "already initialized"); nsresult result; if (nsnull != mFirstChild) { result = NS_ERROR_UNEXPECTED; } else if (nsnull != aListName) { result = NS_ERROR_INVALID_ARG; } else { mFirstChild = aChildList; result = NS_OK; } return result; } NS_IMETHODIMP nsContainerFrame::DeleteFrame(nsIPresContext& aPresContext) { // Prevent event dispatch during destruction nsIView* view; GetView(view); if (nsnull != view) { view->SetClientData(nsnull); } // Delete the primary child list DeleteFrameList(aPresContext, &mFirstChild); // Base class will delete the frame return nsFrame::DeleteFrame(aPresContext); } /** * Helper method to delete a frame list and keep the list sane during * the deletion. */ void nsContainerFrame::DeleteFrameList(nsIPresContext& aPresContext, nsIFrame** aListP) { nsIFrame* first; while (nsnull != (first = *aListP)) { nsIFrame* nextChild; first->GetNextSibling(nextChild); first->DeleteFrame(aPresContext); // Once we've deleted the child frame make sure it's no longer in // the child list *aListP = nextChild; } } void nsContainerFrame::SizeOfWithoutThis(nsISizeOfHandler* aHandler) const { nsSplittableFrame::SizeOfWithoutThis(aHandler); for (nsIFrame* child = mFirstChild; child; ) { child->SizeOf(aHandler); child->GetNextSibling(child); } } NS_IMETHODIMP nsContainerFrame::DidReflow(nsIPresContext& aPresContext, nsDidReflowStatus aStatus) { NS_FRAME_TRACE_MSG(NS_FRAME_TRACE_CALLS, ("enter nsContainerFrame::DidReflow: status=%d", aStatus)); if (NS_FRAME_REFLOW_FINISHED == aStatus) { // Apply DidReflow to each and every list that this frame implements nsIAtom* listName = nsnull; PRInt32 listIndex = 0; do { nsIFrame* kid; FirstChild(listName, kid); while (nsnull != kid) { nsIHTMLReflow* htmlReflow; nsresult rv; rv = kid->QueryInterface(kIHTMLReflowIID, (void**)&htmlReflow); if (NS_SUCCEEDED(rv)) { htmlReflow->DidReflow(aPresContext, aStatus); } kid->GetNextSibling(kid); } NS_IF_RELEASE(listName); GetAdditionalChildListName(listIndex++, listName); } while(nsnull != listName); } NS_FRAME_TRACE_OUT("nsContainerFrame::DidReflow"); // Let nsFrame position and size our view (if we have one), and clear // the NS_FRAME_IN_REFLOW bit return nsFrame::DidReflow(aPresContext, aStatus); } ///////////////////////////////////////////////////////////////////////////// // Child frame enumeration NS_IMETHODIMP nsContainerFrame::FirstChild(nsIAtom* aListName, nsIFrame*& aFirstChild) const { // We only know about the unnamed principal child list if (nsnull == aListName) { aFirstChild = mFirstChild; return NS_OK; } else { aFirstChild = nsnull; return NS_ERROR_INVALID_ARG; } } ///////////////////////////////////////////////////////////////////////////// // Style support NS_IMETHODIMP nsContainerFrame::ReResolveStyleContext(nsIPresContext* aPresContext, nsIStyleContext* aParentContext) { nsIStyleContext* oldContext = mStyleContext; nsresult result = nsFrame::ReResolveStyleContext(aPresContext, aParentContext); if (oldContext != mStyleContext) { // Update primary child list nsIFrame* child; result = FirstChild(nsnull, child); while ((NS_SUCCEEDED(result)) && (nsnull != child)) { result = child->ReResolveStyleContext(aPresContext, mStyleContext); child->GetNextSibling(child); } // Update overflow list too child = mOverflowList; while ((NS_SUCCEEDED(result)) && (nsnull != child)) { result = child->ReResolveStyleContext(aPresContext, mStyleContext); child->GetNextSibling(child); } // And just to be complete, update our prev-in-flows overflow list // too (since in theory, those frames will become our frames) if (nsnull != mPrevInFlow) { child = ((nsContainerFrame*)mPrevInFlow)->mOverflowList; while ((NS_SUCCEEDED(result)) && (nsnull != child)) { result = child->ReResolveStyleContext(aPresContext, mStyleContext); child->GetNextSibling(child); } } } return result; } ///////////////////////////////////////////////////////////////////////////// // Painting NS_IMETHODIMP nsContainerFrame::Paint(nsIPresContext& aPresContext, nsIRenderingContext& aRenderingContext, const nsRect& aDirtyRect) { PaintChildren(aPresContext, aRenderingContext, aDirtyRect); return NS_OK; } // Paint the children of a container, assuming nothing about the // childrens spatial arrangement. Given relative positioning, negative // margins, etc, that's probably a good thing. // // Note: aDirtyRect is in our coordinate system (and of course, child // rect's are also in our coordinate system) void nsContainerFrame::PaintChildren(nsIPresContext& aPresContext, nsIRenderingContext& aRenderingContext, const nsRect& aDirtyRect) { const nsStyleDisplay* disp = (const nsStyleDisplay*) mStyleContext->GetStyleData(eStyleStruct_Display); // Child elements have the opportunity to override the visibility property // of their parent and display even if the parent is hidden PRBool clipState; // If overflow is hidden then set the clip rect so that children // don't leak out of us if (NS_STYLE_OVERFLOW_HIDDEN == disp->mOverflow) { aRenderingContext.PushState(); aRenderingContext.SetClipRect(nsRect(0, 0, mRect.width, mRect.height), nsClipCombine_kIntersect, clipState); } nsIFrame* kid = mFirstChild; while (nsnull != kid) { PaintChild(aPresContext, aRenderingContext, aDirtyRect, kid); kid->GetNextSibling(kid); } if (NS_STYLE_OVERFLOW_HIDDEN == disp->mOverflow) { aRenderingContext.PopState(clipState); } } // Paint one child frame void nsContainerFrame::PaintChild(nsIPresContext& aPresContext, nsIRenderingContext& aRenderingContext, const nsRect& aDirtyRect, nsIFrame* aFrame) { nsIView *pView; aFrame->GetView(pView); if (nsnull == pView) { nsRect kidRect; aFrame->GetRect(kidRect); nsFrameState state; aFrame->GetFrameState(state); // Compute the constrained damage area; set the overlap flag to // PR_TRUE if any portion of the child frame intersects the // dirty rect. nsRect damageArea; PRBool overlap; if (NS_FRAME_OUTSIDE_CHILDREN & state) { // If the child frame has children that leak out of our box // then we don't constrain the damageArea to just the childs // bounding rect. damageArea = aDirtyRect; overlap = PR_TRUE; } else { // Compute the intersection of the dirty rect and the childs // rect (both are in our coordinate space). This limits the // damageArea to just the portion that intersects the childs // rect. overlap = damageArea.IntersectRect(aDirtyRect, kidRect); #ifdef NS_DEBUG if (!overlap && (0 == kidRect.width) && (0 == kidRect.height)) { overlap = PR_TRUE; } #endif } if (overlap) { // Translate damage area into the kids coordinate // system. Translate rendering context into the kids // coordinate system. damageArea.x -= kidRect.x; damageArea.y -= kidRect.y; aRenderingContext.PushState(); aRenderingContext.Translate(kidRect.x, kidRect.y); // Paint the kid aFrame->Paint(aPresContext, aRenderingContext, damageArea); PRBool clipState; aRenderingContext.PopState(clipState); #ifdef NS_DEBUG // Draw a border around the child if (nsIFrame::GetShowFrameBorders() && !kidRect.IsEmpty()) { aRenderingContext.SetColor(NS_RGB(255,0,0)); aRenderingContext.DrawRect(kidRect); } #endif } } } NS_IMETHODIMP nsContainerFrame::GetFrameForPoint(const nsPoint& aPoint, nsIFrame** aFrame) { return GetFrameForPointUsing(aPoint, nsnull, aFrame); } nsresult nsContainerFrame::GetFrameForPointUsing(const nsPoint& aPoint, nsIAtom* aList, nsIFrame** aFrame) { nsIFrame* kid; nsRect kidRect; nsPoint tmp; *aFrame = nsnull; FirstChild(aList, kid); while (nsnull != kid) { kid->GetRect(kidRect); if (kidRect.Contains(aPoint)) { tmp.MoveTo(aPoint.x - kidRect.x, aPoint.y - kidRect.y); return kid->GetFrameForPoint(tmp, aFrame); } kid->GetNextSibling(kid); } FirstChild(aList, kid); while (nsnull != kid) { nsFrameState state; kid->GetFrameState(state); if (NS_FRAME_OUTSIDE_CHILDREN & state) { kid->GetRect(kidRect); tmp.MoveTo(aPoint.x - kidRect.x, aPoint.y - kidRect.y); if (NS_OK == kid->GetFrameForPoint(tmp, aFrame)) { return NS_OK; } } kid->GetNextSibling(kid); } *aFrame = this; return NS_ERROR_FAILURE; } ///////////////////////////////////////////////////////////////////////////// // Helper member functions /** * Queries the child frame for the nsIHTMLReflow interface and if it's * supported invokes the WillReflow() and Reflow() member functions. If * the reflow succeeds and the child frame is complete, deletes any * next-in-flows using DeleteChildsNextInFlow() */ nsresult nsContainerFrame::ReflowChild(nsIFrame* aKidFrame, nsIPresContext& aPresContext, nsHTMLReflowMetrics& aDesiredSize, const nsHTMLReflowState& aReflowState, nsReflowStatus& aStatus) { NS_PRECONDITION(aReflowState.frame == aKidFrame, "bad reflow state"); // Query for the nsIHTMLReflow interface nsIHTMLReflow* htmlReflow; nsresult result; result = aKidFrame->QueryInterface(kIHTMLReflowIID, (void**)&htmlReflow); if (NS_FAILED(result)) { return result; } // Send the WillReflow notification, and reflow the child frame htmlReflow->WillReflow(aPresContext); result = htmlReflow->Reflow(aPresContext, aDesiredSize, aReflowState, aStatus); // If the reflow was successful and the child frame is complete, delete any // next-in-flows if (NS_SUCCEEDED(result) && NS_FRAME_IS_COMPLETE(aStatus)) { nsIFrame* kidNextInFlow; aKidFrame->GetNextInFlow(kidNextInFlow); if (nsnull != kidNextInFlow) { // Remove all of the childs next-in-flows. Make sure that we ask // the right parent to do the removal (it's possible that the // parent is not this because we are executing pullup code) nsIFrame* parent; aKidFrame->GetGeometricParent(parent); ((nsContainerFrame*)parent)->DeleteChildsNextInFlow(aPresContext, aKidFrame); } } return result; } /** * Remove and delete aChild's next-in-flow(s). Updates the sibling and flow * pointers * * Updates the child count and content offsets of all containers that are * affected * * @param aChild child this child's next-in-flow * @return PR_TRUE if successful and PR_FALSE otherwise */ PRBool nsContainerFrame::DeleteChildsNextInFlow(nsIPresContext& aPresContext, nsIFrame* aChild) { NS_PRECONDITION(IsChild(aChild), "bad geometric parent"); nsIFrame* nextInFlow; nsContainerFrame* parent; aChild->GetNextInFlow(nextInFlow); NS_PRECONDITION(nsnull != nextInFlow, "null next-in-flow"); nextInFlow->GetGeometricParent((nsIFrame*&)parent); // If the next-in-flow has a next-in-flow then delete it, too (and // delete it first). nsIFrame* nextNextInFlow; nextInFlow->GetNextInFlow(nextNextInFlow); if (nsnull != nextNextInFlow) { parent->DeleteChildsNextInFlow(aPresContext, nextInFlow); } #ifdef NS_DEBUG PRInt32 childCount; nsIFrame* firstChild; nextInFlow->FirstChild(nsnull, firstChild); childCount = LengthOf(firstChild); if ((0 != childCount) || (nsnull != firstChild)) { nsIFrame* top = nextInFlow; for (;;) { nsIFrame* parent; top->GetGeometricParent(parent); if (nsnull == parent) { break; } top = parent; } top->List(stdout, 0, nsnull); } NS_ASSERTION((0 == childCount) && (nsnull == firstChild), "deleting !empty next-in-flow"); #endif // Disconnect the next-in-flow from the flow list nextInFlow->BreakFromPrevFlow(); // Take the next-in-flow out of the parent's child list if (parent->mFirstChild == nextInFlow) { nextInFlow->GetNextSibling(parent->mFirstChild); } else { nsIFrame* nextSibling; // Because the next-in-flow is not the first child of the parent // we know that it shares a parent with aChild. Therefore, we need // to capture the next-in-flow's next sibling (in case the // next-in-flow is the last next-in-flow for aChild AND the // next-in-flow is not the last child in parent) NS_ASSERTION(((nsContainerFrame*)parent)->IsChild(aChild), "screwy flow"); aChild->GetNextSibling(nextSibling); NS_ASSERTION(nextSibling == nextInFlow, "unexpected sibling"); nextInFlow->GetNextSibling(nextSibling); aChild->SetNextSibling(nextSibling); } // Delete the next-in-flow frame WillDeleteNextInFlowFrame(nextInFlow); nextInFlow->DeleteFrame(aPresContext); #ifdef NS_DEBUG aChild->GetNextInFlow(nextInFlow); NS_POSTCONDITION(nsnull == nextInFlow, "non null next-in-flow"); #endif return PR_TRUE; } void nsContainerFrame::WillDeleteNextInFlowFrame(nsIFrame* aNextInFlow) { } /** * Push aFromChild and its next siblings to the next-in-flow. Change the * geometric parent of each frame that's pushed. If there is no next-in-flow * the frames are placed on the overflow list (and the geometric parent is * left unchanged). * * Updates the next-in-flow's child count. Does not update the * pusher's child count. * * @param aFromChild the first child frame to push. It is disconnected from * aPrevSibling * @param aPrevSibling aFromChild's previous sibling. Must not be null. It's * an error to push a parent's first child frame */ void nsContainerFrame::PushChildren(nsIFrame* aFromChild, nsIFrame* aPrevSibling) { NS_PRECONDITION(nsnull != aFromChild, "null pointer"); NS_PRECONDITION(nsnull != aPrevSibling, "pushing first child"); #ifdef NS_DEBUG nsIFrame* prevNextSibling; aPrevSibling->GetNextSibling(prevNextSibling); NS_PRECONDITION(prevNextSibling == aFromChild, "bad prev sibling"); #endif // Disconnect aFromChild from its previous sibling aPrevSibling->SetNextSibling(nsnull); // Do we have a next-in-flow? nsContainerFrame* nextInFlow = (nsContainerFrame*)mNextInFlow; if (nsnull != nextInFlow) { PRInt32 numChildren = 0; nsIFrame* lastChild = nsnull; // Compute the number of children being pushed, and for each child change // its geometric parent. Remember the last child for (nsIFrame* f = aFromChild; nsnull != f; f->GetNextSibling(f)) { numChildren++; #ifdef NOISY printf(" "); ((nsFrame*)f)->ListTag(stdout); printf("\n"); #endif lastChild = f; f->SetGeometricParent(nextInFlow); nsIFrame* contentParent; f->GetContentParent(contentParent); if (this == contentParent) { f->SetContentParent(nextInFlow); } } NS_ASSERTION(numChildren > 0, "no children to push"); // Prepend the frames to our next-in-flow's child list lastChild->SetNextSibling(nextInFlow->mFirstChild); nextInFlow->mFirstChild = aFromChild; } else { // Add the frames to our overflow list NS_ASSERTION(nsnull == mOverflowList, "bad overflow list"); #ifdef NOISY ListTag(stdout); printf(": pushing kids to my overflow list\n"); #endif mOverflowList = aFromChild; } } /** * Moves any frames on the overflwo lists (the prev-in-flow's overflow list and * the receiver's overflow list) to the child list. * * Updates this frame's child count and content mapping. * * @return PR_TRUE if any frames were moved and PR_FALSE otherwise */ PRBool nsContainerFrame::MoveOverflowToChildList() { PRBool result = PR_FALSE; // Check for an overflow list with our prev-in-flow nsContainerFrame* prevInFlow = (nsContainerFrame*)mPrevInFlow; if (nsnull != prevInFlow) { if (nsnull != prevInFlow->mOverflowList) { NS_ASSERTION(nsnull == mFirstChild, "bad overflow list"); AppendChildren(prevInFlow->mOverflowList); prevInFlow->mOverflowList = nsnull; result = PR_TRUE; } } // It's also possible that we have an overflow list for ourselves if (nsnull != mOverflowList) { NS_ASSERTION(nsnull != mFirstChild, "overflow list but no mapped children"); AppendChildren(mOverflowList, PR_FALSE); mOverflowList = nsnull; result = PR_TRUE; } return result; } /** * Append child list starting at aChild to this frame's child list. Used for * processing of the overflow list. * * Updates this frame's child count and content mapping. * * @param aChild the beginning of the child list * @param aSetParent if true each child's geometric (and content parent if * they're the same) parent is set to this frame. */ void nsContainerFrame::AppendChildren(nsIFrame* aChild, PRBool aSetParent) { // Link the frames into our child frame list if (nsnull == mFirstChild) { // We have no children so aChild becomes the first child mFirstChild = aChild; } else { nsIFrame* lastChild = LastFrame(mFirstChild); lastChild->SetNextSibling(aChild); } // Update our child count and last content offset nsIFrame* lastChild; for (nsIFrame* f = aChild; nsnull != f; f->GetNextSibling(f)) { lastChild = f; // Reset the geometric parent if requested if (aSetParent) { nsIFrame* geometricParent; nsIFrame* contentParent; f->GetGeometricParent(geometricParent); f->GetContentParent(contentParent); if (contentParent == geometricParent) { f->SetContentParent(this); } f->SetGeometricParent(this); } } } ///////////////////////////////////////////////////////////////////////////// // Debugging NS_IMETHODIMP nsContainerFrame::List(FILE* out, PRInt32 aIndent, nsIListFilter *aFilter) const { // if a filter is present, only output this frame if the filter says // we should nsAutoString tagString; if (nsnull != mContent) { nsIAtom* tag; mContent->GetTag(tag); if (tag != nsnull) { tag->ToString(tagString); NS_RELEASE(tag); } } PRBool outputMe = (nsnull==aFilter) || aFilter->OutputTag(&tagString); if (outputMe) { // Indent IndentBy(out, aIndent); // Output the tag ListTag(out); nsIView* view; GetView(view); if (nsnull != view) { fprintf(out, " [view=%p]", view); } if (nsnull != mPrevInFlow) { fprintf(out, "prev-in-flow=%p ", mPrevInFlow); } if (nsnull != mNextInFlow) { fprintf(out, "next-in-flow=%p ", mNextInFlow); } // Output the rect out << mRect; } // Output the children if (nsnull != mFirstChild) { if (outputMe) { if (0 != mState) { fprintf(out, " [state=%08x]", mState); } fputs("<\n", out); } for (nsIFrame* child = mFirstChild; child; child->GetNextSibling(child)) { child->List(out, aIndent + 1, aFilter); } if (outputMe) { IndentBy(out, aIndent); fputs(">\n", out); } } else { if (outputMe) { if (0 != mState) { fprintf(out, " [state=%08x]", mState); } fputs("<>\n", out); } } return NS_OK; } NS_IMETHODIMP nsContainerFrame::VerifyTree() const { #ifdef NS_DEBUG NS_ASSERTION(0 == (mState & NS_FRAME_IN_REFLOW), "frame is in reflow"); NS_ASSERTION(nsnull == mOverflowList, "bad overflow list"); #endif return NS_OK; } PRInt32 nsContainerFrame::LengthOf(nsIFrame* aFrame) { PRInt32 result = 0; while (nsnull != aFrame) { result++; aFrame->GetNextSibling(aFrame); } return result; } nsIFrame* nsContainerFrame::LastFrame(nsIFrame* aFrame) { nsIFrame* lastChild = nsnull; while (nsnull != aFrame) { lastChild = aFrame; aFrame->GetNextSibling(aFrame); } return lastChild; } nsIFrame* nsContainerFrame::FrameAt(nsIFrame* aFrame, PRInt32 aIndex) { while ((aIndex-- > 0) && (aFrame != nsnull)) { aFrame->GetNextSibling(aFrame); } return aFrame; } ///////////////////////////////////////////////////////////////////////////// #ifdef NS_DEBUG PRBool nsContainerFrame::IsChild(const nsIFrame* aChild) const { // Check the geometric parent nsIFrame* parent; aChild->GetGeometricParent(parent); if (parent != (nsIFrame*)this) { return PR_FALSE; } return PR_TRUE; } #endif