src/third_party/WebKit/Source/core/inspector/InspectorStyleSheet.h

   1 /*
   2  * Copyright (C) 2010, Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1.  Redistributions of source code must retain the above copyright
   8  *     notice, this list of conditions and the following disclaimer.
   9  * 2.  Redistributions in binary form must reproduce the above copyright
  10  *     notice, this list of conditions and the following disclaimer in the
  11  *     documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  17  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  19  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  22  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  */
  24
  25 #ifndef InspectorStyleSheet_h
  26 #define InspectorStyleSheet_h
  27
  28 #include "core/InspectorTypeBuilder.h"
  29 #include "core/css/CSSPropertySourceData.h"
  30 #include "core/css/CSSStyleDeclaration.h"
  31 #include "core/inspector/InspectorStyleTextEditor.h"
  32 #include "platform/JSONValues.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/HashMap.h"
  35 #include "wtf/PassRefPtr.h"
  36 #include "wtf/RefPtr.h"
  37 #include "wtf/Vector.h"
  38 #include "wtf/text/WTFString.h"
  39
  40 class ParsedStyleSheet;
  41
  42 namespace blink {
  43
  44 class CSSMediaRule;
  45 class CSSStyleDeclaration;
  46 class CSSStyleRule;
  47 class CSSStyleSheet;
  48 class Document;
  49 class Element;
  50 class ExceptionState;
  51 class InspectorPageAgent;
  52 class InspectorResourceAgent;
  53 class InspectorStyleSheetBase;
  54
  55 typedef WillBeHeapVector<RefPtrWillBeMember<CSSRule> > CSSRuleVector;
  56 typedef String ErrorString;
  57 typedef Vector<unsigned> LineEndings;
  58
  59 class InspectorCSSId {
  60 public:
  61     InspectorCSSId()
  62         : m_ordinal(0)
  63     {
  64     }
  65
  66     InspectorCSSId(const String& styleSheetId, unsigned ordinal)
  67         : m_styleSheetId(styleSheetId)
  68         , m_ordinal(ordinal)
  69     {
  70     }
  71
  72     bool isEmpty() const { return m_styleSheetId.isEmpty(); }
  73
  74     const String& styleSheetId() const { return m_styleSheetId; }
  75     unsigned ordinal() const { return m_ordinal; }
  76
  77 private:
  78     String m_styleSheetId;
  79     unsigned m_ordinal;
  80 };
  81
  82 struct InspectorStyleProperty {
  83     ALLOW_ONLY_INLINE_ALLOCATION();
  84 public:
  85     explicit InspectorStyleProperty(CSSPropertySourceData sourceData)
  86         : sourceData(sourceData)
  87         , hasSource(true)
  88     {
  89     }
  90
  91     InspectorStyleProperty(CSSPropertySourceData sourceData, bool hasSource)
  92         : sourceData(sourceData)
  93         , hasSource(hasSource)
  94     {
  95     }
  96
  97     bool hasRawText() const { return !rawText.isEmpty(); }
  98
  99     void trace(Visitor* visitor) { visitor->trace(sourceData); }
 100
 101     CSSPropertySourceData sourceData;
 102     bool hasSource;
 103     String rawText;
 104 };
 105
 106 class InspectorStyle final : public RefCountedWillBeGarbageCollectedFinalized<InspectorStyle> {
 107 public:
 108     static PassRefPtrWillBeRawPtr<InspectorStyle> create(const InspectorCSSId&, PassRefPtrWillBeRawPtr<CSSStyleDeclaration>, InspectorStyleSheetBase* parentStyleSheet);
 109
 110     CSSStyleDeclaration* cssStyle() const { return m_style.get(); }
 111     PassRefPtr<TypeBuilder::CSS::CSSStyle> buildObjectForStyle() const;
 112     PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::CSSComputedStyleProperty> > buildArrayForComputedStyle() const;
 113     bool setPropertyText(unsigned index, const String& text, bool overwrite, ExceptionState&);
 114     bool styleText(String* result) const;
 115     bool textForRange(const SourceRange&, String* result) const;
 116
 117     void trace(Visitor*);
 118
 119 private:
 120     InspectorStyle(const InspectorCSSId&, PassRefPtrWillBeRawPtr<CSSStyleDeclaration>, InspectorStyleSheetBase* parentStyleSheet);
 121
 122     bool verifyPropertyText(const String& propertyText, bool canOmitSemicolon);
 123     void populateAllProperties(WillBeHeapVector<InspectorStyleProperty>& result) const;
 124     PassRefPtr<TypeBuilder::CSS::CSSStyle> styleWithProperties() const;
 125     PassRefPtrWillBeRawPtr<CSSRuleSourceData> extractSourceData() const;
 126     bool applyStyleText(const String&);
 127     String shorthandValue(const String& shorthandProperty) const;
 128     NewLineAndWhitespace& newLineAndWhitespaceDelimiters() const;
 129     inline Document* ownerDocument() const;
 130
 131     InspectorCSSId m_styleId;
 132     RefPtrWillBeMember<CSSStyleDeclaration> m_style;
 133     RawPtrWillBeMember<InspectorStyleSheetBase> m_parentStyleSheet;
 134     mutable std::pair<String, String> m_format;
 135     mutable bool m_formatAcquired;
 136 };
 137
 138 class InspectorStyleSheetBase : public RefCountedWillBeGarbageCollectedFinalized<InspectorStyleSheetBase> {
 139 public:
 140     class Listener {
 141     public:
 142         Listener() { }
 143         virtual ~Listener() { }
 144         virtual void styleSheetChanged(InspectorStyleSheetBase*) = 0;
 145         virtual void willReparseStyleSheet() = 0;
 146         virtual void didReparseStyleSheet() = 0;
 147     };
 148     virtual ~InspectorStyleSheetBase() { }
 149     virtual void trace(Visitor*) { }
 150
 151     String id() const { return m_id; }
 152
 153     virtual Document* ownerDocument() const = 0;
 154     virtual bool setText(const String&, ExceptionState&) = 0;
 155     virtual bool getText(String* result) const = 0;
 156     bool setPropertyText(const InspectorCSSId&, unsigned propertyIndex, const String& text, bool overwrite, ExceptionState&);
 157
 158     virtual bool setStyleText(const InspectorCSSId&, const String&) = 0;
 159     bool getStyleText(const InspectorCSSId&, String*);
 160
 161     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId&) const = 0;
 162     virtual InspectorCSSId styleId(CSSStyleDeclaration*) const = 0;
 163
 164     PassRefPtr<TypeBuilder::CSS::CSSStyle> buildObjectForStyle(CSSStyleDeclaration*);
 165     bool findPropertyByRange(const SourceRange&, InspectorCSSId*, unsigned* propertyIndex, bool* overwrite);
 166     bool lineNumberAndColumnToOffset(unsigned lineNumber, unsigned columnNumber, unsigned* offset);
 167
 168 protected:
 169     InspectorStyleSheetBase(const String& id, Listener*);
 170
 171     Listener* listener() const { return m_listener; }
 172     void onStyleSheetTextChanged();
 173     const LineEndings* lineEndings();
 174
 175     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) = 0;
 176     virtual unsigned ruleCount() = 0;
 177
 178     // Also accessed by friend class InspectorStyle.
 179     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned) const = 0;
 180     virtual bool ensureParsedDataReady() = 0;
 181
 182 private:
 183     friend class InspectorStyle;
 184
 185     String m_id;
 186     Listener* m_listener;
 187     OwnPtr<LineEndings> m_lineEndings;
 188 };
 189
 190 class InspectorStyleSheet : public InspectorStyleSheetBase {
 191 public:
 192     static PassRefPtrWillBeRawPtr<InspectorStyleSheet> create(InspectorPageAgent*, InspectorResourceAgent*, const String& id, PassRefPtrWillBeRawPtr<CSSStyleSheet> pageStyleSheet, TypeBuilder::CSS::StyleSheetOrigin::Enum, const String& documentURL, Listener*);
 193
 194     virtual ~InspectorStyleSheet();
 195     virtual void trace(Visitor*) override;
 196
 197     String finalURL() const;
 198     virtual Document* ownerDocument() const override;
 199     virtual bool setText(const String&, ExceptionState&) override;
 200     virtual bool getText(String* result) const override;
 201     String ruleSelector(const InspectorCSSId&, ExceptionState&);
 202     bool setRuleSelector(const InspectorCSSId&, const String& selector, ExceptionState&);
 203     CSSStyleRule* addRule(const String& ruleText, const SourceRange& location, ExceptionState&);
 204     bool deleteRule(const InspectorCSSId&, const String& oldText, ExceptionState&);
 205
 206     CSSStyleSheet* pageStyleSheet() const { return m_pageStyleSheet.get(); }
 207
 208     PassRefPtr<TypeBuilder::CSS::CSSStyleSheetHeader> buildObjectForStyleSheetInfo() const;
 209     PassRefPtr<TypeBuilder::CSS::CSSRule> buildObjectForRule(CSSStyleRule*, PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::CSSMedia> >);
 210
 211     PassRefPtr<TypeBuilder::CSS::SourceRange> ruleHeaderSourceRange(const CSSRule*);
 212     PassRefPtr<TypeBuilder::CSS::SourceRange> mediaQueryExpValueSourceRange(const CSSRule*, size_t mediaQueryIndex, size_t mediaQueryExpIndex);
 213
 214     InspectorCSSId ruleId(CSSStyleRule*) const;
 215     CSSStyleRule* ruleForId(const InspectorCSSId&) const;
 216
 217     virtual InspectorCSSId styleId(CSSStyleDeclaration*) const override;
 218     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId&) const override;
 219     virtual bool setStyleText(const InspectorCSSId&, const String&) override;
 220
 221     bool findRuleBySelectorRange(const SourceRange&, InspectorCSSId*);
 222
 223     const CSSRuleVector& flatRules();
 224
 225 protected:
 226     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) override;
 227     virtual unsigned ruleCount() override;
 228
 229     // Also accessed by friend class InspectorStyle.
 230     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned) const override;
 231     virtual bool ensureParsedDataReady() override;
 232
 233 private:
 234     InspectorStyleSheet(InspectorPageAgent*, InspectorResourceAgent*, const String& id, PassRefPtrWillBeRawPtr<CSSStyleSheet> pageStyleSheet, TypeBuilder::CSS::StyleSheetOrigin::Enum, const String& documentURL, Listener*);
 235     unsigned ruleIndexBySourceRange(const CSSMediaRule* parentMediaRule, const SourceRange&);
 236     CSSStyleRule* insertCSSOMRuleInStyleSheet(const SourceRange&, const String& ruleText, ExceptionState&);
 237     CSSStyleRule* insertCSSOMRuleInMediaRule(CSSMediaRule*, const SourceRange&, const String& ruleText, ExceptionState&);
 238     CSSStyleRule* insertCSSOMRuleBySourceRange(const SourceRange&, const String& ruleText, ExceptionState&);
 239     bool verifyRuleText(const String& ruleText);
 240     unsigned ruleIndexByStyle(CSSStyleDeclaration*) const;
 241     String sourceMapURL() const;
 242     String sourceURL() const;
 243     bool ensureText() const;
 244     void ensureFlatRules() const;
 245     bool styleSheetTextWithChangedStyle(CSSStyleDeclaration*, const String& newStyleText, String* result);
 246     bool originalStyleSheetText(String* result) const;
 247     bool resourceStyleSheetText(String* result) const;
 248     bool inlineStyleSheetText(String* result) const;
 249     PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::Selector> > selectorsFromSource(const CSSRuleSourceData*, const String&);
 250     PassRefPtr<TypeBuilder::CSS::SelectorList> buildObjectForSelectorList(CSSStyleRule*);
 251     String url() const;
 252     bool hasSourceURL() const;
 253     bool startsAtZero() const;
 254
 255     void updateText(const String& newText);
 256     Element* ownerStyleElement() const;
 257
 258     RawPtrWillBeMember<InspectorPageAgent> m_pageAgent;
 259     RawPtrWillBeMember<InspectorResourceAgent> m_resourceAgent;
 260     RefPtrWillBeMember<CSSStyleSheet> m_pageStyleSheet;
 261     TypeBuilder::CSS::StyleSheetOrigin::Enum m_origin;
 262     String m_documentURL;
 263     OwnPtr<ParsedStyleSheet> m_parsedStyleSheet;
 264     mutable CSSRuleVector m_flatRules;
 265     mutable String m_sourceURL;
 266 };
 267
 268 class InspectorStyleSheetForInlineStyle final : public InspectorStyleSheetBase {
 269 public:
 270     static PassRefPtrWillBeRawPtr<InspectorStyleSheetForInlineStyle> create(const String& id, PassRefPtrWillBeRawPtr<Element>, Listener*);
 271
 272     void didModifyElementAttribute();
 273     virtual Document* ownerDocument() const override;
 274     virtual bool setText(const String&, ExceptionState&) override;
 275     virtual bool getText(String* result) const override;
 276
 277     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId& id) const override { ASSERT_UNUSED(id, !id.ordinal()); return inlineStyle(); }
 278     virtual InspectorCSSId styleId(CSSStyleDeclaration* style) const override { return InspectorCSSId(id(), 0); }
 279     virtual bool setStyleText(const InspectorCSSId&, const String&) override;
 280
 281     virtual void trace(Visitor*) override;
 282
 283 protected:
 284     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) override;
 285     virtual unsigned ruleCount() override { return 1; }
 286
 287     // Also accessed by friend class InspectorStyle.
 288     virtual bool ensureParsedDataReady() override;
 289     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned ruleIndex) const override { ASSERT_UNUSED(ruleIndex, !ruleIndex); return m_ruleSourceData; }
 290
 291 private:
 292     InspectorStyleSheetForInlineStyle(const String& id, PassRefPtrWillBeRawPtr<Element>, Listener*);
 293     CSSStyleDeclaration* inlineStyle() const;
 294     const String& elementStyleText() const;
 295     PassRefPtrWillBeRawPtr<CSSRuleSourceData> getStyleAttributeData() const;
 296
 297     RefPtrWillBeMember<Element> m_element;
 298     RefPtrWillBeMember<CSSRuleSourceData> m_ruleSourceData;
 299     RefPtrWillBeMember<InspectorStyle> m_inspectorStyle;
 300
 301     // Contains "style" attribute value.
 302     mutable String m_styleText;
 303     mutable bool m_isStyleTextValid;
 304 };
 305
 306
 307 } // namespace blink
 308
 309 WTF_ALLOW_MOVE_AND_INIT_WITH_MEM_FUNCTIONS(blink::InspectorStyleProperty);
 310
 311 #endif // !defined(InspectorStyleSheet_h)