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 CSSRuleList;
  46 class CSSStyleDeclaration;
  47 class CSSStyleRule;
  48 class CSSStyleSheet;
  49 class Document;
  50 class Element;
  51 class ExceptionState;
  52 class InspectorPageAgent;
  53 class InspectorResourceAgent;
  54 class InspectorStyleSheetBase;
  55
  56 typedef WillBeHeapVector<RefPtrWillBeMember<CSSRule> > CSSRuleVector;
  57 typedef String ErrorString;
  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     void setRawTextFromStyleDeclaration(const String& styleDeclaration)
  98     {
  99         unsigned start = sourceData.range.start;
 100         unsigned end = sourceData.range.end;
 101         ASSERT(start < end);
 102         ASSERT(end <= styleDeclaration.length());
 103         rawText = styleDeclaration.substring(start, end - start);
 104     }
 105
 106     bool hasRawText() const { return !rawText.isEmpty(); }
 107
 108     void trace(Visitor* visitor) { visitor->trace(sourceData); }
 109
 110     CSSPropertySourceData sourceData;
 111     bool hasSource;
 112     String rawText;
 113 };
 114
 115 class InspectorStyle FINAL : public RefCountedWillBeGarbageCollectedFinalized<InspectorStyle> {
 116 public:
 117     static PassRefPtrWillBeRawPtr<InspectorStyle> create(const InspectorCSSId&, PassRefPtrWillBeRawPtr<CSSStyleDeclaration>, InspectorStyleSheetBase* parentStyleSheet);
 118
 119     CSSStyleDeclaration* cssStyle() const { return m_style.get(); }
 120     PassRefPtr<TypeBuilder::CSS::CSSStyle> buildObjectForStyle() const;
 121     PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::CSSComputedStyleProperty> > buildArrayForComputedStyle() const;
 122     bool setPropertyText(unsigned index, const String& text, bool overwrite, ExceptionState&);
 123     bool styleText(String* result) const;
 124
 125     void trace(Visitor*);
 126
 127 private:
 128     InspectorStyle(const InspectorCSSId&, PassRefPtrWillBeRawPtr<CSSStyleDeclaration>, InspectorStyleSheetBase* parentStyleSheet);
 129
 130     bool verifyPropertyText(const String& propertyText, bool canOmitSemicolon);
 131     void populateAllProperties(WillBeHeapVector<InspectorStyleProperty>& result) const;
 132     PassRefPtr<TypeBuilder::CSS::CSSStyle> styleWithProperties() const;
 133     PassRefPtrWillBeRawPtr<CSSRuleSourceData> extractSourceData() const;
 134     bool applyStyleText(const String&);
 135     String shorthandValue(const String& shorthandProperty) const;
 136     NewLineAndWhitespace& newLineAndWhitespaceDelimiters() const;
 137     inline Document* ownerDocument() const;
 138
 139     InspectorCSSId m_styleId;
 140     RefPtrWillBeMember<CSSStyleDeclaration> m_style;
 141     RawPtrWillBeMember<InspectorStyleSheetBase> m_parentStyleSheet;
 142     mutable std::pair<String, String> m_format;
 143     mutable bool m_formatAcquired;
 144 };
 145
 146 class InspectorStyleSheetBase : public RefCountedWillBeGarbageCollectedFinalized<InspectorStyleSheetBase> {
 147 public:
 148     class Listener {
 149     public:
 150         Listener() { }
 151         virtual ~Listener() { }
 152         virtual void styleSheetChanged(InspectorStyleSheetBase*) = 0;
 153         virtual void willReparseStyleSheet() = 0;
 154         virtual void didReparseStyleSheet() = 0;
 155     };
 156     virtual ~InspectorStyleSheetBase() { }
 157     virtual void trace(Visitor*) { }
 158
 159     String id() const { return m_id; }
 160
 161     virtual Document* ownerDocument() const = 0;
 162     virtual bool setText(const String&, ExceptionState&) = 0;
 163     virtual bool getText(String* result) const = 0;
 164     bool setPropertyText(const InspectorCSSId&, unsigned propertyIndex, const String& text, bool overwrite, ExceptionState&);
 165
 166     virtual bool setStyleText(const InspectorCSSId&, const String&) = 0;
 167     bool getStyleText(const InspectorCSSId&, String*);
 168
 169     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId&) const = 0;
 170     virtual InspectorCSSId styleId(CSSStyleDeclaration*) const = 0;
 171
 172     PassRefPtr<TypeBuilder::CSS::CSSStyle> buildObjectForStyle(CSSStyleDeclaration*);
 173     bool findPropertyByRange(const SourceRange&, InspectorCSSId*, unsigned* propertyIndex, bool* overwrite);
 174     bool lineNumberAndColumnToOffset(unsigned lineNumber, unsigned columnNumber, unsigned* offset);
 175
 176 protected:
 177     InspectorStyleSheetBase(const String& id, Listener*);
 178
 179     Listener* listener() const { return m_listener; }
 180     void fireStyleSheetChanged();
 181     PassOwnPtr<Vector<unsigned> > lineEndings();
 182
 183     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) = 0;
 184     virtual unsigned ruleCount() = 0;
 185
 186     // Also accessed by friend class InspectorStyle.
 187     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned) const = 0;
 188     virtual bool ensureParsedDataReady() = 0;
 189
 190 private:
 191     friend class InspectorStyle;
 192
 193     String m_id;
 194     Listener* m_listener;
 195 };
 196
 197 class InspectorStyleSheet : public InspectorStyleSheetBase {
 198 public:
 199     static PassRefPtrWillBeRawPtr<InspectorStyleSheet> create(InspectorPageAgent*, InspectorResourceAgent*, const String& id, PassRefPtrWillBeRawPtr<CSSStyleSheet> pageStyleSheet, TypeBuilder::CSS::StyleSheetOrigin::Enum, const String& documentURL, Listener*);
 200
 201     virtual ~InspectorStyleSheet();
 202     virtual void trace(Visitor*) OVERRIDE;
 203
 204     String finalURL() const;
 205     virtual Document* ownerDocument() const OVERRIDE;
 206     virtual bool setText(const String&, ExceptionState&) OVERRIDE;
 207     virtual bool getText(String* result) const OVERRIDE;
 208     String ruleSelector(const InspectorCSSId&, ExceptionState&);
 209     bool setRuleSelector(const InspectorCSSId&, const String& selector, ExceptionState&);
 210     CSSStyleRule* addRule(const String& ruleText, const SourceRange& location, ExceptionState&);
 211     bool deleteRule(const InspectorCSSId&, const String& oldText, ExceptionState&);
 212
 213     CSSStyleSheet* pageStyleSheet() const { return m_pageStyleSheet.get(); }
 214
 215     PassRefPtr<TypeBuilder::CSS::CSSStyleSheetHeader> buildObjectForStyleSheetInfo() const;
 216     PassRefPtr<TypeBuilder::CSS::CSSRule> buildObjectForRule(CSSStyleRule*, PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::CSSMedia> >);
 217
 218     PassRefPtr<TypeBuilder::CSS::SourceRange> ruleHeaderSourceRange(const CSSRule*);
 219
 220     InspectorCSSId ruleId(CSSStyleRule*) const;
 221     CSSStyleRule* ruleForId(const InspectorCSSId&) const;
 222
 223     virtual InspectorCSSId styleId(CSSStyleDeclaration*) const OVERRIDE;
 224     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId&) const OVERRIDE;
 225     virtual bool setStyleText(const InspectorCSSId&, const String&) OVERRIDE;
 226
 227     bool findRuleBySelectorRange(const SourceRange&, InspectorCSSId*);
 228
 229     const CSSRuleVector& flatRules();
 230
 231 protected:
 232     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) OVERRIDE;
 233     virtual unsigned ruleCount() OVERRIDE;
 234
 235     // Also accessed by friend class InspectorStyle.
 236     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned) const OVERRIDE;
 237     virtual bool ensureParsedDataReady() OVERRIDE;
 238
 239 private:
 240     InspectorStyleSheet(InspectorPageAgent*, InspectorResourceAgent*, const String& id, PassRefPtrWillBeRawPtr<CSSStyleSheet> pageStyleSheet, TypeBuilder::CSS::StyleSheetOrigin::Enum, const String& documentURL, Listener*);
 241     unsigned ruleIndexBySourceRange(const CSSMediaRule* parentMediaRule, const SourceRange&);
 242     CSSStyleRule* insertCSSOMRuleInStyleSheet(const SourceRange&, const String& ruleText, ExceptionState&);
 243     CSSStyleRule* insertCSSOMRuleInMediaRule(CSSMediaRule*, const SourceRange&, const String& ruleText, ExceptionState&);
 244     CSSStyleRule* insertCSSOMRuleBySourceRange(const SourceRange&, const String& ruleText, ExceptionState&);
 245     bool verifyRuleText(const String& ruleText);
 246     unsigned ruleIndexByStyle(CSSStyleDeclaration*) const;
 247     String sourceMapURL() const;
 248     String sourceURL() const;
 249     bool ensureText() const;
 250     void ensureFlatRules() const;
 251     bool styleSheetTextWithChangedStyle(CSSStyleDeclaration*, const String& newStyleText, String* result);
 252     bool originalStyleSheetText(String* result) const;
 253     bool resourceStyleSheetText(String* result) const;
 254     bool inlineStyleSheetText(String* result) const;
 255     PassRefPtr<TypeBuilder::Array<TypeBuilder::CSS::Selector> > selectorsFromSource(const CSSRuleSourceData*, const String&);
 256     PassRefPtr<TypeBuilder::CSS::SelectorList> buildObjectForSelectorList(CSSStyleRule*);
 257     String url() const;
 258     bool hasSourceURL() const;
 259     bool startsAtZero() const;
 260
 261     void updateText(const String& newText);
 262     Element* ownerStyleElement() const;
 263
 264     RawPtrWillBeMember<InspectorPageAgent> m_pageAgent;
 265     RawPtrWillBeMember<InspectorResourceAgent> m_resourceAgent;
 266     RefPtrWillBeMember<CSSStyleSheet> m_pageStyleSheet;
 267     TypeBuilder::CSS::StyleSheetOrigin::Enum m_origin;
 268     String m_documentURL;
 269     OwnPtr<ParsedStyleSheet> m_parsedStyleSheet;
 270     mutable CSSRuleVector m_flatRules;
 271     mutable String m_sourceURL;
 272 };
 273
 274 class InspectorStyleSheetForInlineStyle FINAL : public InspectorStyleSheetBase {
 275 public:
 276     static PassRefPtrWillBeRawPtr<InspectorStyleSheetForInlineStyle> create(const String& id, PassRefPtrWillBeRawPtr<Element>, Listener*);
 277
 278     void didModifyElementAttribute();
 279     virtual Document* ownerDocument() const OVERRIDE;
 280     virtual bool setText(const String&, ExceptionState&) OVERRIDE;
 281     virtual bool getText(String* result) const OVERRIDE;
 282
 283     virtual CSSStyleDeclaration* styleForId(const InspectorCSSId& id) const OVERRIDE { ASSERT_UNUSED(id, !id.ordinal()); return inlineStyle(); }
 284     virtual InspectorCSSId styleId(CSSStyleDeclaration* style) const OVERRIDE { return InspectorCSSId(id(), 0); }
 285     virtual bool setStyleText(const InspectorCSSId&, const String&) OVERRIDE;
 286
 287     virtual void trace(Visitor*) OVERRIDE;
 288
 289 protected:
 290     virtual PassRefPtrWillBeRawPtr<InspectorStyle> inspectorStyleForId(const InspectorCSSId&) OVERRIDE;
 291     virtual unsigned ruleCount() OVERRIDE { return 1; }
 292
 293     // Also accessed by friend class InspectorStyle.
 294     virtual bool ensureParsedDataReady() OVERRIDE;
 295     virtual PassRefPtrWillBeRawPtr<CSSRuleSourceData> ruleSourceDataAt(unsigned ruleIndex) const OVERRIDE { ASSERT_UNUSED(ruleIndex, !ruleIndex); return m_ruleSourceData; }
 296
 297 private:
 298     InspectorStyleSheetForInlineStyle(const String& id, PassRefPtrWillBeRawPtr<Element>, Listener*);
 299     CSSStyleDeclaration* inlineStyle() const;
 300     const String& elementStyleText() const;
 301     PassRefPtrWillBeRawPtr<CSSRuleSourceData> getStyleAttributeData() const;
 302
 303     RefPtrWillBeMember<Element> m_element;
 304     RefPtrWillBeMember<CSSRuleSourceData> m_ruleSourceData;
 305     RefPtrWillBeMember<InspectorStyle> m_inspectorStyle;
 306
 307     // Contains "style" attribute value.
 308     mutable String m_styleText;
 309     mutable bool m_isStyleTextValid;
 310 };
 311
 312
 313 } // namespace blink
 314
 315 WTF_ALLOW_MOVE_AND_INIT_WITH_MEM_FUNCTIONS(blink::InspectorStyleProperty);
 316
 317 #endif // !defined(InspectorStyleSheet_h)