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