f75feb8ca7a6158eb831b30dc7c08bae8058ba9b
[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 "HTMLOptionElement.h"
38 #include "HTMLOptGroupElement.h"
39 #include "HTMLSelectElement.h"
40 #include "NodeRenderStyle.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         HTMLElement* element = listItems[i];
155         if (!element->hasTagName(optionTag))
156             continue;
157
158         String text = toHTMLOptionElement(element)->textIndentedToRespectGroupLabel();
159         applyTextTransform(style(), text, ' ');
160         if (theme()->popupOptionSupportsTextIndent()) {
161             // Add in the option's text indent.  We can't calculate percentage values for now.
162             float optionWidth = 0;
163             if (RenderStyle* optionStyle = element->renderStyle())
164                 optionWidth += optionStyle->textIndent().calcMinValue(0);
165             if (!text.isEmpty())
166                 optionWidth += style()->font().width(text);
167             maxOptionWidth = max(maxOptionWidth, optionWidth);
168         } else if (!text.isEmpty())
169             maxOptionWidth = max(maxOptionWidth, style()->font().width(text));
170     }
171
172     int width = static_cast<int>(ceilf(maxOptionWidth));
173     if (m_optionsWidth == width)
174         return;
175
176     m_optionsWidth = width;
177     if (parent())
178         setNeedsLayoutAndPrefWidthsRecalc();
179 }
180
181 void RenderMenuList::updateFromElement()
182 {
183     if (m_optionsChanged) {
184         updateOptionsWidth();
185         m_optionsChanged = false;
186     }
187
188     if (m_popupIsVisible)
189         m_popup->updateFromElement();
190     else
191         setTextFromOption(toHTMLSelectElement(node())->selectedIndex());
192 }
193
194 void RenderMenuList::setTextFromOption(int optionIndex)
195 {
196     HTMLSelectElement* select = toHTMLSelectElement(node());
197     const Vector<HTMLElement*>& listItems = select->listItems();
198     int size = listItems.size();
199
200     int i = select->optionToListIndex(optionIndex);
201     String text = "";
202     if (i >= 0 && i < size) {
203         Element* element = listItems[i];
204         if (element->hasTagName(optionTag)) {
205             text = toHTMLOptionElement(element)->textIndentedToRespectGroupLabel();
206             m_optionStyle = element->renderStyle();
207         }
208     }
209
210     setText(text.stripWhiteSpace());
211     didUpdateActiveOption(optionIndex);
212 }
213
214 void RenderMenuList::setText(const String& s)
215 {
216     if (s.isEmpty()) {
217         if (!m_buttonText || !m_buttonText->isBR()) {
218             if (m_buttonText)
219                 m_buttonText->destroy();
220             m_buttonText = new (renderArena()) RenderBR(document());
221             m_buttonText->setStyle(style());
222             addChild(m_buttonText);
223         }
224     } else {
225         if (m_buttonText && !m_buttonText->isBR())
226             m_buttonText->setText(s.impl(), true);
227         else {
228             if (m_buttonText)
229                 m_buttonText->destroy();
230             m_buttonText = new (renderArena()) RenderText(document(), s.impl());
231             m_buttonText->setStyle(style());
232             addChild(m_buttonText);
233         }
234         adjustInnerStyle();
235     }
236 }
237
238 String RenderMenuList::text() const
239 {
240     return m_buttonText ? m_buttonText->text() : 0;
241 }
242
243 LayoutRect RenderMenuList::controlClipRect(const LayoutPoint& additionalOffset) const
244 {
245     // Clip to the intersection of the content box and the content box for the inner box
246     // This will leave room for the arrows which sit in the inner box padding,
247     // and if the inner box ever spills out of the outer box, that will get clipped too.
248     LayoutRect outerBox(additionalOffset.x() + borderLeft() + paddingLeft(), 
249                    additionalOffset.y() + borderTop() + paddingTop(),
250                    contentWidth(), 
251                    contentHeight());
252     
253     LayoutRect innerBox(additionalOffset.x() + m_innerBlock->x() + m_innerBlock->paddingLeft(), 
254                    additionalOffset.y() + m_innerBlock->y() + m_innerBlock->paddingTop(),
255                    m_innerBlock->contentWidth(), 
256                    m_innerBlock->contentHeight());
257
258     return intersection(outerBox, innerBox);
259 }
260
261 void RenderMenuList::computePreferredLogicalWidths()
262 {
263     m_minPreferredLogicalWidth = 0;
264     m_maxPreferredLogicalWidth = 0;
265     
266     if (style()->width().isFixed() && style()->width().value() > 0)
267         m_minPreferredLogicalWidth = m_maxPreferredLogicalWidth = computeContentBoxLogicalWidth(style()->width().value());
268     else
269         m_maxPreferredLogicalWidth = max(m_optionsWidth, theme()->minimumMenuListSize(style())) + m_innerBlock->paddingLeft() + m_innerBlock->paddingRight();
270
271     if (style()->minWidth().isFixed() && style()->minWidth().value() > 0) {
272         m_maxPreferredLogicalWidth = max(m_maxPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->minWidth().value()));
273         m_minPreferredLogicalWidth = max(m_minPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->minWidth().value()));
274     } else if (style()->width().isPercent() || (style()->width().isAuto() && style()->height().isPercent()))
275         m_minPreferredLogicalWidth = 0;
276     else
277         m_minPreferredLogicalWidth = m_maxPreferredLogicalWidth;
278
279     if (style()->maxWidth().isFixed()) {
280         m_maxPreferredLogicalWidth = min(m_maxPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->maxWidth().value()));
281         m_minPreferredLogicalWidth = min(m_minPreferredLogicalWidth, computeContentBoxLogicalWidth(style()->maxWidth().value()));
282     }
283
284     LayoutUnit toAdd = borderAndPaddingWidth();
285     m_minPreferredLogicalWidth += toAdd;
286     m_maxPreferredLogicalWidth += toAdd;
287
288     setPreferredLogicalWidthsDirty(false);
289 }
290
291 void RenderMenuList::showPopup()
292 {
293     if (m_popupIsVisible)
294         return;
295
296     // Create m_innerBlock here so it ends up as the first child.
297     // This is important because otherwise we might try to create m_innerBlock
298     // inside the showPopup call and it would fail.
299     createInnerBlock();
300     if (!m_popup)
301         m_popup = document()->page()->chrome()->createPopupMenu(this);
302     m_popupIsVisible = true;
303
304     // Compute the top left taking transforms into account, but use
305     // the actual width of the element to size the popup.
306     FloatPoint absTopLeft = localToAbsolute(FloatPoint(), false, true);
307     LayoutRect absBounds = absoluteBoundingBoxRectIgnoringTransforms();
308     absBounds.setLocation(roundedIntPoint(absTopLeft));
309     HTMLSelectElement* select = toHTMLSelectElement(node());
310     m_popup->show(absBounds, document()->view(), select->optionToListIndex(select->selectedIndex()));
311 }
312
313 void RenderMenuList::hidePopup()
314 {
315     if (m_popup)
316         m_popup->hide();
317 }
318
319 void RenderMenuList::valueChanged(unsigned listIndex, bool fireOnChange)
320 {
321     // Check to ensure a page navigation has not occurred while
322     // the popup was up.
323     Document* doc = static_cast<Element*>(node())->document();
324     if (!doc || doc != doc->frame()->document())
325         return;
326     
327     HTMLSelectElement* select = toHTMLSelectElement(node());
328     select->setSelectedIndexByUser(select->listToOptionIndex(listIndex), true, fireOnChange);
329 }
330
331 #if ENABLE(NO_LISTBOX_RENDERING)
332 void RenderMenuList::listBoxSelectItem(int listIndex, bool allowMultiplySelections, bool shift, bool fireOnChangeNow)
333 {
334     toHTMLSelectElement(node())->listBoxSelectItem(listIndex, allowMultiplySelections, shift, fireOnChangeNow);
335 }
336
337 bool RenderMenuList::multiple()
338 {
339     return toHTMLSelectElement(node())->multiple();
340 }
341 #endif
342
343 void RenderMenuList::didSetSelectedIndex(int listIndex)
344 {
345     didUpdateActiveOption(toHTMLSelectElement(node())->listToOptionIndex(listIndex));
346 }
347
348 void RenderMenuList::didUpdateActiveOption(int optionIndex)
349 {
350     if (!AXObjectCache::accessibilityEnabled())
351         return;
352
353     if (m_lastActiveIndex == optionIndex)
354         return;
355     m_lastActiveIndex = optionIndex;
356
357     HTMLSelectElement* select = toHTMLSelectElement(node());
358     int listIndex = select->optionToListIndex(optionIndex);
359     if (listIndex < 0 || listIndex >= static_cast<int>(select->listItems().size()))
360         return;
361
362     ASSERT(select->listItems()[listIndex]);
363
364     if (AccessibilityMenuList* menuList = static_cast<AccessibilityMenuList*>(document()->axObjectCache()->get(this)))
365         menuList->didUpdateActiveOption(optionIndex);
366 }
367
368 String RenderMenuList::itemText(unsigned listIndex) const
369 {
370     HTMLSelectElement* select = toHTMLSelectElement(node());
371     const Vector<HTMLElement*>& listItems = select->listItems();
372     if (listIndex >= listItems.size())
373         return String();
374
375     String itemString;
376     Element* element = listItems[listIndex];
377     if (element->hasTagName(optgroupTag))
378         itemString = static_cast<const HTMLOptGroupElement*>(element)->groupLabelText();
379     else if (element->hasTagName(optionTag))
380         itemString = toHTMLOptionElement(element)->textIndentedToRespectGroupLabel();
381
382     applyTextTransform(style(), itemString, ' ');
383     return itemString;
384 }
385
386 String RenderMenuList::itemLabel(unsigned) const
387 {
388     return String();
389 }
390
391 String RenderMenuList::itemIcon(unsigned) const
392 {
393     return String();
394 }
395
396 String RenderMenuList::itemAccessibilityText(unsigned listIndex) const
397 {
398     // Allow the accessible name be changed if necessary.
399     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
400     if (listIndex >= listItems.size())
401         return String();
402     return listItems[listIndex]->fastGetAttribute(aria_labelAttr);
403 }
404     
405 String RenderMenuList::itemToolTip(unsigned listIndex) const
406 {
407     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
408     if (listIndex >= listItems.size())
409         return String();
410     return listItems[listIndex]->title();
411 }
412
413 bool RenderMenuList::itemIsEnabled(unsigned listIndex) const
414 {
415     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
416     if (listIndex >= listItems.size())
417         return false;
418     HTMLElement* element = listItems[listIndex];
419
420     bool groupEnabled = true;
421     if (Element* parentElement = element->parentElement()) {
422         if (parentElement->hasTagName(optgroupTag))
423             groupEnabled = !static_cast<HTMLOptGroupElement*>(parentElement)->disabled();
424     }
425     if (!groupEnabled)
426         return false;
427
428     return element->isEnabledFormControl();
429 }
430
431 PopupMenuStyle RenderMenuList::itemStyle(unsigned listIndex) const
432 {
433     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
434     if (listIndex >= listItems.size()) {
435         // If we are making an out of bounds access, then we want to use the style
436         // of a different option element (index 0). However, if there isn't an option element
437         // before at index 0, we fall back to the menu's style.
438         if (!listIndex)
439             return menuStyle();
440
441         // Try to retrieve the style of an option element we know exists (index 0).
442         listIndex = 0;
443     }
444     HTMLElement* element = listItems[listIndex];
445     
446     RenderStyle* style = element->renderStyle() ? element->renderStyle() : element->computedStyle();
447     return style ? PopupMenuStyle(style->visitedDependentColor(CSSPropertyColor), itemBackgroundColor(listIndex), style->font(), style->visibility() == VISIBLE, style->display() == NONE, style->textIndent(), style->direction(), style->unicodeBidi() == Override) : menuStyle();
448 }
449
450 Color RenderMenuList::itemBackgroundColor(unsigned listIndex) const
451 {
452     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
453     if (listIndex >= listItems.size())
454         return style()->visitedDependentColor(CSSPropertyBackgroundColor);
455     HTMLElement* element = listItems[listIndex];
456
457     Color backgroundColor;
458     if (element->renderStyle())
459         backgroundColor = element->renderStyle()->visitedDependentColor(CSSPropertyBackgroundColor);
460     // If the item has an opaque background color, return that.
461     if (!backgroundColor.hasAlpha())
462         return backgroundColor;
463
464     // Otherwise, the item's background is overlayed on top of the menu background.
465     backgroundColor = style()->visitedDependentColor(CSSPropertyBackgroundColor).blend(backgroundColor);
466     if (!backgroundColor.hasAlpha())
467         return backgroundColor;
468
469     // If the menu background is not opaque, then add an opaque white background behind.
470     return Color(Color::white).blend(backgroundColor);
471 }
472
473 PopupMenuStyle RenderMenuList::menuStyle() const
474 {
475     RenderStyle* s = m_innerBlock ? m_innerBlock->style() : style();
476     return PopupMenuStyle(s->visitedDependentColor(CSSPropertyColor), s->visitedDependentColor(CSSPropertyBackgroundColor), s->font(), s->visibility() == VISIBLE, s->display() == NONE, s->textIndent(), style()->direction(), style()->unicodeBidi() == Override);
477 }
478
479 HostWindow* RenderMenuList::hostWindow() const
480 {
481     return document()->view()->hostWindow();
482 }
483
484 PassRefPtr<Scrollbar> RenderMenuList::createScrollbar(ScrollableArea* scrollableArea, ScrollbarOrientation orientation, ScrollbarControlSize controlSize)
485 {
486     RefPtr<Scrollbar> widget;
487     bool hasCustomScrollbarStyle = style()->hasPseudoStyle(SCROLLBAR);
488     if (hasCustomScrollbarStyle)
489         widget = RenderScrollbar::createCustomScrollbar(scrollableArea, orientation, this);
490     else
491         widget = Scrollbar::createNativeScrollbar(scrollableArea, orientation, controlSize);
492     return widget.release();
493 }
494
495 int RenderMenuList::clientInsetLeft() const
496 {
497     return 0;
498 }
499
500 int RenderMenuList::clientInsetRight() const
501 {
502     return 0;
503 }
504
505 int RenderMenuList::clientPaddingLeft() const
506 {
507     return paddingLeft() + m_innerBlock->paddingLeft();
508 }
509
510 const int endOfLinePadding = 2;
511 int RenderMenuList::clientPaddingRight() const
512 {
513     if (style()->appearance() == MenulistPart || style()->appearance() == MenulistButtonPart) {
514         // For these appearance values, the theme applies padding to leave room for the
515         // drop-down button. But leaving room for the button inside the popup menu itself
516         // looks strange, so we return a small default padding to avoid having a large empty
517         // space appear on the side of the popup menu.
518         return endOfLinePadding;
519     }
520
521     // If the appearance isn't MenulistPart, then the select is styled (non-native), so
522     // we want to return the user specified padding.
523     return paddingRight() + m_innerBlock->paddingRight();
524 }
525
526 int RenderMenuList::listSize() const
527 {
528     return toHTMLSelectElement(node())->listItems().size();
529 }
530
531 int RenderMenuList::selectedIndex() const
532 {
533     HTMLSelectElement* select = toHTMLSelectElement(node());
534     return select->optionToListIndex(select->selectedIndex());
535 }
536
537 void RenderMenuList::popupDidHide()
538 {
539     m_popupIsVisible = false;
540 }
541
542 bool RenderMenuList::itemIsSeparator(unsigned listIndex) const
543 {
544     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
545     return listIndex < listItems.size() && listItems[listIndex]->hasTagName(hrTag);
546 }
547
548 bool RenderMenuList::itemIsLabel(unsigned listIndex) const
549 {
550     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
551     return listIndex < listItems.size() && listItems[listIndex]->hasTagName(optgroupTag);
552 }
553
554 bool RenderMenuList::itemIsSelected(unsigned listIndex) const
555 {
556     const Vector<HTMLElement*>& listItems = toHTMLSelectElement(node())->listItems();
557     if (listIndex >= listItems.size())
558         return false;
559     HTMLElement* element = listItems[listIndex];
560     return element->hasTagName(optionTag) && toHTMLOptionElement(element)->selected();
561 }
562
563 void RenderMenuList::setTextFromItem(unsigned listIndex)
564 {
565     setTextFromOption(toHTMLSelectElement(node())->listToOptionIndex(listIndex));
566 }
567
568 FontSelector* RenderMenuList::fontSelector() const
569 {
570     return document()->styleSelector()->fontSelector();
571 }
572
573 }