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 PrerenderHandle_h 33 #define PrerenderHandle_h 34 35 #include "weborigin/ReferrerPolicy.h" 36 #include "wtf/PassRefPtr.h" 37 #include "wtf/RefCounted.h" 38 #include "wtf/RefPtr.h" 39 #include "wtf/text/WTFString.h" 40 41 namespace WebCore { 42 43 class KURL; 44 class Prerender; 45 class PrerenderClient; 46 47 class PrerenderHandle : public RefCounted<PrerenderHandle> { 48 WTF_MAKE_NONCOPYABLE(PrerenderHandle); 49 public: 50 static PassRefPtr<PrerenderHandle> create(PrerenderClient*, const KURL&, const String& referrer, ReferrerPolicy); 51 ~PrerenderHandle(); 52 53 Prerender* prerender(); 54 55 void removeClient(); 56 57 // A prerender link element is added when it is inserted into a document. 58 void add(); 59 60 // A prerender is abandoned when it's navigated away from. This is is a weaker signal 61 // than cancel(), since the launcher hasn't indicated that the prerender isn't wanted, 62 // and we may end up using it after, for instance, a short redirect chain. 63 void abandon(); 64 65 // A prerender is canceled when it is removed from a document. 66 void cancel(); 67 68 // A prerender is suspended along with the DOM containing its linkloader & prerenderer. 69 void suspend(); 70 void resume(); 71 72 const KURL& url() const; 73 const String& referrer() const; 74 ReferrerPolicy referrerPolicy() const; 75 76 private: 77 PrerenderHandle(PrerenderClient*, const KURL&, const String& referrer, ReferrerPolicy); 78 79 RefPtr<Prerender> m_prerender; 80 }; 81 82 } // namespace WebCore 83 84 #endif // PrerenderHandle_h 85