/*
 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 *           (C) 2001 Dirk Mueller (mueller@kde.org)
 *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
 * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
 * rights reserved.
 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
 * (http://www.torchmobile.com/)
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public License
 * along with this library; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef DocumentInit_h
#define DocumentInit_h

#include "core/CoreExport.h"
#include "core/dom/SandboxFlags.h"
#include "core/dom/SecurityContext.h"
#include "core/dom/custom/V0CustomElementRegistrationContext.h"
#include "platform/heap/Handle.h"
#include "platform/weborigin/KURL.h"
#include "public/platform/WebInsecureRequestPolicy.h"

namespace blink {

class Document;
class LocalFrame;
class HTMLImportsController;
class Settings;

class CORE_EXPORT DocumentInit final {
  STACK_ALLOCATED();

 public:
  DocumentInit(const KURL& = KURL(),
               LocalFrame* = nullptr,
               Document* contextDocument = nullptr,
               HTMLImportsController* = nullptr,
               const ContentSecurityPolicy* = nullptr);
  DocumentInit(Document* ownerDocument,
               const KURL&,
               LocalFrame*,
               Document* contextDocument = nullptr,
               HTMLImportsController* = nullptr,
               const ContentSecurityPolicy* = nullptr);
  DocumentInit(const DocumentInit&);
  ~DocumentInit();

  const KURL& url() const { return m_url; }
  LocalFrame* frame() const { return m_frame; }
  HTMLImportsController* importsController() const {
    return m_importsController;
  }

  bool hasSecurityContext() const { return frameForSecurityContext(); }
  bool shouldTreatURLAsSrcdocDocument() const;
  bool shouldSetURL() const;
  bool isSeamlessAllowedFor(Document* child) const;
  bool shouldReuseDefaultView() const { return m_shouldReuseDefaultView; }
  SandboxFlags getSandboxFlags() const;
  bool isHostedInReservedIPRange() const;
  WebInsecureRequestPolicy getInsecureRequestPolicy() const;
  SecurityContext::InsecureNavigationsSet* insecureNavigationsToUpgrade() const;

  Document* parent() const { return m_parent.get(); }
  Document* owner() const { return m_owner.get(); }
  KURL parentBaseURL() const;
  LocalFrame* ownerFrame() const;
  Settings* settings() const;

  DocumentInit& withRegistrationContext(V0CustomElementRegistrationContext*);
  DocumentInit& withNewRegistrationContext();
  V0CustomElementRegistrationContext* registrationContext(Document*) const;
  Document* contextDocument() const;

  static DocumentInit fromContext(Document* contextDocument,
                                  const KURL& = KURL());

 private:
  LocalFrame* frameForSecurityContext() const;

  KURL m_url;
  Member<LocalFrame> m_frame;
  Member<Document> m_parent;
  Member<Document> m_owner;
  Member<Document> m_contextDocument;
  Member<HTMLImportsController> m_importsController;
  Member<V0CustomElementRegistrationContext> m_registrationContext;
  bool m_createNewRegistrationContext;

  // In some rare cases, we'll re-use a LocalDOMWindow for a new Document. For
  // example, when a script calls window.open("..."), the browser gives
  // JavaScript a window synchronously but kicks off the load in the window
  // asynchronously. Web sites expect that modifications that they make to the
  // window object synchronously won't be blown away when the network load
  // commits. To make that happen, we "securely transition" the existing
  // LocalDOMWindow to the Document that results from the network load. See also
  // SecurityContext::isSecureTransitionTo.
  // FIXME: This is for DocumentWriter creation, not for one of Document.
  bool m_shouldReuseDefaultView;
};

}  // namespace blink

#endif  // DocumentInit_h
