Follow up the recent HTMLSelectElement improvements with a little bit more
[WebKit-https.git] / Source / WebCore / rendering / RenderMenuList.cpp
1 /*
2  * This file is part of the select element renderer in WebCore.
3  *
4  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
5  * Copyright (C) 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
6  *               2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #include "config.h"
26 #include "RenderMenuList.h"
27
28 #include "AXObjectCache.h"
29 #include "AccessibilityMenuList.h"
30 #include "CSSFontSelector.h"
31 #include "CSSStyleSelector.h"
32 #include "Chrome.h"
33 #include "FontCache.h"
34 #include "Frame.h"
35 #include "FrameView.h"
36 #include "HTMLNames.h"
37 #include "HTMLOptGroupElement.h"
38 #include "HTMLSelectElement.h"
39 #include "NodeRenderStyle.h"
40 #include "OptionElement.h"
41 #include "Page.h"
42 #include "PopupMenu.h"
43 #include "RenderBR.h"
44 #include "RenderScrollbar.h"
45 #include "RenderTheme.h"
46 #include "TextRun.h"
47 #include <math.h>
48
49 using namespace std;
50
51 namespace WebCore {
52
53 using namespace HTMLNames;
54
55 RenderMenuList::RenderMenuList(Element* element)
56     : RenderDeprecatedFlexibleBox(element)
57     , m_buttonText(0)
58     , m_innerBlock(0)
59     , m_optionsChanged(true)
60     , m_optionsWidth(0)
61     , m_lastActiveIndex(-1)
62     , m_popupIsVisible(false)
63 {
64     ASSERT(element);
65     ASSERT(element->isHTMLElement());
66     ASSERT(element->hasTagName(HTMLNames::selectTag));
67 }
68
69 RenderMenuList::~RenderMenuList()
70 {
71     if (m_popup)
72         m_popup->disconnectClient();
73     m_popup = 0;
74 }
75
76 void RenderMenuList::createInnerBlock()
77 {
78     if (m_innerBlock) {
79         ASSERT(firstChild() == m_innerBlock);
80         ASSERT(!m_innerBlock->nextSibling());
81         return;
82     }
83
84     // Create an anonymous block.
85     ASSERT(!firstChild());
86     m_innerBlock = createAnonymousBlock();
87     adjustInnerStyle();
88     RenderDeprecatedFlexibleBox::addChild(m_innerBlock);
89 }
90
91 void RenderMenuList::adjustInnerStyle()
92 {
93     RenderStyle* innerStyle = m_innerBlock->style();
94     innerStyle->setBoxFlex(1);
95     
96     innerStyle->setPaddingLeft(Length(theme()->popupInternalPaddingLeft(style()), Fixed));
97     innerStyle->setPaddingRight(Length(theme()->popupInternalPaddingRight(style()), Fixed));
98     innerStyle->setPaddingTop(Length(theme()->popupInternalPaddingTop(style()), Fixed));
99     innerStyle->setPaddingBottom(Length(theme()->popupInternalPaddingBottom(style()), Fixed));
100
101     if (document()->page()->chrome()->selectItemWritingDirectionIsNatural()) {
102         // Items in the popup will not respect the CSS text-align and direction properties,
103         // so we must adjust our own style to match.
104         innerStyle->setTextAlign(LEFT);
105         TextDirection direction = (m_buttonText && m_buttonText->text()->defaultWritingDirection() == WTF::Unicode::RightToLeft) ? RTL : LTR;
106         innerStyle->setDirection(direction);
107     } else if (m_optionStyle && document()->page()->chrome()->selectItemAlignmentFollowsMenuWritingDirection()) {
108         if ((m_optionStyle->direction() != innerStyle->direction() || m_optionStyle->unicodeBidi() != innerStyle->unicodeBidi()))
109             m_innerBlock->setNeedsLayoutAndPrefWidthsRecalc();
110         innerStyle->setTextAlign(style()->isLeftToRightDirection() ? LEFT : RIGHT);
111         innerStyle->setDirection(m_optionStyle->direction());
112         innerStyle->setUnicodeBidi(m_optionStyle->unicodeBidi());
113     }
114 }
115
116 void RenderMenuList::addChild(RenderObject* newChild, RenderObject* beforeChild)
117 {
118     createInnerBlock();
119     m_innerBlock->addChild(newChild, beforeChild);
120     ASSERT(m_innerBlock == firstChild());
121 }
122
123 void RenderMenuList::removeChild(RenderObject* oldChild)
124 {
125     if (oldChild == m_innerBlock || !m_innerBlock) {
126         RenderDeprecatedFlexibleBox::removeChild(oldChild);
127         m_innerBlock = 0;
128     } else
129         m_innerBlock->removeChild(oldChild);
130 }
131
132 void RenderMenuList::styleDidChange(StyleDifference diff, const RenderStyle* oldStyle)
133 {
134     RenderBlock::styleDidChange(diff, oldStyle);
135
136     if (m_buttonText)
137         m_buttonText->setStyle(style());
138     if (m_innerBlock) // RenderBlock handled updating the anonymous block's style.
139         adjustInnerStyle();
140
141     bool fontChanged = !oldStyle || oldStyle->font() != style()->font();
142     if (fontChanged)
143         updateOptionsWidth();
144 }
145
146 void RenderMenuList::updateOptionsWidth()
147 {
148     float maxOptionWidth = 0;
149     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
150     int size = listItems.size();    
151     FontCachePurgePreventer fontCachePurgePreventer;
152
153     for (int i = 0; i < size; ++i) {
154         Element* element = listItems[i];
155         OptionElement* optionElement = toOptionElement(element);
156         if (!optionElement)
157             continue;
158
159         String text = optionElement->textIndentedToRespectGroupLabel();
160         applyTextTransform(style(), text, ' ');
161         if (theme()->popupOptionSupportsTextIndent()) {
162             // Add in the option's text indent.  We can't calculate percentage values for now.
163             float optionWidth = 0;
164             if (RenderStyle* optionStyle = element->renderStyle())
165                 optionWidth += optionStyle->textIndent().calcMinValue(0);
166             if (!text.isEmpty())
167                 optionWidth += style()->font().width(text);
168             maxOptionWidth = max(maxOptionWidth, optionWidth);
169         } else if (!text.isEmpty())
170             maxOptionWidth = max(maxOptionWidth, style()->font().width(text));
171     }
172
173     int width = static_cast<int>(ceilf(maxOptionWidth));
174     if (m_optionsWidth == width)
175         return;
176
177     m_optionsWidth = width;
178     if (parent())
179         setNeedsLayoutAndPrefWidthsRecalc();
180 }
181
182 void RenderMenuList::updateFromElement()
183 {
184     if (m_optionsChanged) {
185         updateOptionsWidth();
186         m_optionsChanged = false;
187     }
188
189     if (m_popupIsVisible)
190         m_popup->updateFromElement();
191     else
192         setTextFromOption(toHTMLSelectElement(node())->selectedIndex());
193 }
194
195 void RenderMenuList::setTextFromOption(int optionIndex)
196 {
197     HTMLSelectElement* select = toHTMLSelectElement(node());
198     const Vector<HTMLElement*>& listItems = select->listItems();
199     int size = listItems.size();
200
201     int i = select->optionToListIndex(optionIndex);
202     String text = "";
203     if (i >= 0 && i < size) {
204         Element* element = listItems[i];
205         if (OptionElement* optionElement = toOptionElement(element)) {
206             text = optionElement->textIndentedToRespectGroupLabel();
207             m_optionStyle = element->renderStyle();
208         }
209     }
210
211     setText(text.stripWhiteSpace());
212     didUpdateActiveOption(optionIndex);
213 }
214
215 void RenderMenuList::setText(const String& s)
216 {
217     if (s.isEmpty()) {
218         if (!m_buttonText || !m_buttonText->isBR()) {
219             if (m_buttonText)
220                 m_buttonText->destroy();
221             m_buttonText = new (renderArena()) RenderBR(document());
222             m_buttonText->setStyle(style());
223             addChild(m_buttonText);
224         }
225     } else {
226         if (m_buttonText && !m_buttonText->isBR())
227             m_buttonText->setText(s.impl(), true);
228         else {
229             if (m_buttonText)
230                 m_buttonText->destroy();
231             m_buttonText = new (renderArena()) RenderText(document(), s.impl());
232             m_buttonText->setStyle(style());
233             addChild(m_buttonText);
234         }
235         adjustInnerStyle();
236     }
237 }
238
239 String RenderMenuList::text() const
240 {
241     return m_buttonText ? m_buttonText->text() : 0;
242 }
243
244 LayoutRect RenderMenuList::controlClipRect(const LayoutPoint& additionalOffset) const
245 {
246     // Clip to the intersection of the content box and the content box for the inner box
247     // This will leave room for the arrows which sit in the inner box padding,
248     // and if the inner box ever spills out of the outer box, that will get clipped too.
249     LayoutRect outerBox(additionalOffset.x() + borderLeft() + paddingLeft(), 
250                    additionalOffset.y() + borderTop() + paddingTop(),
251                    contentWidth(), 
252                    contentHeight());
253     
254     LayoutRect innerBox(additionalOffset.x() + m_innerBlock->x() + m_innerBlock->paddingLeft(), 
255                    additionalOffset.y() + m_innerBlock->y() + m_innerBlock->paddingTop(),
256                    m_innerBlock->contentWidth(), 
257                    m_innerBlock->contentHeight());
258
259     return intersection(outerBox, innerBox);
260 }
261
262 void RenderMenuList::computePreferredLogicalWidths()
263 {
264     m_minPreferredLogicalWidth = 0;
265     m_maxPreferredLogicalWidth = 0;
266     
267     if (style()->width().isFixed() && style()->width().value() > 0)
268         m_minPreferredLogicalWidth = m_maxPreferredLogicalWidth = computeContentBoxLogicalWidth(style()->width().value());
269     else
270         m_maxPreferredLogicalWidth = max(m_optionsWidth, theme()->minimumMenuListSize(style())) + m_innerBlock->paddingLeft() + m_innerBlock->paddingRight();
271
272     if (style()->minWidth().isFixed() && style()->minWidth().value() > 0) {
273         m_maxPreferredLogicalWidth = max(m_maxPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->minWidth().value()));
274         m_minPreferredLogicalWidth = max(m_minPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->minWidth().value()));
275     } else if (style()->width().isPercent() || (style()->width().isAuto() && style()->height().isPercent()))
276         m_minPreferredLogicalWidth = 0;
277     else
278         m_minPreferredLogicalWidth = m_maxPreferredLogicalWidth;
279
280     if (style()->maxWidth().isFixed()) {
281         m_maxPreferredLogicalWidth = min(m_maxPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->maxWidth().value()));
282         m_minPreferredLogicalWidth = min(m_minPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->maxWidth().value()));
283     }
284
285     LayoutUnit toAdd = borderAndPaddingWidth();
286     m_minPreferredLogicalWidth += toAdd;
287     m_maxPreferredLogicalWidth += toAdd;
288
289     setPreferredLogicalWidthsDirty(false);
290 }
291
292 void RenderMenuList::showPopup()
293 {
294     if (m_popupIsVisible)
295         return;
296
297     // Create m_innerBlock here so it ends up as the first child.
298     // This is important because otherwise we might try to create m_innerBlock
299     // inside the showPopup call and it would fail.
300     createInnerBlock();
301     if (!m_popup)
302         m_popup = document()->page()->chrome()->createPopupMenu(this);
303     m_popupIsVisible = true;
304
305     // Compute the top left taking transforms into account, but use
306     // the actual width of the element to size the popup.
307     FloatPoint absTopLeft = localToAbsolute(FloatPoint(), false, true);
308     LayoutRect absBounds = absoluteBoundingBoxRectIgnoringTransforms();
309     absBounds.setLocation(roundedIntPoint(absTopLeft));
310     HTMLSelectElement* select = toHTMLSelectElement(node());
311     m_popup->show(absBounds, document()->view(), select->optionToListIndex(select->selectedIndex()));
312 }
313
314 void RenderMenuList::hidePopup()
315 {
316     if (m_popup)
317         m_popup->hide();
318 }
319
320 void RenderMenuList::valueChanged(unsigned listIndex, bool fireOnChange)
321 {
322     // Check to ensure a page navigation has not occurred while
323     // the popup was up.
324     Document* doc = static_cast<Element*>(node())->document();
325     if (!doc || doc != doc->frame()->document())
326         return;
327     
328     HTMLSelectElement* select = toHTMLSelectElement(node());
329     select->setSelectedIndexByUser(select->listToOptionIndex(listIndex), true, fireOnChange);
330 }
331
332 #if ENABLE(NO_LISTBOX_RENDERING)
333 void RenderMenuList::listBoxSelectItem(int listIndex, bool allowMultiplySelections, bool shift, bool fireOnChangeNow)
334 {
335     toHTMLSelectElement(node())->listBoxSelectItem(listIndex, allowMultiplySelections, shift, fireOnChangeNow);
336 }
337
338 bool RenderMenuList::multiple()
339 {
340     return toHTMLSelectElement(node())->multiple();
341 }
342 #endif
343
344 void RenderMenuList::didSetSelectedIndex(int listIndex)
345 {
346     didUpdateActiveOption(toHTMLSelectElement(node())->listToOptionIndex(listIndex));
347 }
348
349 void RenderMenuList::didUpdateActiveOption(int optionIndex)
350 {
351     if (!AXObjectCache::accessibilityEnabled())
352         return;
353
354     if (m_lastActiveIndex == optionIndex)
355         return;
356     m_lastActiveIndex = optionIndex;
357
358     HTMLSelectElement* select = toHTMLSelectElement(node());
359     int listIndex = select->optionToListIndex(optionIndex);
360     if (listIndex < 0 || listIndex >= static_cast<int>(select->listItems().size()))
361         return;
362
363     ASSERT(select->listItems()[listIndex]);
364
365     if (AccessibilityMenuList* menuList = static_cast<AccessibilityMenuList*>(document()->axObjectCache()->get(this)))
366         menuList->didUpdateActiveOption(optionIndex);
367 }
368
369 String RenderMenuList::itemText(unsigned listIndex) const
370 {
371     HTMLSelectElement* select = toHTMLSelectElement(node());
372     const Vector<HTMLElement*>& listItems = select->listItems();
373     if (listIndex >= listItems.size())
374         return String();
375
376     String itemString;
377     Element* element = listItems[listIndex];
378     if (OptionGroupElement* optionGroupElement = toOptionGroupElement(element))
379         itemString = optionGroupElement->groupLabelText();
380     else if (OptionElement* optionElement = toOptionElement(element))
381         itemString = optionElement->textIndentedToRespectGroupLabel();
382
383     applyTextTransform(style(), itemString, ' ');
384     return itemString;
385 }
386
387 String RenderMenuList::itemLabel(unsigned) const
388 {
389     return String();
390 }
391
392 String RenderMenuList::itemIcon(unsigned) const
393 {
394     return String();
395 }
396
397 String RenderMenuList::itemAccessibilityText(unsigned listIndex) const
398 {
399     // Allow the accessible name be changed if necessary.
400     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
401     if (listIndex >= listItems.size())
402         return String();
403     return listItems[listIndex]->fastGetAttribute(aria_labelAttr);
404 }
405     
406 String RenderMenuList::itemToolTip(unsigned listIndex) const
407 {
408     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
409     if (listIndex >= listItems.size())
410         return String();
411     return listItems[listIndex]->title();
412 }
413
414 bool RenderMenuList::itemIsEnabled(unsigned listIndex) const
415 {
416     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
417     if (listIndex >= listItems.size())
418         return false;
419     HTMLElement* element = listItems[listIndex];
420
421     bool groupEnabled = true;
422     if (Element* parentElement = element->parentElement()) {
423         if (isOptionGroupElement(parentElement))
424             groupEnabled = !static_cast<HTMLOptGroupElement*>(parentElement)->disabled();
425     }
426     if (!groupEnabled)
427         return false;
428
429     return element->isEnabledFormControl();
430 }
431
432 PopupMenuStyle RenderMenuList::itemStyle(unsigned listIndex) const
433 {
434     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
435     if (listIndex >= listItems.size()) {
436         // If we are making an out of bounds access, then we want to use the style
437         // of a different option element (index 0). However, if there isn't an option element
438         // before at index 0, we fall back to the menu's style.
439         if (!listIndex)
440             return menuStyle();
441
442         // Try to retrieve the style of an option element we know exists (index 0).
443         listIndex = 0;
444     }
445     HTMLElement* element = listItems[listIndex];
446     
447     RenderStyle* style = element->renderStyle() ? element->renderStyle() : element->computedStyle();
448     return style ? PopupMenuStyle(style->visitedDependentColor(CSSPropertyColor), itemBackgroundColor(listIndex), style->font(), style->visibility() == VISIBLE, style->display() == NONE, style->textIndent(), style->direction(), style->unicodeBidi() == Override) : menuStyle();
449 }
450
451 Color RenderMenuList::itemBackgroundColor(unsigned listIndex) const
452 {
453     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
454     if (listIndex >= listItems.size())
455         return style()->visitedDependentColor(CSSPropertyBackgroundColor);
456     HTMLElement* element = listItems[listIndex];
457
458     Color backgroundColor;
459     if (element->renderStyle())
460         backgroundColor = element->renderStyle()->visitedDependentColor(CSSPropertyBackgroundColor);
461     // If the item has an opaque background color, return that.
462     if (!backgroundColor.hasAlpha())
463         return backgroundColor;
464
465     // Otherwise, the item's background is overlayed on top of the menu background.
466     backgroundColor = style()->visitedDependentColor(CSSPropertyBackgroundColor).blend(backgroundColor);
467     if (!backgroundColor.hasAlpha())
468         return backgroundColor;
469
470     // If the menu background is not opaque, then add an opaque white background behind.
471     return Color(Color::white).blend(backgroundColor);
472 }
473
474 PopupMenuStyle RenderMenuList::menuStyle() const
475 {
476     RenderStyle* s = m_innerBlock ? m_innerBlock->style() : style();
477     return PopupMenuStyle(s->visitedDependentColor(CSSPropertyColor), s->visitedDependentColor(CSSPropertyBackgroundColor), s->font(), s->visibility() == VISIBLE, s->display() == NONE, s->textIndent(), style()->direction(), style()->unicodeBidi() == Override);
478 }
479
480 HostWindow* RenderMenuList::hostWindow() const
481 {
482     return document()->view()->hostWindow();
483 }
484
485 PassRefPtr<Scrollbar> RenderMenuList::createScrollbar(ScrollableArea* scrollableArea, ScrollbarOrientation orientation, ScrollbarControlSize controlSize)
486 {
487     RefPtr<Scrollbar> widget;
488     bool hasCustomScrollbarStyle = style()->hasPseudoStyle(SCROLLBAR);
489     if (hasCustomScrollbarStyle)
490         widget = RenderScrollbar::createCustomScrollbar(scrollableArea, orientation, this);
491     else
492         widget = Scrollbar::createNativeScrollbar(scrollableArea, orientation, controlSize);
493     return widget.release();
494 }
495
496 int RenderMenuList::clientInsetLeft() const
497 {
498     return 0;
499 }
500
501 int RenderMenuList::clientInsetRight() const
502 {
503     return 0;
504 }
505
506 int RenderMenuList::clientPaddingLeft() const
507 {
508     return paddingLeft() + m_innerBlock->paddingLeft();
509 }
510
511 const int endOfLinePadding = 2;
512 int RenderMenuList::clientPaddingRight() const
513 {
514     if (style()->appearance() == MenulistPart || style()->appearance() == MenulistButtonPart) {
515         // For these appearance values, the theme applies padding to leave room for the
516         // drop-down button. But leaving room for the button inside the popup menu itself
517         // looks strange, so we return a small default padding to avoid having a large empty
518         // space appear on the side of the popup menu.
519         return endOfLinePadding;
520     }
521
522     // If the appearance isn't MenulistPart, then the select is styled (non-native), so
523     // we want to return the user specified padding.
524     return paddingRight() + m_innerBlock->paddingRight();
525 }
526
527 int RenderMenuList::listSize() const
528 {
529     return toHTMLSelectElement(node())->listItems().size();
530 }
531
532 int RenderMenuList::selectedIndex() const
533 {
534     HTMLSelectElement* select = toHTMLSelectElement(node());
535     return select->optionToListIndex(select->selectedIndex());
536 }
537
538 void RenderMenuList::popupDidHide()
539 {
540     m_popupIsVisible = false;
541 }
542
543 bool RenderMenuList::itemIsSeparator(unsigned listIndex) const
544 {
545     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
546     return listIndex < listItems.size() && listItems[listIndex]->hasTagName(hrTag);
547 }
548
549 bool RenderMenuList::itemIsLabel(unsigned listIndex) const
550 {
551     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
552     return listIndex < listItems.size() && isOptionGroupElement(listItems[listIndex]);
553 }
554
555 bool RenderMenuList::itemIsSelected(unsigned listIndex) const
556 {
557     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
558     if (listIndex >= listItems.size())
559         return false;
560     if (OptionElement* optionElement = toOptionElement(listItems[listIndex]))
561         return optionElement->selected();
562     return false;
563 }
564
565 void RenderMenuList::setTextFromItem(unsigned listIndex)
566 {
567     setTextFromOption(toHTMLSelectElement(node())->listToOptionIndex(listIndex));
568 }
569
570 FontSelector* RenderMenuList::fontSelector() const
571 {
572     return document()->styleSelector()->fontSelector();
573 }
574
575 }