Toggling underline or strike through affects each other
[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(CSSPropertyID propertyID, const String& value)
98     {
99         return adoptRef(*new EditingStyle(propertyID, value));
100     }
101
102     static Ref<EditingStyle> create(CSSPropertyID propertyID, CSSValueID value)
103     {
104         return adoptRef(*new EditingStyle(propertyID, value));
105     }
106
107     WEBCORE_EXPORT ~EditingStyle();
108
109     MutableStyleProperties* style() { return m_mutableStyle.get(); }
110     bool textDirection(WritingDirection&) const;
111     bool isEmpty() const;
112     void setStyle(PassRefPtr<MutableStyleProperties>);
113     void overrideWithStyle(const StyleProperties*);
114     void overrideTypingStyleAt(const EditingStyle&, const Position&);
115     void clear();
116     PassRefPtr<EditingStyle> copy() const;
117     PassRefPtr<EditingStyle> extractAndRemoveBlockProperties();
118     PassRefPtr<EditingStyle> extractAndRemoveTextDirection();
119     void removeBlockProperties();
120     void removeStyleAddedByNode(Node*);
121     void removeStyleConflictingWithStyleOfNode(Node*);
122     template<typename T> void removeEquivalentProperties(const T&);
123     void collapseTextDecorationProperties();
124     enum ShouldIgnoreTextOnlyProperties { IgnoreTextOnlyProperties, DoNotIgnoreTextOnlyProperties };
125     TriState triStateOfStyle(EditingStyle*) const;
126     TriState triStateOfStyle(const VisibleSelection&) const;
127     bool conflictsWithInlineStyleOfElement(StyledElement* element) const { return conflictsWithInlineStyleOfElement(element, 0, 0); }
128     bool conflictsWithInlineStyleOfElement(StyledElement* element, RefPtr<MutableStyleProperties>& newInlineStyle,
129         EditingStyle* extractedStyle) const
130     {
131         return conflictsWithInlineStyleOfElement(element, &newInlineStyle, extractedStyle);
132     }
133     bool conflictsWithImplicitStyleOfElement(HTMLElement*, EditingStyle* extractedStyle = 0, ShouldExtractMatchingStyle = DoNotExtractMatchingStyle) const;
134     bool conflictsWithImplicitStyleOfAttributes(HTMLElement*) const;
135     bool extractConflictingImplicitStyleOfAttributes(HTMLElement*, ShouldPreserveWritingDirection, EditingStyle* extractedStyle,
136             Vector<QualifiedName>& conflictingAttributes, ShouldExtractMatchingStyle) const;
137     bool styleIsPresentInComputedStyleOfNode(Node*) const;
138
139     static bool elementIsStyledSpanOrHTMLEquivalent(const HTMLElement*);
140
141     void prepareToApplyAt(const Position&, ShouldPreserveWritingDirection = DoNotPreserveWritingDirection);
142     void mergeTypingStyle(Document&);
143     enum CSSPropertyOverrideMode { OverrideValues, DoNotOverrideValues };
144     void mergeInlineStyleOfElement(StyledElement*, CSSPropertyOverrideMode, PropertiesToInclude = AllProperties);
145     static PassRefPtr<EditingStyle> wrappingStyleForSerialization(Node* context, bool shouldAnnotate);
146     void mergeStyleFromRules(StyledElement*);
147     void mergeStyleFromRulesForSerialization(StyledElement*);
148     void removeStyleFromRulesAndContext(StyledElement*, Node* context);
149     void removePropertiesInElementDefaultStyle(Element*);
150     void forceInline();
151     bool convertPositionStyle();
152     bool isFloating();
153     int legacyFontSize(Document*) const;
154
155     float fontSizeDelta() const { return m_fontSizeDelta; }
156     bool hasFontSizeDelta() const { return m_fontSizeDelta != NoFontDelta; }
157     bool shouldUseFixedDefaultFontSize() const { return m_shouldUseFixedDefaultFontSize; }
158     
159     void setUnderlineChange(TextDecorationChange change) { m_underlineChange = static_cast<unsigned>(change); }
160     TextDecorationChange underlineChange() const { return static_cast<TextDecorationChange>(m_underlineChange); }
161     void setStrikeThroughChange(TextDecorationChange change) { m_strikeThroughChange = static_cast<unsigned>(change); }
162     TextDecorationChange strikeThroughChange() const { return static_cast<TextDecorationChange>(m_strikeThroughChange); }
163
164     static PassRefPtr<EditingStyle> styleAtSelectionStart(const VisibleSelection&, bool shouldUseBackgroundColorInEffect = false);
165     static WritingDirection textDirectionForSelection(const VisibleSelection&, EditingStyle* typingStyle, bool& hasNestedOrMultipleEmbeddings);
166 private:
167     EditingStyle();
168     EditingStyle(Node*, PropertiesToInclude);
169     EditingStyle(const Position&, PropertiesToInclude);
170     explicit EditingStyle(const StyleProperties*);
171     EditingStyle(CSSPropertyID, const String& value);
172     EditingStyle(CSSPropertyID, CSSValueID);
173     void init(Node*, PropertiesToInclude);
174     void removeTextFillAndStrokeColorsIfNeeded(RenderStyle*);
175     void setProperty(CSSPropertyID, const String& value, bool important = false);
176     void extractFontSizeDelta();
177     template<typename T> TriState triStateOfStyle(T& styleToCompare, ShouldIgnoreTextOnlyProperties) const;
178     bool conflictsWithInlineStyleOfElement(StyledElement*, RefPtr<MutableStyleProperties>* newInlineStyle, EditingStyle* extractedStyle) const;
179     void mergeInlineAndImplicitStyleOfElement(StyledElement*, CSSPropertyOverrideMode, PropertiesToInclude);
180     void mergeStyle(const StyleProperties*, CSSPropertyOverrideMode);
181
182     RefPtr<MutableStyleProperties> m_mutableStyle;
183     unsigned m_shouldUseFixedDefaultFontSize : 1;
184     unsigned m_underlineChange : 2;
185     unsigned m_strikeThroughChange : 2;
186     float m_fontSizeDelta = NoFontDelta;
187
188     friend class HTMLElementEquivalent;
189     friend class HTMLAttributeEquivalent;
190     friend class HTMLTextDecorationEquivalent;
191 };
192
193 class StyleChange {
194 public:
195     StyleChange() { }
196     StyleChange(EditingStyle*, const Position&);
197
198     const StyleProperties* cssStyle() const { return m_cssStyle.get(); }
199     bool applyBold() const { return m_applyBold; }
200     bool applyItalic() const { return m_applyItalic; }
201     bool applyUnderline() const { return m_applyUnderline; }
202     bool applyLineThrough() const { return m_applyLineThrough; }
203     bool applySubscript() const { return m_applySubscript; }
204     bool applySuperscript() const { return m_applySuperscript; }
205     bool applyFontColor() const { return m_applyFontColor.length() > 0; }
206     bool applyFontFace() const { return m_applyFontFace.length() > 0; }
207     bool applyFontSize() const { return m_applyFontSize.length() > 0; }
208
209     String fontColor() { return m_applyFontColor; }
210     String fontFace() { return m_applyFontFace; }
211     String fontSize() { return m_applyFontSize; }
212
213     bool operator==(const StyleChange&);
214     bool operator!=(const StyleChange& other)
215     {
216         return !(*this == other);
217     }
218 private:
219     void extractTextStyles(Document*, MutableStyleProperties&, bool shouldUseFixedFontDefaultSize);
220
221     RefPtr<MutableStyleProperties> m_cssStyle;
222     bool m_applyBold = false;
223     bool m_applyItalic = false;
224     bool m_applyUnderline = false;
225     bool m_applyLineThrough = false;
226     bool m_applySubscript = false;
227     bool m_applySuperscript = false;
228     String m_applyFontColor;
229     String m_applyFontFace;
230     String m_applyFontSize;
231 };
232
233 } // namespace WebCore
234
235 #endif // EditingStyle_h