src/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 WebCore {
  45 class Prerender;
  46 }
  47
  48 namespace blink {
  49
  50 class WebPrerender {
  51 public:
  52     class ExtraData {
  53     public:
  54         virtual ~ExtraData() { }
  55     };
  56
  57     ~WebPrerender() { reset(); }
  58     WebPrerender() { }
  59     WebPrerender(const WebPrerender& other) { assign(other); }
  60     WebPrerender& operator=(const WebPrerender& other)
  61     {
  62         assign(other);
  63         return *this;
  64     }
  65
  66 #if INSIDE_BLINK
  67     BLINK_PLATFORM_EXPORT explicit WebPrerender(PassRefPtr<WebCore::Prerender>);
  68
  69     BLINK_PLATFORM_EXPORT const WebCore::Prerender* toPrerender() const;
  70 #endif
  71
  72     BLINK_PLATFORM_EXPORT void reset();
  73     BLINK_PLATFORM_EXPORT void assign(const WebPrerender&);
  74     BLINK_PLATFORM_EXPORT bool isNull() const;
  75
  76     BLINK_PLATFORM_EXPORT WebURL url() const;
  77     BLINK_PLATFORM_EXPORT WebString referrer() const;
  78     BLINK_PLATFORM_EXPORT WebReferrerPolicy referrerPolicy() const;
  79
  80     BLINK_PLATFORM_EXPORT void setExtraData(ExtraData*);
  81     BLINK_PLATFORM_EXPORT const ExtraData* extraData() const;
  82
  83     BLINK_PLATFORM_EXPORT void didStartPrerender();
  84     BLINK_PLATFORM_EXPORT void didStopPrerender();
  85     BLINK_PLATFORM_EXPORT void didSendLoadForPrerender();
  86     BLINK_PLATFORM_EXPORT void didSendDOMContentLoadedForPrerender();
  87
  88 private:
  89     WebPrivatePtr<WebCore::Prerender> m_private;
  90 };
  91
  92 } // namespace blink
  93
  94 #endif // WebPrerender_h