2011-02-22 Ryosuke Niwa <rniwa@webkit.org>
[WebKit-https.git] / Source / WebCore / editing / ApplyStyleCommand.h
1 /*
2  * Copyright (C) 2005, 2006, 2008, 2009 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef ApplyStyleCommand_h
27 #define ApplyStyleCommand_h
28
29 #include "CompositeEditCommand.h"
30 #include "HTMLElement.h"
31 #include "WritingDirection.h"
32
33 namespace WebCore {
34
35 class CSSPrimitiveValue;
36 class EditingStyle;
37 class HTMLElement;
38 class StyleChange;
39
40 enum ShouldIncludeTypingStyle {
41     IncludeTypingStyle,
42     IgnoreTypingStyle
43 };
44
45 class ApplyStyleCommand : public CompositeEditCommand {
46 public:
47     enum EPropertyLevel { PropertyDefault, ForceBlockProperties };
48     enum InlineStyleRemovalMode { RemoveIfNeeded, RemoveAlways, RemoveNone };
49     enum EAddStyledElement { AddStyledElement, DoNotAddStyledElement };
50     typedef bool (*IsInlineElementToRemoveFunction)(const Element*);
51
52     static PassRefPtr<ApplyStyleCommand> create(Document* document, const EditingStyle* style, EditAction action = EditActionChangeAttributes, EPropertyLevel level = PropertyDefault)
53     {
54         return adoptRef(new ApplyStyleCommand(document, style, action, level));
55     }
56     static PassRefPtr<ApplyStyleCommand> create(Document* document, const EditingStyle* style, const Position& start, const Position& end, EditAction action = EditActionChangeAttributes, EPropertyLevel level = PropertyDefault)
57     {
58         return adoptRef(new ApplyStyleCommand(document, style, start, end, action, level));
59     }
60     static PassRefPtr<ApplyStyleCommand> create(PassRefPtr<Element> element, bool removeOnly = false, EditAction action = EditActionChangeAttributes)
61     {
62         return adoptRef(new ApplyStyleCommand(element, removeOnly, action));
63     }
64     static PassRefPtr<ApplyStyleCommand> create(Document* document, const EditingStyle* style, IsInlineElementToRemoveFunction isInlineElementToRemoveFunction, EditAction action = EditActionChangeAttributes)
65     {
66         return adoptRef(new ApplyStyleCommand(document, style, isInlineElementToRemoveFunction, action));
67     }
68
69 private:
70     ApplyStyleCommand(Document*, const EditingStyle*, EditAction, EPropertyLevel);
71     ApplyStyleCommand(Document*, const EditingStyle*, const Position& start, const Position& end, EditAction, EPropertyLevel);
72     ApplyStyleCommand(PassRefPtr<Element>, bool removeOnly, EditAction);
73     ApplyStyleCommand(Document*, const EditingStyle*, bool (*isInlineElementToRemove)(const Element*), EditAction);
74
75     virtual void doApply();
76     virtual EditAction editingAction() const;
77
78     // style-removal helpers
79     bool isStyledInlineElementToRemove(Element*) const;
80     bool removeStyleFromRunBeforeApplyingStyle(EditingStyle*, RefPtr<Node>& runStart, RefPtr<Node>& runEnd);
81     bool removeInlineStyleFromElement(EditingStyle*, PassRefPtr<HTMLElement>, InlineStyleRemovalMode = RemoveIfNeeded, CSSMutableStyleDeclaration* extractedStyle = 0);
82     inline bool shouldRemoveInlineStyleFromElement(EditingStyle* style, HTMLElement* element) {return removeInlineStyleFromElement(style, element, RemoveNone);}
83     bool removeImplicitlyStyledElement(CSSMutableStyleDeclaration*, HTMLElement*, InlineStyleRemovalMode, CSSMutableStyleDeclaration* extractedStyle);
84     void replaceWithSpanOrRemoveIfWithoutAttributes(HTMLElement*&);
85     bool removeCSSStyle(EditingStyle*, HTMLElement*, InlineStyleRemovalMode = RemoveIfNeeded, CSSMutableStyleDeclaration* extractedStyle = 0);
86     HTMLElement* highestAncestorWithConflictingInlineStyle(EditingStyle*, Node*);
87     void applyInlineStyleToPushDown(Node*, CSSMutableStyleDeclaration*);
88     void pushDownInlineStyleAroundNode(EditingStyle*, Node*);
89     void removeInlineStyle(EditingStyle* , const Position& start, const Position& end);
90     bool nodeFullySelected(Node*, const Position& start, const Position& end) const;
91     bool nodeFullyUnselected(Node*, const Position& start, const Position& end) const;
92
93     // style-application helpers
94     void applyBlockStyle(EditingStyle*);
95     void applyRelativeFontStyleChange(EditingStyle*);
96     void applyInlineStyle(EditingStyle*);
97     void fixRangeAndApplyInlineStyle(EditingStyle*, const Position& start, const Position& end);
98     void applyInlineStyleToNodeRange(EditingStyle*, Node* startNode, Node* pastEndNode);
99     void addBlockStyle(const StyleChange&, HTMLElement*);
100     void addInlineStyleIfNeeded(CSSMutableStyleDeclaration*, PassRefPtr<Node> start, PassRefPtr<Node> end, EAddStyledElement addStyledElement = AddStyledElement);
101     void splitTextAtStart(const Position& start, const Position& end);
102     void splitTextAtEnd(const Position& start, const Position& end);
103     void splitTextElementAtStart(const Position& start, const Position& end);
104     void splitTextElementAtEnd(const Position& start, const Position& end);
105     bool shouldSplitTextElement(Element*, EditingStyle*);
106     bool isValidCaretPositionInTextNode(const Position& position);
107     bool mergeStartWithPreviousIfIdentical(const Position& start, const Position& end);
108     bool mergeEndWithNextIfIdentical(const Position& start, const Position& end);
109     void cleanupUnstyledAppleStyleSpans(Node* dummySpanAncestor);
110
111     void surroundNodeRangeWithElement(PassRefPtr<Node> start, PassRefPtr<Node> end, PassRefPtr<Element>);
112     float computedFontSize(Node*);
113     void joinChildTextNodes(Node*, const Position& start, const Position& end);
114
115     HTMLElement* splitAncestorsWithUnicodeBidi(Node*, bool before, WritingDirection allowedDirection);
116     void removeEmbeddingUpToEnclosingBlock(Node* node, Node* unsplitAncestor);
117
118     void updateStartEnd(const Position& newStart, const Position& newEnd);
119     Position startPosition();
120     Position endPosition();
121
122     RefPtr<EditingStyle> m_style;
123     EditAction m_editingAction;
124     EPropertyLevel m_propertyLevel;
125     Position m_start;
126     Position m_end;
127     bool m_useEndingSelection;
128     RefPtr<Element> m_styledInlineElement;
129     bool m_removeOnly;
130     IsInlineElementToRemoveFunction m_isInlineElementToRemoveFunction;
131 };
132
133 enum LegacyFontSizeMode { AlwaysUseLegacyFontSize, UseLegacyFontSizeOnlyIfPixelValuesMatch };
134 int legacyFontSizeFromCSSValue(Document*, CSSPrimitiveValue*, bool shouldUseFixedFontDefaultSize, LegacyFontSizeMode);
135 bool isStyleSpan(const Node*);
136 PassRefPtr<HTMLElement> createStyleSpanElement(Document*);
137 RefPtr<CSSMutableStyleDeclaration> getPropertiesNotIn(CSSStyleDeclaration* styleWithRedundantProperties, CSSStyleDeclaration* baseStyle);
138
139 } // namespace WebCore
140
141 #endif