/* -*- 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/. */

#ifndef NSSUBDOCUMENTFRAME_H_

#define NSSUBDOCUMENTFRAME_H_

#include "mozilla/Attributes.h"

#include "nsAtomicContainerFrame.h"

#include "nsIReflowCallback.h"

#include "nsFrameLoader.h"

#include "Units.h"

namespace mozilla {

namespace layout {

class RenderFrameParent;

}

}

/******************************************************************************

 * nsSubDocumentFrame

 *****************************************************************************/

class nsSubDocumentFrame final

  : public nsAtomicContainerFrame

  , public nsIReflowCallback

{

public:

  NS_DECL_FRAMEARENA_HELPERS(nsSubDocumentFrame)

  explicit nsSubDocumentFrame(ComputedStyle* aStyle);

#ifdef DEBUG_FRAME_DUMP

  void List(FILE* out = stderr, const char* aPrefix = "", uint32_t aFlags = 0) const override;

  nsresult GetFrameName(nsAString& aResult) const override;

#endif

  NS_DECL_QUERYFRAME

  bool IsFrameOfType(uint32_t aFlags) const override

  {

    return nsAtomicContainerFrame::IsFrameOfType(aFlags &

      ~(nsIFrame::eReplaced |

        nsIFrame::eReplacedSizing |

        nsIFrame::eReplacedContainsBlock));

  }

  void Init(nsIContent*       aContent,

            nsContainerFrame* aParent,

            nsIFrame*         aPrevInFlow) override;

  void DestroyFrom(nsIFrame* aDestructRoot, PostDestroyData& aPostDestroyData) override;

  nscoord GetMinISize(gfxContext *aRenderingContext) override;

  nscoord GetPrefISize(gfxContext *aRenderingContext) override;

  mozilla::IntrinsicSize GetIntrinsicSize() override;

  nsSize  GetIntrinsicRatio() override;

  mozilla::LogicalSize

  ComputeAutoSize(gfxContext*                 aRenderingContext,

                  mozilla::WritingMode        aWritingMode,

                  const mozilla::LogicalSize& aCBSize,

                  nscoord                     aAvailableISize,

                  const mozilla::LogicalSize& aMargin,

                  const mozilla::LogicalSize& aBorder,

                  const mozilla::LogicalSize& aPadding,

                  ComputeSizeFlags            aFlags) override;

  mozilla::LogicalSize

  ComputeSize(gfxContext*                 aRenderingContext,

              mozilla::WritingMode        aWritingMode,

              const mozilla::LogicalSize& aCBSize,

              nscoord                     aAvailableISize,

              const mozilla::LogicalSize& aMargin,

              const mozilla::LogicalSize& aBorder,

              const mozilla::LogicalSize& aPadding,

              ComputeSizeFlags            aFlags) override;

  void Reflow(nsPresContext*     aPresContext,

              ReflowOutput&      aDesiredSize,

              const ReflowInput& aReflowInput,

              nsReflowStatus&    aStatus) override;

  void BuildDisplayList(nsDisplayListBuilder*   aBuilder,

                        const nsDisplayListSet& aLists) override;

  nsresult AttributeChanged(int32_t aNameSpaceID,

                            nsAtom* aAttribute,

                            int32_t aModType) override;

  // if the content is "visibility:hidden", then just hide the view

  // and all our contents. We don't extend "visibility:hidden" to

  // the child content ourselves, since it belongs to a different

  // document and CSS doesn't inherit in there.

  bool SupportsVisibilityHidden() override { return false; }

#ifdef ACCESSIBILITY

  mozilla::a11y::AccType AccessibleType() override;

#endif

  nsIDocShell* GetDocShell();

  nsresult BeginSwapDocShells(nsIFrame* aOther);

  void EndSwapDocShells(nsIFrame* aOther);

  nsView* EnsureInnerView();

  nsIFrame* GetSubdocumentRootFrame();

  enum {

    IGNORE_PAINT_SUPPRESSION = 0x1

  };

  nsIPresShell* GetSubdocumentPresShellForPainting(uint32_t aFlags);

  mozilla::ScreenIntSize GetSubdocumentSize();

  // nsIReflowCallback

  bool ReflowFinished() override;

  void ReflowCallbackCanceled() override;

  bool ShouldClipSubdocument()

  {

    nsFrameLoader* frameLoader = FrameLoader();

    return !frameLoader || frameLoader->ShouldClipSubdocument();

  }

  bool ShouldClampScrollPosition()

  {

    nsFrameLoader* frameLoader = FrameLoader();

    return !frameLoader || frameLoader->ShouldClampScrollPosition();

  }

  /**

   * Return true if pointer event hit-testing should be allowed to target

   * content in the subdocument.

   */

  bool PassPointerEventsToChildren();

  void MaybeShowViewer()

  {

    if (!mDidCreateDoc && !mCallingShow) {

      ShowViewer();

    }

  }

  mozilla::layout::RenderFrameParent* GetRenderFrameParent() const;

protected:

  friend class AsyncFrameInit;

  // Helper method to look up the HTML marginwidth & marginheight attributes.

  mozilla::CSSIntSize GetMarginAttributes();

  nsFrameLoader* FrameLoader() const;

  bool IsInline() { return mIsInline; }

  nscoord GetIntrinsicISize();

  nscoord GetIntrinsicBSize();

  // Show our document viewer. The document viewer is hidden via a script

  // runner, so that we can save and restore the presentation if we're

  // being reframed.

  void ShowViewer();

  void ClearDisplayItems();

  /* Obtains the frame we should use for intrinsic size information if we are

   * an HTML <object> or <embed>  (a replaced element - not <iframe>)

   * and our sub-document has an intrinsic size. The frame returned is the

   * frame for the document element of the document we're embedding.

   *

   * Called "Obtain*" and not "Get*" because of comment on GetDocShell that

   * says it should be called ObtainDocShell because of its side effects.

   */

  nsIFrame* ObtainIntrinsicSizeFrame();

  nsView* GetViewInternal() const override { return mOuterView; }

  void SetViewInternal(nsView* aView) override { mOuterView = aView; }

  mutable RefPtr<nsFrameLoader> mFrameLoader;

  nsView* mOuterView;

  nsView* mInnerView;

  bool mIsInline;

  bool mPostedReflowCallback;

  bool mDidCreateDoc;

  bool mCallingShow;

  WeakFrame mPreviousCaret;

};

#endif /* NSSUBDOCUMENTFRAME_H_ */