fd08033e267fa337f0b3e2e3da6a3add19a2faeb
[WebKit.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 #pragma once
33
34 #include "CSSPropertyNames.h"
35 #include "CSSValueKeywords.h"
36 #include "StyleProperties.h"
37 #include "WritingDirection.h"
38 #include <wtf/Forward.h>
39 #include <wtf/Optional.h>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/TriState.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WebCore {
46
47 class CSSStyleDeclaration;
48 class CSSComputedStyleDeclaration;
49 class CSSPrimitiveValue;
50 class CSSValue;
51 class ComputedStyleExtractor;
52 class Document;
53 class Element;
54 class HTMLElement;
55 class MutableStyleProperties;
56 class Node;
57 class Position;
58 class QualifiedName;
59 class RenderStyle;
60 class StyleProperties;
61 class StyledElement;
62 class VisibleSelection;
63
64 enum class TextDecorationChange { None, Add, Remove };
65
66 class EditingStyle : public RefCounted<EditingStyle> {
67 public:
68
69     enum PropertiesToInclude { AllProperties, OnlyEditingInheritableProperties, EditingPropertiesInEffect };
70
71     enum ShouldPreserveWritingDirection { PreserveWritingDirection, DoNotPreserveWritingDirection };
72     enum ShouldExtractMatchingStyle { ExtractMatchingStyle, DoNotExtractMatchingStyle };
73     static float NoFontDelta;
74
75     static Ref<EditingStyle> create()
76     {
77         return adoptRef(*new EditingStyle);
78     }
79
80     static Ref<EditingStyle> create(Node* node, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
81     {
82         return adoptRef(*new EditingStyle(node, propertiesToInclude));
83     }
84
85     static Ref<EditingStyle> create(const Position& position, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
86     {
87         return adoptRef(*new EditingStyle(position, propertiesToInclude));
88     }
89
90     static Ref<EditingStyle> create(const StyleProperties* style)
91     {
92         return adoptRef(*new EditingStyle(style));
93     }
94
95     static Ref<EditingStyle> create(const CSSStyleDeclaration* style)
96     {
97         return adoptRef(*new EditingStyle(style));
98     }
99
100     static Ref<EditingStyle> create(CSSPropertyID propertyID, const String& value)
101     {
102         return adoptRef(*new EditingStyle(propertyID, value));
103     }
104
105     static Ref<EditingStyle> create(CSSPropertyID propertyID, CSSValueID value)
106     {
107         return adoptRef(*new EditingStyle(propertyID, value));
108     }
109
110     WEBCORE_EXPORT ~EditingStyle();
111
112     MutableStyleProperties* style() { return m_mutableStyle.get(); }
113     Ref<MutableStyleProperties> styleWithResolvedTextDecorations() const;
114     Optional<WritingDirection> textDirection() const;
115     bool isEmpty() const;
116     void setStyle(RefPtr<MutableStyleProperties>&&);
117     void overrideWithStyle(const StyleProperties&);
118     void overrideTypingStyleAt(const EditingStyle&, const Position&);
119     void clear();
120     Ref<EditingStyle> copy() const;
121     Ref<EditingStyle> extractAndRemoveBlockProperties();
122     Ref<EditingStyle> extractAndRemoveTextDirection();
123     void removeBlockProperties();
124     void removeStyleAddedByNode(Node*);
125     void removeStyleConflictingWithStyleOfNode(Node&);
126     template<typename T> void removeEquivalentProperties(T&);
127     void collapseTextDecorationProperties();
128     enum ShouldIgnoreTextOnlyProperties { IgnoreTextOnlyProperties, DoNotIgnoreTextOnlyProperties };
129     TriState triStateOfStyle(EditingStyle*) const;
130     TriState triStateOfStyle(const VisibleSelection&) const;
131     bool conflictsWithInlineStyleOfElement(StyledElement& element) const { return conflictsWithInlineStyleOfElement(element, nullptr, nullptr); }
132     bool conflictsWithInlineStyleOfElement(StyledElement& element, RefPtr<MutableStyleProperties>& newInlineStyle, EditingStyle* extractedStyle) const
133     {
134         return conflictsWithInlineStyleOfElement(element, &newInlineStyle, extractedStyle);
135     }
136     bool conflictsWithImplicitStyleOfElement(HTMLElement&, EditingStyle* extractedStyle = nullptr, ShouldExtractMatchingStyle = DoNotExtractMatchingStyle) const;
137     bool conflictsWithImplicitStyleOfAttributes(HTMLElement&) const;
138     bool extractConflictingImplicitStyleOfAttributes(HTMLElement&, ShouldPreserveWritingDirection, EditingStyle* extractedStyle, Vector<QualifiedName>& conflictingAttributes, ShouldExtractMatchingStyle) const;
139     bool styleIsPresentInComputedStyleOfNode(Node&) const;
140
141     static bool elementIsStyledSpanOrHTMLEquivalent(const HTMLElement&);
142
143     void prepareToApplyAt(const Position&, ShouldPreserveWritingDirection = DoNotPreserveWritingDirection);
144     void mergeTypingStyle(Document&);
145     enum CSSPropertyOverrideMode { OverrideValues, DoNotOverrideValues };
146     void mergeInlineStyleOfElement(StyledElement&, CSSPropertyOverrideMode, PropertiesToInclude = AllProperties);
147     static Ref<EditingStyle> wrappingStyleForSerialization(Node& context, bool shouldAnnotate);
148     void mergeStyleFromRules(StyledElement&);
149     void mergeStyleFromRulesForSerialization(StyledElement&);
150     void removeStyleFromRulesAndContext(StyledElement&, Node* context);
151     void removePropertiesInElementDefaultStyle(Element&);
152     void forceInline();
153     void addDisplayContents();
154     bool convertPositionStyle();
155     bool isFloating();
156     int legacyFontSize(Document&) const;
157
158     float fontSizeDelta() const { return m_fontSizeDelta; }
159     bool hasFontSizeDelta() const { return m_fontSizeDelta != NoFontDelta; }
160     bool shouldUseFixedDefaultFontSize() const { return m_shouldUseFixedDefaultFontSize; }
161     
162     void setUnderlineChange(TextDecorationChange change) { m_underlineChange = static_cast<unsigned>(change); }
163     TextDecorationChange underlineChange() const { return static_cast<TextDecorationChange>(m_underlineChange); }
164     void setStrikeThroughChange(TextDecorationChange change) { m_strikeThroughChange = static_cast<unsigned>(change); }
165     TextDecorationChange strikeThroughChange() const { return static_cast<TextDecorationChange>(m_strikeThroughChange); }
166
167     WEBCORE_EXPORT bool hasStyle(CSSPropertyID, const String& value);
168     WEBCORE_EXPORT static RefPtr<EditingStyle> styleAtSelectionStart(const VisibleSelection&, bool shouldUseBackgroundColorInEffect = false);
169     static WritingDirection textDirectionForSelection(const VisibleSelection&, EditingStyle* typingStyle, bool& hasNestedOrMultipleEmbeddings);
170
171     Ref<EditingStyle> inverseTransformColorIfNeeded(Element&);
172
173 private:
174     EditingStyle();
175     EditingStyle(Node*, PropertiesToInclude);
176     EditingStyle(const Position&, PropertiesToInclude);
177     WEBCORE_EXPORT explicit EditingStyle(const CSSStyleDeclaration*);
178     explicit EditingStyle(const StyleProperties*);
179     EditingStyle(CSSPropertyID, const String& value);
180     EditingStyle(CSSPropertyID, CSSValueID);
181     void init(Node*, PropertiesToInclude);
182     void removeTextFillAndStrokeColorsIfNeeded(const RenderStyle*);
183     void setProperty(CSSPropertyID, const String& value, bool important = false);
184     void extractFontSizeDelta();
185     template<typename T> TriState triStateOfStyle(T& styleToCompare, ShouldIgnoreTextOnlyProperties) const;
186     bool conflictsWithInlineStyleOfElement(StyledElement&, RefPtr<MutableStyleProperties>* newInlineStyle, EditingStyle* extractedStyle) const;
187     void mergeInlineAndImplicitStyleOfElement(StyledElement&, CSSPropertyOverrideMode, PropertiesToInclude);
188     void mergeStyle(const StyleProperties*, CSSPropertyOverrideMode);
189
190     RefPtr<MutableStyleProperties> m_mutableStyle;
191     unsigned m_shouldUseFixedDefaultFontSize : 1;
192     unsigned m_underlineChange : 2;
193     unsigned m_strikeThroughChange : 2;
194     float m_fontSizeDelta = NoFontDelta;
195
196     friend class HTMLElementEquivalent;
197     friend class HTMLAttributeEquivalent;
198     friend class HTMLTextDecorationEquivalent;
199 };
200
201 class StyleChange {
202 public:
203     StyleChange() { }
204     StyleChange(EditingStyle*, const Position&);
205
206     const StyleProperties* cssStyle() const { return m_cssStyle.get(); }
207     bool applyBold() const { return m_applyBold; }
208     bool applyItalic() const { return m_applyItalic; }
209     bool applyUnderline() const { return m_applyUnderline; }
210     bool applyLineThrough() const { return m_applyLineThrough; }
211     bool applySubscript() const { return m_applySubscript; }
212     bool applySuperscript() const { return m_applySuperscript; }
213     bool applyFontColor() const { return m_applyFontColor.length() > 0; }
214     bool applyFontFace() const { return m_applyFontFace.length() > 0; }
215     bool applyFontSize() const { return m_applyFontSize.length() > 0; }
216
217     String fontColor() { return m_applyFontColor; }
218     String fontFace() { return m_applyFontFace; }
219     String fontSize() { return m_applyFontSize; }
220
221     bool operator==(const StyleChange&);
222     bool operator!=(const StyleChange& other)
223     {
224         return !(*this == other);
225     }
226 private:
227     void extractTextStyles(Document&, MutableStyleProperties&, bool shouldUseFixedFontDefaultSize);
228
229     RefPtr<MutableStyleProperties> m_cssStyle;
230     bool m_applyBold = false;
231     bool m_applyItalic = false;
232     bool m_applyUnderline = false;
233     bool m_applyLineThrough = false;
234     bool m_applySubscript = false;
235     bool m_applySuperscript = false;
236     String m_applyFontColor;
237     String m_applyFontFace;
238     String m_applyFontSize;
239 };
240
241 } // namespace WebCore