Source/WebCore/loader/Prerenderer.h

/*
 * Copyright (C) 2012 Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT
 * OWNER OR 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.
 *
 */

#ifndef Prerenderer_h
#define Prerenderer_h

#if ENABLE(LINK_PRERENDER)

#include "ActiveDOMObject.h"
#include "KURL.h"
#include <wtf/OwnPtr.h>
#include <wtf/PassOwnPtr.h>
#include <wtf/PassRefPtr.h>
#include <wtf/RefPtr.h>
#include <wtf/SinglyLinkedList.h>
#include <wtf/Vector.h>

namespace WebCore {

class Document;
class PrerenderClient;
class PrerenderHandle;
class PrerendererClient;
class Page;

class Prerenderer : public ActiveDOMObject {
    WTF_MAKE_NONCOPYABLE(Prerenderer);
public:
    virtual ~Prerenderer();

    PassRefPtr<PrerenderHandle> render(PrerenderClient*, const KURL&);

    static PassOwnPtr<Prerenderer> create(Document*);

    // From ActiveDOMObject:
    virtual bool canSuspend() const OVERRIDE { return true; }
    virtual void stop() OVERRIDE;
    virtual void suspend(ReasonForSuspension) OVERRIDE;
    virtual void resume() OVERRIDE;

private:
    typedef Vector<RefPtr<PrerenderHandle> > HandleVector;
    typedef Vector<KURL> KURLVector;

    explicit Prerenderer(Document*);

    Document* document();
    PrerendererClient* client();

    bool m_initializedClient;
    PrerendererClient* m_client;
    HandleVector m_activeHandles;
    HandleVector m_suspendedHandles;
};

}

#endif // ENABLE(LINK_PRERENDER)

#endif // Prerenderer_h