Home | History | Annotate | Download | only in platform 
      1 /*
      2  * Copyright (C) 2012 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 
     32 #ifndef Prerender_h
     33 #define Prerender_h
     34 
     35 #include "platform/PlatformExport.h"
     36 #include "platform/weborigin/KURL.h"
     37 #include "platform/weborigin/ReferrerPolicy.h"
     38 #include "wtf/OwnPtr.h"
     39 #include "wtf/PassOwnPtr.h"
     40 #include "wtf/PassRefPtr.h"
     41 #include "wtf/RefCounted.h"
     42 #include "wtf/RefPtr.h"
     43 #include "wtf/text/WTFString.h"
     44 
     45 namespace blink {
     46 class WebPrerender;
     47 }
     48 
     49 namespace WebCore {
     50 
     51 class PrerenderClient;
     52 
     53 // PrerenderRelType is a bitfield since multiple rel attributes can be set
     54 // on the same link.
     55 enum PrerenderRelType {
     56     PrerenderRelTypePrerender = 0x1,
     57     PrerenderRelTypeNext = 0x2,
     58 };
     59 
     60 class PLATFORM_EXPORT Prerender : public RefCounted<Prerender> {
     61     WTF_MAKE_NONCOPYABLE(Prerender);
     62 public:
     63     class ExtraData : public RefCounted<ExtraData> {
     64     public:
     65         virtual ~ExtraData() { }
     66     };
     67 
     68     static PassRefPtr<Prerender> create(PrerenderClient*, const KURL&, unsigned relTypes, const String& referrer, ReferrerPolicy);
     69     ~Prerender();
     70 
     71     void removeClient();
     72 
     73     void add();
     74     void cancel();
     75     void abandon();
     76 
     77     const KURL& url() const { return m_url; }
     78     unsigned relTypes() const { return m_relTypes; }
     79     const String& referrer() const { return m_referrer; }
     80     ReferrerPolicy referrerPolicy() const { return m_referrerPolicy; }
     81 
     82     void setExtraData(PassRefPtr<ExtraData> extraData) { m_extraData = extraData; }
     83     ExtraData* extraData() { return m_extraData.get(); }
     84 
     85     void didStartPrerender();
     86     void didStopPrerender();
     87     void didSendLoadForPrerender();
     88     void didSendDOMContentLoadedForPrerender();
     89 
     90 private:
     91     Prerender(PrerenderClient*, const KURL&, unsigned relTypes, const String& referrer, ReferrerPolicy);
     92 
     93     PrerenderClient* m_client;
     94 
     95     const KURL m_url;
     96     const unsigned m_relTypes;
     97     const String m_referrer;
     98     const ReferrerPolicy m_referrerPolicy;
     99 
    100     RefPtr<ExtraData> m_extraData;
    101 };
    102 
    103 }
    104 
    105 #endif // Prerender_h
    106