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

#define __NS_SVGMARKERFRAME_H__

#include "mozilla/Attributes.h"

#include "gfxMatrix.h"

#include "gfxRect.h"

#include "nsFrame.h"

#include "nsLiteralString.h"

#include "nsQueryFrame.h"

#include "nsSVGContainerFrame.h"

#include "nsSVGUtils.h"

class gfxContext;

namespace mozilla {

class SVGGeometryFrame;

namespace dom {

class SVGViewportElement;

} // namespace dom

} // namespace mozilla

struct nsSVGMark;

class nsSVGMarkerFrame final : public nsSVGContainerFrame

{

  typedef mozilla::image::imgDrawingParams imgDrawingParams;

  friend class nsSVGMarkerAnonChildFrame;

  friend nsContainerFrame*

  NS_NewSVGMarkerFrame(nsIPresShell* aPresShell, ComputedStyle* aStyle);

protected:

  explicit nsSVGMarkerFrame(ComputedStyle* aStyle)

    : nsSVGContainerFrame(aStyle, kClassID)

    , mMarkedFrame(nullptr)

    , mInUse(false)

    , mInUse2(false)

  {

    AddStateBits(NS_FRAME_IS_NONDISPLAY);

  }

public:

  NS_DECL_FRAMEARENA_HELPERS(nsSVGMarkerFrame)

  // nsIFrame interface:

#ifdef DEBUG

  virtual void Init(nsIContent*       aContent,

                    nsContainerFrame* aParent,

                    nsIFrame*         aPrevInFlow) override;

#endif

  virtual void BuildDisplayList(nsDisplayListBuilder*   aBuilder,

                                const nsDisplayListSet& aLists) override {}

  virtual nsresult AttributeChanged(int32_t         aNameSpaceID,

                                    nsAtom*        aAttribute,

                                    int32_t         aModType) override;

#ifdef DEBUG_FRAME_DUMP

  virtual nsresult GetFrameName(nsAString& aResult) const override

  {

    return MakeFrameName(NS_LITERAL_STRING("SVGMarker"), aResult);

  }

#endif

  virtual nsContainerFrame* GetContentInsertionFrame() override {

    // Any children must be added to our single anonymous inner frame kid.

    MOZ_ASSERT(PrincipalChildList().FirstChild() &&

               PrincipalChildList().FirstChild()->IsSVGMarkerAnonChildFrame(),

               "Where is our anonymous child?");

    return PrincipalChildList().FirstChild()->GetContentInsertionFrame();

  }

  // nsSVGMarkerFrame methods:

  void PaintMark(gfxContext& aContext,

                 const gfxMatrix& aToMarkedFrameUserSpace,

                 mozilla::SVGGeometryFrame* aMarkedFrame,

                 const nsSVGMark& aMark,

                 float aStrokeWidth,

                 imgDrawingParams& aImgParams);

  SVGBBox GetMarkBBoxContribution(const Matrix& aToBBoxUserspace,

                                  uint32_t aFlags,

                                  mozilla::SVGGeometryFrame* aMarkedFrame,

                                  const nsSVGMark& aMark,

                                  float aStrokeWidth);

  // Return our anonymous box child.

  void AppendDirectlyOwnedAnonBoxes(nsTArray<OwnedAnonBox>& aResult) override;

private:

  // stuff needed for callback

  mozilla::SVGGeometryFrame *mMarkedFrame;

  Matrix mMarkerTM;

  // nsSVGContainerFrame methods:

  virtual gfxMatrix GetCanvasTM() override;

  // A helper class to allow us to paint markers safely. The helper

  // automatically sets and clears the mInUse flag on the marker frame (to

  // prevent nasty reference loops) as well as the reference to the marked

  // frame and its coordinate context. It's easy to mess this up

  // and break things, so this helper makes the code far more robust.

  class MOZ_RAII AutoMarkerReferencer

  {

  public:

    AutoMarkerReferencer(nsSVGMarkerFrame *aFrame,

                         mozilla::SVGGeometryFrame *aMarkedFrame

                         MOZ_GUARD_OBJECT_NOTIFIER_PARAM);

    ~AutoMarkerReferencer();

  private:

    nsSVGMarkerFrame *mFrame;

    MOZ_DECL_USE_GUARD_OBJECT_NOTIFIER

  };

  // nsSVGMarkerFrame methods:

  void SetParentCoordCtxProvider(mozilla::dom::SVGViewportElement *aContext);

  // recursion prevention flag

  bool mInUse;

  // second recursion prevention flag, for GetCanvasTM()

  bool mInUse2;

};

////////////////////////////////////////////////////////////////////////

// nsMarkerAnonChildFrame class

class nsSVGMarkerAnonChildFrame final : public nsSVGDisplayContainerFrame

{

  friend nsContainerFrame*

  NS_NewSVGMarkerAnonChildFrame(nsIPresShell* aPresShell,

                                ComputedStyle* aStyle);

  explicit nsSVGMarkerAnonChildFrame(ComputedStyle* aStyle)

    : nsSVGDisplayContainerFrame(aStyle, kClassID)

  {}

public:

  NS_DECL_FRAMEARENA_HELPERS(nsSVGMarkerAnonChildFrame)

#ifdef DEBUG

  virtual void Init(nsIContent*       aContent,

                    nsContainerFrame* aParent,

                    nsIFrame*         aPrevInFlow) override;

#endif

#ifdef DEBUG_FRAME_DUMP

  virtual nsresult GetFrameName(nsAString& aResult) const override {

    return MakeFrameName(NS_LITERAL_STRING("SVGMarkerAnonChild"), aResult);

  }

#endif

  // nsSVGContainerFrame methods:

  virtual gfxMatrix GetCanvasTM() override

  {

    return static_cast<nsSVGMarkerFrame*>(GetParent())->GetCanvasTM();

  }

};

#endif