15267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)/* 25267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * Copyright (C) 2009 Google Inc. All rights reserved. 35267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 45267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * modification, are permitted provided that the following conditions are 65267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * met: 75267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 85267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Redistributions of source code must retain the above copyright 95267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Redistributions in binary form must reproduce the above 115267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * in the documentation and/or other materials provided with the 135267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * distribution. 145267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * contributors may be used to endorse or promote products derived from 165267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * this software without specific prior written permission. 175267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 185267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) */ 305267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 315267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#ifndef WebNode_h 325267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#define WebNode_h 335267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 345267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#include "../platform/WebCommon.h" 355267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#include "../platform/WebPrivatePtr.h" 365267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#include "../platform/WebString.h" 375267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#include "WebExceptionCode.h" 385267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 395267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)namespace WebCore { class Node; } 405267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 415267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)namespace WebKit { 425267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebDOMEvent; 435267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebDOMEventListener; 445267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebDOMEventListenerPrivate; 455267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebDocument; 465267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebElement; 475267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebFrame; 485267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebNodeList; 495267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebPluginContainer; 505267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 515267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// Provides access to some properties of a DOM node. 525267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebNode { 535267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)public: 545267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) virtual ~WebNode() { reset(); } 555267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 565267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebNode() { } 575267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebNode(const WebNode& n) { assign(n); } 585267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebNode& operator=(const WebNode& n) 595267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) { 605267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) assign(n); 615267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return *this; 625267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) } 635267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 645267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT void reset(); 655267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT void assign(const WebNode&); 665267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 675267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool equals(const WebNode&) const; 685267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // Required for using WebNodes in std maps. Note the order used is 695267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // arbitrary and should not be expected to have any specific meaning. 705267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool lessThan(const WebNode&) const; 715267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 725267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) bool isNull() const { return m_private.isNull(); } 735267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 745267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) enum NodeType { 755267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) ElementNode = 1, 765267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) AttributeNode = 2, 775267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) TextNode = 3, 785267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) CDataSectionNode = 4, 795267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // EntityReferenceNodes are deprecated and impossible to create in WebKit. 805267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) EntityNode = 6, 815267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) ProcessingInstructionsNode = 7, 825267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) CommentNode = 8, 835267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) DocumentNode = 9, 845267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) DocumentTypeNode = 10, 855267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) DocumentFragmentNode = 11, 865267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) NotationNode = 12, 875267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) XPathNamespaceNode = 13, 885267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) ShadowRootNode = 14 895267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) }; 905267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 915267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT NodeType nodeType() const; 925267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNode parentNode() const; 935267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebString nodeName() const; 945267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebString nodeValue() const; 955267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool setNodeValue(const WebString&); 965267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebDocument document() const; 975267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNode firstChild() const; 985267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNode lastChild() const; 995267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNode previousSibling() const; 1005267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNode nextSibling() const; 1015267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool hasChildNodes() const; 1025267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNodeList childNodes(); 1035267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebString createMarkup() const; 1045267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool isLink() const; 1055267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool isTextNode() const; 1065267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool isFocusable() const; 1075267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool isContentEditable() const; 1085267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool isElementNode() const; 1095267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // addEventListener only works with a small set of eventTypes. 1105267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT void addEventListener(const WebString& eventType, WebDOMEventListener* listener, bool useCapture); 1115267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool dispatchEvent(const WebDOMEvent&); 1125267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT void simulateClick(); 1135267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebNodeList getElementsByTagName(const WebString&) const; 1145267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebElement querySelector(const WebString&, WebExceptionCode&) const; 1155267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebElement rootEditableElement() const; 1165267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool focused() const; 1175267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool remove(); 1185267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1195267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // Returns true if the node has a non-empty bounding box in layout. 1205267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // This does not 100% guarantee the user can see it, but is pretty close. 1215267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // Note: This method only works properly after layout has occurred. 1225267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT bool hasNonEmptyBoundingBox() const; 1235267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebPluginContainer* pluginContainer() const; 1245267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WEBKIT_EXPORT WebElement shadowHost() const; 1255267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1265267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) template<typename T> T to() 1275267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) { 1285267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) T res; 1295267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) res.WebNode::assign(*this); 1305267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return res; 1315267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) } 1325267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1335267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) template<typename T> const T toConst() const 1345267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) { 1355267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) T res; 1365267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) res.WebNode::assign(*this); 1375267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return res; 1385267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) } 1395267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1405267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#if WEBKIT_IMPLEMENTATION 1415267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebNode(const WTF::PassRefPtr<WebCore::Node>&); 1425267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebNode& operator=(const WTF::PassRefPtr<WebCore::Node>&); 1435267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) operator WTF::PassRefPtr<WebCore::Node>() const; 1445267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#endif 1455267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1465267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#if WEBKIT_IMPLEMENTATION 1475267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) template<typename T> T* unwrap() 1485267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) { 1495267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return static_cast<T*>(m_private.get()); 1505267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) } 1515267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1525267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) template<typename T> const T* constUnwrap() const 1535267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) { 1545267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return static_cast<const T*>(m_private.get()); 1555267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) } 1565267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#endif 1575267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1585267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)protected: 1595267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebPrivatePtr<WebCore::Node> m_private; 1605267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)}; 1615267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1625267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)inline bool operator==(const WebNode& a, const WebNode& b) 1635267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles){ 1645267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return a.equals(b); 1655267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)} 1665267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1675267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)inline bool operator!=(const WebNode& a, const WebNode& b) 1685267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles){ 1695267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return !(a == b); 1705267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)} 1715267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1725267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)inline bool operator<(const WebNode& a, const WebNode& b) 1735267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles){ 1745267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) return a.lessThan(b); 1755267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)} 1765267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1775267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)} // namespace WebKit 1785267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 1795267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#endif 180