layout/mathml/nsMathMLmtableFrame.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsMathMLmtableFrame_h___
   7 #define nsMathMLmtableFrame_h___
   8
   9 #include "mozilla/Attributes.h"
  10 #include "nsMathMLContainerFrame.h"
  11 #include "nsBlockFrame.h"
  12 #include "nsTableOuterFrame.h"
  13 #include "nsTableRowFrame.h"
  14 #include "nsTableCellFrame.h"
  15
  16 //
  17 // <mtable> -- table or matrix
  18 //
  19
  20 class nsMathMLmtableOuterFrame : public nsTableOuterFrame,
  21                                  public nsMathMLFrame
  22 {
  23 public:
  24   friend nsContainerFrame* NS_NewMathMLmtableOuterFrame(nsIPresShell* aPresShell,
  25                                                         nsStyleContext* aContext);
  26
  27   NS_DECL_QUERYFRAME
  28   NS_DECL_FRAMEARENA_HELPERS
  29
  30   // overloaded nsTableOuterFrame methods
  31
  32   virtual void
  33   Reflow(nsPresContext*          aPresContext,
  34          nsHTMLReflowMetrics&     aDesiredSize,
  35          const nsHTMLReflowState& aReflowState,
  36          nsReflowStatus&          aStatus) MOZ_OVERRIDE;
  37
  38   virtual nsresult
  39   AttributeChanged(int32_t  aNameSpaceID,
  40                    nsIAtom* aAttribute,
  41                    int32_t  aModType) MOZ_OVERRIDE;
  42
  43   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
  44   {
  45     return nsTableOuterFrame::IsFrameOfType(aFlags & ~(nsIFrame::eMathML));
  46   }
  47
  48 protected:
  49   explicit nsMathMLmtableOuterFrame(nsStyleContext* aContext) : nsTableOuterFrame(aContext) {}
  50   virtual ~nsMathMLmtableOuterFrame();
  51
  52   // helper to find the row frame at a given index, positive or negative, e.g.,
  53   // 1..n means the first row down to the last row, -1..-n means the last row
  54   // up to the first row. Used for alignments that are relative to a given row
  55   nsIFrame*
  56   GetRowFrameAt(nsPresContext* aPresContext,
  57                 int32_t         aRowIndex);
  58 }; // class nsMathMLmtableOuterFrame
  59
  60 // --------------
  61
  62 class nsMathMLmtableFrame : public nsTableFrame
  63 {
  64 public:
  65   NS_DECL_QUERYFRAME_TARGET(nsMathMLmtableFrame)
  66   NS_DECL_QUERYFRAME
  67   NS_DECL_FRAMEARENA_HELPERS
  68
  69   friend nsContainerFrame* NS_NewMathMLmtableFrame(nsIPresShell* aPresShell,
  70                                                    nsStyleContext* aContext);
  71
  72   // Overloaded nsTableFrame methods
  73
  74   virtual void
  75   SetInitialChildList(ChildListID  aListID,
  76                       nsFrameList& aChildList) MOZ_OVERRIDE;
  77
  78   virtual void
  79   AppendFrames(ChildListID  aListID,
  80                nsFrameList& aFrameList) MOZ_OVERRIDE
  81   {
  82     nsTableFrame::AppendFrames(aListID, aFrameList);
  83     RestyleTable();
  84   }
  85
  86   virtual void
  87   InsertFrames(ChildListID aListID,
  88                nsIFrame* aPrevFrame,
  89                nsFrameList& aFrameList) MOZ_OVERRIDE
  90   {
  91     nsTableFrame::InsertFrames(aListID, aPrevFrame, aFrameList);
  92     RestyleTable();
  93   }
  94
  95   virtual void
  96   RemoveFrame(ChildListID aListID,
  97               nsIFrame* aOldFrame) MOZ_OVERRIDE
  98   {
  99     nsTableFrame::RemoveFrame(aListID, aOldFrame);
 100     RestyleTable();
 101   }
 102
 103   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
 104   {
 105     return nsTableFrame::IsFrameOfType(aFlags & ~(nsIFrame::eMathML));
 106   }
 107
 108   // helper to restyle and reflow the table when a row is changed -- since MathML
 109   // attributes are inter-dependent and row/colspan can affect the table, it is
 110   // safer (albeit grossly suboptimal) to just relayout the whole thing.
 111   void RestyleTable();
 112
 113   /** helper to get the cell spacing X style value */
 114   nscoord GetCellSpacingX(int32_t aColIndex) MOZ_OVERRIDE;
 115
 116   /** Sums the combined cell spacing between the columns aStartColIndex to
 117    *  aEndColIndex.
 118    */
 119   nscoord GetCellSpacingX(int32_t aStartColIndex,
 120                           int32_t aEndColIndex) MOZ_OVERRIDE;
 121
 122   /** helper to get the cell spacing Y style value */
 123   nscoord GetCellSpacingY(int32_t aRowIndex) MOZ_OVERRIDE;
 124
 125   /** Sums the combined cell spacing between the rows aStartRowIndex to
 126    *  aEndRowIndex.
 127    */
 128   nscoord GetCellSpacingY(int32_t aStartRowIndex,
 129                           int32_t aEndRowIndex) MOZ_OVERRIDE;
 130
 131   void SetColSpacingArray(const nsTArray<nscoord>& aColSpacing)
 132   {
 133     mColSpacing = aColSpacing;
 134   }
 135
 136   void SetRowSpacingArray(const nsTArray<nscoord>& aRowSpacing)
 137   {
 138     mRowSpacing = aRowSpacing;
 139   }
 140
 141   void SetFrameSpacing(nscoord aSpacingX, nscoord aSpacingY)
 142   {
 143     mFrameSpacingX = aSpacingX;
 144     mFrameSpacingY = aSpacingY;
 145   }
 146
 147   /** Determines whether the placement of table cells is determined by CSS
 148    * spacing based on padding and border-spacing, or one based upon the
 149    * rowspacing, columnspacing and framespacing attributes.  The second
 150    * approach is used if the user specifies at least one of those attributes.
 151    */
 152   void SetUseCSSSpacing();
 153
 154   bool GetUseCSSSpacing()
 155   {
 156     return mUseCSSSpacing;
 157   }
 158
 159 protected:
 160   explicit nsMathMLmtableFrame(nsStyleContext* aContext) : nsTableFrame(aContext) {}
 161   virtual ~nsMathMLmtableFrame();
 162
 163 private:
 164   nsTArray<nscoord> mColSpacing;
 165   nsTArray<nscoord> mRowSpacing;
 166   nscoord mFrameSpacingX;
 167   nscoord mFrameSpacingY;
 168   bool mUseCSSSpacing;
 169 }; // class nsMathMLmtableFrame
 170
 171 // --------------
 172
 173 class nsMathMLmtrFrame : public nsTableRowFrame
 174 {
 175 public:
 176   NS_DECL_FRAMEARENA_HELPERS
 177
 178   friend nsContainerFrame* NS_NewMathMLmtrFrame(nsIPresShell* aPresShell,
 179                                                 nsStyleContext* aContext);
 180
 181   // overloaded nsTableRowFrame methods
 182
 183   virtual nsresult
 184   AttributeChanged(int32_t  aNameSpaceID,
 185                    nsIAtom* aAttribute,
 186                    int32_t  aModType) MOZ_OVERRIDE;
 187
 188   virtual void
 189   AppendFrames(ChildListID  aListID,
 190                nsFrameList& aFrameList) MOZ_OVERRIDE
 191   {
 192     nsTableRowFrame::AppendFrames(aListID, aFrameList);
 193     RestyleTable();
 194   }
 195
 196   virtual void
 197   InsertFrames(ChildListID aListID,
 198                nsIFrame* aPrevFrame,
 199                nsFrameList& aFrameList) MOZ_OVERRIDE
 200   {
 201     nsTableRowFrame::InsertFrames(aListID, aPrevFrame, aFrameList);
 202     RestyleTable();
 203   }
 204
 205   virtual void
 206   RemoveFrame(ChildListID aListID,
 207               nsIFrame* aOldFrame) MOZ_OVERRIDE
 208   {
 209     nsTableRowFrame::RemoveFrame(aListID, aOldFrame);
 210     RestyleTable();
 211   }
 212
 213   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
 214   {
 215     return nsTableRowFrame::IsFrameOfType(aFlags & ~(nsIFrame::eMathML));
 216   }
 217
 218   // helper to restyle and reflow the table -- @see nsMathMLmtableFrame.
 219   void RestyleTable()
 220   {
 221     nsTableFrame* tableFrame = nsTableFrame::GetTableFrame(this);
 222     if (tableFrame && tableFrame->IsFrameOfType(nsIFrame::eMathML)) {
 223       // relayout the table
 224       ((nsMathMLmtableFrame*)tableFrame)->RestyleTable();
 225     }
 226   }
 227
 228 protected:
 229   explicit nsMathMLmtrFrame(nsStyleContext* aContext) : nsTableRowFrame(aContext) {}
 230   virtual ~nsMathMLmtrFrame();
 231 }; // class nsMathMLmtrFrame
 232
 233 // --------------
 234
 235 class nsMathMLmtdFrame : public nsTableCellFrame
 236 {
 237 public:
 238   NS_DECL_FRAMEARENA_HELPERS
 239
 240   friend nsContainerFrame* NS_NewMathMLmtdFrame(nsIPresShell* aPresShell,
 241                                                 nsStyleContext* aContext);
 242
 243   // overloaded nsTableCellFrame methods
 244
 245   virtual nsresult
 246   AttributeChanged(int32_t  aNameSpaceID,
 247                    nsIAtom* aAttribute,
 248                    int32_t  aModType) MOZ_OVERRIDE;
 249
 250   virtual uint8_t GetVerticalAlign() const MOZ_OVERRIDE;
 251   virtual nsresult ProcessBorders(nsTableFrame* aFrame,
 252                                   nsDisplayListBuilder* aBuilder,
 253                                   const nsDisplayListSet& aLists) MOZ_OVERRIDE;
 254
 255   virtual int32_t GetRowSpan() MOZ_OVERRIDE;
 256   virtual int32_t GetColSpan() MOZ_OVERRIDE;
 257   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
 258   {
 259     return nsTableCellFrame::IsFrameOfType(aFlags & ~(nsIFrame::eMathML));
 260   }
 261
 262   virtual nsMargin* GetBorderWidth(nsMargin& aBorder) const MOZ_OVERRIDE;
 263
 264   virtual nsMargin GetBorderOverflow() MOZ_OVERRIDE;
 265
 266 protected:
 267   explicit nsMathMLmtdFrame(nsStyleContext* aContext) : nsTableCellFrame(aContext) {}
 268   virtual ~nsMathMLmtdFrame();
 269 }; // class nsMathMLmtdFrame
 270
 271 // --------------
 272
 273 class nsMathMLmtdInnerFrame : public nsBlockFrame,
 274                               public nsMathMLFrame {
 275 public:
 276   friend nsContainerFrame* NS_NewMathMLmtdInnerFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
 277
 278   NS_DECL_QUERYFRAME
 279   NS_DECL_FRAMEARENA_HELPERS
 280
 281   // Overloaded nsIMathMLFrame methods
 282
 283   NS_IMETHOD
 284   UpdatePresentationDataFromChildAt(int32_t         aFirstIndex,
 285                                     int32_t         aLastIndex,
 286                                     uint32_t        aFlagsValues,
 287                                     uint32_t        aFlagsToUpdate) MOZ_OVERRIDE
 288   {
 289     nsMathMLContainerFrame::PropagatePresentationDataFromChildAt(this,
 290       aFirstIndex, aLastIndex, aFlagsValues, aFlagsToUpdate);
 291     return NS_OK;
 292   }
 293
 294   virtual void
 295   Reflow(nsPresContext*          aPresContext,
 296          nsHTMLReflowMetrics&     aDesiredSize,
 297          const nsHTMLReflowState& aReflowState,
 298          nsReflowStatus&          aStatus) MOZ_OVERRIDE;
 299
 300   virtual bool IsFrameOfType(uint32_t aFlags) const MOZ_OVERRIDE
 301   {
 302     return nsBlockFrame::IsFrameOfType(aFlags &
 303       ~(nsIFrame::eMathML | nsIFrame::eExcludesIgnorableWhitespace));
 304   }
 305
 306   virtual const nsStyleText* StyleTextForLineLayout() MOZ_OVERRIDE;
 307   virtual void DidSetStyleContext(nsStyleContext* aOldStyleContext) MOZ_OVERRIDE;
 308
 309   bool
 310   IsMrowLike() MOZ_OVERRIDE {
 311     return mFrames.FirstChild() != mFrames.LastChild() ||
 312            !mFrames.FirstChild();
 313   }
 314
 315 protected:
 316   explicit nsMathMLmtdInnerFrame(nsStyleContext* aContext);
 317   virtual ~nsMathMLmtdInnerFrame();
 318
 319   nsStyleText* mUniqueStyleText;
 320
 321 };  // class nsMathMLmtdInnerFrame
 322
 323 #endif /* nsMathMLmtableFrame_h___ */