render_frame_host_factory.h revision f2477e01787aa58f445919b809d89e252beef54f 
1// Copyright 2013 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_FACTORY_H_
6#define CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_FACTORY_H_
7
8#include "base/basictypes.h"
9#include "base/memory/scoped_ptr.h"
10#include "content/common/content_export.h"
11
12namespace content {
13
14class FrameTree;
15class RenderFrameHostImpl;
16class RenderViewHostImpl;
17
18// A factory for creating RenderFrameHosts. There is a global factory function
19// that can be installed for the purposes of testing to provide a specialized
20// RenderFrameHostImpl class.
21class CONTENT_EXPORT RenderFrameHostFactory {
22 public:
23  // Creates a new RenderFrameHostImpl using the currently registered factory,
24  // or a regular RenderFrameHostImpl if no factory is registered.
25  static scoped_ptr<RenderFrameHostImpl> Create(
26      RenderViewHostImpl* render_view_host,
27      FrameTree* frame_tree,
28      int routing_id,
29      bool is_swapped_out);
30
31  // Returns true if there is currently a globally-registered factory.
32  static bool has_factory() { return !!factory_; }
33
34 protected:
35  RenderFrameHostFactory() {}
36  virtual ~RenderFrameHostFactory() {}
37
38  // You can derive from this class and specify an implementation for this
39  // function to create an alternate kind of RenderFrameHostImpl for testing.
40  virtual scoped_ptr<RenderFrameHostImpl> CreateRenderFrameHost(
41      RenderViewHostImpl* render_view_host,
42      FrameTree* frame_tree,
43      int routing_id,
44      bool is_swapped_out) = 0;
45
46  // Registers a factory to be called when new RenderFrameHostImpls are created.
47  // We have only one global factory, so there must be no factory registered
48  // before the call. This class does NOT take ownership of the pointer.
49  static void RegisterFactory(RenderFrameHostFactory* factory);
50
51  // Unregister the previously registered factory. With no factory registered,
52  // regular RenderFrameHostImpls will be created.
53  static void UnregisterFactory();
54
55 private:
56  // The current globally registered factory. This is NULL when we should create
57  // regular RenderFrameHostImpls.
58  static RenderFrameHostFactory* factory_;
59
60  DISALLOW_COPY_AND_ASSIGN(RenderFrameHostFactory);
61};
62
63}  // namespace content
64
65#endif  // CONTENT_BROWSER_FRAME_HOST_RENDER_FRAME_HOST_FACTORY_H_
66