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