getAttribute does not behave correctly for mixed-case attributes on HTML elements
[WebKit-https.git] / Source / WebCore / dom / Element.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Peter Kelly (pmk@post.com)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2013 Apple Inc. All rights reserved.
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 #ifndef Element_h
26 #define Element_h
27
28 #include "Attribute.h"
29 #include "CollectionType.h"
30 #include "Document.h"
31 #include "FragmentScriptingPermission.h"
32 #include "HTMLNames.h"
33 #include "ScrollTypes.h"
34 #include "SpaceSplitString.h"
35
36 namespace WebCore {
37
38 class Attr;
39 class ClientRect;
40 class ClientRectList;
41 class DOMStringMap;
42 class DOMTokenList;
43 class Element;
44 class ElementRareData;
45 class ElementShadow;
46 class ShareableElementData;
47 class IntSize;
48 class Locale;
49 class UniqueElementData;
50 class PseudoElement;
51 class RenderRegion;
52 class ShadowRoot;
53 class StylePropertySet;
54
55 class ElementData : public RefCounted<ElementData> {
56     WTF_MAKE_FAST_ALLOCATED;
57 public:
58     // Override RefCounted's deref() to ensure operator delete is called on
59     // the appropriate subclass type.
60     void deref();
61
62     void clearClass() const { m_classNames.clear(); }
63     void setClass(const AtomicString& className, bool shouldFoldCase) const { m_classNames.set(className, shouldFoldCase); }
64     const SpaceSplitString& classNames() const { return m_classNames; }
65
66     const AtomicString& idForStyleResolution() const { return m_idForStyleResolution; }
67     void setIdForStyleResolution(const AtomicString& newId) const { m_idForStyleResolution = newId; }
68
69     const StylePropertySet* inlineStyle() const { return m_inlineStyle.get(); }
70
71     const StylePropertySet* presentationAttributeStyle() const;
72
73     size_t length() const;
74     bool isEmpty() const { return !length(); }
75
76     const Attribute* attributeItem(unsigned index) const;
77     const Attribute* getAttributeItem(const QualifiedName&) const;
78     size_t getAttributeItemIndex(const QualifiedName&) const;
79     size_t getAttributeItemIndex(const AtomicString& name, bool shouldIgnoreAttributeCase) const;
80
81     bool hasID() const { return !m_idForStyleResolution.isNull(); }
82     bool hasClass() const { return !m_classNames.isNull(); }
83
84     bool isEquivalent(const ElementData* other) const;
85
86     void reportMemoryUsage(MemoryObjectInfo*) const;
87
88     bool isUnique() const { return m_isUnique; }
89
90 protected:
91     ElementData();
92     ElementData(unsigned arraySize);
93     ElementData(const ElementData&, bool isUnique);
94
95     unsigned m_isUnique : 1;
96     unsigned m_arraySize : 28;
97     mutable unsigned m_presentationAttributeStyleIsDirty : 1;
98     mutable unsigned m_styleAttributeIsDirty : 1;
99 #if ENABLE(SVG)
100     mutable unsigned m_animatedSVGAttributesAreDirty : 1;
101 #endif
102
103     mutable RefPtr<StylePropertySet> m_inlineStyle;
104     mutable SpaceSplitString m_classNames;
105     mutable AtomicString m_idForStyleResolution;
106
107 private:
108     friend class Element;
109     friend class StyledElement;
110     friend class ShareableElementData;
111     friend class UniqueElementData;
112 #if ENABLE(SVG)
113     friend class SVGElement;
114 #endif
115
116     const Attribute* getAttributeItem(const AtomicString& name, bool shouldIgnoreAttributeCase) const;
117     size_t getAttributeItemIndexSlowCase(const AtomicString& name, bool shouldIgnoreAttributeCase) const;
118
119     PassRefPtr<UniqueElementData> makeUniqueCopy() const;
120 };
121
122 #if COMPILER(MSVC)
123 #pragma warning(push)
124 #pragma warning(disable: 4200) // Disable "zero-sized array in struct/union" warning
125 #endif
126
127 class ShareableElementData : public ElementData {
128 public:
129     static PassRefPtr<ShareableElementData> createWithAttributes(const Vector<Attribute>&);
130
131     explicit ShareableElementData(const Vector<Attribute>&);
132     explicit ShareableElementData(const UniqueElementData&);
133     ~ShareableElementData();
134
135     Attribute m_attributeArray[0];
136 };
137
138 #if COMPILER(MSVC)
139 #pragma warning(pop)
140 #endif
141
142 class UniqueElementData : public ElementData {
143 public:
144     static PassRefPtr<UniqueElementData> create();
145     PassRefPtr<ShareableElementData> makeShareableCopy() const;
146
147     // These functions do no error/duplicate checking.
148     void addAttribute(const QualifiedName&, const AtomicString&);
149     void removeAttribute(size_t index);
150
151     Attribute* attributeItem(unsigned index);
152     Attribute* getAttributeItem(const QualifiedName&);
153
154     UniqueElementData();
155     explicit UniqueElementData(const ShareableElementData&);
156     explicit UniqueElementData(const UniqueElementData&);
157
158     mutable RefPtr<StylePropertySet> m_presentationAttributeStyle;
159     Vector<Attribute, 4> m_attributeVector;
160 };
161
162 enum AffectedSelectorType {
163     AffectedSelectorChecked = 1,
164     AffectedSelectorEnabled = 1 << 1,
165     AffectedSelectorDisabled = 1 << 2,
166     AffectedSelectorIndeterminate = 1 << 3,
167     AffectedSelectorLink = 1 << 4,
168     AffectedSelectorTarget = 1 << 5,
169     AffectedSelectorVisited = 1 << 6
170 };
171 typedef int AffectedSelectorMask;
172
173 enum SpellcheckAttributeState {
174     SpellcheckAttributeTrue,
175     SpellcheckAttributeFalse,
176     SpellcheckAttributeDefault
177 };
178
179 class Element : public ContainerNode {
180 public:
181     static PassRefPtr<Element> create(const QualifiedName&, Document*);
182     virtual ~Element();
183
184     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
185     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
186     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
187     DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
188     DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
189     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
190     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
191     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
192     DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
193     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
194     DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
195     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
196     DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
197     DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
198     DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
199     DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
200     DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
201     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
202     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
203     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
204     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
205     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
206     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
207     DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
208     DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
209     DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
210
211     // These four attribute event handler attributes are overridden by HTMLBodyElement
212     // and HTMLFrameSetElement to forward to the DOMWindow.
213     DECLARE_VIRTUAL_ATTRIBUTE_EVENT_LISTENER(blur);
214     DECLARE_VIRTUAL_ATTRIBUTE_EVENT_LISTENER(error);
215     DECLARE_VIRTUAL_ATTRIBUTE_EVENT_LISTENER(focus);
216     DECLARE_VIRTUAL_ATTRIBUTE_EVENT_LISTENER(load);
217
218     // WebKit extensions
219     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut);
220     DEFINE_ATTRIBUTE_EVENT_LISTENER(cut);
221     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy);
222     DEFINE_ATTRIBUTE_EVENT_LISTENER(copy);
223     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste);
224     DEFINE_ATTRIBUTE_EVENT_LISTENER(paste);
225     DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
226     DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
227     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectstart);
228 #if ENABLE(TOUCH_EVENTS)
229     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
230     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
231     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
232     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
233 #endif
234 #if ENABLE(FULLSCREEN_API)
235     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenchange);
236     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenerror);
237 #endif
238
239     bool hasAttribute(const QualifiedName&) const;
240     const AtomicString& getAttribute(const QualifiedName&) const;
241     void setAttribute(const QualifiedName&, const AtomicString& value);
242     void setSynchronizedLazyAttribute(const QualifiedName&, const AtomicString& value);
243     void removeAttribute(const QualifiedName&);
244
245     // Typed getters and setters for language bindings.
246     int getIntegralAttribute(const QualifiedName& attributeName) const;
247     void setIntegralAttribute(const QualifiedName& attributeName, int value);
248     unsigned getUnsignedIntegralAttribute(const QualifiedName& attributeName) const;
249     void setUnsignedIntegralAttribute(const QualifiedName& attributeName, unsigned value);
250
251     // Call this to get the value of an attribute that is known not to be the style
252     // attribute or one of the SVG animatable attributes.
253     bool fastHasAttribute(const QualifiedName&) const;
254     const AtomicString& fastGetAttribute(const QualifiedName&) const;
255 #ifndef NDEBUG
256     bool fastAttributeLookupAllowed(const QualifiedName&) const;
257 #endif
258
259 #ifdef DUMP_NODE_STATISTICS
260     bool hasNamedNodeMap() const;
261 #endif
262     bool hasAttributes() const;
263     // This variant will not update the potentially invalid attributes. To be used when not interested
264     // in style attribute or one of the SVG animation attributes.
265     bool hasAttributesWithoutUpdate() const;
266
267     bool hasAttribute(const AtomicString& name) const;
268     bool hasAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
269
270     const AtomicString& getAttribute(const AtomicString& name) const;
271     const AtomicString& getAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName) const;
272
273     void setAttribute(const AtomicString& name, const AtomicString& value, ExceptionCode&);
274     static bool parseAttributeName(QualifiedName&, const AtomicString& namespaceURI, const AtomicString& qualifiedName, ExceptionCode&);
275     void setAttributeNS(const AtomicString& namespaceURI, const AtomicString& qualifiedName, const AtomicString& value, ExceptionCode&);
276
277     bool isIdAttributeName(const QualifiedName&) const;
278     const AtomicString& getIdAttribute() const;
279     void setIdAttribute(const AtomicString&);
280
281     const AtomicString& getNameAttribute() const;
282
283     // Call this to get the value of the id attribute for style resolution purposes.
284     // The value will already be lowercased if the document is in compatibility mode,
285     // so this function is not suitable for non-style uses.
286     const AtomicString& idForStyleResolution() const;
287
288     // Internal methods that assume the existence of attribute storage, one should use hasAttributes()
289     // before calling them.
290     size_t attributeCount() const;
291     const Attribute* attributeItem(unsigned index) const;
292     const Attribute* getAttributeItem(const QualifiedName&) const;
293     size_t getAttributeItemIndex(const QualifiedName& name) const { return elementData()->getAttributeItemIndex(name); }
294     size_t getAttributeItemIndex(const AtomicString& name, bool shouldIgnoreAttributeCase) const { return elementData()->getAttributeItemIndex(name, shouldIgnoreAttributeCase); }
295
296     void scrollIntoView(bool alignToTop = true);
297     void scrollIntoViewIfNeeded(bool centerIfNeeded = true);
298
299     void scrollByLines(int lines);
300     void scrollByPages(int pages);
301
302     int offsetLeft();
303     int offsetTop();
304     int offsetWidth();
305     int offsetHeight();
306
307     // FIXME: Replace uses of offsetParent in the platform with calls
308     // to the render layer and merge bindingsOffsetParent and offsetParent.
309     Element* bindingsOffsetParent();
310
311     Element* offsetParent();
312     int clientLeft();
313     int clientTop();
314     int clientWidth();
315     int clientHeight();
316     virtual int scrollLeft();
317     virtual int scrollTop();
318     virtual void setScrollLeft(int);
319     virtual void setScrollTop(int);
320     virtual int scrollWidth();
321     virtual int scrollHeight();
322
323     IntRect boundsInRootViewSpace();
324
325     PassRefPtr<ClientRectList> getClientRects();
326     PassRefPtr<ClientRect> getBoundingClientRect();
327     
328     // Returns the absolute bounding box translated into screen coordinates:
329     IntRect screenRect() const;
330
331     void removeAttribute(const AtomicString& name);
332     void removeAttributeNS(const AtomicString& namespaceURI, const AtomicString& localName);
333
334     PassRefPtr<Attr> detachAttribute(size_t index);
335
336     PassRefPtr<Attr> getAttributeNode(const AtomicString& name);
337     PassRefPtr<Attr> getAttributeNodeNS(const AtomicString& namespaceURI, const AtomicString& localName);
338     PassRefPtr<Attr> setAttributeNode(Attr*, ExceptionCode&);
339     PassRefPtr<Attr> setAttributeNodeNS(Attr*, ExceptionCode&);
340     PassRefPtr<Attr> removeAttributeNode(Attr*, ExceptionCode&);
341
342     PassRefPtr<Attr> attrIfExists(const QualifiedName&);
343     PassRefPtr<Attr> ensureAttr(const QualifiedName&);
344
345     const Vector<RefPtr<Attr> >& attrNodeList();
346
347     virtual CSSStyleDeclaration* style();
348
349     const QualifiedName& tagQName() const { return m_tagName; }
350     String tagName() const { return nodeName(); }
351     bool hasTagName(const QualifiedName& tagName) const { return m_tagName.matches(tagName); }
352     
353     // A fast function for checking the local name against another atomic string.
354     bool hasLocalName(const AtomicString& other) const { return m_tagName.localName() == other; }
355     bool hasLocalName(const QualifiedName& other) const { return m_tagName.localName() == other.localName(); }
356
357     const AtomicString& localName() const { return m_tagName.localName(); }
358     const AtomicString& prefix() const { return m_tagName.prefix(); }
359     const AtomicString& namespaceURI() const { return m_tagName.namespaceURI(); }
360
361     virtual KURL baseURI() const;
362
363     virtual String nodeName() const;
364
365     PassRefPtr<Element> cloneElementWithChildren();
366     PassRefPtr<Element> cloneElementWithoutChildren();
367
368     void normalizeAttributes();
369     String nodeNamePreservingCase() const;
370
371     void setBooleanAttribute(const QualifiedName& name, bool);
372
373     // For exposing to DOM only.
374     NamedNodeMap* attributes() const;
375
376     enum AttributeModificationReason {
377         ModifiedDirectly,
378         ModifiedByCloning
379     };
380
381     // This method is called whenever an attribute is added, changed or removed.
382     virtual void attributeChanged(const QualifiedName&, const AtomicString&, AttributeModificationReason = ModifiedDirectly);
383     virtual void parseAttribute(const QualifiedName&, const AtomicString&) { }
384
385     // Only called by the parser immediately after element construction.
386     void parserSetAttributes(const Vector<Attribute>&);
387
388     // Remove attributes that might introduce scripting from the vector leaving the element unchanged.
389     void stripScriptingAttributes(Vector<Attribute>&) const;
390
391     const ElementData* elementData() const { return m_elementData.get(); }
392     UniqueElementData* ensureUniqueElementData();
393
394     void synchronizeAllAttributes() const;
395
396     // Clones attributes only.
397     void cloneAttributesFromElement(const Element&);
398
399     // Clones all attribute-derived data, including subclass specifics (through copyNonAttributeProperties.)
400     void cloneDataFromElement(const Element&);
401
402     bool hasEquivalentAttributes(const Element* other) const;
403
404     virtual void copyNonAttributePropertiesFromElement(const Element&) { }
405
406     virtual void attach();
407     virtual void detach();
408     virtual RenderObject* createRenderer(RenderArena*, RenderStyle*);
409     virtual bool rendererIsNeeded(const NodeRenderingContext&);
410     void recalcStyle(StyleChange = NoChange);
411     void didAffectSelector(AffectedSelectorMask);
412
413     ElementShadow* shadow() const;
414     ElementShadow* ensureShadow();
415     PassRefPtr<ShadowRoot> createShadowRoot(ExceptionCode&);
416     ShadowRoot* shadowRoot() const;
417
418     bool hasAuthorShadowRoot() const { return shadowRoot(); }
419     virtual void willAddAuthorShadowRoot() { }
420
421     ShadowRoot* userAgentShadowRoot() const;
422     ShadowRoot* ensureUserAgentShadowRoot();
423
424     virtual const AtomicString& shadowPseudoId() const;
425
426     RenderStyle* computedStyle(PseudoId = NOPSEUDO);
427
428     // Methods for indicating the style is affected by dynamic updates (e.g., children changing, our position changing in our sibling list, etc.)
429     bool styleAffectedByEmpty() const { return hasRareData() && rareDataStyleAffectedByEmpty(); }
430     bool childrenAffectedByHover() const { return hasRareData() && rareDataChildrenAffectedByHover(); }
431     bool childrenAffectedByActive() const { return hasRareData() && rareDataChildrenAffectedByActive(); }
432     bool childrenAffectedByDrag() const { return hasRareData() && rareDataChildrenAffectedByDrag(); }
433     bool childrenAffectedByPositionalRules() const { return hasRareData() && (rareDataChildrenAffectedByForwardPositionalRules() || rareDataChildrenAffectedByBackwardPositionalRules()); }
434     bool childrenAffectedByFirstChildRules() const { return hasRareData() && rareDataChildrenAffectedByFirstChildRules(); }
435     bool childrenAffectedByLastChildRules() const { return hasRareData() && rareDataChildrenAffectedByLastChildRules(); }
436     bool childrenAffectedByDirectAdjacentRules() const { return hasRareData() && rareDataChildrenAffectedByDirectAdjacentRules(); }
437     bool childrenAffectedByForwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByForwardPositionalRules(); }
438     bool childrenAffectedByBackwardPositionalRules() const { return hasRareData() && rareDataChildrenAffectedByBackwardPositionalRules(); }
439     unsigned childIndex() const { return hasRareData() ? rareDataChildIndex() : 0; }
440
441     bool hasFlagsSetDuringStylingOfChildren() const;
442
443     void setStyleAffectedByEmpty();
444     void setChildrenAffectedByHover(bool);
445     void setChildrenAffectedByActive(bool);
446     void setChildrenAffectedByDrag(bool);
447     void setChildrenAffectedByFirstChildRules();
448     void setChildrenAffectedByLastChildRules();
449     void setChildrenAffectedByDirectAdjacentRules();
450     void setChildrenAffectedByForwardPositionalRules();
451     void setChildrenAffectedByBackwardPositionalRules();
452     void setChildIndex(unsigned);
453
454     void setIsInCanvasSubtree(bool);
455     bool isInCanvasSubtree() const;
456
457     AtomicString computeInheritedLanguage() const;
458     Locale& locale() const;
459
460     virtual void accessKeyAction(bool /*sendToAnyEvent*/) { }
461
462     virtual bool isURLAttribute(const Attribute&) const { return false; }
463     virtual bool isHTMLContentAttribute(const Attribute&) const { return false; }
464
465     KURL getURLAttribute(const QualifiedName&) const;
466     KURL getNonEmptyURLAttribute(const QualifiedName&) const;
467
468     virtual const AtomicString& imageSourceURL() const;
469     virtual String target() const { return String(); }
470
471     virtual void focus(bool restorePreviousSelection = true, FocusDirection = FocusDirectionNone);
472     virtual void updateFocusAppearance(bool restorePreviousSelection);
473     virtual void blur();
474
475     String innerText();
476     String outerText();
477  
478     virtual String title() const;
479
480     const AtomicString& pseudo() const;
481     void setPseudo(const AtomicString&);
482
483     LayoutSize minimumSizeForResizing() const;
484     void setMinimumSizeForResizing(const LayoutSize&);
485
486     // Use Document::registerForDocumentActivationCallbacks() to subscribe to these
487     virtual void documentWillSuspendForPageCache() { }
488     virtual void documentDidResumeFromPageCache() { }
489
490     // Use Document::registerForMediaVolumeCallbacks() to subscribe to this
491     virtual void mediaVolumeDidChange() { }
492
493     // Use Document::registerForPrivateBrowsingStateChangedCallbacks() to subscribe to this.
494     virtual void privateBrowsingStateDidChange() { }
495
496     virtual void didBecomeFullscreenElement() { }
497     virtual void willStopBeingFullscreenElement() { }
498
499 #if ENABLE(VIDEO_TRACK)
500     virtual void captionPreferencesChanged() { }
501 #endif
502
503     bool isFinishedParsingChildren() const { return isParsingChildrenFinished(); }
504     virtual void finishParsingChildren();
505     virtual void beginParsingChildren();
506
507     bool hasPseudoElements() const;
508     PseudoElement* pseudoElement(PseudoId) const;
509     RenderObject* pseudoElementRenderer(PseudoId) const;
510     bool childNeedsShadowWalker() const;
511     void didShadowTreeAwareChildrenChange();
512
513     // ElementTraversal API
514     Element* firstElementChild() const;
515     Element* lastElementChild() const;
516     Element* previousElementSibling() const;
517     Element* nextElementSibling() const;
518     unsigned childElementCount() const;
519
520     virtual bool matchesReadOnlyPseudoClass() const;
521     virtual bool matchesReadWritePseudoClass() const;
522     bool webkitMatchesSelector(const String& selectors, ExceptionCode&);
523     virtual bool shouldAppearIndeterminate() const;
524
525     DOMTokenList* classList();
526
527     DOMStringMap* dataset();
528
529 #if ENABLE(MATHML)
530     virtual bool isMathMLElement() const { return false; }
531 #else
532     static bool isMathMLElement() { return false; }
533 #endif
534
535 #if ENABLE(VIDEO)
536     virtual bool isMediaElement() const { return false; }
537 #endif
538
539 #if ENABLE(INPUT_SPEECH)
540     virtual bool isInputFieldSpeechButtonElement() const { return false; }
541 #endif
542 #if ENABLE(INPUT_MULTIPLE_FIELDS_UI)
543     virtual bool isDateTimeFieldElement() const;
544 #endif
545
546     virtual bool isFormControlElement() const { return false; }
547     virtual bool isSpinButtonElement() const { return false; }
548     virtual bool isTextFormControl() const { return false; }
549     virtual bool isOptionalFormControl() const { return false; }
550     virtual bool isRequiredFormControl() const { return false; }
551     virtual bool isDefaultButtonForForm() const { return false; }
552     virtual bool willValidate() const { return false; }
553     virtual bool isValidFormControlElement() { return false; }
554     virtual bool isInRange() const { return false; }
555     virtual bool isOutOfRange() const { return false; }
556     virtual bool isFrameElementBase() const { return false; }
557     virtual bool isTextFieldDecoration() const { return false; }
558
559     virtual bool canContainRangeEndPoint() const { return true; }
560
561     virtual const AtomicString& formControlType() const { return nullAtom; }
562
563     virtual bool wasChangedSinceLastFormControlChangeEvent() const;
564     virtual void setChangedSinceLastFormControlChangeEvent(bool);
565     virtual void dispatchFormControlChangeEvent() { }
566
567     // Used for disabled form elements; if true, prevents mouse events from being dispatched
568     // to event listeners, and prevents DOMActivate events from being sent at all.
569     virtual bool isDisabledFormControl() const;
570
571 #if ENABLE(DIALOG_ELEMENT)
572     bool isInert() const;
573 #endif
574
575 #if ENABLE(SVG)
576     virtual bool childShouldCreateRenderer(const NodeRenderingContext&) const;
577     bool hasPendingResources() const;
578     void setHasPendingResources();
579     void clearHasPendingResources();
580     virtual void buildPendingResource() { };
581 #endif
582
583 #if ENABLE(FULLSCREEN_API)
584     enum {
585         ALLOW_KEYBOARD_INPUT = 1 << 0,
586         LEGACY_MOZILLA_REQUEST = 1 << 1,
587     };
588     
589     void webkitRequestFullScreen(unsigned short flags);
590     virtual bool containsFullScreenElement() const;
591     virtual void setContainsFullScreenElement(bool);
592     virtual void setContainsFullScreenElementOnAncestorsCrossingFrameBoundaries(bool);
593
594     // W3C API
595     void webkitRequestFullscreen();
596 #endif
597
598 #if ENABLE(DIALOG_ELEMENT)
599     bool isInTopLayer() const;
600     void setIsInTopLayer(bool);
601 #endif
602
603 #if ENABLE(POINTER_LOCK)
604     void webkitRequestPointerLock();
605 #endif
606
607     virtual bool isSpellCheckingEnabled() const;
608
609     PassRefPtr<RenderStyle> styleForRenderer();
610
611     RenderRegion* renderRegion() const;
612 #if ENABLE(CSS_REGIONS)
613     const AtomicString& webkitRegionOverset() const;
614     Vector<RefPtr<Range> > webkitGetRegionFlowRanges() const;
615 #endif
616
617     bool hasID() const;
618     bool hasClass() const;
619     const SpaceSplitString& classNames() const;
620
621     IntSize savedLayerScrollOffset() const;
622     void setSavedLayerScrollOffset(const IntSize&);
623
624     virtual void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
625
626 protected:
627     Element(const QualifiedName& tagName, Document* document, ConstructionType type)
628         : ContainerNode(document, type)
629         , m_tagName(tagName)
630     {
631     }
632
633     virtual InsertionNotificationRequest insertedInto(ContainerNode*) OVERRIDE;
634     virtual void removedFrom(ContainerNode*) OVERRIDE;
635     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
636     virtual void removeAllEventListeners() OVERRIDE;
637
638     virtual bool willRecalcStyle(StyleChange);
639     virtual void didRecalcStyle(StyleChange);
640     virtual PassRefPtr<RenderStyle> customStyleForRenderer();
641
642     virtual bool shouldRegisterAsNamedItem() const { return false; }
643     virtual bool shouldRegisterAsExtraNamedItem() const { return false; }
644
645     void clearTabIndexExplicitlyIfNeeded();    
646     void setTabIndexExplicitly(short);
647     virtual bool supportsFocus() const OVERRIDE;
648     virtual short tabIndex() const OVERRIDE;
649
650     PassRefPtr<HTMLCollection> ensureCachedHTMLCollection(CollectionType);
651     HTMLCollection* cachedHTMLCollection(CollectionType);
652
653     // classAttributeChanged() exists to share code between
654     // parseAttribute (called via setAttribute()) and
655     // svgAttributeChanged (called when element.className.baseValue is set)
656     void classAttributeChanged(const AtomicString& newClassString);
657
658 private:
659     void updatePseudoElement(PseudoId, StyleChange = NoChange);
660     PassRefPtr<PseudoElement> createPseudoElementIfNeeded(PseudoId);
661     void setPseudoElement(PseudoId, PassRefPtr<PseudoElement>);
662
663     virtual bool areAuthorShadowsAllowed() const { return true; }
664     virtual void didAddUserAgentShadowRoot(ShadowRoot*) { }
665     virtual bool alwaysCreateUserAgentShadowRoot() const { return false; }
666
667     // FIXME: Remove the need for Attr to call willModifyAttribute/didModifyAttribute.
668     friend class Attr;
669
670     enum SynchronizationOfLazyAttribute { NotInSynchronizationOfLazyAttribute = 0, InSynchronizationOfLazyAttribute };
671
672     void didAddAttribute(const QualifiedName&, const AtomicString&);
673     void willModifyAttribute(const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
674     void didModifyAttribute(const QualifiedName&, const AtomicString&);
675     void didRemoveAttribute(const QualifiedName&);
676
677     void synchronizeAttribute(const QualifiedName&) const;
678     void synchronizeAttribute(const AtomicString& localName) const;
679
680     void updateId(const AtomicString& oldId, const AtomicString& newId);
681     void updateId(TreeScope*, const AtomicString& oldId, const AtomicString& newId);
682     void updateName(const AtomicString& oldName, const AtomicString& newName);
683     void updateLabel(TreeScope*, const AtomicString& oldForAttributeValue, const AtomicString& newForAttributeValue);
684
685     void scrollByUnits(int units, ScrollGranularity);
686
687     virtual void setPrefix(const AtomicString&, ExceptionCode&);
688     virtual NodeType nodeType() const;
689     virtual bool childTypeAllowed(NodeType) const;
690
691     void setAttributeInternal(size_t index, const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
692     void addAttributeInternal(const QualifiedName&, const AtomicString& value, SynchronizationOfLazyAttribute);
693     void removeAttributeInternal(size_t index, SynchronizationOfLazyAttribute);
694     void attributeChangedFromParserOrByCloning(const QualifiedName&, const AtomicString&, AttributeModificationReason);
695
696 #ifndef NDEBUG
697     virtual void formatForDebugger(char* buffer, unsigned length) const;
698 #endif
699
700     bool pseudoStyleCacheIsInvalid(const RenderStyle* currentStyle, RenderStyle* newStyle);
701
702     void cancelFocusAppearanceUpdate();
703
704     virtual const AtomicString& virtualPrefix() const { return prefix(); }
705     virtual const AtomicString& virtualLocalName() const { return localName(); }
706     virtual const AtomicString& virtualNamespaceURI() const { return namespaceURI(); }
707     virtual RenderStyle* virtualComputedStyle(PseudoId pseudoElementSpecifier = NOPSEUDO) { return computedStyle(pseudoElementSpecifier); }
708     
709     // cloneNode is private so that non-virtual cloneElementWithChildren and cloneElementWithoutChildren
710     // are used instead.
711     virtual PassRefPtr<Node> cloneNode(bool deep) OVERRIDE;
712     virtual PassRefPtr<Element> cloneElementWithoutAttributesAndChildren();
713
714     QualifiedName m_tagName;
715     bool rareDataStyleAffectedByEmpty() const;
716     bool rareDataChildrenAffectedByHover() const;
717     bool rareDataChildrenAffectedByActive() const;
718     bool rareDataChildrenAffectedByDrag() const;
719     bool rareDataChildrenAffectedByFirstChildRules() const;
720     bool rareDataChildrenAffectedByLastChildRules() const;
721     bool rareDataChildrenAffectedByDirectAdjacentRules() const;
722     bool rareDataChildrenAffectedByForwardPositionalRules() const;
723     bool rareDataChildrenAffectedByBackwardPositionalRules() const;
724     unsigned rareDataChildIndex() const;
725
726     SpellcheckAttributeState spellcheckAttributeState() const;
727
728     void updateNamedItemRegistration(const AtomicString& oldName, const AtomicString& newName);
729     void updateExtraNamedItemRegistration(const AtomicString& oldName, const AtomicString& newName);
730
731     void unregisterNamedFlowContentNode();
732
733     void createUniqueElementData();
734
735     bool shouldInvalidateDistributionWhenAttributeChanged(ElementShadow*, const QualifiedName&, const AtomicString&);
736
737     ElementRareData* elementRareData() const;
738     ElementRareData* ensureElementRareData();
739
740     void detachAllAttrNodesFromElement();
741     void detachAttrNodeFromElementWithValue(Attr*, const AtomicString& value);
742
743     void createRendererIfNeeded();
744
745     bool isJavaScriptURLAttribute(const Attribute&) const;
746
747     RefPtr<ElementData> m_elementData;
748 };
749     
750 inline Element* toElement(Node* node)
751 {
752     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isElementNode());
753     return static_cast<Element*>(node);
754 }
755
756 inline const Element* toElement(const Node* node)
757 {
758     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isElementNode());
759     return static_cast<const Element*>(node);
760 }
761
762 // This will catch anyone doing an unnecessary cast.
763 void toElement(const Element*);
764
765 inline bool isDisabledFormControl(const Node* node)
766 {
767     return node->isElementNode() && toElement(node)->isDisabledFormControl();
768 }
769
770 inline bool Node::hasTagName(const QualifiedName& name) const
771 {
772     return isElementNode() && toElement(this)->hasTagName(name);
773 }
774     
775 inline bool Node::hasLocalName(const AtomicString& name) const
776 {
777     return isElementNode() && toElement(this)->hasLocalName(name);
778 }
779
780 inline bool Node::hasAttributes() const
781 {
782     return isElementNode() && toElement(this)->hasAttributes();
783 }
784
785 inline NamedNodeMap* Node::attributes() const
786 {
787     return isElementNode() ? toElement(this)->attributes() : 0;
788 }
789
790 inline Element* Node::parentElement() const
791 {
792     ContainerNode* parent = parentNode();
793     return parent && parent->isElementNode() ? toElement(parent) : 0;
794 }
795
796 inline Element* Element::previousElementSibling() const
797 {
798     Node* n = previousSibling();
799     while (n && !n->isElementNode())
800         n = n->previousSibling();
801     return static_cast<Element*>(n);
802 }
803
804 inline Element* Element::nextElementSibling() const
805 {
806     Node* n = nextSibling();
807     while (n && !n->isElementNode())
808         n = n->nextSibling();
809     return static_cast<Element*>(n);
810 }
811
812 inline bool Element::fastHasAttribute(const QualifiedName& name) const
813 {
814     ASSERT(fastAttributeLookupAllowed(name));
815     return elementData() && getAttributeItem(name);
816 }
817
818 inline const AtomicString& Element::fastGetAttribute(const QualifiedName& name) const
819 {
820     ASSERT(fastAttributeLookupAllowed(name));
821     if (elementData()) {
822         if (const Attribute* attribute = getAttributeItem(name))
823             return attribute->value();
824     }
825     return nullAtom;
826 }
827
828 inline bool Element::hasAttributesWithoutUpdate() const
829 {
830     return elementData() && !elementData()->isEmpty();
831 }
832
833 inline const AtomicString& Element::idForStyleResolution() const
834 {
835     ASSERT(hasID());
836     return elementData()->idForStyleResolution();
837 }
838
839 inline bool Element::isIdAttributeName(const QualifiedName& attributeName) const
840 {
841     // FIXME: This check is probably not correct for the case where the document has an id attribute
842     // with a non-null namespace, because it will return false, a false negative, if the prefixes
843     // don't match but the local name and namespace both do. However, since this has been like this
844     // for a while and the code paths may be hot, we'll have to measure performance if we fix it.
845     return attributeName == document()->idAttributeName();
846 }
847
848 inline const AtomicString& Element::getIdAttribute() const
849 {
850     return hasID() ? fastGetAttribute(document()->idAttributeName()) : nullAtom;
851 }
852
853 inline const AtomicString& Element::getNameAttribute() const
854 {
855     return hasName() ? fastGetAttribute(HTMLNames::nameAttr) : nullAtom;
856 }
857
858 inline void Element::setIdAttribute(const AtomicString& value)
859 {
860     setAttribute(document()->idAttributeName(), value);
861 }
862
863 inline const SpaceSplitString& Element::classNames() const
864 {
865     ASSERT(hasClass());
866     ASSERT(elementData());
867     return elementData()->classNames();
868 }
869
870 inline size_t Element::attributeCount() const
871 {
872     ASSERT(elementData());
873     return elementData()->length();
874 }
875
876 inline const Attribute* Element::attributeItem(unsigned index) const
877 {
878     ASSERT(elementData());
879     return elementData()->attributeItem(index);
880 }
881
882 inline const Attribute* Element::getAttributeItem(const QualifiedName& name) const
883 {
884     ASSERT(elementData());
885     return elementData()->getAttributeItem(name);
886 }
887
888 inline bool Element::hasID() const
889 {
890     return elementData() && elementData()->hasID();
891 }
892
893 inline bool Element::hasClass() const
894 {
895     return elementData() && elementData()->hasClass();
896 }
897
898 inline UniqueElementData* Element::ensureUniqueElementData()
899 {
900     if (!elementData() || !elementData()->isUnique())
901         createUniqueElementData();
902     return static_cast<UniqueElementData*>(m_elementData.get());
903 }
904
905 // Put here to make them inline.
906 inline bool Node::hasID() const
907 {
908     return isElementNode() && toElement(this)->hasID();
909 }
910
911 inline bool Node::hasClass() const
912 {
913     return isElementNode() && toElement(this)->hasClass();
914 }
915
916 inline Node::InsertionNotificationRequest Node::insertedInto(ContainerNode* insertionPoint)
917 {
918     ASSERT(insertionPoint->inDocument() || isContainerNode());
919     if (insertionPoint->inDocument())
920         setFlag(InDocumentFlag);
921     if (parentOrShadowHostNode()->isInShadowTree())
922         setFlag(IsInShadowTreeFlag);
923     return InsertionDone;
924 }
925
926 inline void Node::removedFrom(ContainerNode* insertionPoint)
927 {
928     ASSERT(insertionPoint->inDocument() || isContainerNode());
929     if (insertionPoint->inDocument())
930         clearFlag(InDocumentFlag);
931     if (isInShadowTree() && !treeScope()->rootNode()->isShadowRoot())
932         clearFlag(IsInShadowTreeFlag);
933 }
934
935 inline bool isShadowHost(const Node* node)
936 {
937     return node && node->isElementNode() && toElement(node)->shadow();
938 }
939
940 inline size_t ElementData::length() const
941 {
942     if (isUnique())
943         return static_cast<const UniqueElementData*>(this)->m_attributeVector.size();
944     return m_arraySize;
945 }
946
947 inline const StylePropertySet* ElementData::presentationAttributeStyle() const
948 {
949     if (!m_isUnique)
950         return 0;
951     return static_cast<const UniqueElementData*>(this)->m_presentationAttributeStyle.get();
952 }
953
954 inline const Attribute* ElementData::getAttributeItem(const AtomicString& name, bool shouldIgnoreAttributeCase) const
955 {
956     size_t index = getAttributeItemIndex(name, shouldIgnoreAttributeCase);
957     if (index != notFound)
958         return attributeItem(index);
959     return 0;
960 }
961
962 inline size_t ElementData::getAttributeItemIndex(const QualifiedName& name) const
963 {
964     for (unsigned i = 0; i < length(); ++i) {
965         if (attributeItem(i)->name().matches(name))
966             return i;
967     }
968     return notFound;
969 }
970
971 // We use a boolean parameter instead of calling shouldIgnoreAttributeCase so that the caller
972 // can tune the behavior (hasAttribute is case sensitive whereas getAttribute is not).
973 inline size_t ElementData::getAttributeItemIndex(const AtomicString& name, bool shouldIgnoreAttributeCase) const
974 {
975     unsigned len = length();
976     bool doSlowCheck = shouldIgnoreAttributeCase;
977
978     const AtomicString caseAdjustedName = shouldIgnoreAttributeCase ? name.lower() : name;
979     // Optimize for the case where the attribute exists and its name exactly matches.
980     for (unsigned i = 0; i < len; ++i) {
981         const Attribute* attribute = attributeItem(i);
982         if (!attribute->name().hasPrefix()) {
983             if (caseAdjustedName == attribute->localName())
984                 return i;
985         } else
986             doSlowCheck = true;
987     }
988
989     if (doSlowCheck)
990         return getAttributeItemIndexSlowCase(name, shouldIgnoreAttributeCase);
991     return notFound;
992 }
993
994 inline const Attribute* ElementData::getAttributeItem(const QualifiedName& name) const
995 {
996     for (unsigned i = 0; i < length(); ++i) {
997         if (attributeItem(i)->name().matches(name))
998             return attributeItem(i);
999     }
1000     return 0;
1001 }
1002
1003 inline const Attribute* ElementData::attributeItem(unsigned index) const
1004 {
1005     ASSERT_WITH_SECURITY_IMPLICATION(index < length());
1006     if (m_isUnique)
1007         return &static_cast<const UniqueElementData*>(this)->m_attributeVector.at(index);
1008     return &static_cast<const ShareableElementData*>(this)->m_attributeArray[index];
1009 }
1010
1011 } // namespace
1012
1013 #endif