/*
* Copyright (c) 2013, 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 DummyPageHolder_h
#define DummyPageHolder_h
#include "core/loader/EmptyClients.h"
#include "core/page/Page.h"
#include "platform/geometry/IntSize.h"
#include "wtf/FastAllocBase.h"
#include "wtf/Noncopyable.h"
#include "wtf/OwnPtr.h"
#include "wtf/PassOwnPtr.h"
namespace WebCore {
class Document;
class LocalFrame;
class FrameView;
class IntSize;
// Creates a dummy Page, LocalFrame, and FrameView whose clients are all no-op.
//
// This class can be used when you write unit tests for components which do not work correctly without renderers.
// To make sure the renderers are created, you need to call |frameView().layout()| after you add nodes into
// |document()|.
//
// Since DummyPageHolder stores empty clients in it, it must outlive the Page, LocalFrame, FrameView and any other objects
// created by it. DummyPageHolder's destructor ensures this condition by checking remaining references to the LocalFrame.
class DummyPageHolder {
WTF_MAKE_NONCOPYABLE(DummyPageHolder);
WTF_MAKE_FAST_ALLOCATED;
public:
static PassOwnPtr<DummyPageHolder> create(const IntSize& initialViewSize = IntSize());
~DummyPageHolder();
Page& page() const;
LocalFrame& frame() const;
FrameView& frameView() const;
Document& document() const;
private:
explicit DummyPageHolder(const IntSize& initialViewSize);
OwnPtr<Page> m_page;
RefPtr<LocalFrame> m_frame;
Page::PageClients m_pageClients;
EmptyChromeClient m_chromeClient;
EmptyContextMenuClient m_contextMenuClient;
EmptyEditorClient m_editorClient;
EmptyDragClient m_dragClient;
EmptyInspectorClient m_inspectorClient;
EmptyBackForwardClient m_backForwardClient;
EmptyFrameLoaderClient m_frameLoaderClient;
};
} // namespace WebCore
#endif // DummyPageHolder_h