gecko-dev/layout/tables/nsTableWrapperFrame.h
Ting-Yu Lin 26a6db6fb1 Bug 1909761 Part 2 - Create a helper struct IntrinsicSizeInput to aggregate needed data when computing intrinsic inline size. r=dholbert
This patch changes the signature to `GetMinISize()`, `GetPrefISize()`,
`IntrinsicISize` by adding a helper struct as a preparation. Then we can just
add more data such as a percentage basis to the struct without altering the
signature in the future.

When passing `IntrinsicSizeInput` struct down to another helper method, we
generally just pass the original one if the method is computing the intrinsic
size of our own or our anonymous children. If the method is computing our
children's intrinsic contribution, we'll need to create a brand new
`IntrinsicSizeInput` for our children.

Differential Revision: https://phabricator.services.mozilla.com/D219521
2024-09-03 04:25:41 +00:00

283 lines
10 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 nsTableWrapperFrame_h__
#define nsTableWrapperFrame_h__
#include "LayoutConstants.h"
#include "mozilla/Attributes.h"
#include "mozilla/Maybe.h"
#include "nscore.h"
#include "nsContainerFrame.h"
#include "nsCellMap.h"
#include "nsTableFrame.h"
namespace mozilla {
class PresShell;
} // namespace mozilla
/**
* Primary frame for a table element,
* the nsTableWrapperFrame contains 0 or one caption frame, and a nsTableFrame
* pseudo-frame (referred to as the "inner frame').
*/
class nsTableWrapperFrame : public nsContainerFrame {
public:
NS_DECL_QUERYFRAME
NS_DECL_FRAMEARENA_HELPERS(nsTableWrapperFrame)
/** instantiate a new instance of nsTableRowFrame.
* @param aPresShell the pres shell for this frame
*
* @return the frame that was created
*/
friend nsTableWrapperFrame* NS_NewTableWrapperFrame(
mozilla::PresShell* aPresShell, ComputedStyle* aStyle);
// nsIFrame overrides - see there for a description
void Destroy(DestroyContext&) override;
const nsFrameList& GetChildList(ChildListID aListID) const override;
void GetChildLists(nsTArray<ChildList>* aLists) const override;
void SetInitialChildList(ChildListID aListID,
nsFrameList&& aChildList) override;
void AppendFrames(ChildListID aListID, nsFrameList&& aFrameList) override;
void InsertFrames(ChildListID aListID, nsIFrame* aPrevFrame,
const nsLineList::iterator* aPrevFrameLine,
nsFrameList&& aFrameList) override;
void RemoveFrame(DestroyContext&, ChildListID, nsIFrame*) override;
nsContainerFrame* GetContentInsertionFrame() override {
return PrincipalChildList().FirstChild()->GetContentInsertionFrame();
}
#ifdef ACCESSIBILITY
mozilla::a11y::AccType AccessibleType() override;
#endif
void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists) override;
void BuildDisplayListForInnerTable(nsDisplayListBuilder* aBuilder,
const nsDisplayListSet& aLists);
nscoord SynthesizeFallbackBaseline(
mozilla::WritingMode aWM,
BaselineSharingGroup aBaselineGroup) const override;
Maybe<nscoord> GetNaturalBaselineBOffset(
mozilla::WritingMode aWM, BaselineSharingGroup aBaselineGroup,
BaselineExportContext aExportContext) const override;
nscoord IntrinsicISize(const mozilla::IntrinsicSizeInput& aInput,
mozilla::IntrinsicISizeType aType) override;
SizeComputationResult ComputeSize(
gfxContext* aRenderingContext, mozilla::WritingMode aWM,
const mozilla::LogicalSize& aCBSize, nscoord aAvailableISize,
const mozilla::LogicalSize& aMargin,
const mozilla::LogicalSize& aBorderPadding,
const mozilla::StyleSizeOverrides& aSizeOverrides,
mozilla::ComputeSizeFlags aFlags) override;
mozilla::LogicalSize ComputeAutoSize(
gfxContext* aRenderingContext, mozilla::WritingMode aWM,
const mozilla::LogicalSize& aCBSize, nscoord aAvailableISize,
const mozilla::LogicalSize& aMargin,
const mozilla::LogicalSize& aBorderPadding,
const mozilla::StyleSizeOverrides& aSizeOverrides,
mozilla::ComputeSizeFlags aFlags) override;
/** process a reflow command for the table.
* This involves reflowing the caption and the inner table.
* @see nsIFrame::Reflow */
void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
const ReflowInput& aReflowInput,
nsReflowStatus& aStatus) override;
#ifdef DEBUG_FRAME_DUMP
nsresult GetFrameName(nsAString& aResult) const override;
#endif
ComputedStyle* GetParentComputedStyle(
nsIFrame** aProviderFrame) const override;
/**
* Return the content for the cell at the given row and column.
*/
nsIContent* GetCellAt(uint32_t aRowIdx, uint32_t aColIdx) const;
/**
* Return the number of rows in the table.
*/
int32_t GetRowCount() const { return InnerTableFrame()->GetRowCount(); }
/**
* Return the number of columns in the table.
*/
int32_t GetColCount() const { return InnerTableFrame()->GetColCount(); }
/**
* Return the index of the cell at the given row and column.
*/
int32_t GetIndexByRowAndColumn(int32_t aRowIdx, int32_t aColIdx) const {
nsTableCellMap* cellMap = InnerTableFrame()->GetCellMap();
if (!cellMap) return -1;
return cellMap->GetIndexByRowAndColumn(aRowIdx, aColIdx);
}
/**
* Get the row and column indices for the cell at the given index.
*/
void GetRowAndColumnByIndex(int32_t aCellIdx, int32_t* aRowIdx,
int32_t* aColIdx) const {
*aRowIdx = *aColIdx = 0;
nsTableCellMap* cellMap = InnerTableFrame()->GetCellMap();
if (cellMap) {
cellMap->GetRowAndColumnByIndex(aCellIdx, aRowIdx, aColIdx);
}
}
/**
* return the frame for the cell at the given row and column.
*/
nsTableCellFrame* GetCellFrameAt(uint32_t aRowIdx, uint32_t aColIdx) const {
nsTableCellMap* map = InnerTableFrame()->GetCellMap();
if (!map) {
return nullptr;
}
return map->GetCellInfoAt(aRowIdx, aColIdx);
}
/**
* Return the col span of the cell at the given row and column indices.
*/
uint32_t GetEffectiveColSpanAt(uint32_t aRowIdx, uint32_t aColIdx) const {
nsTableCellMap* map = InnerTableFrame()->GetCellMap();
return map->GetEffectiveColSpan(aRowIdx, aColIdx);
}
/**
* Return the effective row span of the cell at the given row and column.
*/
uint32_t GetEffectiveRowSpanAt(uint32_t aRowIdx, uint32_t aColIdx) const {
nsTableCellMap* map = InnerTableFrame()->GetCellMap();
return map->GetEffectiveRowSpan(aRowIdx, aColIdx);
}
protected:
explicit nsTableWrapperFrame(ComputedStyle* aStyle,
nsPresContext* aPresContext,
ClassID aID = kClassID);
virtual ~nsTableWrapperFrame();
using MaybeCaptionSide = Maybe<mozilla::StyleCaptionSide>;
// Get a StyleCaptionSide value, or Nothing if no caption is present.
//
// (Remember that caption-side values are interpreted logically, despite
// having "physical" names.)
MaybeCaptionSide GetCaptionSide() const;
mozilla::StyleVerticalAlignKeyword GetCaptionVerticalAlign() const;
nscoord ComputeFinalBSize(const mozilla::LogicalSize& aInnerSize,
const mozilla::LogicalSize& aCaptionSize,
const mozilla::LogicalMargin& aCaptionMargin,
const mozilla::WritingMode aWM) const;
void GetCaptionOrigin(mozilla::StyleCaptionSide,
const mozilla::LogicalSize& aInnerSize,
const mozilla::LogicalSize& aCaptionSize,
mozilla::LogicalMargin& aCaptionMargin,
mozilla::LogicalPoint& aOrigin,
mozilla::WritingMode aWM) const;
void GetInnerOrigin(const MaybeCaptionSide&,
const mozilla::LogicalSize& aCaptionSize,
const mozilla::LogicalMargin& aCaptionMargin,
const mozilla::LogicalSize& aInnerSize,
mozilla::LogicalPoint& aOrigin,
mozilla::WritingMode aWM) const;
// This is a helper for CreateReflowInputForInnerTable() and
// ComputeAutoSize(). It computes whether we need shrink-wrap behavior for
// children.
//
// Note: We don't need to call this in CreateReflowInputForCaption() because
// when we reflow the captions, we want them to stretch their inline-sizes to
// be at least as wide as the inner table frame.
mozilla::ComputeSizeFlags CreateComputeSizeFlagsForChild() const;
// Create and init the child reflow input, using passed-in aChildRI, so that
// caller can use it after we return.
//
// @param aBSizeOccupiedByCaption the block size occupied by the caption
// within our content box.
void CreateReflowInputForInnerTable(
nsPresContext* aPresContext, nsTableFrame* aTableFrame,
const ReflowInput& aOuterRI, Maybe<ReflowInput>& aChildRI,
const nscoord aAvailISize, nscoord aBSizeOccupiedByCaption = 0) const;
void CreateReflowInputForCaption(nsPresContext* aPresContext,
nsIFrame* aCaptionFrame,
const ReflowInput& aOuterRI,
Maybe<ReflowInput>& aChildRI,
const nscoord aAvailISize) const;
// Reflow the child (caption or inner table frame).
void ReflowChild(nsPresContext* aPresContext, nsIFrame* aChildFrame,
const ReflowInput& aChildRI, ReflowOutput& aMetrics,
nsReflowStatus& aStatus);
// Set the overflow areas in our reflow metrics
void UpdateOverflowAreas(ReflowOutput& aMet);
nsTableFrame* InnerTableFrame() const {
return static_cast<nsTableFrame*>(mFrames.FirstChild());
}
/**
* Helper for ComputeAutoSize.
* Compute the margin-box inline size of the frame given the inputs.
*
* Note: CaptionShrinkWrapISize doesn't need StyleSizeOverrides parameter.
*/
mozilla::LogicalSize InnerTableShrinkWrapSize(
gfxContext* aRenderingContext, nsTableFrame* aTableFrame,
mozilla::WritingMode aWM, const mozilla::LogicalSize& aCBSize,
nscoord aAvailableISize,
const mozilla::StyleSizeOverrides& aSizeOverrides,
mozilla::ComputeSizeFlags aFlag) const;
mozilla::LogicalSize CaptionShrinkWrapSize(
gfxContext* aRenderingContext, nsIFrame* aCaptionFrame,
mozilla::WritingMode aWM, const mozilla::LogicalSize& aCBSize,
nscoord aAvailableISize, mozilla::ComputeSizeFlags aFlag) const;
/**
* Create a new StyleSize by reducing the size by aAmountToReduce.
*
* @param aStyleSize must be a Length.
*/
mozilla::StyleSize ReduceStyleSizeBy(const mozilla::StyleSize& aStyleSize,
const nscoord aAmountToReduce) const;
/**
* Compute StyleSizeOverrides for inner table frame given the overrides of the
* table wrapper frame.
*/
mozilla::StyleSizeOverrides ComputeSizeOverridesForInnerTable(
const nsTableFrame* aTableFrame,
const mozilla::StyleSizeOverrides& aWrapperSizeOverrides,
const mozilla::LogicalSize& aBorderPadding,
nscoord aBSizeOccupiedByCaption) const;
private:
nsFrameList mCaptionFrames;
};
#endif