1ba129c638fca2b711b651f37c557fc2d9e140ab
[WebKit-https.git] / Source / WebCore / html / SearchInputType.cpp
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include "config.h"
33 #include "SearchInputType.h"
34
35 #include "HTMLInputElement.h"
36 #include "HTMLNames.h"
37 #include "InputTypeNames.h"
38 #include "KeyboardEvent.h"
39 #include "RenderSearchField.h"
40 #include "ShadowRoot.h"
41 #include "TextControlInnerElements.h"
42
43 namespace WebCore {
44
45 using namespace HTMLNames;
46
47 SearchInputType::SearchInputType(HTMLInputElement& element)
48     : BaseTextInputType(element)
49     , m_resultsButton(nullptr)
50     , m_cancelButton(nullptr)
51     , m_searchEventTimer(*this, &SearchInputType::searchEventTimerFired)
52 {
53 }
54
55 void SearchInputType::addSearchResult()
56 {
57 #if !PLATFORM(IOS)
58     if (auto* renderer = element().renderer())
59         downcast<RenderSearchField>(*renderer).addSearchResult();
60 #endif
61 }
62
63 static void updateResultButtonPseudoType(SearchFieldResultsButtonElement& resultButton, int maxResults)
64 {
65     if (!maxResults)
66         resultButton.setPseudo(AtomicString("-webkit-search-results-decoration", AtomicString::ConstructFromLiteral));
67     else if (maxResults < 0)
68         resultButton.setPseudo(AtomicString("-webkit-search-decoration", AtomicString::ConstructFromLiteral));
69     else if (maxResults > 0)
70         resultButton.setPseudo(AtomicString("-webkit-search-results-button", AtomicString::ConstructFromLiteral));
71 }
72
73 void SearchInputType::maxResultsAttributeChanged()
74 {
75     if (m_resultsButton)
76         updateResultButtonPseudoType(*m_resultsButton, element().maxResults());
77 }
78
79 RenderPtr<RenderElement> SearchInputType::createInputRenderer(RenderStyle&& style)
80 {
81     return createRenderer<RenderSearchField>(element(), WTFMove(style));
82 }
83
84 const AtomicString& SearchInputType::formControlType() const
85 {
86     return InputTypeNames::search();
87 }
88
89 bool SearchInputType::isSearchField() const
90 {
91     return true;
92 }
93
94 bool SearchInputType::needsContainer() const
95 {
96     return true;
97 }
98
99 void SearchInputType::createShadowSubtree()
100 {
101     ASSERT(!m_resultsButton);
102     ASSERT(!m_cancelButton);
103
104     TextFieldInputType::createShadowSubtree();
105     HTMLElement* container = containerElement();
106     HTMLElement* textWrapper = innerBlockElement();
107     ASSERT(container);
108     ASSERT(textWrapper);
109
110     auto resultsButton = SearchFieldResultsButtonElement::create(element().document());
111     m_resultsButton = resultsButton.ptr();
112     updateResultButtonPseudoType(resultsButton.get(), element().maxResults());
113     container->insertBefore(resultsButton, textWrapper, IGNORE_EXCEPTION);
114
115     auto cancelButton = SearchFieldCancelButtonElement::create(element().document());
116     m_cancelButton = cancelButton.ptr();
117     container->insertBefore(cancelButton, textWrapper->nextSibling(), IGNORE_EXCEPTION);
118 }
119
120 HTMLElement* SearchInputType::resultsButtonElement() const
121 {
122     return m_resultsButton;
123 }
124
125 HTMLElement* SearchInputType::cancelButtonElement() const
126 {
127     return m_cancelButton;
128 }
129
130 void SearchInputType::handleKeydownEvent(KeyboardEvent* event)
131 {
132     if (element().isDisabledOrReadOnly()) {
133         TextFieldInputType::handleKeydownEvent(event);
134         return;
135     }
136
137     const String& key = event->keyIdentifier();
138     if (key == "U+001B") {
139         Ref<HTMLInputElement> input(this->element());
140         input->setValueForUser(emptyString());
141         input->onSearch();
142         event->setDefaultHandled();
143         return;
144     }
145     TextFieldInputType::handleKeydownEvent(event);
146 }
147
148 void SearchInputType::destroyShadowSubtree()
149 {
150     TextFieldInputType::destroyShadowSubtree();
151     m_resultsButton = nullptr;
152     m_cancelButton = nullptr;
153 }
154
155 void SearchInputType::startSearchEventTimer()
156 {
157     ASSERT(element().renderer());
158     unsigned length = element().innerTextValue().length();
159
160     if (!length) {
161         stopSearchEventTimer();
162         element().onSearch();
163         return;
164     }
165
166     // After typing the first key, we wait 0.5 seconds.
167     // After the second key, 0.4 seconds, then 0.3, then 0.2 from then on.
168     m_searchEventTimer.startOneShot(std::max(0.2, 0.6 - 0.1 * length));
169 }
170
171 void SearchInputType::stopSearchEventTimer()
172 {
173     m_searchEventTimer.stop();
174 }
175
176 void SearchInputType::searchEventTimerFired()
177 {
178     element().onSearch();
179 }
180
181 bool SearchInputType::searchEventsShouldBeDispatched() const
182 {
183     return element().hasAttributeWithoutSynchronization(incrementalAttr);
184 }
185
186 void SearchInputType::didSetValueByUserEdit()
187 {
188     if (m_cancelButton && element().renderer())
189         downcast<RenderSearchField>(*element().renderer()).updateCancelButtonVisibility();
190
191     // If the incremental attribute is set, then dispatch the search event
192     if (searchEventsShouldBeDispatched())
193         startSearchEventTimer();
194
195     TextFieldInputType::didSetValueByUserEdit();
196 }
197
198 bool SearchInputType::sizeShouldIncludeDecoration(int, int& preferredSize) const
199 {
200     preferredSize = element().size();
201     return true;
202 }
203
204 float SearchInputType::decorationWidth() const
205 {
206     float width = 0;
207     if (m_resultsButton)
208         width += m_resultsButton->computedStyle()->logicalWidth().value();
209     if (m_cancelButton)
210         width += m_cancelButton->computedStyle()->logicalWidth().value();
211     return width;
212 }
213
214 } // namespace WebCore