3c4a808a0e
To account for spacing between bases or text boxes during reflow, the line layout which manages the bases updates its inline direction coordinate based on the preferred inline size for the corresponding text boxes. Next, the base is reflowed at the correct inline coordinate. Each paired text box is then also reflowed at the proper inline position determined by (1) the current position of its corresponding base and (2) its own preferred width. In computing intrinsic widths, accounting for spacing is less complicated. The minimum intrinsic width is the width of the widest ruby column, and the preferred intrinsic width is the sum of all the ruby column widths. Each ruby column width is the maximum width of its base box and text boxes. These individual widths are determined using GetPrefISize on the base and text boxes. Ruby base container frames store a list of pointers to the ruby text container frames in the segment they denote. This list of pointers is created in the ruby frame reflow method before calling the reflow method for the ruby base container. The list exists and is used only during reflow of the main ruby frame and is cleared before returning from reflow.
285 lines
10 KiB
C++
285 lines
10 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=2 et sw=2 tw=80: */
|
|
/* This Source Code is subject to the terms of the Mozilla Public License
|
|
* version 2.0 (the "License"). You can obtain a copy of the License at
|
|
* http://mozilla.org/MPL/2.0/. */
|
|
|
|
/* rendering object for CSS "display: ruby" */
|
|
#include "nsRubyFrame.h"
|
|
#include "nsLineLayout.h"
|
|
#include "nsPresContext.h"
|
|
#include "nsStyleContext.h"
|
|
#include "WritingModes.h"
|
|
#include "nsRubyBaseContainerFrame.h"
|
|
#include "nsRubyTextContainerFrame.h"
|
|
|
|
using namespace mozilla;
|
|
|
|
//----------------------------------------------------------------------
|
|
|
|
// Frame class boilerplate
|
|
// =======================
|
|
|
|
NS_QUERYFRAME_HEAD(nsRubyFrame)
|
|
NS_QUERYFRAME_ENTRY(nsRubyFrame)
|
|
NS_QUERYFRAME_TAIL_INHERITING(nsContainerFrame)
|
|
|
|
NS_IMPL_FRAMEARENA_HELPERS(nsRubyFrame)
|
|
|
|
nsContainerFrame*
|
|
NS_NewRubyFrame(nsIPresShell* aPresShell,
|
|
nsStyleContext* aContext)
|
|
{
|
|
return new (aPresShell) nsRubyFrame(aContext);
|
|
}
|
|
|
|
//----------------------------------------------------------------------
|
|
|
|
// nsRubyFrame Method Implementations
|
|
// ==================================
|
|
|
|
nsIAtom*
|
|
nsRubyFrame::GetType() const
|
|
{
|
|
return nsGkAtoms::rubyFrame;
|
|
}
|
|
|
|
/* virtual */ bool
|
|
nsRubyFrame::IsFrameOfType(uint32_t aFlags) const
|
|
{
|
|
return nsContainerFrame::IsFrameOfType(aFlags &
|
|
~(nsIFrame::eLineParticipant));
|
|
}
|
|
|
|
#ifdef DEBUG_FRAME_DUMP
|
|
nsresult
|
|
nsRubyFrame::GetFrameName(nsAString& aResult) const
|
|
{
|
|
return MakeFrameName(NS_LITERAL_STRING("Ruby"), aResult);
|
|
}
|
|
#endif
|
|
|
|
void
|
|
nsRubyFrame::CalculateColSizes(nsRenderingContext* aRenderingContext,
|
|
nsTArray<nscoord>& aColSizes)
|
|
{
|
|
nsFrameList::Enumerator e(this->PrincipalChildList());
|
|
uint32_t annotationNum = 0;
|
|
int segmentNum = -1;
|
|
|
|
nsTArray<int> segmentBaseCounts;
|
|
|
|
for(; !e.AtEnd(); e.Next()) {
|
|
nsIFrame* childFrame = e.get();
|
|
if (childFrame->GetType() == nsGkAtoms::rubyBaseContainerFrame) {
|
|
segmentNum++;
|
|
segmentBaseCounts.AppendElement(0);
|
|
nsFrameList::Enumerator bases(childFrame->PrincipalChildList());
|
|
for(; !bases.AtEnd(); bases.Next()) {
|
|
aColSizes.AppendElement(bases.get()->GetPrefISize(aRenderingContext));
|
|
segmentBaseCounts.ElementAt(segmentNum)++;
|
|
}
|
|
} else if (childFrame->GetType() == nsGkAtoms::rubyTextContainerFrame) {
|
|
if (segmentNum == -1) {
|
|
// No rbc exists for first segment, so act as if there is one
|
|
segmentNum++;
|
|
segmentBaseCounts.AppendElement(1);
|
|
aColSizes.AppendElement(0);
|
|
}
|
|
nsFrameList::Enumerator annotations(childFrame->PrincipalChildList());
|
|
uint32_t baseCount = segmentBaseCounts.ElementAt(segmentNum);
|
|
for(; !annotations.AtEnd(); annotations.Next()) {
|
|
nsIFrame* annotationFrame = annotations.get();
|
|
if (annotationNum > baseCount) {
|
|
aColSizes.AppendElement(annotationFrame->
|
|
GetPrefISize(aRenderingContext));
|
|
baseCount++;
|
|
segmentBaseCounts.ElementAt(segmentNum) = baseCount;
|
|
annotationNum++;
|
|
} else if (annotationNum < baseCount - 1) {
|
|
//there are fewer annotations than bases, so the last annotation is
|
|
//associated with (spans) the remaining bases. This means these
|
|
//columns can't be broken up, so gather their entire ISize in one
|
|
//entry of aColSizes and clear the other entries.
|
|
int baseSum = 0;
|
|
for (uint32_t i = annotationNum; i < annotationNum + baseCount; i++) {
|
|
baseSum += aColSizes.ElementAt(i);
|
|
if (i > annotationNum) {
|
|
aColSizes.ElementAt(i) = 0;
|
|
}
|
|
}
|
|
aColSizes.ElementAt(annotationNum) =
|
|
std::max(baseSum, annotationFrame->GetPrefISize(aRenderingContext));
|
|
annotationNum = baseCount;
|
|
} else {
|
|
aColSizes.ElementAt(annotationNum) =
|
|
std::max(aColSizes.ElementAt(annotationNum),
|
|
annotationFrame->GetPrefISize(aRenderingContext));
|
|
annotationNum++;
|
|
}
|
|
}
|
|
} else {
|
|
NS_ASSERTION(false, "Unrecognized child type for ruby frame.");
|
|
}
|
|
}
|
|
}
|
|
|
|
/* virtual */ void
|
|
nsRubyFrame::AddInlineMinISize(nsRenderingContext *aRenderingContext,
|
|
nsIFrame::InlineMinISizeData *aData)
|
|
{
|
|
//FIXME: This needs to handle the cases where it's possible for a ruby base to
|
|
//break, as well as forced breaks.
|
|
nsTArray<int> colSizes;
|
|
CalculateColSizes(aRenderingContext, colSizes);
|
|
|
|
nscoord max = 0;
|
|
for (uint32_t i = 0; i < colSizes.Length(); i++) {
|
|
if (colSizes.ElementAt(i) > max) {
|
|
max = colSizes.ElementAt(i);
|
|
}
|
|
}
|
|
|
|
aData->currentLine += max;
|
|
}
|
|
|
|
/* virtual */ void
|
|
nsRubyFrame::AddInlinePrefISize(nsRenderingContext *aRenderingContext,
|
|
nsIFrame::InlinePrefISizeData *aData)
|
|
{
|
|
nsTArray<int> colSizes;
|
|
CalculateColSizes(aRenderingContext, colSizes);
|
|
|
|
nscoord sum = 0;
|
|
for (uint32_t i = 0; i < colSizes.Length(); i++) {
|
|
sum += colSizes.ElementAt(i);
|
|
}
|
|
|
|
aData->currentLine += sum;
|
|
}
|
|
|
|
/* virtual */ nscoord
|
|
nsRubyFrame::GetLogicalBaseline(WritingMode aWritingMode) const
|
|
{
|
|
return mBaseline;
|
|
}
|
|
|
|
/* virtual */ void
|
|
nsRubyFrame::Reflow(nsPresContext* aPresContext,
|
|
nsHTMLReflowMetrics& aDesiredSize,
|
|
const nsHTMLReflowState& aReflowState,
|
|
nsReflowStatus& aStatus)
|
|
{
|
|
DO_GLOBAL_REFLOW_COUNT("nsRubyFrame");
|
|
DISPLAY_REFLOW(aPresContext, this, aReflowState, aDesiredSize, aStatus);
|
|
|
|
if (!aReflowState.mLineLayout) {
|
|
NS_ASSERTION(aReflowState.mLineLayout,
|
|
"No line layout provided to RubyFrame reflow method.");
|
|
aStatus = NS_FRAME_COMPLETE;
|
|
return;
|
|
}
|
|
|
|
// Begin the span for the ruby frame
|
|
WritingMode frameWM = aReflowState.GetWritingMode();
|
|
WritingMode lineWM = aReflowState.mLineLayout->GetWritingMode();
|
|
LogicalMargin borderPadding = aReflowState.ComputedLogicalBorderPadding();
|
|
nscoord availableISize = aReflowState.AvailableISize();
|
|
NS_ASSERTION(availableISize != NS_UNCONSTRAINEDSIZE,
|
|
"should no longer use available widths");
|
|
// Subtract off inline axis border+padding from availableISize
|
|
availableISize -= borderPadding.IStartEnd(frameWM);
|
|
aReflowState.mLineLayout->BeginSpan(this, &aReflowState,
|
|
borderPadding.IStart(frameWM),
|
|
availableISize, &mBaseline);
|
|
|
|
// FIXME: line breaking / continuations not yet implemented
|
|
aStatus = NS_FRAME_COMPLETE;
|
|
LogicalSize availSize(lineWM, aReflowState.AvailableISize(),
|
|
aReflowState.AvailableBSize());
|
|
// The ruby base container for the current segment
|
|
nsRubyBaseContainerFrame* segmentRBC = nullptr;
|
|
nscoord annotationBSize = 0;
|
|
for (nsFrameList::Enumerator e(mFrames); !e.AtEnd(); e.Next()) {
|
|
nsIFrame* childFrame = e.get();
|
|
if (e.get()->GetType() == nsGkAtoms::rubyBaseContainerFrame) {
|
|
if (segmentRBC) {
|
|
annotationBSize = 0;
|
|
}
|
|
|
|
// Figure out what all the text containers are for this segment (necessary
|
|
// for reflow calculations)
|
|
segmentRBC = do_QueryFrame(childFrame);
|
|
nsFrameList::Enumerator segment(e);
|
|
segment.Next();
|
|
while (!segment.AtEnd() && (segment.get()->GetType() !=
|
|
nsGkAtoms::rubyBaseContainerFrame)) {
|
|
if (segment.get()->GetType() == nsGkAtoms::rubyTextContainerFrame) {
|
|
segmentRBC->AppendTextContainer(segment.get());
|
|
}
|
|
segment.Next();
|
|
}
|
|
|
|
nsReflowStatus frameReflowStatus;
|
|
nsHTMLReflowMetrics metrics(aReflowState, aDesiredSize.mFlags);
|
|
nsHTMLReflowState childReflowState(aPresContext, aReflowState,
|
|
childFrame, availSize);
|
|
childReflowState.mLineLayout = aReflowState.mLineLayout;
|
|
childFrame->Reflow(aPresContext, metrics, childReflowState,
|
|
frameReflowStatus);
|
|
NS_ASSERTION(frameReflowStatus == NS_FRAME_COMPLETE,
|
|
"Ruby line breaking is not yet implemented");
|
|
childFrame->SetSize(LogicalSize(lineWM, metrics.ISize(lineWM),
|
|
metrics.BSize(lineWM)));
|
|
FinishReflowChild(childFrame, aPresContext, metrics, &childReflowState, 0,
|
|
0, NS_FRAME_NO_MOVE_FRAME | NS_FRAME_NO_MOVE_VIEW);
|
|
|
|
} else if (childFrame->GetType() == nsGkAtoms::rubyTextContainerFrame) {
|
|
nsReflowStatus frameReflowStatus;
|
|
nsHTMLReflowMetrics metrics(aReflowState, aDesiredSize.mFlags);
|
|
nsHTMLReflowState childReflowState(aPresContext, aReflowState, childFrame,
|
|
availSize);
|
|
childReflowState.mLineLayout = aReflowState.mLineLayout;
|
|
childFrame->Reflow(aPresContext, metrics, childReflowState,
|
|
frameReflowStatus);
|
|
NS_ASSERTION(frameReflowStatus == NS_FRAME_COMPLETE,
|
|
"Ruby line breaking is not yet implemented");
|
|
annotationBSize += metrics.BSize(lineWM);
|
|
childFrame->SetSize(LogicalSize(lineWM, metrics.ISize(lineWM),
|
|
metrics.BSize(lineWM)));
|
|
// FIXME: This is a temporary calculation for finding the block coordinate
|
|
// of the ruby text container. A better one replace it once it's been
|
|
// spec'ed.
|
|
nscoord baseContainerBCoord;
|
|
if (segmentRBC) {
|
|
// Find the starting block coordinate of the ruby base container for
|
|
// this segment. For now, the ruby text container will be placed so that
|
|
// its bottom edge touches this coordinate.
|
|
baseContainerBCoord = segmentRBC->
|
|
GetLogicalPosition(this->GetParent()->GetLogicalSize().ISize(lineWM)).
|
|
B(lineWM);
|
|
} else {
|
|
baseContainerBCoord = 0;
|
|
}
|
|
FinishReflowChild(childFrame, aPresContext, metrics, &childReflowState, 0,
|
|
baseContainerBCoord - metrics.BSize(lineWM), 0);
|
|
} else {
|
|
NS_NOTREACHED(
|
|
"Unrecognized child type for ruby frame will not be reflowed.");
|
|
}
|
|
}
|
|
|
|
// Null the pointers between child frames.
|
|
for (nsFrameList::Enumerator children(mFrames); !children.AtEnd();
|
|
children.Next()) {
|
|
nsRubyBaseContainerFrame* rbcFrame = do_QueryFrame(children.get());
|
|
if (rbcFrame) {
|
|
rbcFrame->ClearTextContainers();
|
|
}
|
|
}
|
|
|
|
aDesiredSize.ISize(lineWM) = aReflowState.mLineLayout->EndSpan(this);
|
|
nsLayoutUtils::SetBSizeFromFontMetrics(this, aDesiredSize, aReflowState,
|
|
borderPadding, lineWM, frameWM);
|
|
}
|