layout/generic/nsRubyTextContainerFrame.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 et sw=2 tw=80: */
   3 /* This Source Code is subject to the terms of the Mozilla Public License
   4  * version 2.0 (the "License"). You can obtain a copy of the License at
   5  * http://mozilla.org/MPL/2.0/. */
   6
   7 /* rendering object for CSS "display: ruby-text-container" */
   8
   9 #include "nsRubyTextContainerFrame.h"
  10 #include "nsPresContext.h"
  11 #include "nsStyleContext.h"
  12 #include "WritingModes.h"
  13 #include "RubyReflowState.h"
  14 #include "mozilla/UniquePtr.h"
  15
  16 using namespace mozilla;
  17
  18 //----------------------------------------------------------------------
  19
  20 // Frame class boilerplate
  21 // =======================
  22
  23 NS_QUERYFRAME_HEAD(nsRubyTextContainerFrame)
  24   NS_QUERYFRAME_ENTRY(nsRubyTextContainerFrame)
  25 NS_QUERYFRAME_TAIL_INHERITING(nsContainerFrame)
  26
  27 NS_IMPL_FRAMEARENA_HELPERS(nsRubyTextContainerFrame)
  28
  29 nsContainerFrame*
  30 NS_NewRubyTextContainerFrame(nsIPresShell* aPresShell,
  31                              nsStyleContext* aContext)
  32 {
  33   return new (aPresShell) nsRubyTextContainerFrame(aContext);
  34 }
  35
  36
  37 //----------------------------------------------------------------------
  38
  39 // nsRubyTextContainerFrame Method Implementations
  40 // ===============================================
  41
  42 nsIAtom*
  43 nsRubyTextContainerFrame::GetType() const
  44 {
  45   return nsGkAtoms::rubyTextContainerFrame;
  46 }
  47
  48 #ifdef DEBUG_FRAME_DUMP
  49 nsresult
  50 nsRubyTextContainerFrame::GetFrameName(nsAString& aResult) const
  51 {
  52   return MakeFrameName(NS_LITERAL_STRING("RubyTextContainer"), aResult);
  53 }
  54 #endif
  55
  56 /* virtual */ bool
  57 nsRubyTextContainerFrame::IsFrameOfType(uint32_t aFlags) const
  58 {
  59   if (aFlags & eSupportsCSSTransforms) {
  60     return false;
  61   }
  62   return nsRubyTextContainerFrameSuper::IsFrameOfType(aFlags);
  63 }
  64
  65 /* virtual */ void
  66 nsRubyTextContainerFrame::SetInitialChildList(ChildListID aListID,
  67                                               nsFrameList& aChildList)
  68 {
  69   nsRubyTextContainerFrameSuper::SetInitialChildList(aListID, aChildList);
  70   UpdateSpanFlag();
  71 }
  72
  73 /* virtual */ void
  74 nsRubyTextContainerFrame::AppendFrames(ChildListID aListID,
  75                                        nsFrameList& aFrameList)
  76 {
  77   nsRubyTextContainerFrameSuper::AppendFrames(aListID, aFrameList);
  78   UpdateSpanFlag();
  79 }
  80
  81 /* virtual */ void
  82 nsRubyTextContainerFrame::InsertFrames(ChildListID aListID,
  83                                        nsIFrame* aPrevFrame,
  84                                        nsFrameList& aFrameList)
  85 {
  86   nsRubyTextContainerFrameSuper::InsertFrames(aListID, aPrevFrame, aFrameList);
  87   UpdateSpanFlag();
  88 }
  89
  90 /* virtual */ void
  91 nsRubyTextContainerFrame::RemoveFrame(ChildListID aListID,
  92                                       nsIFrame* aOldFrame)
  93 {
  94   nsRubyTextContainerFrameSuper::RemoveFrame(aListID, aOldFrame);
  95   UpdateSpanFlag();
  96 }
  97
  98 void
  99 nsRubyTextContainerFrame::UpdateSpanFlag()
 100 {
 101   bool isSpan = false;
 102   // The continuation checks are safe here because spans never break.
 103   if (!GetPrevContinuation() && !GetNextContinuation()) {
 104     nsIFrame* onlyChild = mFrames.OnlyChild();
 105     if (onlyChild && onlyChild->IsPseudoFrame(GetContent())) {
 106       // Per CSS Ruby spec, if the only child of an rtc frame is
 107       // a pseudo rt frame, it spans all bases in the segment.
 108       isSpan = true;
 109     }
 110   }
 111
 112   if (isSpan) {
 113     AddStateBits(NS_RUBY_TEXT_CONTAINER_IS_SPAN);
 114   } else {
 115     RemoveStateBits(NS_RUBY_TEXT_CONTAINER_IS_SPAN);
 116   }
 117 }
 118
 119 /* virtual */ void
 120 nsRubyTextContainerFrame::Reflow(nsPresContext* aPresContext,
 121                                  nsHTMLReflowMetrics& aDesiredSize,
 122                                  const nsHTMLReflowState& aReflowState,
 123                                  nsReflowStatus& aStatus)
 124 {
 125   DO_GLOBAL_REFLOW_COUNT("nsRubyTextContainerFrame");
 126   DISPLAY_REFLOW(aPresContext, this, aReflowState, aDesiredSize, aStatus);
 127
 128   MOZ_ASSERT(aReflowState.mRubyReflowState, "No ruby reflow state provided");
 129
 130   // All rt children have already been reflowed. All we need to do is
 131   // to report complete and return the desired size provided by the
 132   // ruby base container.
 133
 134   // Although a ruby text container may have continuations, returning
 135   // NS_FRAME_COMPLETE here is still safe, since its parent, ruby frame,
 136   // ignores the status, and continuations of the ruby base container
 137   // will take care of our continuations.
 138   aStatus = NS_FRAME_COMPLETE;
 139   WritingMode lineWM = aReflowState.mLineLayout->GetWritingMode();
 140   const RubyReflowState::TextContainerInfo& info =
 141     aReflowState.mRubyReflowState->GetCurrentTextContainerInfo(this);
 142   aDesiredSize.SetSize(lineWM, info.mLineSize);
 143 }