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

#define HTMLFrameSetElement_h

#include "mozilla/Attributes.h"

#include "mozilla/UniquePtr.h"

#include "nsGenericHTMLElement.h"

/**

 * The nsFramesetUnit enum is used to denote the type of each entry

 * in the row or column spec.

 */

enum nsFramesetUnit {

  eFramesetUnit_Fixed = 0,

  eFramesetUnit_Percent,

  eFramesetUnit_Relative

};

/**

 * The nsFramesetSpec struct is used to hold a single entry in the

 * row or column spec.

 */

struct nsFramesetSpec {

  nsFramesetUnit mUnit;

  nscoord        mValue;

};

/**

 * The maximum number of entries allowed in the frame set element row

 * or column spec.

 */

#define NS_MAX_FRAMESET_SPEC_COUNT 16000

//----------------------------------------------------------------------

namespace mozilla {

namespace dom {

class OnBeforeUnloadEventHandlerNonNull;

class HTMLFrameSetElement final : public nsGenericHTMLElement

{

public:

  explicit HTMLFrameSetElement(already_AddRefed<mozilla::dom::NodeInfo>&& aNodeInfo)

    : nsGenericHTMLElement(std::move(aNodeInfo)),

      mNumRows(0),

      mNumCols(0),

      mCurrentRowColHint(NS_STYLE_HINT_REFLOW)

  {

    SetHasWeirdParserInsertionMode();

  }

  NS_IMPL_FROMNODE_HTML_WITH_TAG(HTMLFrameSetElement, frameset)

  // nsISupports

  NS_INLINE_DECL_REFCOUNTING_INHERITED(HTMLFrameSetElement,

                                       nsGenericHTMLElement)

  void GetCols(DOMString& aCols)

  {

    GetHTMLAttr(nsGkAtoms::cols, aCols);

  }

  void SetCols(const nsAString& aCols, ErrorResult& aError)

  {

    SetHTMLAttr(nsGkAtoms::cols, aCols, aError);

  }

  void GetRows(DOMString& aRows)

  {

    GetHTMLAttr(nsGkAtoms::rows, aRows);

  }

  void SetRows(const nsAString& aRows, ErrorResult& aError)

  {

    SetHTMLAttr(nsGkAtoms::rows, aRows, aError);

  }

  virtual bool IsEventAttributeNameInternal(nsAtom *aName) override;

  // Event listener stuff; we need to declare only the ones we need to

  // forward to window that don't come from nsIDOMHTMLFrameSetElement.

#define EVENT(name_, id_, type_, struct_) /* nothing; handled by the superclass */

#define WINDOW_EVENT_HELPER(name_, type_)                               \

  type_* GetOn##name_();                                                \

  void SetOn##name_(type_* handler);

#define WINDOW_EVENT(name_, id_, type_, struct_)                        \

  WINDOW_EVENT_HELPER(name_, EventHandlerNonNull)

#define BEFOREUNLOAD_EVENT(name_, id_, type_, struct_)                  \

  WINDOW_EVENT_HELPER(name_, OnBeforeUnloadEventHandlerNonNull)

#include "mozilla/EventNameList.h" // IWYU pragma: keep

#undef BEFOREUNLOAD_EVENT

#undef WINDOW_EVENT

#undef WINDOW_EVENT_HELPER

#undef EVENT

   /**

    * GetRowSpec is used to get the "rows" spec.

    * @param out int32_t aNumValues The number of row sizes specified.

    * @param out nsFramesetSpec* aSpecs The array of size specifications.

             This is _not_ owned by the caller, but by the nsFrameSetElement

             implementation.  DO NOT DELETE IT.

    */

  nsresult GetRowSpec(int32_t *aNumValues, const nsFramesetSpec** aSpecs);

   /**

    * GetColSpec is used to get the "cols" spec

    * @param out int32_t aNumValues The number of row sizes specified.

    * @param out nsFramesetSpec* aSpecs The array of size specifications.

             This is _not_ owned by the caller, but by the nsFrameSetElement

             implementation.  DO NOT DELETE IT.

    */

  nsresult GetColSpec(int32_t *aNumValues, const nsFramesetSpec** aSpecs);

  virtual bool ParseAttribute(int32_t aNamespaceID,

                                nsAtom* aAttribute,

                                const nsAString& aValue,

                                nsIPrincipal* aMaybeScriptedPrincipal,

                                nsAttrValue& aResult) override;

  virtual nsChangeHint GetAttributeChangeHint(const nsAtom* aAttribute,

                                              int32_t aModType) const override;

  virtual nsresult Clone(dom::NodeInfo*, nsINode** aResult) const override;

protected:

  virtual ~HTMLFrameSetElement();

  virtual JSObject* WrapNode(JSContext *aCx, JS::Handle<JSObject*> aGivenProto) override;

  virtual nsresult BeforeSetAttr(int32_t aNamespaceID, nsAtom* aName,

                                 const nsAttrValueOrString* aValue,

                                 bool aNotify) override;

private:

  nsresult ParseRowCol(const nsAString& aValue,

                       int32_t& aNumSpecs,

                       UniquePtr<nsFramesetSpec[]>* aSpecs);

  /**

   * The number of size specs in our "rows" attr

   */

  int32_t          mNumRows;

  /**

   * The number of size specs in our "cols" attr

   */

  int32_t          mNumCols;

  /**

   * The style hint to return for the rows/cols attrs in

   * GetAttributeChangeHint

   */

  nsChangeHint      mCurrentRowColHint;

  /**

   * The parsed representation of the "rows" attribute

   */

  UniquePtr<nsFramesetSpec[]>  mRowSpecs; // parsed, non-computed dimensions

  /**

   * The parsed representation of the "cols" attribute

   */

  UniquePtr<nsFramesetSpec[]>  mColSpecs; // parsed, non-computed dimensions

};

} // namespace dom

} // namespace mozilla

#endif // HTMLFrameSetElement_h