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 WebDocument_h
32#define WebDocument_h
33
34#include "../platform/WebReferrerPolicy.h"
35#include "../platform/WebVector.h"
36#include "WebDraggableRegion.h"
37#include "WebExceptionCode.h"
38#include "WebNode.h"
39#include "WebSecurityOrigin.h"
40
41#if WEBKIT_IMPLEMENTATION
42namespace WebCore {
43class Document;
44class DocumentType;
45}
46namespace WTF { template <typename T> class PassRefPtr; }
47#endif
48
49namespace v8 {
50class Value;
51template <class T> class Handle;
52}
53
54namespace WebKit {
55class WebAccessibilityObject;
56class WebDocumentType;
57class WebElement;
58class WebFormElement;
59class WebFrame;
60class WebNodeCollection;
61class WebNodeList;
62class WebString;
63class WebURL;
64
65// Provides readonly access to some properties of a DOM document.
66class WebDocument : public WebNode {
67public:
68    enum UserStyleLevel {
69        UserStyleUserLevel,
70        UserStyleAuthorLevel
71    };
72
73    WebDocument() { }
74    WebDocument(const WebDocument& e) : WebNode(e) { }
75
76    WebDocument& operator=(const WebDocument& e)
77    {
78        WebNode::assign(e);
79        return *this;
80    }
81    void assign(const WebDocument& e) { WebNode::assign(e); }
82
83    WEBKIT_EXPORT WebURL url() const;
84    // Note: Security checks should use the securityOrigin(), not url().
85    WEBKIT_EXPORT WebSecurityOrigin securityOrigin() const;
86
87    WEBKIT_EXPORT WebString encoding() const;
88    WEBKIT_EXPORT WebString contentLanguage() const;
89
90    // The url of the OpenSearch Desription Document (if any).
91    WEBKIT_EXPORT WebURL openSearchDescriptionURL() const;
92
93    // Returns the frame the document belongs to or 0 if the document is frameless.
94    WEBKIT_EXPORT WebFrame* frame() const;
95    WEBKIT_EXPORT bool isHTMLDocument() const;
96    WEBKIT_EXPORT bool isXHTMLDocument() const;
97    WEBKIT_EXPORT bool isPluginDocument() const;
98    WEBKIT_EXPORT WebURL baseURL() const;
99
100    // The firstPartyForCookies is used to compute whether this document
101    // appears in a "third-party" context for the purpose of third-party
102    // cookie blocking.
103    WEBKIT_EXPORT WebURL firstPartyForCookies() const;
104
105    WEBKIT_EXPORT WebElement documentElement() const;
106    WEBKIT_EXPORT WebElement body() const;
107    WEBKIT_EXPORT WebElement head();
108    WEBKIT_EXPORT WebString title() const;
109    WEBKIT_EXPORT WebNodeCollection all();
110    WEBKIT_EXPORT void forms(WebVector<WebFormElement>&) const;
111    WEBKIT_EXPORT void images(WebVector<WebElement>&);
112    WEBKIT_EXPORT WebURL completeURL(const WebString&) const;
113    WEBKIT_EXPORT WebElement getElementById(const WebString&) const;
114    WEBKIT_EXPORT WebNode focusedNode() const;
115    WEBKIT_EXPORT WebDocumentType doctype() const;
116    WEBKIT_EXPORT void cancelFullScreen();
117    WEBKIT_EXPORT WebElement fullScreenElement() const;
118    WEBKIT_EXPORT WebDOMEvent createEvent(const WebString& eventType);
119    WEBKIT_EXPORT WebReferrerPolicy referrerPolicy() const;
120    WEBKIT_EXPORT WebElement createElement(const WebString& tagName);
121
122    // Accessibility support. These methods should only be called on the
123    // top-level document, because one accessibility cache spans all of
124    // the documents on the page.
125
126    // Gets the accessibility object for this document.
127    WEBKIT_EXPORT WebAccessibilityObject accessibilityObject() const;
128
129    // Gets the accessibility object for an object on this page by ID.
130    WEBKIT_EXPORT WebAccessibilityObject accessibilityObjectFromID(int axID) const;
131    // Inserts the given CSS source code as a user stylesheet in the document.
132    // Meant for programatic/one-off injection, as opposed to
133    // WebView::addUserStyleSheet which inserts styles for the lifetime of the
134    // WebView.
135    WEBKIT_EXPORT void insertUserStyleSheet(const WebString& sourceCode, UserStyleLevel);
136
137    WEBKIT_EXPORT WebVector<WebDraggableRegion> draggableRegions() const;
138
139    WEBKIT_EXPORT v8::Handle<v8::Value> registerEmbedderCustomElement(const WebString& name, v8::Handle<v8::Value> options, WebExceptionCode&);
140
141#if WEBKIT_IMPLEMENTATION
142    WebDocument(const WTF::PassRefPtr<WebCore::Document>&);
143    WebDocument& operator=(const WTF::PassRefPtr<WebCore::Document>&);
144    operator WTF::PassRefPtr<WebCore::Document>() const;
145#endif
146};
147
148} // namespace WebKit
149
150#endif
151