gecko-dev/layout/generic/nsFrameSetFrame.h

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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/. */

/* rendering object for HTML <frameset> elements */

#ifndef nsHTMLFrameset_h___
#define nsHTMLFrameset_h___

#include "mozilla/Attributes.h"
#include "mozilla/UniquePtr.h"
#include "nsContainerFrame.h"
#include "nsColor.h"

class nsIContent;
class nsPresContext;
struct nsRect;
struct nsSize;
class nsAtom;
class nsHTMLFramesetBorderFrame;
class nsHTMLFramesetFrame;

#define NO_COLOR 0xFFFFFFFA

// defined at HTMLFrameSetElement.h
struct nsFramesetSpec;

struct nsBorderColor {
  nscolor mLeft;
  nscolor mRight;
  nscolor mTop;
  nscolor mBottom;

  nsBorderColor() { Set(NO_COLOR); }
  ~nsBorderColor() = default;
  void Set(nscolor aColor) { mLeft = mRight = mTop = mBottom = aColor; }
};

enum nsFrameborder {
  eFrameborder_Yes = 0,
  eFrameborder_No,
  eFrameborder_Notset
};

struct nsFramesetDrag {
  nsHTMLFramesetFrame* mSource;  // frameset whose border was dragged to cause
                                 // the resize
  int32_t mIndex;   // index of left col or top row of effected area
  int32_t mChange;  // pos for left to right or top to bottom, neg otherwise
  bool mVertical;   // vertical if true, otherwise horizontal

  nsFramesetDrag();
  void Reset(bool aVertical, int32_t aIndex, int32_t aChange,
             nsHTMLFramesetFrame* aSource);
  void UnSet();
};

/*******************************************************************************
 * nsHTMLFramesetFrame
 ******************************************************************************/
class nsHTMLFramesetFrame final : public nsContainerFrame {
 public:
  NS_DECL_QUERYFRAME
  NS_DECL_FRAMEARENA_HELPERS(nsHTMLFramesetFrame)

  explicit nsHTMLFramesetFrame(ComputedStyle* aStyle,
                               nsPresContext* aPresContext);

  virtual ~nsHTMLFramesetFrame();

  virtual void Init(nsIContent* aContent, nsContainerFrame* aParent,
                    nsIFrame* aPrevInFlow) override;

  virtual void SetInitialChildList(ChildListID aListID,
                                   nsFrameList& aChildList) override;

  static bool gDragInProgress;

  void GetSizeOfChild(nsIFrame* aChild, mozilla::WritingMode aWM,
                      mozilla::LogicalSize& aSize);

  void GetSizeOfChildAt(int32_t aIndexInParent, mozilla::WritingMode aWM,
                        mozilla::LogicalSize& aSize, nsIntPoint& aCellIndex);

  virtual nsresult HandleEvent(nsPresContext* aPresContext,
                               mozilla::WidgetGUIEvent* aEvent,
                               nsEventStatus* aEventStatus) override;

  mozilla::Maybe<Cursor> GetCursor(const nsPoint&) override;

  virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
                                const nsDisplayListSet& aLists) override;

  virtual void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
                      const ReflowInput& aReflowInput,
                      nsReflowStatus& aStatus) override;

#ifdef DEBUG_FRAME_DUMP
  virtual nsresult GetFrameName(nsAString& aResult) const override;
#endif

  void StartMouseDrag(nsPresContext* aPresContext,
                      nsHTMLFramesetBorderFrame* aBorder,
                      mozilla::WidgetGUIEvent* aEvent);

  void MouseDrag(nsPresContext* aPresContext, mozilla::WidgetGUIEvent* aEvent);

  void EndMouseDrag(nsPresContext* aPresContext);

  nsFrameborder GetParentFrameborder() { return mParentFrameborder; }

  void SetParentFrameborder(nsFrameborder aValue) {
    mParentFrameborder = aValue;
  }

  nsFramesetDrag& GetDrag() { return mDrag; }

  void RecalculateBorderResize();

 protected:
  void Scale(nscoord aDesired, int32_t aNumIndicies, int32_t* aIndicies,
             int32_t aNumItems, int32_t* aItems);

  void CalculateRowCol(nsPresContext* aPresContext, nscoord aSize,
                       int32_t aNumSpecs, const nsFramesetSpec* aSpecs,
                       nscoord* aValues);

  void GenerateRowCol(nsPresContext* aPresContext, nscoord aSize,
                      int32_t aNumSpecs, const nsFramesetSpec* aSpecs,
                      nscoord* aValues, nsString& aNewAttr);

  virtual void GetDesiredSize(nsPresContext* aPresContext,
                              const ReflowInput& aReflowInput,
                              ReflowOutput& aDesiredSize);

  int32_t GetBorderWidth(nsPresContext* aPresContext,
                         bool aTakeForcingIntoAccount);

  int32_t GetParentBorderWidth() { return mParentBorderWidth; }

  void SetParentBorderWidth(int32_t aWidth) { mParentBorderWidth = aWidth; }

  nscolor GetParentBorderColor() { return mParentBorderColor; }

  void SetParentBorderColor(nscolor aColor) { mParentBorderColor = aColor; }

  nsFrameborder GetFrameBorder();

  nsFrameborder GetFrameBorder(nsIContent* aContent);

  nscolor GetBorderColor();

  nscolor GetBorderColor(nsIContent* aFrameContent);

  bool GetNoResize(nsIFrame* aChildFrame);

  void ReflowPlaceChild(nsIFrame* aChild, nsPresContext* aPresContext,
                        const ReflowInput& aReflowInput, nsPoint& aOffset,
                        nsSize& aSize, nsIntPoint* aCellIndex = 0);

  bool CanResize(bool aVertical, bool aLeft);

  bool CanChildResize(bool aVertical, bool aLeft, int32_t aChildX);

  void SetBorderResize(nsHTMLFramesetBorderFrame* aBorderFrame);

  template <typename T, class D = mozilla::DefaultDelete<T>>
  using UniquePtr = mozilla::UniquePtr<T, D>;

  nsFramesetDrag mDrag;
  nsBorderColor mEdgeColors;
  nsHTMLFramesetBorderFrame* mDragger;
  nsHTMLFramesetFrame* mTopLevelFrameset;
  UniquePtr<nsHTMLFramesetBorderFrame*[]> mVerBorders;  // vertical borders
  UniquePtr<nsHTMLFramesetBorderFrame*[]> mHorBorders;  // horizontal borders
  UniquePtr<nsFrameborder[]>
      mChildFrameborder;  // the frameborder attr of children
  UniquePtr<nsBorderColor[]> mChildBorderColors;
  UniquePtr<nscoord[]> mRowSizes;  // currently computed row sizes
  UniquePtr<nscoord[]> mColSizes;  // currently computed col sizes
  mozilla::LayoutDeviceIntPoint mFirstDragPoint;
  int32_t mNumRows;
  int32_t mNumCols;
  int32_t mNonBorderChildCount;
  int32_t mNonBlankChildCount;
  int32_t mEdgeVisibility;
  nsFrameborder mParentFrameborder;
  nscolor mParentBorderColor;
  int32_t mParentBorderWidth;
  int32_t mPrevNeighborOrigSize;  // used during resize
  int32_t mNextNeighborOrigSize;
  int32_t mMinDrag;
  int32_t mChildCount;
};

#endif