Optimize fetching the Node for never-anonymous renderers.
[WebKit-https.git] / Source / WebCore / rendering / RenderTextControl.cpp
1 /**
2  * Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3  *           (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)  
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 "RenderTextControl.h"
24
25 #include "HTMLTextFormControlElement.h"
26 #include "HitTestResult.h"
27 #include "RenderText.h"
28 #include "RenderTheme.h"
29 #include "ScrollbarTheme.h"
30 #include "StyleInheritedData.h"
31 #include "TextIterator.h"
32 #include "VisiblePosition.h"
33 #include <wtf/unicode/CharacterNames.h>
34
35 using namespace std;
36
37 namespace WebCore {
38
39 RenderTextControl::RenderTextControl(HTMLTextFormControlElement& element)
40     : RenderBlockFlow(&element)
41 {
42 }
43
44 RenderTextControl::~RenderTextControl()
45 {
46 }
47
48 HTMLTextFormControlElement& RenderTextControl::textFormControlElement() const
49 {
50     return toHTMLTextFormControlElement(nodeForNonAnonymous());
51 }
52
53 HTMLElement* RenderTextControl::innerTextElement() const
54 {
55     return textFormControlElement().innerTextElement();
56 }
57
58 void RenderTextControl::styleDidChange(StyleDifference diff, const RenderStyle* oldStyle)
59 {
60     RenderBlock::styleDidChange(diff, oldStyle);
61     Element* innerText = innerTextElement();
62     if (!innerText)
63         return;
64     RenderBlock* innerTextRenderer = toRenderBlock(innerText->renderer());
65     if (innerTextRenderer) {
66         // We may have set the width and the height in the old style in layout().
67         // Reset them now to avoid getting a spurious layout hint.
68         innerTextRenderer->style()->setHeight(Length());
69         innerTextRenderer->style()->setWidth(Length());
70         innerTextRenderer->setStyle(createInnerTextStyle(style()));
71         innerText->setNeedsStyleRecalc();
72     }
73     textFormControlElement().updatePlaceholderVisibility(false);
74 }
75
76 static inline bool updateUserModifyProperty(const HTMLTextFormControlElement& element, RenderStyle* style)
77 {
78     bool isDisabled = element.isDisabledFormControl();
79     bool isReadOnlyControl = element.isReadOnly();
80
81     style->setUserModify((isReadOnlyControl || isDisabled) ? READ_ONLY : READ_WRITE_PLAINTEXT_ONLY);
82     return isDisabled;
83 }
84
85 void RenderTextControl::adjustInnerTextStyle(const RenderStyle* startStyle, RenderStyle* textBlockStyle) const
86 {
87     // The inner block, if present, always has its direction set to LTR,
88     // so we need to inherit the direction and unicode-bidi style from the element.
89     textBlockStyle->setDirection(style()->direction());
90     textBlockStyle->setUnicodeBidi(style()->unicodeBidi());
91
92     bool disabled = updateUserModifyProperty(textFormControlElement(), textBlockStyle);
93     if (disabled)
94         textBlockStyle->setColor(theme()->disabledTextColor(textBlockStyle->visitedDependentColor(CSSPropertyColor), startStyle->visitedDependentColor(CSSPropertyBackgroundColor)));
95 }
96
97 int RenderTextControl::textBlockLogicalHeight() const
98 {
99     return logicalHeight() - borderAndPaddingLogicalHeight();
100 }
101
102 int RenderTextControl::textBlockLogicalWidth() const
103 {
104     Element* innerText = innerTextElement();
105     ASSERT(innerText);
106
107     LayoutUnit unitWidth = logicalWidth() - borderAndPaddingLogicalWidth();
108     if (innerText->renderer())
109         unitWidth -= innerText->renderBox()->paddingStart() + innerText->renderBox()->paddingEnd();
110
111     return unitWidth;
112 }
113
114 void RenderTextControl::updateFromElement()
115 {
116     Element* innerText = innerTextElement();
117     if (innerText && innerText->renderer())
118         updateUserModifyProperty(textFormControlElement(), innerText->renderer()->style());
119 }
120
121 int RenderTextControl::scrollbarThickness() const
122 {
123     // FIXME: We should get the size of the scrollbar from the RenderTheme instead.
124     return ScrollbarTheme::theme()->scrollbarThickness();
125 }
126
127 void RenderTextControl::computeLogicalHeight(LayoutUnit logicalHeight, LayoutUnit logicalTop, LogicalExtentComputedValues& computedValues) const
128 {
129     HTMLElement* innerText = innerTextElement();
130     ASSERT(innerText);
131     if (RenderBox* innerTextBox = innerText->renderBox()) {
132         LayoutUnit nonContentHeight = innerTextBox->borderAndPaddingHeight() + innerTextBox->marginHeight();
133         logicalHeight = computeControlLogicalHeight(innerTextBox->lineHeight(true, HorizontalLine, PositionOfInteriorLineBoxes), nonContentHeight) + borderAndPaddingHeight();
134
135         // We are able to have a horizontal scrollbar if the overflow style is scroll, or if its auto and there's no word wrap.
136         if ((isHorizontalWritingMode() && (style()->overflowX() == OSCROLL ||  (style()->overflowX() == OAUTO && innerText->renderer()->style()->overflowWrap() == NormalOverflowWrap)))
137             || (!isHorizontalWritingMode() && (style()->overflowY() == OSCROLL ||  (style()->overflowY() == OAUTO && innerText->renderer()->style()->overflowWrap() == NormalOverflowWrap))))
138             logicalHeight += scrollbarThickness();
139     }
140
141     RenderBox::computeLogicalHeight(logicalHeight, logicalTop, computedValues);
142 }
143
144 void RenderTextControl::hitInnerTextElement(HitTestResult& result, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset)
145 {
146     HTMLElement* innerText = innerTextElement();
147     if (!innerText->renderer())
148         return;
149
150     LayoutPoint adjustedLocation = accumulatedOffset + location();
151     LayoutPoint localPoint = pointInContainer - toLayoutSize(adjustedLocation + innerText->renderBox()->location());
152     if (hasOverflowClip())
153         localPoint += scrolledContentOffset();
154     result.setInnerNode(innerText);
155     result.setInnerNonSharedNode(innerText);
156     result.setLocalPoint(localPoint);
157 }
158
159 static const char* fontFamiliesWithInvalidCharWidth[] = {
160     "American Typewriter",
161     "Arial Hebrew",
162     "Chalkboard",
163     "Cochin",
164     "Corsiva Hebrew",
165     "Courier",
166     "Euphemia UCAS",
167     "Geneva",
168     "Gill Sans",
169     "Hei",
170     "Helvetica",
171     "Hoefler Text",
172     "InaiMathi",
173     "Kai",
174     "Lucida Grande",
175     "Marker Felt",
176     "Monaco",
177     "Mshtakan",
178     "New Peninim MT",
179     "Osaka",
180     "Raanana",
181     "STHeiti",
182     "Symbol",
183     "Times",
184     "Apple Braille",
185     "Apple LiGothic",
186     "Apple LiSung",
187     "Apple Symbols",
188     "AppleGothic",
189     "AppleMyungjo",
190     "#GungSeo",
191     "#HeadLineA",
192     "#PCMyungjo",
193     "#PilGi",
194 };
195
196 // For font families where any of the fonts don't have a valid entry in the OS/2 table
197 // for avgCharWidth, fallback to the legacy webkit behavior of getting the avgCharWidth
198 // from the width of a '0'. This only seems to apply to a fixed number of Mac fonts,
199 // but, in order to get similar rendering across platforms, we do this check for
200 // all platforms.
201 bool RenderTextControl::hasValidAvgCharWidth(AtomicString family)
202 {
203     if (family.isEmpty())
204         return false;
205
206     // Internal fonts on OS X also have an invalid entry in the table for avgCharWidth.
207     // They are hidden by having a name that begins with a period, so simply search
208     // for that here rather than try to keep the list up to date.
209     if (family.startsWith('.'))
210         return false;
211
212     static HashSet<AtomicString>* fontFamiliesWithInvalidCharWidthMap = 0;
213     
214     if (!fontFamiliesWithInvalidCharWidthMap) {
215         fontFamiliesWithInvalidCharWidthMap = new HashSet<AtomicString>;
216
217         for (size_t i = 0; i < WTF_ARRAY_LENGTH(fontFamiliesWithInvalidCharWidth); ++i)
218             fontFamiliesWithInvalidCharWidthMap->add(AtomicString(fontFamiliesWithInvalidCharWidth[i]));
219     }
220
221     return !fontFamiliesWithInvalidCharWidthMap->contains(family);
222 }
223
224 float RenderTextControl::getAvgCharWidth(AtomicString family)
225 {
226     if (hasValidAvgCharWidth(family))
227         return roundf(style()->font().primaryFont()->avgCharWidth());
228
229     const UChar ch = '0';
230     const String str = String(&ch, 1);
231     const Font& font = style()->font();
232     TextRun textRun = constructTextRun(this, font, str, style(), TextRun::AllowTrailingExpansion);
233     textRun.disableRoundingHacks();
234     return font.width(textRun);
235 }
236
237 float RenderTextControl::scaleEmToUnits(int x) const
238 {
239     // This matches the unitsPerEm value for MS Shell Dlg and Courier New from the "head" font table.
240     float unitsPerEm = 2048.0f;
241     return roundf(style()->font().size() * x / unitsPerEm);
242 }
243
244 void RenderTextControl::computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const
245 {
246     // Use average character width. Matches IE.
247     const AtomicString& family = style()->font().firstFamily();
248     maxLogicalWidth = preferredContentLogicalWidth(const_cast<RenderTextControl*>(this)->getAvgCharWidth(family));
249     if (RenderBox* innerTextRenderBox = innerTextElement()->renderBox())
250         maxLogicalWidth += innerTextRenderBox->paddingStart() + innerTextRenderBox->paddingEnd();
251     if (!style()->logicalWidth().isPercent())
252         minLogicalWidth = maxLogicalWidth;
253 }
254
255 void RenderTextControl::computePreferredLogicalWidths()
256 {
257     ASSERT(preferredLogicalWidthsDirty());
258
259     m_minPreferredLogicalWidth = 0;
260     m_maxPreferredLogicalWidth = 0;
261
262     if (style()->logicalWidth().isFixed() && style()->logicalWidth().value() >= 0)
263         m_minPreferredLogicalWidth = m_maxPreferredLogicalWidth = adjustContentBoxLogicalWidthForBoxSizing(style()->logicalWidth().value());
264     else
265         computeIntrinsicLogicalWidths(m_minPreferredLogicalWidth, m_maxPreferredLogicalWidth);
266
267     if (style()->logicalMinWidth().isFixed() && style()->logicalMinWidth().value() > 0) {
268         m_maxPreferredLogicalWidth = max(m_maxPreferredLogicalWidth, adjustContentBoxLogicalWidthForBoxSizing(style()->logicalMinWidth().value()));
269         m_minPreferredLogicalWidth = max(m_minPreferredLogicalWidth, adjustContentBoxLogicalWidthForBoxSizing(style()->logicalMinWidth().value()));
270     }
271
272     if (style()->logicalMaxWidth().isFixed()) {
273         m_maxPreferredLogicalWidth = min(m_maxPreferredLogicalWidth, adjustContentBoxLogicalWidthForBoxSizing(style()->logicalMaxWidth().value()));
274         m_minPreferredLogicalWidth = min(m_minPreferredLogicalWidth, adjustContentBoxLogicalWidthForBoxSizing(style()->logicalMaxWidth().value()));
275     }
276
277     LayoutUnit toAdd = borderAndPaddingLogicalWidth();
278
279     m_minPreferredLogicalWidth += toAdd;
280     m_maxPreferredLogicalWidth += toAdd;
281
282     setPreferredLogicalWidthsDirty(false);
283 }
284
285 void RenderTextControl::addFocusRingRects(Vector<IntRect>& rects, const LayoutPoint& additionalOffset, const RenderLayerModelObject*)
286 {
287     if (!size().isEmpty())
288         rects.append(pixelSnappedIntRect(additionalOffset, size()));
289 }
290
291 RenderObject* RenderTextControl::layoutSpecialExcludedChild(bool relayoutChildren)
292 {
293     HTMLElement* placeholder = textFormControlElement().placeholderElement();
294     RenderObject* placeholderRenderer = placeholder ? placeholder->renderer() : 0;
295     if (!placeholderRenderer)
296         return 0;
297     if (relayoutChildren) {
298         // The markParents arguments should be false because this function is
299         // called from layout() of the parent and the placeholder layout doesn't
300         // affect the parent layout.
301         placeholderRenderer->setChildNeedsLayout(true, MarkOnlyThis);
302     }
303     return placeholderRenderer;
304 }
305
306 bool RenderTextControl::canBeReplacedWithInlineRunIn() const
307 {
308     return false;
309 }
310
311 } // namespace WebCore