initial import
[vuplus_webkit] / Source / WebCore / dom / SelectElement.cpp
1 /*
2  * Copyright (C) 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
3  * Copyright (C) 2011 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #include "config.h"
23 #include "SelectElement.h"
24
25 #include "Attribute.h"
26 #include "Chrome.h"
27 #include "ChromeClient.h"
28 #include "Element.h"
29 #include "Event.h"
30 #include "EventHandler.h"
31 #include "EventNames.h"
32 #include "FormDataList.h"
33 #include "Frame.h"
34 #include "HTMLFormElement.h"
35 #include "HTMLNames.h"
36 #include "HTMLSelectElement.h"
37 #include "KeyboardEvent.h"
38 #include "MouseEvent.h"
39 #include "OptionElement.h"
40 #include "OptionGroupElement.h"
41 #include "Page.h"
42 #include "RenderListBox.h"
43 #include "RenderMenuList.h"
44 #include "SpatialNavigation.h"
45 #include <wtf/Assertions.h>
46 #include <wtf/unicode/CharacterNames.h>
47
48 // Configure platform-specific behavior when focused pop-up receives arrow/space/return keystroke.
49 // (PLATFORM(MAC) and PLATFORM(GTK) are always false in Chromium, hence the extra tests.)
50 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
51 #define ARROW_KEYS_POP_MENU 1
52 #define SPACE_OR_RETURN_POP_MENU 0
53 #elif PLATFORM(GTK) || (PLATFORM(CHROMIUM) && OS(UNIX))
54 #define ARROW_KEYS_POP_MENU 0
55 #define SPACE_OR_RETURN_POP_MENU 1
56 #else
57 #define ARROW_KEYS_POP_MENU 0
58 #define SPACE_OR_RETURN_POP_MENU 0
59 #endif
60
61 using std::min;
62 using std::max;
63 using namespace WTF;
64 using namespace Unicode;
65
66 namespace WebCore {
67
68 static const DOMTimeStamp typeAheadTimeout = 1000;
69
70 enum SkipDirection {
71     SkipBackwards = -1,
72     SkipForwards = 1
73 };
74
75 // Returns the 1st valid item |skip| items from |listIndex| in direction |direction| if there is one.
76 // Otherwise, it returns the valid item closest to that boundary which is past |listIndex| if there is one.
77 // Otherwise, it returns |listIndex|.
78 // Valid means that it is enabled and an option element.
79 static int nextValidIndex(const Vector<Element*>& listItems, int listIndex, SkipDirection direction, int skip)
80 {
81     ASSERT(direction == -1 || direction == 1);
82     int lastGoodIndex = listIndex;
83     int size = listItems.size();
84     for (listIndex += direction; listIndex >= 0 && listIndex < size; listIndex += direction) {
85         --skip;
86         if (!listItems[listIndex]->disabled() && isOptionElement(listItems[listIndex])) {
87             lastGoodIndex = listIndex;
88             if (skip <= 0)
89                 break;
90         }
91     }
92     return lastGoodIndex;
93 }
94
95 static int nextSelectableListIndex(SelectElementData& data, Element* element, int startIndex)
96 {
97     return nextValidIndex(data.listItems(element), startIndex, SkipForwards, 1);
98 }
99
100 static int previousSelectableListIndex(SelectElementData& data, Element* element, int startIndex)
101 {
102     if (startIndex == -1)
103         startIndex = data.listItems(element).size();
104     return nextValidIndex(data.listItems(element), startIndex, SkipBackwards, 1);
105 }
106
107 static int firstSelectableListIndex(SelectElementData& data, Element* element)
108 {
109     const Vector<Element*>& items = data.listItems(element);
110     int index = nextValidIndex(items, items.size(), SkipBackwards, INT_MAX);
111     if (static_cast<unsigned>(index) == items.size())
112         return -1;
113     return index;
114 }
115
116 static int lastSelectableListIndex(SelectElementData& data, Element* element)
117 {
118     return nextValidIndex(data.listItems(element), -1, SkipForwards, INT_MAX);
119 }
120
121 // Returns the index of the next valid item one page away from |startIndex| in direction |direction|.
122 static int nextSelectableListIndexPageAway(SelectElementData& data, Element* element, int startIndex, SkipDirection direction)
123 {
124     const Vector<Element*>& items = data.listItems(element);
125     // Can't use data->size() because renderer forces a minimum size.
126     int pageSize = 0;
127     if (element->renderer()->isListBox())
128         pageSize = toRenderListBox(element->renderer())->size() - 1; // -1 so we still show context
129
130     // One page away, but not outside valid bounds.
131     // If there is a valid option item one page away, the index is chosen.
132     // If there is no exact one page away valid option, returns startIndex or the most far index.
133     int edgeIndex = (direction == SkipForwards) ? 0 : (items.size() - 1);
134     int skipAmount = pageSize + ((direction == SkipForwards) ? startIndex : (edgeIndex - startIndex));
135     return nextValidIndex(items, edgeIndex, direction, skipAmount);
136 }
137
138 void SelectElement::selectAll(SelectElementData& data, Element* element)
139 {
140     ASSERT(!data.usesMenuList());
141     if (!element->renderer() || !data.multiple())
142         return;
143
144     // Save the selection so it can be compared to the new selectAll selection when dispatching change events
145     saveLastSelection(data, element);
146
147     data.setActiveSelectionState(true);
148     setActiveSelectionAnchorIndex(data, element, nextSelectableListIndex(data, element, -1));
149     setActiveSelectionEndIndex(data, previousSelectableListIndex(data, element, -1));
150
151     updateListBoxSelection(data, element, false);
152     listBoxOnChange(data, element);
153 }
154
155 void SelectElement::saveLastSelection(SelectElementData& data, Element* element)
156 {
157     if (data.usesMenuList()) {
158         data.setLastOnChangeIndex(selectedIndex(data, element));
159         return;
160     }
161
162     Vector<bool>& lastOnChangeSelection = data.lastOnChangeSelection(); 
163     lastOnChangeSelection.clear();
164
165     const Vector<Element*>& items = data.listItems(element);
166     for (unsigned i = 0; i < items.size(); ++i) {
167         OptionElement* optionElement = toOptionElement(items[i]);
168         lastOnChangeSelection.append(optionElement && optionElement->selected());
169     }
170 }
171
172 void SelectElement::setActiveSelectionAnchorIndex(SelectElementData& data, Element* element, int index)
173 {
174     data.setActiveSelectionAnchorIndex(index);
175
176     // Cache the selection state so we can restore the old selection as the new selection pivots around this anchor index
177     Vector<bool>& cachedStateForActiveSelection = data.cachedStateForActiveSelection(); 
178     cachedStateForActiveSelection.clear();
179
180     const Vector<Element*>& items = data.listItems(element);
181     for (unsigned i = 0; i < items.size(); ++i) {
182         OptionElement* optionElement = toOptionElement(items[i]);
183         cachedStateForActiveSelection.append(optionElement && optionElement->selected());
184     }
185 }
186
187 void SelectElement::setActiveSelectionEndIndex(SelectElementData& data, int index)
188 {
189     data.setActiveSelectionEndIndex(index);
190 }
191
192 void SelectElement::updateListBoxSelection(SelectElementData& data, Element* element, bool deselectOtherOptions)
193 {
194     ASSERT(element->renderer() && (element->renderer()->isListBox() || data.multiple()));
195     ASSERT(!data.listItems(element).size() || data.activeSelectionAnchorIndex() >= 0);
196
197     unsigned start = min(data.activeSelectionAnchorIndex(), data.activeSelectionEndIndex());
198     unsigned end = max(data.activeSelectionAnchorIndex(), data.activeSelectionEndIndex());
199     Vector<bool>& cachedStateForActiveSelection = data.cachedStateForActiveSelection();
200
201     const Vector<Element*>& items = data.listItems(element);
202     for (unsigned i = 0; i < items.size(); ++i) {
203         OptionElement* optionElement = toOptionElement(items[i]);
204         if (!optionElement || items[i]->disabled())
205             continue;
206
207         if (i >= start && i <= end)
208             optionElement->setSelectedState(data.activeSelectionState());
209         else if (deselectOtherOptions || i >= cachedStateForActiveSelection.size())
210             optionElement->setSelectedState(false);
211         else
212             optionElement->setSelectedState(cachedStateForActiveSelection[i]);
213     }
214
215     toSelectElement(element)->updateValidity();
216     scrollToSelection(data, element);
217 }
218
219 void SelectElement::listBoxOnChange(SelectElementData& data, Element* element)
220 {
221     ASSERT(!data.usesMenuList() || data.multiple());
222
223     Vector<bool>& lastOnChangeSelection = data.lastOnChangeSelection(); 
224     const Vector<Element*>& items = data.listItems(element);
225
226     // If the cached selection list is empty, or the size has changed, then fire dispatchFormControlChangeEvent, and return early.
227     if (lastOnChangeSelection.isEmpty() || lastOnChangeSelection.size() != items.size()) {
228         element->dispatchFormControlChangeEvent();
229         return;
230     }
231
232     // Update lastOnChangeSelection and fire dispatchFormControlChangeEvent
233     bool fireOnChange = false;
234     for (unsigned i = 0; i < items.size(); ++i) {
235         OptionElement* optionElement = toOptionElement(items[i]);
236         bool selected = optionElement &&  optionElement->selected();
237         if (selected != lastOnChangeSelection[i])
238             fireOnChange = true;
239         lastOnChangeSelection[i] = selected;
240     }
241
242     if (fireOnChange)
243         element->dispatchFormControlChangeEvent();
244 }
245
246 void SelectElement::menuListOnChange(SelectElementData& data, Element* element)
247 {
248     ASSERT(data.usesMenuList());
249
250     int selected = selectedIndex(data, element);
251     if (data.lastOnChangeIndex() != selected && data.userDrivenChange()) {
252         data.setLastOnChangeIndex(selected);
253         data.setUserDrivenChange(false);
254         element->dispatchFormControlChangeEvent();
255     }
256 }
257
258 void SelectElement::scrollToSelection(SelectElementData& data, Element* element)
259 {
260     if (data.usesMenuList())
261         return;
262
263     if (RenderObject* renderer = element->renderer())
264         toRenderListBox(renderer)->selectionChanged();
265 }
266
267 void SelectElement::setOptionsChangedOnRenderer(SelectElementData& data, Element* element)
268 {
269     if (RenderObject* renderer = element->renderer()) {
270         if (data.usesMenuList())
271             toRenderMenuList(renderer)->setOptionsChanged(true);
272         else
273             toRenderListBox(renderer)->setOptionsChanged(true);
274     }
275 }
276
277 void SelectElement::setRecalcListItems(SelectElementData& data, Element* element)
278 {
279     data.setShouldRecalcListItems(true);
280     data.setActiveSelectionAnchorIndex(-1); // Manual selection anchor is reset when manipulating the select programmatically.
281     setOptionsChangedOnRenderer(data, element);
282     element->setNeedsStyleRecalc();
283 }
284
285 void SelectElement::recalcListItems(SelectElementData& data, const Element* element, bool updateSelectedStates)
286 {
287     Vector<Element*>& listItems = data.rawListItems();
288     listItems.clear();
289
290     data.setShouldRecalcListItems(false);
291
292     OptionElement* foundSelected = 0;
293     for (Node* currentNode = element->firstChild(); currentNode;) {
294         if (!currentNode->isElementNode()) {
295             currentNode = currentNode->traverseNextSibling(element);
296             continue;
297         }
298
299         Element* current = static_cast<Element*>(currentNode);
300
301         // optgroup tags may not nest. However, both FireFox and IE will
302         // flatten the tree automatically, so we follow suit.
303         // (http://www.w3.org/TR/html401/interact/forms.html#h-17.6)
304         if (isOptionGroupElement(current)) {
305             listItems.append(current);
306             if (current->firstChild()) {
307                 currentNode = current->firstChild();
308                 continue;
309             }
310         }
311
312         if (OptionElement* optionElement = toOptionElement(current)) {
313             listItems.append(current);
314
315             if (updateSelectedStates && !data.multiple()) {
316                 if (!foundSelected && (data.size() <= 1 || optionElement->selected())) {
317                     foundSelected = optionElement;
318                     foundSelected->setSelectedState(true);
319                 } else if (foundSelected && optionElement->selected()) {
320                     foundSelected->setSelectedState(false);
321                     foundSelected = optionElement;
322                 }
323             }
324         }
325
326         if (current->hasTagName(HTMLNames::hrTag))
327             listItems.append(current);
328
329         // In conforming HTML code, only <optgroup> and <option> will be found
330         // within a <select>. We call traverseNextSibling so that we only step
331         // into those tags that we choose to. For web-compat, we should cope
332         // with the case where odd tags like a <div> have been added but we
333         // handle this because such tags have already been removed from the
334         // <select>'s subtree at this point.
335         currentNode = currentNode->traverseNextSibling(element);
336     }
337 }
338
339 int SelectElement::selectedIndex(const SelectElementData& data, const Element* element)
340 {
341     unsigned index = 0;
342
343     // return the number of the first option selected
344     const Vector<Element*>& items = data.listItems(element);
345     for (size_t i = 0; i < items.size(); ++i) {
346         if (OptionElement* optionElement = toOptionElement(items[i])) {
347             if (optionElement->selected())
348                 return index;
349             ++index;
350         }
351     }
352
353     return -1;
354 }
355
356 void SelectElement::setSelectedIndex(SelectElementData& data, Element* element, int optionIndex, bool deselect, bool fireOnChangeNow, bool userDrivenChange)
357 {
358     if (optionIndex == -1 && !deselect && !data.multiple())
359         optionIndex = nextSelectableListIndex(data, element, -1);
360     if (!data.multiple())
361         deselect = true;
362
363     const Vector<Element*>& items = data.listItems(element);
364     int listIndex = optionToListIndex(data, element, optionIndex);
365
366     Element* excludeElement = 0;
367     if (OptionElement* optionElement = (listIndex >= 0 ? toOptionElement(items[listIndex]) : 0)) {
368         excludeElement = items[listIndex];
369         if (data.activeSelectionAnchorIndex() < 0 || deselect)
370             setActiveSelectionAnchorIndex(data, element, listIndex);
371         if (data.activeSelectionEndIndex() < 0 || deselect)
372             setActiveSelectionEndIndex(data, listIndex);
373         optionElement->setSelectedState(true);
374     }
375
376     if (deselect)
377         deselectItems(data, element, excludeElement);
378
379     // For the menu list case, this is what makes the selected element appear.
380     if (RenderObject* renderer = element->renderer())
381         renderer->updateFromElement();
382
383     scrollToSelection(data, element);
384
385     // This only gets called with fireOnChangeNow for menu lists. 
386     if (data.usesMenuList()) {
387         data.setUserDrivenChange(userDrivenChange);
388         if (fireOnChangeNow)
389             menuListOnChange(data, element);
390         RenderObject* renderer = element->renderer();
391         if (renderer) {
392             if (data.usesMenuList())
393                 toRenderMenuList(renderer)->didSetSelectedIndex(listIndex);
394             else if (renderer->isListBox())
395                 toRenderListBox(renderer)->selectionChanged();
396         }
397     }
398
399     toSelectElement(element)->updateValidity();
400     if (Frame* frame = element->document()->frame())
401         frame->page()->chrome()->client()->formStateDidChange(element);
402 }
403
404 int SelectElement::optionToListIndex(const SelectElementData& data, const Element* element, int optionIndex)
405 {
406     const Vector<Element*>& items = data.listItems(element);
407     int listSize = (int) items.size();
408     if (optionIndex < 0 || optionIndex >= listSize)
409         return -1;
410
411     int optionIndex2 = -1;
412     for (int listIndex = 0; listIndex < listSize; ++listIndex) {
413         if (isOptionElement(items[listIndex])) {
414             ++optionIndex2;
415             if (optionIndex2 == optionIndex)
416                 return listIndex;
417         }
418     }
419
420     return -1;
421 }
422
423 int SelectElement::listToOptionIndex(const SelectElementData& data, const Element* element, int listIndex)
424 {
425     const Vector<Element*>& items = data.listItems(element);
426     if (listIndex < 0 || listIndex >= int(items.size()) ||
427         !isOptionElement(items[listIndex]))
428         return -1;
429
430     int optionIndex = 0; // actual index of option not counting OPTGROUP entries that may be in list
431     for (int i = 0; i < listIndex; ++i)
432         if (isOptionElement(items[i]))
433             ++optionIndex;
434
435     return optionIndex;
436 }
437
438 void SelectElement::dispatchFocusEvent(SelectElementData& data, Element* element)
439 {
440     // Save the selection so it can be compared to the new selection when dispatching change events during blur event dispatchal
441     if (data.usesMenuList())
442         saveLastSelection(data, element);
443 }
444
445 void SelectElement::dispatchBlurEvent(SelectElementData& data, Element* element)
446 {
447     // We only need to fire change events here for menu lists, because we fire change events for list boxes whenever the selection change is actually made.
448     // This matches other browsers' behavior.
449     if (data.usesMenuList())
450         menuListOnChange(data, element);
451 }
452
453 void SelectElement::deselectItems(SelectElementData& data, Element* element, Element* excludeElement)
454 {
455     const Vector<Element*>& items = data.listItems(element);
456     for (unsigned i = 0; i < items.size(); ++i) {
457         if (items[i] == excludeElement)
458             continue;
459
460         if (OptionElement* optionElement = toOptionElement(items[i]))
461             optionElement->setSelectedState(false);
462     }
463 }
464
465 bool SelectElement::saveFormControlState(const SelectElementData& data, const Element* element, String& value)
466 {
467     const Vector<Element*>& items = data.listItems(element);
468     int length = items.size();
469
470     // FIXME: Change this code to use the new StringImpl::createUninitialized code path.
471     Vector<char, 1024> characters(length);
472     for (int i = 0; i < length; ++i) {
473         OptionElement* optionElement = toOptionElement(items[i]);
474         bool selected = optionElement && optionElement->selected();
475         characters[i] = selected ? 'X' : '.';
476     }
477
478     value = String(characters.data(), length);
479     return true;
480 }
481
482 void SelectElement::restoreFormControlState(SelectElementData& data, Element* element, const String& state)
483 {
484     recalcListItems(data, element);
485
486     const Vector<Element*>& items = data.listItems(element);
487     int length = items.size();
488
489     for (int i = 0; i < length; ++i) {
490         if (OptionElement* optionElement = toOptionElement(items[i]))
491             optionElement->setSelectedState(state[i] == 'X');
492     }
493
494     setOptionsChangedOnRenderer(data, element);
495 }
496
497 void SelectElement::parseMultipleAttribute(SelectElementData& data, Element* element, Attribute* attribute)
498 {
499     bool oldUsesMenuList = data.usesMenuList();
500     data.setMultiple(!attribute->isNull());
501     toSelectElement(element)->updateValidity();
502     if (oldUsesMenuList != data.usesMenuList() && element->attached()) {
503         element->detach();
504         element->attach();
505     }
506 }
507
508 bool SelectElement::appendFormData(SelectElementData& data, Element* element, FormDataList& list)
509 {
510     const AtomicString& name = element->formControlName();
511     if (name.isEmpty())
512         return false;
513
514     bool successful = false;
515     const Vector<Element*>& items = data.listItems(element);
516
517     for (unsigned i = 0; i < items.size(); ++i) {
518         OptionElement* optionElement = toOptionElement(items[i]);
519         if (optionElement && optionElement->selected() && !optionElement->disabled()) {
520             list.appendData(name, optionElement->value());
521             successful = true;
522         }
523     }
524
525     // It's possible that this is a menulist with multiple options and nothing
526     // will be submitted (!successful). We won't send a unselected non-disabled
527     // option as fallback. This behavior matches to other browsers.
528     return successful;
529
530
531 void SelectElement::reset(SelectElementData& data, Element* element)
532 {
533     OptionElement* firstOption = 0;
534     OptionElement* selectedOption = 0;
535
536     const Vector<Element*>& items = data.listItems(element);
537     for (unsigned i = 0; i < items.size(); ++i) {
538         OptionElement* optionElement = toOptionElement(items[i]);
539         if (!optionElement)
540             continue;
541
542         if (items[i]->fastHasAttribute(HTMLNames::selectedAttr)) {
543             if (selectedOption && !data.multiple())
544                 selectedOption->setSelectedState(false);
545             optionElement->setSelectedState(true);
546             selectedOption = optionElement;
547         } else
548             optionElement->setSelectedState(false);
549
550         if (!firstOption)
551             firstOption = optionElement;
552     }
553
554     if (!selectedOption && firstOption && !data.multiple() && data.size() <= 1)
555         firstOption->setSelectedState(true);
556
557     setOptionsChangedOnRenderer(data, element);
558     element->setNeedsStyleRecalc();
559 }
560
561 #if !PLATFORM(WIN) || OS(WINCE)
562 bool SelectElement::platformHandleKeydownEvent(SelectElementData& data, Element* element, KeyboardEvent* event)
563 {
564 #if ARROW_KEYS_POP_MENU
565     if (!isSpatialNavigationEnabled(element->document()->frame())) {
566         if (event->keyIdentifier() == "Down" || event->keyIdentifier() == "Up") {
567             element->focus();
568
569             // Calling focus() may cause us to lose our renderer. Return true so that our caller doesn't process the event
570             // further, but don't set the event as handled.
571             if (!element->renderer())
572                 return true;
573
574             // Save the selection so it can be compared to the new selection when dispatching change events during setSelectedIndex,
575             // which gets called from RenderMenuList::valueChanged, which gets called after the user makes a selection from the menu.
576             saveLastSelection(data, element);
577             if (RenderMenuList* menuList = toRenderMenuList(element->renderer()))
578                 menuList->showPopup();
579             event->setDefaultHandled();
580         }
581         return true;
582     }
583 #endif
584     return false;
585 }
586 #endif
587
588 void SelectElement::menuListDefaultEventHandler(SelectElementData& data, Element* element, Event* event, HTMLFormElement* htmlForm)
589 {
590     if (event->type() == eventNames().keydownEvent) {
591         if (!element->renderer() || !event->isKeyboardEvent())
592             return;
593
594         if (platformHandleKeydownEvent(data, element, static_cast<KeyboardEvent*>(event)))
595             return;
596
597         // When using spatial navigation, we want to be able to navigate away from the select element
598         // when the user hits any of the arrow keys, instead of changing the selection.
599         if (isSpatialNavigationEnabled(element->document()->frame())) {
600             if (!data.activeSelectionState())
601                 return;
602         }
603
604         const String& keyIdentifier = static_cast<KeyboardEvent*>(event)->keyIdentifier();
605         bool handled = false;
606
607         UNUSED_PARAM(htmlForm);
608         const Vector<Element*>& listItems = data.listItems(element);
609
610         int listIndex = optionToListIndex(data, element, selectedIndex(data, element));
611
612         if (keyIdentifier == "Down" || keyIdentifier == "Right") {
613             listIndex = nextValidIndex(listItems, listIndex, SkipForwards, 1);
614             handled = true;
615         } else if (keyIdentifier == "Up" || keyIdentifier == "Left") {
616             listIndex = nextValidIndex(listItems, listIndex, SkipBackwards, 1);
617             handled = true;
618         } else if (keyIdentifier == "PageDown") {
619             listIndex = nextValidIndex(listItems, listIndex, SkipForwards, 3);
620             handled = true;
621         } else if (keyIdentifier == "PageUp") {
622             listIndex = nextValidIndex(listItems, listIndex, SkipBackwards, 3);
623             handled = true;
624         } else if (keyIdentifier == "Home") {
625             listIndex = nextValidIndex(listItems, -1, SkipForwards, 1);
626             handled = true;
627         } else if (keyIdentifier == "End") {
628             listIndex = nextValidIndex(listItems, listItems.size(), SkipBackwards, 1);
629             handled = true;
630         }
631
632         if (handled && listIndex >= 0 && static_cast<unsigned>(listIndex) < listItems.size())
633             setSelectedIndex(data, element, listToOptionIndex(data, element, listIndex));
634
635         if (handled)
636             event->setDefaultHandled();
637     }
638
639     // Use key press event here since sending simulated mouse events
640     // on key down blocks the proper sending of the key press event.
641     if (event->type() == eventNames().keypressEvent) {
642         if (!element->renderer() || !event->isKeyboardEvent())
643             return;
644
645         int keyCode = static_cast<KeyboardEvent*>(event)->keyCode();
646         bool handled = false;
647
648         if (keyCode == ' ' && isSpatialNavigationEnabled(element->document()->frame())) {
649             // Use space to toggle arrow key handling for selection change or spatial navigation.
650             data.setActiveSelectionState(!data.activeSelectionState());
651             event->setDefaultHandled();
652             return;
653         }
654
655 #if SPACE_OR_RETURN_POP_MENU
656         if (keyCode == ' ' || keyCode == '\r') {
657             element->focus();
658
659             if (!element->renderer()) // Calling focus() may cause us to lose our renderer, in which case do not want to handle the event.
660                 return;
661
662             // Save the selection so it can be compared to the new selection when dispatching change events during setSelectedIndex,
663             // which gets called from RenderMenuList::valueChanged, which gets called after the user makes a selection from the menu.
664             saveLastSelection(data, element);
665             if (RenderMenuList* menuList = toRenderMenuList(element->renderer()))
666                 menuList->showPopup();
667             handled = true;
668         }
669 #elif ARROW_KEYS_POP_MENU
670         if (keyCode == ' ') {
671             element->focus();
672
673             if (!element->renderer()) // Calling focus() may cause us to lose our renderer, in which case do not want to handle the event.
674                 return;
675
676             // Save the selection so it can be compared to the new selection when dispatching change events during setSelectedIndex,
677             // which gets called from RenderMenuList::valueChanged, which gets called after the user makes a selection from the menu.
678             saveLastSelection(data, element);
679             if (RenderMenuList* menuList = toRenderMenuList(element->renderer()))
680                 menuList->showPopup();
681             handled = true;
682         } else if (keyCode == '\r') {
683             if (htmlForm)
684                 htmlForm->submitImplicitly(event, false);
685             menuListOnChange(data, element);
686             handled = true;
687         }
688 #else
689         int listIndex = optionToListIndex(data, element, selectedIndex(data, element));
690         if (keyCode == '\r') {
691             // listIndex should already be selected, but this will fire the onchange handler.
692             setSelectedIndex(data, element, listToOptionIndex(data, element, listIndex), true, true);
693             handled = true;
694         }
695 #endif
696         if (handled)
697             event->setDefaultHandled();
698     }
699
700     if (event->type() == eventNames().mousedownEvent && event->isMouseEvent() && static_cast<MouseEvent*>(event)->button() == LeftButton) {
701         element->focus();
702         if (element->renderer() && element->renderer()->isMenuList()) {
703             if (RenderMenuList* menuList = toRenderMenuList(element->renderer())) {
704                 if (menuList->popupIsVisible())
705                     menuList->hidePopup();
706                 else {
707                     // Save the selection so it can be compared to the new selection when we call onChange during setSelectedIndex,
708                     // which gets called from RenderMenuList::valueChanged, which gets called after the user makes a selection from the menu.
709                     saveLastSelection(data, element);
710                     menuList->showPopup();
711                 }
712             }
713         }
714         event->setDefaultHandled();
715     }
716 }
717
718 void SelectElement::updateSelectedState(SelectElementData& data, Element* element, int listIndex,
719                                         bool multi, bool shift)
720 {
721     ASSERT(listIndex >= 0);
722
723     // Save the selection so it can be compared to the new selection when dispatching change events during mouseup, or after autoscroll finishes.
724     saveLastSelection(data, element);
725
726     data.setActiveSelectionState(true);
727
728     bool shiftSelect = data.multiple() && shift;
729     bool multiSelect = data.multiple() && multi && !shift;
730
731     Element* clickedElement = data.listItems(element)[listIndex];
732     OptionElement* option = toOptionElement(clickedElement);
733     if (option) {
734         // Keep track of whether an active selection (like during drag selection), should select or deselect
735         if (option->selected() && multi)
736             data.setActiveSelectionState(false);
737
738         if (!data.activeSelectionState())
739             option->setSelectedState(false);
740     }
741
742     // If we're not in any special multiple selection mode, then deselect all other items, excluding the clicked option.
743     // If no option was clicked, then this will deselect all items in the list.
744     if (!shiftSelect && !multiSelect)
745         deselectItems(data, element, clickedElement);
746
747     // If the anchor hasn't been set, and we're doing a single selection or a shift selection, then initialize the anchor to the first selected index.
748     if (data.activeSelectionAnchorIndex() < 0 && !multiSelect)
749         setActiveSelectionAnchorIndex(data, element, selectedIndex(data, element));
750
751     // Set the selection state of the clicked option
752     if (option && !clickedElement->disabled())
753         option->setSelectedState(true);
754
755     // If there was no selectedIndex() for the previous initialization, or
756     // If we're doing a single selection, or a multiple selection (using cmd or ctrl), then initialize the anchor index to the listIndex that just got clicked.
757     if (data.activeSelectionAnchorIndex() < 0 || !shiftSelect)
758         setActiveSelectionAnchorIndex(data, element, listIndex);
759
760     setActiveSelectionEndIndex(data, listIndex);
761     updateListBoxSelection(data, element, !multiSelect);
762 }
763
764 void SelectElement::listBoxDefaultEventHandler(SelectElementData& data, Element* element, Event* event, HTMLFormElement* htmlForm)
765 {
766     const Vector<Element*>& listItems = data.listItems(element);
767
768     if (event->type() == eventNames().mousedownEvent && event->isMouseEvent() && static_cast<MouseEvent*>(event)->button() == LeftButton) {
769         element->focus();
770
771         if (!element->renderer()) // Calling focus() may cause us to lose our renderer, in which case do not want to handle the event.
772             return;
773
774         // Convert to coords relative to the list box if needed.
775         MouseEvent* mouseEvent = static_cast<MouseEvent*>(event);
776         IntPoint localOffset = roundedIntPoint(element->renderer()->absoluteToLocal(mouseEvent->absoluteLocation(), false, true));
777         int listIndex = toRenderListBox(element->renderer())->listIndexAtOffset(toSize(localOffset));
778         if (listIndex >= 0) {
779 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
780             updateSelectedState(data, element, listIndex, mouseEvent->metaKey(), mouseEvent->shiftKey());
781 #else
782             updateSelectedState(data, element, listIndex, mouseEvent->ctrlKey(), mouseEvent->shiftKey());
783 #endif
784             if (Frame* frame = element->document()->frame())
785                 frame->eventHandler()->setMouseDownMayStartAutoscroll();
786
787             event->setDefaultHandled();
788         }
789     } else if (event->type() == eventNames().mouseupEvent && event->isMouseEvent() && static_cast<MouseEvent*>(event)->button() == LeftButton && element->document()->frame()->eventHandler()->autoscrollRenderer() != element->renderer()) {
790         // This makes sure we fire dispatchFormControlChangeEvent for a single click.  For drag selection, onChange will fire when the autoscroll timer stops.
791         listBoxOnChange(data, element);
792     } else if (event->type() == eventNames().keydownEvent) {
793         if (!event->isKeyboardEvent())
794             return;
795         const String& keyIdentifier = static_cast<KeyboardEvent*>(event)->keyIdentifier();
796
797         bool handled = false;
798         int endIndex = 0;
799         if (data.activeSelectionEndIndex() < 0) {
800             // Initialize the end index
801             if (keyIdentifier == "Down" || keyIdentifier == "PageDown") {
802                 int startIndex = lastSelectedListIndex(data, element);
803                 handled = true;
804                 if (keyIdentifier == "Down")
805                     endIndex = nextSelectableListIndex(data, element, startIndex);
806                 else
807                     endIndex = nextSelectableListIndexPageAway(data, element, startIndex, SkipForwards);
808             } else if (keyIdentifier == "Up" || keyIdentifier == "PageUp") {
809                 int startIndex = optionToListIndex(data, element, selectedIndex(data, element));
810                 handled = true;
811                 if (keyIdentifier == "Up")
812                     endIndex = previousSelectableListIndex(data, element, startIndex);
813                 else
814                     endIndex = nextSelectableListIndexPageAway(data, element, startIndex, SkipBackwards);
815             }
816         } else {
817             // Set the end index based on the current end index
818             if (keyIdentifier == "Down") {
819                 endIndex = nextSelectableListIndex(data, element, data.activeSelectionEndIndex());
820                 handled = true;
821             } else if (keyIdentifier == "Up") {
822                 endIndex = previousSelectableListIndex(data, element, data.activeSelectionEndIndex());
823                 handled = true;
824             } else if (keyIdentifier == "PageDown") {
825                 endIndex = nextSelectableListIndexPageAway(data, element, data.activeSelectionEndIndex(), SkipForwards);
826                 handled = true;
827             } else if (keyIdentifier == "PageUp") {
828                 endIndex = nextSelectableListIndexPageAway(data, element, data.activeSelectionEndIndex(), SkipBackwards);
829                 handled = true;
830             }
831         }
832         if (keyIdentifier == "Home") {
833             endIndex = firstSelectableListIndex(data, element);
834             handled = true;
835         } else if (keyIdentifier == "End") {
836             endIndex = lastSelectableListIndex(data, element);
837             handled = true;
838         }
839
840         if (isSpatialNavigationEnabled(element->document()->frame()))
841             // Check if the selection moves to the boundary.
842             if (keyIdentifier == "Left" || keyIdentifier == "Right" || ((keyIdentifier == "Down" || keyIdentifier == "Up") && endIndex == data.activeSelectionEndIndex()))
843                 return;
844
845         if (endIndex >= 0 && handled) {
846             // Save the selection so it can be compared to the new selection when dispatching change events immediately after making the new selection.
847             saveLastSelection(data, element);
848
849             ASSERT_UNUSED(listItems, !listItems.size() || (endIndex >= 0 && static_cast<unsigned>(endIndex) < listItems.size()));
850             setActiveSelectionEndIndex(data, endIndex);
851
852             bool selectNewItem = !data.multiple() || static_cast<KeyboardEvent*>(event)->shiftKey() || !isSpatialNavigationEnabled(element->document()->frame());
853             if (selectNewItem)
854                 data.setActiveSelectionState(true);
855             // If the anchor is unitialized, or if we're going to deselect all other options, then set the anchor index equal to the end index.
856             bool deselectOthers = !data.multiple() || (!static_cast<KeyboardEvent*>(event)->shiftKey() && selectNewItem);
857             if (data.activeSelectionAnchorIndex() < 0 || deselectOthers) {
858                 if (deselectOthers)
859                     deselectItems(data, element);
860                 setActiveSelectionAnchorIndex(data, element, data.activeSelectionEndIndex());
861             }
862
863             toRenderListBox(element->renderer())->scrollToRevealElementAtListIndex(endIndex);
864             if (selectNewItem) {
865                 updateListBoxSelection(data, element, deselectOthers);
866                 listBoxOnChange(data, element);
867             } else
868                 scrollToSelection(data, element);
869
870             event->setDefaultHandled();
871         }
872     } else if (event->type() == eventNames().keypressEvent) {
873         if (!event->isKeyboardEvent())
874             return;
875         int keyCode = static_cast<KeyboardEvent*>(event)->keyCode();
876
877         if (keyCode == '\r') {
878             if (htmlForm)
879                 htmlForm->submitImplicitly(event, false);
880             event->setDefaultHandled();
881         } else if (data.multiple() && keyCode == ' ' && isSpatialNavigationEnabled(element->document()->frame())) {
882             // Use space to toggle selection change.
883             data.setActiveSelectionState(!data.activeSelectionState());
884             updateSelectedState(data, element, listToOptionIndex(data, element, data.activeSelectionEndIndex()), true /*multi*/, false /*shift*/);
885             listBoxOnChange(data, element);
886             event->setDefaultHandled();
887         }
888     }
889 }
890
891 void SelectElement::defaultEventHandler(SelectElementData& data, Element* element, Event* event, HTMLFormElement* htmlForm)
892 {
893     if (!element->renderer())
894         return;
895
896     if (data.usesMenuList())
897         menuListDefaultEventHandler(data, element, event, htmlForm);
898     else 
899         listBoxDefaultEventHandler(data, element, event, htmlForm);
900
901     if (event->defaultHandled())
902         return;
903
904     if (event->type() == eventNames().keypressEvent && event->isKeyboardEvent()) {
905         KeyboardEvent* keyboardEvent = static_cast<KeyboardEvent*>(event);
906         if (!keyboardEvent->ctrlKey() && !keyboardEvent->altKey() && !keyboardEvent->metaKey() && isPrintableChar(keyboardEvent->charCode())) {
907             typeAheadFind(data, element, keyboardEvent);
908             event->setDefaultHandled();
909             return;
910         }
911     }
912 }
913
914 int SelectElement::lastSelectedListIndex(const SelectElementData& data, const Element* element)
915 {
916     // return the number of the last option selected
917     unsigned index = 0;
918     bool found = false;
919     const Vector<Element*>& items = data.listItems(element);
920     for (size_t i = 0; i < items.size(); ++i) {
921         if (OptionElement* optionElement = toOptionElement(items[i])) {
922             if (optionElement->selected()) {
923                 index = i;
924                 found = true;
925             }
926         }
927     }
928
929     return found ? (int) index : -1;
930 }
931
932 static String stripLeadingWhiteSpace(const String& string)
933 {
934     int length = string.length();
935
936     int i;
937     for (i = 0; i < length; ++i) {
938         if (string[i] != noBreakSpace && (string[i] <= 0x7F ? !isASCIISpace(string[i]) : (direction(string[i]) != WhiteSpaceNeutral)))
939             break;
940     }
941
942     return string.substring(i, length - i);
943 }
944
945 void SelectElement::typeAheadFind(SelectElementData& data, Element* element, KeyboardEvent* event)
946 {
947     if (event->timeStamp() < data.lastCharTime())
948         return;
949
950     DOMTimeStamp delta = event->timeStamp() - data.lastCharTime();
951     data.setLastCharTime(event->timeStamp());
952
953     UChar c = event->charCode();
954
955     String prefix;
956     int searchStartOffset = 1;
957     if (delta > typeAheadTimeout) {
958         prefix = String(&c, 1);
959         data.setTypedString(prefix);
960         data.setRepeatingChar(c);
961     } else {
962         data.typedString().append(c);
963
964         if (c == data.repeatingChar())
965             // The user is likely trying to cycle through all the items starting with this character, so just search on the character
966             prefix = String(&c, 1);
967         else {
968             data.setRepeatingChar(0);
969             prefix = data.typedString();
970             searchStartOffset = 0;
971         }
972     }
973
974     const Vector<Element*>& items = data.listItems(element);
975     int itemCount = items.size();
976     if (itemCount < 1)
977         return;
978
979     int selected = selectedIndex(data, element);
980     int index = (optionToListIndex(data, element, selected >= 0 ? selected : 0) + searchStartOffset) % itemCount;
981     ASSERT(index >= 0);
982
983     // Compute a case-folded copy of the prefix string before beginning the search for
984     // a matching element. This code uses foldCase to work around the fact that
985     // String::startWith does not fold non-ASCII characters. This code can be changed
986     // to use startWith once that is fixed.
987     String prefixWithCaseFolded(prefix.foldCase());
988     for (int i = 0; i < itemCount; ++i, index = (index + 1) % itemCount) {
989         OptionElement* optionElement = toOptionElement(items[index]);
990         if (!optionElement || items[index]->disabled())
991             continue;
992
993         // Fold the option string and check if its prefix is equal to the folded prefix.
994         String text = optionElement->textIndentedToRespectGroupLabel();
995         if (stripLeadingWhiteSpace(text).foldCase().startsWith(prefixWithCaseFolded)) {
996             setSelectedIndex(data, element, listToOptionIndex(data, element, index));
997             if (!data.usesMenuList())
998                 listBoxOnChange(data, element);
999
1000             setOptionsChangedOnRenderer(data, element);
1001             element->setNeedsStyleRecalc();
1002             return;
1003         }
1004     }
1005 }
1006
1007 void SelectElement::insertedIntoTree(SelectElementData& data, Element* element)
1008 {
1009     // When the element is created during document parsing, it won't have any items yet - but for innerHTML
1010     // and related methods, this method is called after the whole subtree is constructed.
1011     recalcListItems(data, element, true);
1012 }
1013
1014 void SelectElement::accessKeySetSelectedIndex(SelectElementData& data, Element* element, int index)
1015 {    
1016     // first bring into focus the list box
1017     if (!element->focused())
1018         element->accessKeyAction(false);
1019     
1020     // if this index is already selected, unselect. otherwise update the selected index
1021     const Vector<Element*>& items = data.listItems(element);
1022     int listIndex = optionToListIndex(data, element, index);
1023     if (OptionElement* optionElement = (listIndex >= 0 ? toOptionElement(items[listIndex]) : 0)) {
1024         if (optionElement->selected())
1025             optionElement->setSelectedState(false);
1026         else
1027             setSelectedIndex(data, element, index, false, true);
1028     }
1029
1030     if (data.usesMenuList())
1031         menuListOnChange(data, element);
1032     else
1033         listBoxOnChange(data, element);
1034
1035     scrollToSelection(data, element);
1036 }
1037
1038 unsigned SelectElement::optionCount(const SelectElementData& data, const Element* element)
1039 {
1040     unsigned options = 0;
1041
1042     const Vector<Element*>& items = data.listItems(element);
1043     for (unsigned i = 0; i < items.size(); ++i) {
1044         if (isOptionElement(items[i]))
1045             ++options;
1046     }
1047
1048     return options;
1049 }
1050
1051 // SelectElementData
1052 SelectElementData::SelectElementData()
1053     : m_lastCharTime(0)
1054     , m_repeatingChar(0)
1055     , m_size(0)
1056     , m_lastOnChangeIndex(-1)
1057     , m_activeSelectionAnchorIndex(-1)
1058     , m_activeSelectionEndIndex(-1)
1059     , m_userDrivenChange(false)
1060     , m_multiple(false)
1061     , m_activeSelectionState(false)
1062     , m_recalcListItems(false)
1063 {
1064 }
1065
1066 SelectElementData::~SelectElementData()
1067 {
1068 }
1069
1070 void SelectElementData::checkListItems(const Element* element) const
1071 {
1072 #if !ASSERT_DISABLED
1073     Vector<Element*> items = m_listItems;
1074     SelectElement::recalcListItems(*const_cast<SelectElementData*>(this), element, false);
1075     ASSERT(items == m_listItems);
1076 #else
1077     UNUSED_PARAM(element);
1078 #endif
1079 }
1080
1081 Vector<Element*>& SelectElementData::listItems(const Element* element)
1082 {
1083     if (m_recalcListItems)
1084         SelectElement::recalcListItems(*this, element);
1085     else
1086         checkListItems(element);
1087
1088     return m_listItems;
1089 }
1090
1091 const Vector<Element*>& SelectElementData::listItems(const Element* element) const
1092 {
1093     if (m_recalcListItems)
1094         SelectElement::recalcListItems(*const_cast<SelectElementData*>(this), element);
1095     else
1096         checkListItems(element);
1097
1098     return m_listItems;
1099 }
1100
1101 SelectElement* toSelectElement(Element* element)
1102 {
1103     if (element->isHTMLElement() && element->hasTagName(HTMLNames::selectTag))
1104         return static_cast<HTMLSelectElement*>(element);
1105     return 0;
1106 }
1107
1108 }