WebCore:
[WebKit-https.git] / WebCore / editing / Editor.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 "Editor.h"
28
29 #include "EditorClient.h"
30 #include "Frame.h"
31 #include "HTMLElement.h"
32 #include "Range.h"
33 #include "Sound.h"
34
35 namespace WebCore {
36
37 // implement as platform-specific
38 Pasteboard generalPasteboard()
39 {
40     return 0;
41 }
42
43 bool Editor::canCopy()
44 { return false; }
45
46 bool Editor::canCut()
47 { return false; }
48
49 bool Editor::canDelete()
50 { return false; }
51
52 bool Editor::canDeleteRange(Range* range)
53 {
54     ExceptionCode ec = 0;
55     Node *startContainer = range->startContainer(ec);
56     Node *endContainer = range->endContainer(ec);
57     if (!startContainer || !endContainer)
58         return false;
59     
60     if (!startContainer->isContentEditable() || !endContainer->isContentEditable())
61         return false;
62     
63     if (range->collapsed(ec)) {
64         VisiblePosition start(startContainer, range->startOffset(ec), DOWNSTREAM);
65         VisiblePosition previous = start.previous();
66         // FIXME: We sometimes allow deletions at the start of editable roots, like when the caret is in an empty list item.
67         if (previous.isNull() || previous.deepEquivalent().node()->rootEditableElement() != startContainer->rootEditableElement())
68             return false;
69     }
70     return true;
71 }
72
73 bool Editor::canPaste()
74 { return false; }
75
76 bool Editor::canSmartCopyOrDelete()
77 { return false; }
78
79 void Editor::deleteSelection()
80 {}
81
82 void Editor::deleteSelectionWithSmartDelete(bool enabled)
83 {}
84
85 bool Editor::isSelectionRichlyEditable()
86 { return false; }
87
88 void Editor::pasteAsPlainTextWithPasteboard(Pasteboard pasteboard)
89 {}
90
91 void Editor::pasteWithPasteboard(Pasteboard pasteboard, bool allowPlainText)
92 {}
93
94 Range* Editor::selectedRange()
95 { return NULL; }
96
97 bool Editor::shouldDeleteRange(Range* range)
98 {
99     ExceptionCode ec;
100     if (!range || range->collapsed(ec))
101         return false;
102     
103     if (!canDeleteRange(range))
104         return false;
105
106     return m_client->shouldDeleteRange(range);
107  }
108
109 bool Editor::tryDHTMLCopy()
110 {
111     bool handled = false;
112     return handled;
113 }
114
115 bool Editor::tryDHTMLCut()
116 {
117     bool handled = false;
118     return handled;
119 }
120
121 bool Editor::tryDHTMLPaste()
122 {
123     bool handled = false;
124     return handled;
125 }
126
127 void Editor::writeSelectionToPasteboard(Pasteboard pasteboard)
128 {}
129
130 bool Editor::shouldShowDeleteInterface(HTMLElement* element)
131 {
132     return m_client->shouldShowDeleteInterface(element);
133 }
134
135 // =============================================================================
136 //
137 // public editing commands
138 //
139 // =============================================================================
140
141 Editor::Editor(Frame* frame, EditorClient* client)
142     : m_frame(frame)
143     , m_client(client)
144     , m_deleteButtonController(this)
145
146 }
147
148 Editor::~Editor()
149 {
150 }
151
152 void Editor::cut()
153 {
154     if (tryDHTMLCut())
155         return; // DHTML did the whole operation
156     if (!canCut()) {
157         systemBeep();
158         return;
159     }
160     
161     if (shouldDeleteRange(selectedRange())) {
162         writeSelectionToPasteboard(generalPasteboard());
163         deleteSelectionWithSmartDelete(canSmartCopyOrDelete());
164     }
165 }
166
167 void Editor::copy()
168 {
169
170     if (tryDHTMLCopy())
171         return; // DHTML did the whole operation
172     if (!canCopy()) {
173         systemBeep();
174         return;
175     }
176     writeSelectionToPasteboard(generalPasteboard());
177 }
178
179 void Editor::paste()
180 {
181     if (tryDHTMLPaste())
182         return;     // DHTML did the whole operation
183     if (!canPaste())
184         return;
185     if (isSelectionRichlyEditable())
186         pasteWithPasteboard(generalPasteboard(), true);
187     else
188         pasteAsPlainTextWithPasteboard(generalPasteboard());
189 }
190
191 void Editor::performDelete()
192 {
193     if (!canDelete()) {
194         systemBeep();
195         return;
196     }
197     deleteSelection();
198 }
199
200 } // namespace WebCore