1/*
2 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4 *           (C) 2001 Dirk Mueller (mueller@kde.org)
5 *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All rights reserved.
7 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
9 * Copyright (C) 2013 Google Inc. All rights reserved.
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Library General Public
13 * License as published by the Free Software Foundation; either
14 * version 2 of the License, or (at your option) any later version.
15 *
16 * This library is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19 * Library General Public License for more details.
20 *
21 * You should have received a copy of the GNU Library General Public License
22 * along with this library; see the file COPYING.LIB.  If not, write to
23 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 * Boston, MA 02110-1301, USA.
25 *
26 */
27
28#ifndef DocumentInit_h
29#define DocumentInit_h
30
31#include "core/dom/SandboxFlags.h"
32#include "core/dom/SecurityContext.h"
33#include "platform/heap/Handle.h"
34#include "platform/weborigin/KURL.h"
35#include "wtf/PassRefPtr.h"
36#include "wtf/RefPtr.h"
37#include "wtf/WeakPtr.h"
38
39namespace blink {
40
41class CustomElementRegistrationContext;
42class Document;
43class LocalFrame;
44class HTMLImportsController;
45class Settings;
46
47class DocumentInit FINAL {
48    STACK_ALLOCATED();
49public:
50    explicit DocumentInit(const KURL& = KURL(), LocalFrame* = 0, WeakPtrWillBeRawPtr<Document> = nullptr, HTMLImportsController* = 0);
51    DocumentInit(const DocumentInit&);
52    ~DocumentInit();
53
54    const KURL& url() const { return m_url; }
55    LocalFrame* frame() const { return m_frame; }
56    HTMLImportsController* importsController() const { return m_importsController; }
57
58    bool hasSecurityContext() const { return frameForSecurityContext(); }
59    bool shouldTreatURLAsSrcdocDocument() const;
60    bool shouldSetURL() const;
61    bool isSeamlessAllowedFor(Document* child) const;
62    bool shouldReuseDefaultView() const { return m_shouldReuseDefaultView; }
63    SandboxFlags sandboxFlags() const;
64
65    Document* parent() const { return m_parent.get(); }
66    Document* owner() const { return m_owner.get(); }
67    KURL parentBaseURL() const;
68    LocalFrame* ownerFrame() const;
69    Settings* settings() const;
70
71    DocumentInit& withRegistrationContext(CustomElementRegistrationContext*);
72    DocumentInit& withNewRegistrationContext();
73    PassRefPtrWillBeRawPtr<CustomElementRegistrationContext> registrationContext(Document*) const;
74    WeakPtrWillBeRawPtr<Document> contextDocument() const;
75
76    static DocumentInit fromContext(WeakPtrWillBeRawPtr<Document> contextDocument, const KURL& = KURL());
77
78private:
79    LocalFrame* frameForSecurityContext() const;
80
81    KURL m_url;
82    RawPtrWillBeMember<LocalFrame> m_frame;
83    RefPtrWillBeMember<Document> m_parent;
84    RefPtrWillBeMember<Document> m_owner;
85    WeakPtrWillBeMember<Document> m_contextDocument;
86    RawPtrWillBeMember<HTMLImportsController> m_importsController;
87    RefPtrWillBeMember<CustomElementRegistrationContext> m_registrationContext;
88    bool m_createNewRegistrationContext;
89
90    // In some rare cases, we'll re-use a LocalDOMWindow for a new Document. For example,
91    // when a script calls window.open("..."), the browser gives JavaScript a window
92    // synchronously but kicks off the load in the window asynchronously. Web sites
93    // expect that modifications that they make to the window object synchronously
94    // won't be blown away when the network load commits. To make that happen, we
95    // "securely transition" the existing LocalDOMWindow to the Document that results from
96    // the network load. See also SecurityContext::isSecureTransitionTo.
97    // FIXME: This is for DocumentWriter creation, not for one of Document.
98    bool m_shouldReuseDefaultView;
99};
100
101} // namespace blink
102
103#endif // DocumentInit_h
104