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
  31 namespace WebCore {
  32
  33 class CSSPrimitiveValue;
  34 class HTMLElement;
  35 class StyleChange;
  36
  37 enum ShouldIncludeTypingStyle {
  38     IncludeTypingStyle,
  39     IgnoreTypingStyle
  40 };
  41
  42 class ApplyStyleCommand : public CompositeEditCommand {
  43 public:
  44     enum EPropertyLevel { PropertyDefault, ForceBlockProperties };
  45     enum InlineStyleRemovalMode { RemoveAttributesAndElements, RemoveNone };
  46     enum EAddStyledElement { AddStyledElement, DoNotAddStyledElement };
  47
  48     static PassRefPtr<ApplyStyleCommand> create(Document* document, CSSStyleDeclaration* style, EditAction action = EditActionChangeAttributes, EPropertyLevel level = PropertyDefault)
  49     {
  50         return adoptRef(new ApplyStyleCommand(document, style, action, level));
  51     }
  52     static PassRefPtr<ApplyStyleCommand> create(Document* document, CSSStyleDeclaration* style, const Position& start, const Position& end, EditAction action = EditActionChangeAttributes, EPropertyLevel level = PropertyDefault)
  53     {
  54         return adoptRef(new ApplyStyleCommand(document, style, start, end, action, level));
  55     }
  56     static PassRefPtr<ApplyStyleCommand> create(PassRefPtr<Element> element, bool removeOnly = false, EditAction action = EditActionChangeAttributes)
  57     {
  58         return adoptRef(new ApplyStyleCommand(element, removeOnly, action));
  59     }
  60
  61     static PassRefPtr<CSSMutableStyleDeclaration> editingStyleAtPosition(Position pos, ShouldIncludeTypingStyle shouldIncludeTypingStyle = IgnoreTypingStyle);
  62
  63 private:
  64     ApplyStyleCommand(Document*, CSSStyleDeclaration*, EditAction, EPropertyLevel);
  65     ApplyStyleCommand(Document*, CSSStyleDeclaration*, const Position& start, const Position& end, EditAction, EPropertyLevel);
  66     ApplyStyleCommand(PassRefPtr<Element>, bool removeOnly, EditAction);
  67
  68     virtual void doApply();
  69     virtual EditAction editingAction() const;
  70
  71     CSSMutableStyleDeclaration* style() const { return m_style.get(); }
  72
  73     // style-removal helpers
  74     bool shouldRemoveTextDecorationTag(CSSStyleDeclaration* styleToApply, int textDecorationAddedByTag) const;
  75     bool implicitlyStyledElementShouldBeRemovedWhenApplyingStyle(HTMLElement*, CSSMutableStyleDeclaration*);
  76     bool removeInlineStyleFromElement(CSSMutableStyleDeclaration*, HTMLElement*, InlineStyleRemovalMode = RemoveAttributesAndElements);
  77     inline bool shouldRemoveInlineStyleFromElement(CSSMutableStyleDeclaration* style, HTMLElement* element) {return removeInlineStyleFromElement(style, element, RemoveNone);}
  78     void replaceWithSpanOrRemoveIfWithoutAttributes(HTMLElement*&);
  79     bool removeHTMLFontStyle(CSSMutableStyleDeclaration*, HTMLElement*, InlineStyleRemovalMode = RemoveAttributesAndElements);
  80     bool removeHTMLBidiEmbeddingStyle(CSSMutableStyleDeclaration*, HTMLElement*, InlineStyleRemovalMode = RemoveAttributesAndElements);
  81     bool removeCSSStyle(CSSMutableStyleDeclaration*, HTMLElement*, InlineStyleRemovalMode = RemoveAttributesAndElements);
  82     HTMLElement* highestAncestorWithConflictingInlineStyle(CSSMutableStyleDeclaration*, Node*);
  83     PassRefPtr<CSSMutableStyleDeclaration> extractInlineStyleToPushDown(Node*, bool isStyledElement, const Vector<int>&);
  84     void applyInlineStyleToPushDown(Node*, CSSMutableStyleDeclaration *style);
  85     void pushDownInlineStyleAroundNode(CSSMutableStyleDeclaration*, Node*);
  86     void removeInlineStyle(PassRefPtr<CSSMutableStyleDeclaration>, const Position& start, const Position& end);
  87     bool nodeFullySelected(Node*, const Position& start, const Position& end) const;
  88     bool nodeFullyUnselected(Node*, const Position& start, const Position& end) const;
  89
  90     // style-application helpers
  91     void applyBlockStyle(CSSMutableStyleDeclaration*);
  92     void applyRelativeFontStyleChange(CSSMutableStyleDeclaration*);
  93     void applyInlineStyle(CSSMutableStyleDeclaration*);
  94     void applyInlineStyleToRange(CSSMutableStyleDeclaration*, const Position& start, const Position& end);
  95     void addBlockStyle(const StyleChange&, HTMLElement*);
  96     void addInlineStyleIfNeeded(CSSMutableStyleDeclaration*, Node* start, Node* end, EAddStyledElement addStyledElement = AddStyledElement);
  97     void splitTextAtStart(const Position& start, const Position& end);
  98     void splitTextAtEnd(const Position& start, const Position& end);
  99     void splitTextElementAtStart(const Position& start, const Position& end);
 100     void splitTextElementAtEnd(const Position& start, const Position& end);
 101     bool shouldSplitTextElement(Element* elem, CSSMutableStyleDeclaration*);
 102     bool isValidCaretPositionInTextNode(const Position& position);
 103     bool mergeStartWithPreviousIfIdentical(const Position& start, const Position& end);
 104     bool mergeEndWithNextIfIdentical(const Position& start, const Position& end);
 105     void cleanupUnstyledAppleStyleSpans(Node* dummySpanAncestor);
 106
 107     void surroundNodeRangeWithElement(Node* start, Node* end, PassRefPtr<Element>);
 108     float computedFontSize(const Node*);
 109     void joinChildTextNodes(Node*, const Position& start, const Position& end);
 110
 111     HTMLElement* splitAncestorsWithUnicodeBidi(Node*, bool before, int allowedDirection);
 112     void removeEmbeddingUpToEnclosingBlock(Node* node, Node* unsplitAncestor);
 113
 114     void updateStartEnd(const Position& newStart, const Position& newEnd);
 115     Position startPosition();
 116     Position endPosition();
 117
 118     RefPtr<CSSMutableStyleDeclaration> m_style;
 119     EditAction m_editingAction;
 120     EPropertyLevel m_propertyLevel;
 121     Position m_start;
 122     Position m_end;
 123     bool m_useEndingSelection;
 124     RefPtr<Element> m_styledInlineElement;
 125     bool m_removeOnly;
 126 };
 127
 128 bool isStyleSpan(const Node*);
 129 PassRefPtr<HTMLElement> createStyleSpanElement(Document*);
 130 RefPtr<CSSMutableStyleDeclaration> getPropertiesNotInComputedStyle(CSSStyleDeclaration* style, CSSComputedStyleDeclaration* computedStyle);
 131
 132 void prepareEditingStyleToApplyAt(CSSMutableStyleDeclaration*, Position);
 133 void removeStylesAddedByNode(CSSMutableStyleDeclaration*, Node*);
 134
 135 } // namespace WebCore
 136
 137 #endif