third_party/WebKit/Source/core/loader/PrerendererClient.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 PrerendererClient_h
#define PrerendererClient_h

#include "base/macros.h"
#include "core/CoreExport.h"
#include "core/page/Page.h"
#include "platform/Supplementable.h"

namespace blink {

class Page;
class Prerender;
class WebPrerendererClient;

class CORE_EXPORT PrerendererClient
    : public GarbageCollected<PrerendererClient>,
      public Supplement<Page> {
  USING_GARBAGE_COLLECTED_MIXIN(PrerendererClient);

 public:
  PrerendererClient(Page&, WebPrerendererClient*);

  virtual void WillAddPrerender(Prerender*);
  virtual bool IsPrefetchOnly();

  static const char* SupplementName();
  static PrerendererClient* From(Page*);

 private:
  WebPrerendererClient* client_;

  DISALLOW_COPY_AND_ASSIGN(PrerendererClient);
};

CORE_EXPORT void ProvidePrerendererClientTo(Page&, PrerendererClient*);

}  // namespace blink

#endif  // PrerendererClient_h