third_party/WebKit/public/platform/WebPrerender.h

   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 #ifndef WebPrerender_h
  32 #define WebPrerender_h
  33
  34 #include "WebCommon.h"
  35 #include "WebPrivatePtr.h"
  36 #include "WebReferrerPolicy.h"
  37 #include "WebString.h"
  38 #include "WebURL.h"
  39
  40 #if INSIDE_BLINK
  41 #include "wtf/PassRefPtr.h"
  42 #endif
  43
  44 namespace blink {
  45
  46 class Prerender;
  47
  48 // WebPrerenderRelType is a bitfield since multiple rel attributes can be set on the same prerender.
  49 enum WebPrerenderRelType {
  50     PrerenderRelTypePrerender = 0x1,
  51     PrerenderRelTypeNext = 0x2,
  52 };
  53
  54 class WebPrerender {
  55 public:
  56     class ExtraData {
  57     public:
  58         virtual ~ExtraData() { }
  59     };
  60
  61     ~WebPrerender() { reset(); }
  62     WebPrerender() { }
  63     WebPrerender(const WebPrerender& other) { assign(other); }
  64     WebPrerender& operator=(const WebPrerender& other)
  65     {
  66         assign(other);
  67         return *this;
  68     }
  69
  70 #if INSIDE_BLINK
  71     BLINK_PLATFORM_EXPORT explicit WebPrerender(PassRefPtr<Prerender>);
  72
  73     BLINK_PLATFORM_EXPORT const Prerender* toPrerender() const;
  74 #endif
  75
  76     BLINK_PLATFORM_EXPORT void reset();
  77     BLINK_PLATFORM_EXPORT void assign(const WebPrerender&);
  78     BLINK_PLATFORM_EXPORT bool isNull() const;
  79
  80     BLINK_PLATFORM_EXPORT WebURL url() const;
  81     BLINK_PLATFORM_EXPORT WebString referrer() const;
  82     BLINK_PLATFORM_EXPORT unsigned relTypes() const;
  83     BLINK_PLATFORM_EXPORT WebReferrerPolicy referrerPolicy() const;
  84
  85     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
  86     BLINK_PLATFORM_EXPORT const ExtraData* extraData() const;
  87
  88     BLINK_PLATFORM_EXPORT void didStartPrerender();
  89     BLINK_PLATFORM_EXPORT void didStopPrerender();
  90     BLINK_PLATFORM_EXPORT void didSendLoadForPrerender();
  91     BLINK_PLATFORM_EXPORT void didSendDOMContentLoadedForPrerender();
  92
  93 private:
  94     WebPrivatePtr<Prerender> m_private;
  95 };
  96
  97 } // namespace blink
  98
  99 #endif // WebPrerender_h