/* 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 DOM_SVG_SVGPATHELEMENT_H_
#define DOM_SVG_SVGPATHELEMENT_H_

#include "SVGAnimatedPathSegList.h"
#include "SVGGeometryElement.h"
#include "mozilla/RefPtr.h"
#include "mozilla/gfx/2D.h"

nsresult NS_NewSVGPathElement(
    nsIContent** aResult, already_AddRefed<mozilla::dom::NodeInfo> aNodeInfo);

namespace mozilla::dom {

struct SVGPathDataSettings;
struct SVGPathSegmentInit;
class SVGPathSegment;

using SVGPathElementBase = SVGGeometryElement;

class SVGPathElement final : public SVGPathElementBase {
  using Path = mozilla::gfx::Path;

 protected:
  friend nsresult(::NS_NewSVGPathElement(
      nsIContent** aResult,
      already_AddRefed<mozilla::dom::NodeInfo> aNodeInfo));
  JSObject* WrapNode(JSContext* cx, JS::Handle<JSObject*> aGivenProto) override;
  explicit SVGPathElement(already_AddRefed<mozilla::dom::NodeInfo> aNodeInfo);

  void GetAsSimplePath(SimplePath* aSimplePath) override;

 public:
  NS_DECL_ADDSIZEOFEXCLUDINGTHIS

  // nsIContent interface
  NS_IMETHOD_(bool) IsAttributeMapped(const nsAtom* name) const override;

  // SVGSVGElement methods:
  bool HasValidDimensions() const override;

  // SVGGeometryElement methods:
  bool AttributeDefinesGeometry(const nsAtom* aName) override;
  bool IsMarkable() override;
  void GetMarkPoints(nsTArray<SVGMark>* aMarks) override;
  /*
   * Note: This function maps d attribute to CSS d property, and we don't flush
   * style in this function because some callers don't need it, so if the caller
   * needs style to be flushed (e.g. DOM APIs), the caller should flush style
   * before calling this.
   */
  already_AddRefed<Path> BuildPath(PathBuilder* aBuilder) override;

  /**
   * This returns a path without the extra little line segments that
   * ApproximateZeroLengthSubpathSquareCaps can insert if we have square-caps.
   * See the comment for that function for more info on that.
   *
   * Note: This function maps d attribute to CSS d property, and we don't flush
   * style in this function because some callers don't need it, so if the caller
   * needs style to be flushed (e.g. DOM APIs), the caller should flush style
   * before calling this.
   */
  already_AddRefed<Path> GetOrBuildPathForMeasuring() override;

  bool GetDistancesFromOriginToEndsOfVisibleSegments(
      FallibleTArray<double>* aOutput) override;

  bool IsClosedLoop() const override;

  // nsIContent interface
  nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;

  SVGAnimatedPathSegList* GetAnimPathSegList() override { return &mD; }

  nsStaticAtom* GetPathDataAttrName() const override { return nsGkAtoms::d; }

  // WebIDL
  MOZ_CAN_RUN_SCRIPT
  already_AddRefed<SVGPathSegment> GetPathSegmentAtLength(float distance);
  MOZ_CAN_RUN_SCRIPT
  void GetPathData(const SVGPathDataSettings& aOptions,
                   nsTArray<RefPtr<SVGPathSegment>>& aValues);
  void SetPathData(const Sequence<SVGPathSegmentInit>& aValues);

  static bool IsDPropertyChangedViaCSS(const ComputedStyle& aNewStyle,
                                       const ComputedStyle& aOldStyle);

 protected:
  SVGAnimatedPathSegList mD;
};

}  // namespace mozilla::dom

#endif  // DOM_SVG_SVGPATHELEMENT_H_