dom/html/HTMLFrameSetElement.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef HTMLFrameSetElement_h
   7 #define HTMLFrameSetElement_h
   8
   9 #include "mozilla/Attributes.h"
  10 #include "nsIDOMHTMLFrameSetElement.h"
  11 #include "nsGenericHTMLElement.h"
  12
  13 /**
  14  * The nsFramesetUnit enum is used to denote the type of each entry
  15  * in the row or column spec.
  16  */
  17 enum nsFramesetUnit {
  18   eFramesetUnit_Fixed = 0,
  19   eFramesetUnit_Percent,
  20   eFramesetUnit_Relative
  21 };
  22
  23 /**
  24  * The nsFramesetSpec struct is used to hold a single entry in the
  25  * row or column spec.
  26  */
  27 struct nsFramesetSpec {
  28   nsFramesetUnit mUnit;
  29   nscoord        mValue;
  30 };
  31
  32 /**
  33  * The maximum number of entries allowed in the frame set element row
  34  * or column spec.
  35  */
  36 #define NS_MAX_FRAMESET_SPEC_COUNT 16000
  37
  38 //----------------------------------------------------------------------
  39
  40 namespace mozilla {
  41 namespace dom {
  42
  43 class OnBeforeUnloadEventHandlerNonNull;
  44
  45 class HTMLFrameSetElement MOZ_FINAL : public nsGenericHTMLElement,
  46                                       public nsIDOMHTMLFrameSetElement
  47 {
  48 public:
  49   explicit HTMLFrameSetElement(already_AddRefed<mozilla::dom::NodeInfo>& aNodeInfo)
  50     : nsGenericHTMLElement(aNodeInfo),
  51       mNumRows(0),
  52       mNumCols(0),
  53       mCurrentRowColHint(NS_STYLE_HINT_REFLOW)
  54   {
  55     SetHasWeirdParserInsertionMode();
  56   }
  57
  58   NS_IMPL_FROMCONTENT_HTML_WITH_TAG(HTMLFrameSetElement, frameset)
  59
  60   // nsISupports
  61   NS_DECL_ISUPPORTS_INHERITED
  62
  63   // nsIDOMHTMLFrameSetElement
  64   NS_DECL_NSIDOMHTMLFRAMESETELEMENT
  65
  66   void GetCols(nsString& aCols)
  67   {
  68     GetHTMLAttr(nsGkAtoms::cols, aCols);
  69   }
  70   void SetCols(const nsAString& aCols, ErrorResult& aError)
  71   {
  72     SetHTMLAttr(nsGkAtoms::cols, aCols, aError);
  73   }
  74   void GetRows(nsString& aRows)
  75   {
  76     GetHTMLAttr(nsGkAtoms::rows, aRows);
  77   }
  78   void SetRows(const nsAString& aRows, ErrorResult& aError)
  79   {
  80     SetHTMLAttr(nsGkAtoms::rows, aRows, aError);
  81   }
  82
  83   virtual bool IsEventAttributeName(nsIAtom *aName) MOZ_OVERRIDE;
  84
  85   // Event listener stuff; we need to declare only the ones we need to
  86   // forward to window that don't come from nsIDOMHTMLFrameSetElement.
  87 #define EVENT(name_, id_, type_, struct_) /* nothing; handled by the superclass */
  88 #define WINDOW_EVENT_HELPER(name_, type_)                               \
  89   type_* GetOn##name_();                                                \
  90   void SetOn##name_(type_* handler);
  91 #define WINDOW_EVENT(name_, id_, type_, struct_)                        \
  92   WINDOW_EVENT_HELPER(name_, EventHandlerNonNull)
  93 #define BEFOREUNLOAD_EVENT(name_, id_, type_, struct_)                  \
  94   WINDOW_EVENT_HELPER(name_, OnBeforeUnloadEventHandlerNonNull)
  95 #include "mozilla/EventNameList.h" // IWYU pragma: keep
  96 #undef BEFOREUNLOAD_EVENT
  97 #undef WINDOW_EVENT
  98 #undef WINDOW_EVENT_HELPER
  99 #undef EVENT
 100
 101   // These override the SetAttr methods in nsGenericHTMLElement (need
 102   // both here to silence compiler warnings).
 103   nsresult SetAttr(int32_t aNameSpaceID, nsIAtom* aName,
 104                    const nsAString& aValue, bool aNotify)
 105   {
 106     return SetAttr(aNameSpaceID, aName, nullptr, aValue, aNotify);
 107   }
 108   virtual nsresult SetAttr(int32_t aNameSpaceID, nsIAtom* aName,
 109                            nsIAtom* aPrefix, const nsAString& aValue,
 110                            bool aNotify) MOZ_OVERRIDE;
 111
 112    /**
 113     * GetRowSpec is used to get the "rows" spec.
 114     * @param out int32_t aNumValues The number of row sizes specified.
 115     * @param out nsFramesetSpec* aSpecs The array of size specifications.
 116              This is _not_ owned by the caller, but by the nsFrameSetElement
 117              implementation.  DO NOT DELETE IT.
 118     */
 119   nsresult GetRowSpec(int32_t *aNumValues, const nsFramesetSpec** aSpecs);
 120    /**
 121     * GetColSpec is used to get the "cols" spec
 122     * @param out int32_t aNumValues The number of row sizes specified.
 123     * @param out nsFramesetSpec* aSpecs The array of size specifications.
 124              This is _not_ owned by the caller, but by the nsFrameSetElement
 125              implementation.  DO NOT DELETE IT.
 126     */
 127   nsresult GetColSpec(int32_t *aNumValues, const nsFramesetSpec** aSpecs);
 128
 129
 130   virtual bool ParseAttribute(int32_t aNamespaceID,
 131                                 nsIAtom* aAttribute,
 132                                 const nsAString& aValue,
 133                                 nsAttrValue& aResult) MOZ_OVERRIDE;
 134   virtual nsChangeHint GetAttributeChangeHint(const nsIAtom* aAttribute,
 135                                               int32_t aModType) const MOZ_OVERRIDE;
 136
 137   virtual nsresult Clone(mozilla::dom::NodeInfo *aNodeInfo, nsINode **aResult) const MOZ_OVERRIDE;
 138
 139 protected:
 140   virtual ~HTMLFrameSetElement();
 141
 142   virtual JSObject* WrapNode(JSContext *aCx) MOZ_OVERRIDE;
 143
 144 private:
 145   nsresult ParseRowCol(const nsAString& aValue,
 146                        int32_t&         aNumSpecs,
 147                        nsFramesetSpec** aSpecs);
 148
 149   /**
 150    * The number of size specs in our "rows" attr
 151    */
 152   int32_t          mNumRows;
 153   /**
 154    * The number of size specs in our "cols" attr
 155    */
 156   int32_t          mNumCols;
 157   /**
 158    * The style hint to return for the rows/cols attrs in
 159    * GetAttributeChangeHint
 160    */
 161   nsChangeHint      mCurrentRowColHint;
 162   /**
 163    * The parsed representation of the "rows" attribute
 164    */
 165   nsAutoArrayPtr<nsFramesetSpec>  mRowSpecs; // parsed, non-computed dimensions
 166   /**
 167    * The parsed representation of the "cols" attribute
 168    */
 169   nsAutoArrayPtr<nsFramesetSpec>  mColSpecs; // parsed, non-computed dimensions
 170 };
 171
 172 } // namespace dom
 173 } // namespace mozilla
 174
 175 #endif // HTMLFrameSetElement_h