layout/style/Rule.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /* base class for all rule types in a CSS style sheet */
   8
   9 #ifndef mozilla_css_Rule_h___
  10 #define mozilla_css_Rule_h___
  11
  12 #include "mozilla/dom/CSSRuleBinding.h"
  13 #include "mozilla/dom/DocumentOrShadowRoot.h"
  14 #include "mozilla/StyleSheet.h"
  15 #include "mozilla/MemoryReporting.h"
  16 #include "nsISupports.h"
  17 #include "nsWrapperCache.h"
  18
  19 template <class T>
  20 struct already_AddRefed;
  21
  22 namespace mozilla {
  23
  24 enum class StyleCssRuleType : uint8_t;
  25
  26 namespace css {
  27 class GroupRule;
  28
  29 class Rule : public nsISupports, public nsWrapperCache {
  30  protected:
  31   Rule(StyleSheet* aSheet, Rule* aParentRule, uint32_t aLineNumber,
  32        uint32_t aColumnNumber)
  33       : mSheet(aSheet),
  34         mParentRule(aParentRule),
  35         mLineNumber(aLineNumber),
  36         mColumnNumber(aColumnNumber) {
  37 #ifdef DEBUG
  38     AssertParentRuleType();
  39 #endif
  40   }
  41
  42 #ifdef DEBUG
  43   void AssertParentRuleType();
  44 #endif
  45
  46   Rule(const Rule& aCopy)
  47       : mSheet(aCopy.mSheet),
  48         mParentRule(aCopy.mParentRule),
  49         mLineNumber(aCopy.mLineNumber),
  50         mColumnNumber(aCopy.mColumnNumber) {}
  51
  52   virtual ~Rule() = default;
  53
  54  public:
  55   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  56   NS_DECL_CYCLE_COLLECTION_SKIPPABLE_WRAPPERCACHE_CLASS(Rule)
  57   // Return true if this rule is known to be a cycle collection leaf, in the
  58   // sense that it doesn't have any outgoing owning edges.
  59   virtual bool IsCCLeaf() const MOZ_MUST_OVERRIDE;
  60
  61   virtual bool IsGroupRule() const { return false; }
  62
  63 #ifdef DEBUG
  64   virtual void List(FILE* out = stdout, int32_t aIndent = 0) const = 0;
  65 #endif
  66
  67   StyleSheet* GetStyleSheet() const { return mSheet; }
  68
  69   // Clear the mSheet pointer on this rule and descendants.
  70   virtual void DropSheetReference();
  71
  72   // Clear the mParentRule pointer on this rule.
  73   void DropParentRuleReference() { mParentRule = nullptr; }
  74
  75   void DropReferences() {
  76     DropSheetReference();
  77     DropParentRuleReference();
  78   }
  79
  80   uint32_t GetLineNumber() const { return mLineNumber; }
  81   uint32_t GetColumnNumber() const { return mColumnNumber; }
  82
  83   // Whether this a rule in a read only style sheet.
  84   bool IsReadOnly() const;
  85
  86   // Whether this rule is an @import rule that hasn't loaded yet (and thus
  87   // doesn't affect the style of the page).
  88   bool IsIncompleteImportRule() const;
  89
  90   // This is pure virtual because all of Rule's data members are non-owning and
  91   // thus measured elsewhere.
  92   virtual size_t SizeOfIncludingThis(MallocSizeOf) const MOZ_MUST_OVERRIDE = 0;
  93
  94   virtual StyleCssRuleType Type() const = 0;
  95
  96   // WebIDL interface
  97   uint16_t TypeForBindings() const {
  98     auto type = uint16_t(Type());
  99     // Per https://drafts.csswg.org/cssom/#dom-cssrule-type for constants > 15
 100     // we return 0.
 101     return type > 15 ? 0 : type;
 102   }
 103   virtual void GetCssText(nsACString& aCssText) const = 0;
 104   void SetCssText(const nsACString& aCssText);
 105   Rule* GetParentRule() const;
 106   StyleSheet* GetParentStyleSheet() const { return GetStyleSheet(); }
 107   nsINode* GetAssociatedDocumentOrShadowRoot() const {
 108     if (!mSheet) {
 109       return nullptr;
 110     }
 111     auto* associated = mSheet->GetAssociatedDocumentOrShadowRoot();
 112     return associated ? &associated->AsNode() : nullptr;
 113   }
 114   nsISupports* GetParentObject() const { return mSheet; }
 115
 116  protected:
 117   // True if we're known-live for cycle collection purposes.
 118   bool IsKnownLive() const;
 119
 120   // Hook subclasses can use to properly unlink the nsWrapperCache of
 121   // their declarations.
 122   void UnlinkDeclarationWrapper(nsWrapperCache& aDecl);
 123
 124   // mSheet should only ever be null when we create a synthetic CSSFontFaceRule
 125   // for an InspectorFontFace.
 126   //
 127   // mSheet and mParentRule will be cleared when they are detached from the
 128   // parent object, either because the rule is removed or the parent is
 129   // destroyed.
 130   StyleSheet* MOZ_NON_OWNING_REF mSheet;
 131   Rule* MOZ_NON_OWNING_REF mParentRule;
 132
 133   // Keep the same type so that MSVC packs them.
 134   uint32_t mLineNumber;
 135   uint32_t mColumnNumber;
 136 };
 137
 138 }  // namespace css
 139 }  // namespace mozilla
 140
 141 #endif /* mozilla_css_Rule_h___ */