REGRESSION(r183770): Crash inside WebEditorClient::shouldApplyStyle when applying...
[WebKit-https.git] / Source / WebCore / editing / EditingStyle.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2013 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #ifndef EditingStyle_h
33 #define EditingStyle_h
34
35 #include "CSSPropertyNames.h"
36 #include "CSSValueKeywords.h"
37 #include "StyleProperties.h"
38 #include "WritingDirection.h"
39 #include <wtf/Forward.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/RefCounted.h>
42 #include <wtf/RefPtr.h>
43 #include <wtf/TriState.h>
44 #include <wtf/Vector.h>
45 #include <wtf/text/WTFString.h>
46
47 namespace WebCore {
48
49 class CSSStyleDeclaration;
50 class CSSComputedStyleDeclaration;
51 class CSSPrimitiveValue;
52 class CSSValue;
53 class ComputedStyleExtractor;
54 class Document;
55 class Element;
56 class HTMLElement;
57 class MutableStyleProperties;
58 class Node;
59 class Position;
60 class QualifiedName;
61 class RenderStyle;
62 class StyleProperties;
63 class StyledElement;
64 class VisibleSelection;
65
66 enum class TextDecorationChange { None, Add, Remove };
67
68 class EditingStyle : public RefCounted<EditingStyle> {
69 public:
70
71     enum PropertiesToInclude { AllProperties, OnlyEditingInheritableProperties, EditingPropertiesInEffect };
72
73     enum ShouldPreserveWritingDirection { PreserveWritingDirection, DoNotPreserveWritingDirection };
74     enum ShouldExtractMatchingStyle { ExtractMatchingStyle, DoNotExtractMatchingStyle };
75     static float NoFontDelta;
76
77     static Ref<EditingStyle> create()
78     {
79         return adoptRef(*new EditingStyle);
80     }
81
82     static Ref<EditingStyle> create(Node* node, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
83     {
84         return adoptRef(*new EditingStyle(node, propertiesToInclude));
85     }
86
87     static Ref<EditingStyle> create(const Position& position, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
88     {
89         return adoptRef(*new EditingStyle(position, propertiesToInclude));
90     }
91
92     static Ref<EditingStyle> create(const StyleProperties* style)
93     {
94         return adoptRef(*new EditingStyle(style));
95     }
96
97     static Ref<EditingStyle> create(const CSSStyleDeclaration* style)
98     {
99         return adoptRef(*new EditingStyle(style));
100     }
101
102     static Ref<EditingStyle> create(CSSPropertyID propertyID, const String& value)
103     {
104         return adoptRef(*new EditingStyle(propertyID, value));
105     }
106
107     static Ref<EditingStyle> create(CSSPropertyID propertyID, CSSValueID value)
108     {
109         return adoptRef(*new EditingStyle(propertyID, value));
110     }
111
112     WEBCORE_EXPORT ~EditingStyle();
113
114     MutableStyleProperties* style() { return m_mutableStyle.get(); }
115     Ref<MutableStyleProperties> styleWithResolvedTextDecorations() const;
116     bool textDirection(WritingDirection&) const;
117     bool isEmpty() const;
118     void setStyle(PassRefPtr<MutableStyleProperties>);
119     void overrideWithStyle(const StyleProperties*);
120     void overrideTypingStyleAt(const EditingStyle&, const Position&);
121     void clear();
122     PassRefPtr<EditingStyle> copy() const;
123     PassRefPtr<EditingStyle> extractAndRemoveBlockProperties();
124     PassRefPtr<EditingStyle> extractAndRemoveTextDirection();
125     void removeBlockProperties();
126     void removeStyleAddedByNode(Node*);
127     void removeStyleConflictingWithStyleOfNode(Node*);
128     template<typename T> void removeEquivalentProperties(const T&);
129     void collapseTextDecorationProperties();
130     enum ShouldIgnoreTextOnlyProperties { IgnoreTextOnlyProperties, DoNotIgnoreTextOnlyProperties };
131     TriState triStateOfStyle(EditingStyle*) const;
132     TriState triStateOfStyle(const VisibleSelection&) const;
133     bool conflictsWithInlineStyleOfElement(StyledElement* element) const { return conflictsWithInlineStyleOfElement(element, 0, 0); }
134     bool conflictsWithInlineStyleOfElement(StyledElement* element, RefPtr<MutableStyleProperties>& newInlineStyle,
135         EditingStyle* extractedStyle) const
136     {
137         return conflictsWithInlineStyleOfElement(element, &newInlineStyle, extractedStyle);
138     }
139     bool conflictsWithImplicitStyleOfElement(HTMLElement*, EditingStyle* extractedStyle = 0, ShouldExtractMatchingStyle = DoNotExtractMatchingStyle) const;
140     bool conflictsWithImplicitStyleOfAttributes(HTMLElement*) const;
141     bool extractConflictingImplicitStyleOfAttributes(HTMLElement*, ShouldPreserveWritingDirection, EditingStyle* extractedStyle,
142             Vector<QualifiedName>& conflictingAttributes, ShouldExtractMatchingStyle) const;
143     bool styleIsPresentInComputedStyleOfNode(Node*) const;
144
145     static bool elementIsStyledSpanOrHTMLEquivalent(const HTMLElement*);
146
147     void prepareToApplyAt(const Position&, ShouldPreserveWritingDirection = DoNotPreserveWritingDirection);
148     void mergeTypingStyle(Document&);
149     enum CSSPropertyOverrideMode { OverrideValues, DoNotOverrideValues };
150     void mergeInlineStyleOfElement(StyledElement*, CSSPropertyOverrideMode, PropertiesToInclude = AllProperties);
151     static PassRefPtr<EditingStyle> wrappingStyleForSerialization(Node* context, bool shouldAnnotate);
152     void mergeStyleFromRules(StyledElement*);
153     void mergeStyleFromRulesForSerialization(StyledElement*);
154     void removeStyleFromRulesAndContext(StyledElement*, Node* context);
155     void removePropertiesInElementDefaultStyle(Element*);
156     void forceInline();
157     bool convertPositionStyle();
158     bool isFloating();
159     int legacyFontSize(Document*) const;
160
161     float fontSizeDelta() const { return m_fontSizeDelta; }
162     bool hasFontSizeDelta() const { return m_fontSizeDelta != NoFontDelta; }
163     bool shouldUseFixedDefaultFontSize() const { return m_shouldUseFixedDefaultFontSize; }
164     
165     void setUnderlineChange(TextDecorationChange change) { m_underlineChange = static_cast<unsigned>(change); }
166     TextDecorationChange underlineChange() const { return static_cast<TextDecorationChange>(m_underlineChange); }
167     void setStrikeThroughChange(TextDecorationChange change) { m_strikeThroughChange = static_cast<unsigned>(change); }
168     TextDecorationChange strikeThroughChange() const { return static_cast<TextDecorationChange>(m_strikeThroughChange); }
169
170     static PassRefPtr<EditingStyle> styleAtSelectionStart(const VisibleSelection&, bool shouldUseBackgroundColorInEffect = false);
171     static WritingDirection textDirectionForSelection(const VisibleSelection&, EditingStyle* typingStyle, bool& hasNestedOrMultipleEmbeddings);
172 private:
173     EditingStyle();
174     EditingStyle(Node*, PropertiesToInclude);
175     EditingStyle(const Position&, PropertiesToInclude);
176     WEBCORE_EXPORT explicit EditingStyle(const CSSStyleDeclaration*);
177     explicit EditingStyle(const StyleProperties*);
178     EditingStyle(CSSPropertyID, const String& value);
179     EditingStyle(CSSPropertyID, CSSValueID);
180     void init(Node*, PropertiesToInclude);
181     void removeTextFillAndStrokeColorsIfNeeded(RenderStyle*);
182     void setProperty(CSSPropertyID, const String& value, bool important = false);
183     void extractFontSizeDelta();
184     template<typename T> TriState triStateOfStyle(T& styleToCompare, ShouldIgnoreTextOnlyProperties) const;
185     bool conflictsWithInlineStyleOfElement(StyledElement*, RefPtr<MutableStyleProperties>* newInlineStyle, EditingStyle* extractedStyle) const;
186     void mergeInlineAndImplicitStyleOfElement(StyledElement*, CSSPropertyOverrideMode, PropertiesToInclude);
187     void mergeStyle(const StyleProperties*, CSSPropertyOverrideMode);
188
189     RefPtr<MutableStyleProperties> m_mutableStyle;
190     unsigned m_shouldUseFixedDefaultFontSize : 1;
191     unsigned m_underlineChange : 2;
192     unsigned m_strikeThroughChange : 2;
193     float m_fontSizeDelta = NoFontDelta;
194
195     friend class HTMLElementEquivalent;
196     friend class HTMLAttributeEquivalent;
197     friend class HTMLTextDecorationEquivalent;
198 };
199
200 class StyleChange {
201 public:
202     StyleChange() { }
203     StyleChange(EditingStyle*, const Position&);
204
205     const StyleProperties* cssStyle() const { return m_cssStyle.get(); }
206     bool applyBold() const { return m_applyBold; }
207     bool applyItalic() const { return m_applyItalic; }
208     bool applyUnderline() const { return m_applyUnderline; }
209     bool applyLineThrough() const { return m_applyLineThrough; }
210     bool applySubscript() const { return m_applySubscript; }
211     bool applySuperscript() const { return m_applySuperscript; }
212     bool applyFontColor() const { return m_applyFontColor.length() > 0; }
213     bool applyFontFace() const { return m_applyFontFace.length() > 0; }
214     bool applyFontSize() const { return m_applyFontSize.length() > 0; }
215
216     String fontColor() { return m_applyFontColor; }
217     String fontFace() { return m_applyFontFace; }
218     String fontSize() { return m_applyFontSize; }
219
220     bool operator==(const StyleChange&);
221     bool operator!=(const StyleChange& other)
222     {
223         return !(*this == other);
224     }
225 private:
226     void extractTextStyles(Document*, MutableStyleProperties&, bool shouldUseFixedFontDefaultSize);
227
228     RefPtr<MutableStyleProperties> m_cssStyle;
229     bool m_applyBold = false;
230     bool m_applyItalic = false;
231     bool m_applyUnderline = false;
232     bool m_applyLineThrough = false;
233     bool m_applySubscript = false;
234     bool m_applySuperscript = false;
235     String m_applyFontColor;
236     String m_applyFontFace;
237     String m_applyFontSize;
238 };
239
240 } // namespace WebCore
241
242 #endif // EditingStyle_h