6bb8ad5d03c9829740bc08dd1f91c554f610b3db
[WebKit-https.git] / WebCore / editing / FormatBlockCommand.cpp
1 /*
2  * Copyright (C) 2006 Apple Computer, 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 #include "config.h"
27 #include "Element.h"
28 #include "FormatBlockCommand.h"
29 #include "Document.h"
30 #include "htmlediting.h"
31 #include "HTMLElement.h"
32 #include "HTMLNames.h"
33 #include "visible_units.h"
34
35 namespace WebCore {
36
37 using namespace HTMLNames;
38
39 FormatBlockCommand::FormatBlockCommand(Document* document, const AtomicString& tagName) 
40     : CompositeEditCommand(document), m_tagName(tagName)
41 {
42 }
43
44 void FormatBlockCommand::doApply()
45 {
46     if (!endingSelection().isNonOrphanedCaretOrRange())
47         return;
48     
49     if (!endingSelection().rootEditableElement())
50         return;
51
52     VisiblePosition visibleEnd = endingSelection().visibleEnd();
53     VisiblePosition visibleStart = endingSelection().visibleStart();
54     // When a selection ends at the start of a paragraph, we rarely paint 
55     // the selection gap before that paragraph, because there often is no gap.  
56     // In a case like this, it's not obvious to the user that the selection 
57     // ends "inside" that paragraph, so it would be confusing if FormatBlock
58     // operated on that paragraph.
59     // FIXME: We paint the gap before some paragraphs that are indented with left 
60     // margin/padding, but not others.  We should make the gap painting more consistent and 
61     // then use a left margin/padding rule here.
62     if (visibleEnd != visibleStart && isStartOfParagraph(visibleEnd)) {
63         setEndingSelection(VisibleSelection(visibleStart, visibleEnd.previous(true)));
64         visibleEnd = endingSelection().visibleEnd();
65     }
66
67     VisiblePosition startOfLastParagraph = startOfParagraph(visibleEnd);
68     if (endingSelection().isCaret() || startOfParagraph(visibleStart) == startOfLastParagraph) {
69         doApplyForSingleParagraph();
70         return;
71     }
72
73     setEndingSelection(visibleStart);
74     doApplyForSingleParagraph();
75     visibleStart = endingSelection().visibleStart();
76     VisiblePosition nextParagraph = endOfParagraph(visibleStart).next();
77     while (nextParagraph.isNotNull() && nextParagraph != startOfLastParagraph) {
78         setEndingSelection(nextParagraph);
79         doApplyForSingleParagraph();
80         nextParagraph = endOfParagraph(endingSelection().visibleStart()).next();
81     }
82     setEndingSelection(visibleEnd);
83     doApplyForSingleParagraph();
84     visibleEnd = endingSelection().visibleEnd();
85
86     setEndingSelection(VisibleSelection(visibleStart.deepEquivalent(), visibleEnd.deepEquivalent(), DOWNSTREAM));
87 }
88
89 void FormatBlockCommand::doApplyForSingleParagraph()
90 {
91     ExceptionCode ec;
92     String localName, prefix;
93     if (!Document::parseQualifiedName(m_tagName, prefix, localName, ec))
94         return;
95     QualifiedName qTypeOfBlock(prefix, localName, xhtmlNamespaceURI);
96
97     Node* refNode = enclosingBlockFlowElement(endingSelection().visibleStart());
98     if (refNode->hasTagName(qTypeOfBlock))
99         // We're already in a block with the format we want, so we don't have to do anything
100         return;
101
102     VisiblePosition paragraphStart = startOfParagraph(endingSelection().visibleStart());
103     VisiblePosition paragraphEnd = endOfParagraph(endingSelection().visibleStart());
104     VisiblePosition blockStart = startOfBlock(endingSelection().visibleStart());
105     VisiblePosition blockEnd = endOfBlock(endingSelection().visibleStart());
106     RefPtr<Element> blockNode = createHTMLElement(document(), m_tagName);
107     RefPtr<Element> placeholder = createBreakElement(document());
108
109     Node* root = endingSelection().start().node()->rootEditableElement();
110     if (validBlockTag(refNode->nodeName().lower()) && 
111         paragraphStart == blockStart && paragraphEnd == blockEnd && 
112         refNode != root && !root->isDescendantOf(refNode))
113         // Already in a valid block tag that only contains the current paragraph, so we can swap with the new tag
114         insertNodeBefore(blockNode, refNode);
115     else {
116         // Avoid inserting inside inline elements that surround paragraphStart with upstream().
117         // This is only to avoid creating bloated markup.
118         insertNodeAt(blockNode, paragraphStart.deepEquivalent().upstream());
119     }
120     appendNode(placeholder, blockNode);
121
122     VisiblePosition destination(Position(placeholder.get(), 0));
123     if (paragraphStart == paragraphEnd && !lineBreakExistsAtVisiblePosition(paragraphStart)) {
124         setEndingSelection(destination);
125         return;
126     }
127     moveParagraph(paragraphStart, paragraphEnd, destination, true, false);
128 }
129
130 }