c47bf637f6deaf091deeb75c0192ce01aff4d794
[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 "PlatformString.h"
36 #include "WritingDirection.h"
37 #include <wtf/Forward.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/Vector.h>
41
42 namespace WebCore {
43
44 class CSSStyleDeclaration;
45 class CSSComputedStyleDeclaration;
46 class CSSMutableStyleDeclaration;
47 class CSSPrimitiveValue;
48 class CSSValue;
49 class Document;
50 class HTMLElement;
51 class Node;
52 class Position;
53 class QualifiedName;
54 class RenderStyle;
55 class StyledElement;
56
57 enum TriState { FalseTriState, TrueTriState, MixedTriState };
58
59 class EditingStyle : public RefCounted<EditingStyle> {
60 public:
61
62     enum PropertiesToInclude { AllProperties, OnlyEditingInheritableProperties, EditingInheritablePropertiesAndBackgroundColorInEffect };
63     enum ShouldPreserveWritingDirection { PreserveWritingDirection, DoNotPreserveWritingDirection };
64     enum ShouldExtractMatchingStyle { ExtractMatchingStyle, DoNotExtractMatchingStyle };
65     static float NoFontDelta;
66
67     static PassRefPtr<EditingStyle> create()
68     {
69         return adoptRef(new EditingStyle());
70     }
71
72     static PassRefPtr<EditingStyle> create(Node* node, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
73     {
74         return adoptRef(new EditingStyle(node, propertiesToInclude));
75     }
76
77     static PassRefPtr<EditingStyle> create(const Position& position, PropertiesToInclude propertiesToInclude = OnlyEditingInheritableProperties)
78     {
79         return adoptRef(new EditingStyle(position, propertiesToInclude));
80     }
81
82     static PassRefPtr<EditingStyle> create(const CSSStyleDeclaration* style)
83     {
84         return adoptRef(new EditingStyle(style));
85     }
86
87     static PassRefPtr<EditingStyle> create(int propertyID, const String& value)
88     {
89         return adoptRef(new EditingStyle(propertyID, value));
90     }
91
92     ~EditingStyle();
93
94     CSSMutableStyleDeclaration* style() { return m_mutableStyle.get(); }
95     bool textDirection(WritingDirection&) const;
96     bool isEmpty() const;
97     void setStyle(PassRefPtr<CSSMutableStyleDeclaration>);
98     void overrideWithStyle(const CSSMutableStyleDeclaration*);
99     void clear();
100     PassRefPtr<EditingStyle> copy() const;
101     PassRefPtr<EditingStyle> extractAndRemoveBlockProperties();
102     PassRefPtr<EditingStyle> extractAndRemoveTextDirection();
103     void removeBlockProperties();
104     void removeStyleAddedByNode(Node*);
105     void removeStyleConflictingWithStyleOfNode(Node*);
106     void removeNonEditingProperties();
107     void collapseTextDecorationProperties();
108     enum ShouldIgnoreTextOnlyProperties { IgnoreTextOnlyProperties, DoNotIgnoreTextOnlyProperties };
109     TriState triStateOfStyle(CSSStyleDeclaration*, ShouldIgnoreTextOnlyProperties = DoNotIgnoreTextOnlyProperties) const;
110     bool conflictsWithInlineStyleOfElement(StyledElement* element) const { return conflictsWithInlineStyleOfElement(element, 0, 0); }
111     bool conflictsWithInlineStyleOfElement(StyledElement* element, EditingStyle* extractedStyle, Vector<CSSPropertyID>& conflictingProperties) const
112     {
113         return conflictsWithInlineStyleOfElement(element, extractedStyle, &conflictingProperties);
114     }
115     bool conflictsWithImplicitStyleOfElement(HTMLElement*, EditingStyle* extractedStyle = 0, ShouldExtractMatchingStyle = DoNotExtractMatchingStyle) const;
116     bool conflictsWithImplicitStyleOfAttributes(HTMLElement*) const;
117     bool extractConflictingImplicitStyleOfAttributes(HTMLElement*, ShouldPreserveWritingDirection, EditingStyle* extractedStyle,
118             Vector<QualifiedName>& conflictingAttributes, ShouldExtractMatchingStyle) const;
119     bool styleIsPresentInComputedStyleOfNode(Node*) const;
120
121     static bool elementIsStyledSpanOrHTMLEquivalent(const HTMLElement*);
122
123     void prepareToApplyAt(const Position&, ShouldPreserveWritingDirection = DoNotPreserveWritingDirection);
124     void mergeTypingStyle(Document*);
125     void mergeInlineStyleOfElement(StyledElement*);
126     void mergeStyleFromRules(StyledElement*);
127     void mergeStyleFromRulesForSerialization(StyledElement*);
128     void removeStyleFromRulesAndContext(StyledElement*, Node* context);
129
130     float fontSizeDelta() const { return m_fontSizeDelta; }
131     bool hasFontSizeDelta() const { return m_fontSizeDelta != NoFontDelta; }
132     bool shouldUseFixedDefaultFontSize() const { return m_shouldUseFixedDefaultFontSize; }
133
134 private:
135     EditingStyle();
136     EditingStyle(Node*, PropertiesToInclude);
137     EditingStyle(const Position&, PropertiesToInclude);
138     EditingStyle(const CSSStyleDeclaration*);
139     EditingStyle(int propertyID, const String& value);
140     void init(Node*, PropertiesToInclude);
141     void removeTextFillAndStrokeColorsIfNeeded(RenderStyle*);
142     void setProperty(int propertyID, const String& value, bool important = false);
143     void replaceFontSizeByKeywordIfPossible(RenderStyle*, CSSComputedStyleDeclaration*);
144     void extractFontSizeDelta();
145     bool conflictsWithInlineStyleOfElement(StyledElement*, EditingStyle* extractedStyle, Vector<CSSPropertyID>* conflictingProperties) const;
146     void mergeStyle(CSSMutableStyleDeclaration*);
147     void removePropertiesInElementDefaultStyle(StyledElement*);
148
149     RefPtr<CSSMutableStyleDeclaration> m_mutableStyle;
150     bool m_shouldUseFixedDefaultFontSize;
151     float m_fontSizeDelta;
152
153     friend class HTMLElementEquivalent;
154     friend class HTMLAttributeEquivalent;
155 };
156
157 class StyleChange {
158 public:
159     StyleChange(EditingStyle*, const Position&);
160
161     String cssStyle() const { return m_cssStyle; }
162     bool applyBold() const { return m_applyBold; }
163     bool applyItalic() const { return m_applyItalic; }
164     bool applyUnderline() const { return m_applyUnderline; }
165     bool applyLineThrough() const { return m_applyLineThrough; }
166     bool applySubscript() const { return m_applySubscript; }
167     bool applySuperscript() const { return m_applySuperscript; }
168     bool applyFontColor() const { return m_applyFontColor.length() > 0; }
169     bool applyFontFace() const { return m_applyFontFace.length() > 0; }
170     bool applyFontSize() const { return m_applyFontSize.length() > 0; }
171
172     String fontColor() { return m_applyFontColor; }
173     String fontFace() { return m_applyFontFace; }
174     String fontSize() { return m_applyFontSize; }
175
176     bool operator==(const StyleChange& other)
177     {
178         return m_cssStyle == other.m_cssStyle
179             && m_applyBold == other.m_applyBold
180             && m_applyItalic == other.m_applyItalic
181             && m_applyUnderline == other.m_applyUnderline
182             && m_applyLineThrough == other.m_applyLineThrough
183             && m_applySubscript == other.m_applySubscript
184             && m_applySuperscript == other.m_applySuperscript
185             && m_applyFontColor == other.m_applyFontColor
186             && m_applyFontFace == other.m_applyFontFace
187             && m_applyFontSize == other.m_applyFontSize;
188     }
189     bool operator!=(const StyleChange& other)
190     {
191         return !(*this == other);
192     }
193 private:
194     void extractTextStyles(Document*, CSSMutableStyleDeclaration*, bool shouldUseFixedFontDefaultSize);
195
196     String m_cssStyle;
197     bool m_applyBold;
198     bool m_applyItalic;
199     bool m_applyUnderline;
200     bool m_applyLineThrough;
201     bool m_applySubscript;
202     bool m_applySuperscript;
203     String m_applyFontColor;
204     String m_applyFontFace;
205     String m_applyFontSize;
206 };
207
208 // FIXME: Remove these functions or make them non-global to discourage using CSSStyleDeclaration directly.
209 int getIdentifierValue(CSSStyleDeclaration*, int propertyID);
210 enum LegacyFontSizeMode { AlwaysUseLegacyFontSize, UseLegacyFontSizeOnlyIfPixelValuesMatch };
211 int legacyFontSizeFromCSSValue(Document*, CSSPrimitiveValue*, bool shouldUseFixedFontDefaultSize, LegacyFontSizeMode);
212 bool hasTransparentBackgroundColor(CSSStyleDeclaration*);
213 PassRefPtr<CSSValue> backgroundColorInEffect(Node*);
214
215 } // namespace WebCore
216
217 #endif // EditingStyle_h