src/third_party/WebKit/Source/core/testing/DummyPageHolder.h

   1 /*
   2  * Copyright (c) 2013, 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 DummyPageHolder_h
  32 #define DummyPageHolder_h
  33
  34 #include "core/loader/FrameLoaderClient.h"
  35 #include "core/page/Page.h"
  36 #include "platform/geometry/IntSize.h"
  37 #include "platform/heap/Handle.h"
  38 #include "wtf/FastAllocBase.h"
  39 #include "wtf/Noncopyable.h"
  40 #include "wtf/OwnPtr.h"
  41 #include "wtf/PassOwnPtr.h"
  42
  43 namespace blink {
  44
  45 class Document;
  46 class LocalFrame;
  47 class FrameView;
  48 class IntSize;
  49
  50 // Creates a dummy Page, LocalFrame, and FrameView whose clients are all no-op.
  51 //
  52 // This class can be used when you write unit tests for components which do not work correctly without renderers.
  53 // To make sure the renderers are created, you need to call |frameView().layout()| after you add nodes into
  54 // |document()|.
  55 //
  56 // Since DummyPageHolder stores empty clients in it, it must outlive the Page, LocalFrame, FrameView and any other objects
  57 // created by it. DummyPageHolder's destructor ensures this condition by checking remaining references to the LocalFrame.
  58
  59 class DummyPageHolder {
  60     WTF_MAKE_NONCOPYABLE(DummyPageHolder);
  61     WTF_MAKE_FAST_ALLOCATED;
  62 public:
  63     static PassOwnPtr<DummyPageHolder> create(
  64         const IntSize& initialViewSize = IntSize(),
  65         Page::PageClients* = 0,
  66         PassOwnPtr<FrameLoaderClient> = PassOwnPtr<FrameLoaderClient>());
  67     ~DummyPageHolder();
  68
  69     Page& page() const;
  70     LocalFrame& frame() const;
  71     FrameView& frameView() const;
  72     Document& document() const;
  73
  74 private:
  75     DummyPageHolder(const IntSize& initialViewSize, Page::PageClients*, PassOwnPtr<FrameLoaderClient>);
  76
  77     OwnPtrWillBePersistent<Page> m_page;
  78     RefPtrWillBePersistent<LocalFrame> m_frame;
  79
  80     Page::PageClients m_pageClients;
  81     OwnPtr<FrameLoaderClient> m_frameLoaderClient;
  82 };
  83
  84 } // namespace blink
  85
  86 #endif // DummyPageHolder_h