layout/mathml/nsMathMLmencloseFrame.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsMathMLmencloseFrame_h___
   8 #define nsMathMLmencloseFrame_h___
   9
  10 #include "mozilla/Attributes.h"
  11 #include "mozilla/EnumSet.h"
  12 #include "nsMathMLChar.h"
  13 #include "nsMathMLContainerFrame.h"
  14
  15 namespace mozilla {
  16 class PresShell;
  17 }  // namespace mozilla
  18
  19 //
  20 // <menclose> -- enclose content with a stretching symbol such
  21 // as a long division sign.
  22 //
  23
  24 /*
  25   The MathML REC describes:
  26
  27   The menclose element renders its content inside the enclosing notation
  28   specified by its notation attribute. menclose accepts any number of arguments;
  29   if this number is not 1, its contents are treated as a single "inferred mrow"
  30   containing its arguments, as described in Section 3.1.3 Required Arguments.
  31 */
  32
  33 enum nsMencloseNotation {
  34   NOTATION_LONGDIV,
  35   NOTATION_RADICAL,
  36   NOTATION_ROUNDEDBOX,
  37   NOTATION_CIRCLE,
  38   NOTATION_LEFT,
  39   NOTATION_RIGHT,
  40   NOTATION_TOP,
  41   NOTATION_BOTTOM,
  42   NOTATION_UPDIAGONALSTRIKE,
  43   NOTATION_DOWNDIAGONALSTRIKE,
  44   NOTATION_VERTICALSTRIKE,
  45   NOTATION_HORIZONTALSTRIKE,
  46   NOTATION_UPDIAGONALARROW,
  47   NOTATION_PHASORANGLE
  48 };
  49
  50 class nsMathMLmencloseFrame : public nsMathMLContainerFrame {
  51  public:
  52   NS_DECL_FRAMEARENA_HELPERS(nsMathMLmencloseFrame)
  53
  54   friend nsIFrame* NS_NewMathMLmencloseFrame(mozilla::PresShell* aPresShell,
  55                                              ComputedStyle* aStyle);
  56
  57   virtual nsresult Place(DrawTarget* aDrawTarget, bool aPlaceOrigin,
  58                          ReflowOutput& aDesiredSize) override;
  59
  60   virtual nsresult MeasureForWidth(DrawTarget* aDrawTarget,
  61                                    ReflowOutput& aDesiredSize) override;
  62
  63   virtual nsresult AttributeChanged(int32_t aNameSpaceID, nsAtom* aAttribute,
  64                                     int32_t aModType) override;
  65
  66   void DidSetComputedStyle(ComputedStyle* aOldStyle) override;
  67
  68   virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
  69                                 const nsDisplayListSet& aLists) override;
  70
  71   NS_IMETHOD
  72   InheritAutomaticData(nsIFrame* aParent) override;
  73
  74   NS_IMETHOD
  75   TransmitAutomaticData() override;
  76
  77   virtual nscoord FixInterFrameSpacing(ReflowOutput& aDesiredSize) override;
  78
  79   bool IsMrowLike() override {
  80     return mFrames.FirstChild() != mFrames.LastChild() || !mFrames.FirstChild();
  81   }
  82
  83  protected:
  84   explicit nsMathMLmencloseFrame(ComputedStyle* aStyle,
  85                                  nsPresContext* aPresContext,
  86                                  ClassID aID = kClassID);
  87   virtual ~nsMathMLmencloseFrame();
  88
  89   nsresult PlaceInternal(DrawTarget* aDrawTarget, bool aPlaceOrigin,
  90                          ReflowOutput& aDesiredSize, bool aWidthOnly);
  91
  92   // functions to parse the "notation" attribute.
  93   nsresult AddNotation(const nsAString& aNotation);
  94   void InitNotations();
  95
  96   // Description of the notations to draw
  97   mozilla::EnumSet<nsMencloseNotation> mNotationsToDraw;
  98   bool IsToDraw(nsMencloseNotation notation) {
  99     return mNotationsToDraw.contains(notation);
 100   }
 101
 102   nscoord mRuleThickness;
 103   nscoord mRadicalRuleThickness;
 104   nsTArray<nsMathMLChar> mMathMLChar;
 105   int8_t mLongDivCharIndex, mRadicalCharIndex;
 106   nscoord mContentWidth;
 107   nsresult AllocateMathMLChar(nsMencloseNotation mask);
 108
 109   // Display a frame of the specified type.
 110   // @param aType Type of frame to display
 111   void DisplayNotation(nsDisplayListBuilder* aBuilder, nsIFrame* aFrame,
 112                        const nsRect& aRect, const nsDisplayListSet& aLists,
 113                        nscoord aThickness, nsMencloseNotation aType);
 114 };
 115
 116 #endif /* nsMathMLmencloseFrame_h___ */