a312c9f3e43c572d94a1f7f54c2add968036991f
[WebKit-https.git] / WebKit / chromium / public / WebNode.h
1 /*
2  * Copyright (C) 2009 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebNode_h
32 #define WebNode_h
33
34 #include "WebCommon.h"
35 #include "WebString.h"
36
37 namespace WebCore { class Node; }
38 #if WEBKIT_IMPLEMENTATION
39 namespace WTF { template <typename T> class PassRefPtr; }
40 #endif
41
42 namespace WebKit {
43 class WebFrame;
44
45 // Provides readonly access to some properties of a DOM node.
46 class WebNode {
47 public:
48     virtual ~WebNode() { reset(); }
49
50     WebNode() : m_private(0) { }
51     WebNode(const WebNode& n) : m_private(0) { assign(n); }
52     WebNode& operator=(const WebNode& n)
53     {
54         assign(n);
55         return *this;
56     }
57
58     WEBKIT_API void reset();
59     WEBKIT_API void assign(const WebNode&);
60
61     bool isNull() const { return !m_private; }
62
63 #if WEBKIT_IMPLEMENTATION
64     WebNode(const WTF::PassRefPtr<WebCore::Node>&);
65     WebNode& operator=(const WTF::PassRefPtr<WebCore::Node>&);
66     operator WTF::PassRefPtr<WebCore::Node>() const;
67 #endif
68
69     WEBKIT_API WebNode parentNode() const;
70     WEBKIT_API WebString nodeName() const;
71     WEBKIT_API WebFrame* frame();
72
73     template<typename T> T toElement()
74     {
75         T res;
76         res.m_private = m_private;
77         return res;
78     }
79
80 protected:
81     typedef WebCore::Node WebNodePrivate;
82     void assign(WebNodePrivate*);
83     WebNodePrivate* m_private;
84     
85     template<typename T> T* unwrap()
86     {
87         return static_cast<T*>(m_private);
88     }
89
90     template<typename T> const T* constUnwrap() const
91     {
92         return static_cast<const T*>(m_private);
93     }
94 };
95
96 } // namespace WebKit
97
98 #endif