Source/WebKit/UIProcess/SuspendedPageProxy.h

/*
 * Copyright (C) 2018 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "Connection.h"
#include "WebBackForwardListItem.h"
#include <WebCore/SecurityOriginData.h>
#include <wtf/RefCounted.h>

namespace WebKit {

class WebPageProxy;
class WebProcessProxy;

class SuspendedPageProxy : public RefCounted<SuspendedPageProxy> {
public:
    static Ref<SuspendedPageProxy> create(WebPageProxy& page, WebProcessProxy& process, WebBackForwardListItem& item)
    {
        return adoptRef(*new SuspendedPageProxy(page, process, item));
    }

    virtual ~SuspendedPageProxy();

    void didReceiveMessage(IPC::Connection&, IPC::Decoder&);

    WebPageProxy& page() const { return m_page; }
    WebProcessProxy* process() const { return m_process; }
    WebBackForwardListItem& item() const { return m_backForwardListItem; }
    const WebCore::SecurityOriginData& origin() const { return m_origin; }

    bool finishedSuspending() const { return m_finishedSuspending; }

    void webProcessDidClose(WebProcessProxy&);
    void destroyWebPageInWebProcess();

#if !LOG_DISABLED
    const char* loggingString() const;
#endif

private:
    SuspendedPageProxy(WebPageProxy&, WebProcessProxy&, WebBackForwardListItem&);

    void didFinishLoad();

    WebPageProxy& m_page;
    WebProcessProxy* m_process;
    Ref<WebBackForwardListItem> m_backForwardListItem;
    WebCore::SecurityOriginData m_origin;

    bool m_finishedSuspending { false };
};

} // namespace WebKit