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