/*

 * Copyright (C) 2009 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 WebPluginContainerImpl_h

#define WebPluginContainerImpl_h

#include "WebPluginContainer.h"

#include "Widget.h"

#include <wtf/PassRefPtr.h>

#include <wtf/Vector.h>

struct NPObject;

namespace WebCore {

class HTMLPlugInElement;

class IntRect;

class KeyboardEvent;

class MouseEvent;

class ResourceError;

class ResourceResponse;

class WheelEvent;

}

namespace WebKit {

class WebPlugin;

class WebPluginLoadObserver;

class WebPluginContainerImpl : public WebCore::Widget, public WebPluginContainer {

public:

    static PassRefPtr<WebPluginContainerImpl> create(WebCore::HTMLPlugInElement* element, WebPlugin* webPlugin)

    {

        return adoptRef(new WebPluginContainerImpl(element, webPlugin));

    }

    // Widget methods

    virtual void setFrameRect(const WebCore::IntRect&);

    virtual void paint(WebCore::GraphicsContext*, const WebCore::IntRect&);

    virtual void invalidateRect(const WebCore::IntRect&);

    virtual void setFocus(bool);

    virtual void show();

    virtual void hide();

    virtual void handleEvent(WebCore::Event*);

    virtual void frameRectsChanged();

    virtual void setParentVisible(bool);

    virtual void setParent(WebCore::ScrollView*);

    virtual void widgetPositionsUpdated();

    // WebPluginContainer methods

    virtual WebElement element();

    virtual void invalidate();

    virtual void invalidateRect(const WebRect&);

    virtual void reportGeometry();

    virtual void clearScriptObjects();

    virtual NPObject* scriptableObjectForElement();

    virtual WebString executeScriptURL(const WebURL&, bool popupsAllowed);

    virtual void loadFrameRequest(const WebURLRequest&, const WebString& target, bool notifyNeeded, void* notifyData);

    // This cannot be null.

    WebPlugin* plugin() { return m_webPlugin; }

    void setPlugin(WebPlugin* plugin) { m_webPlugin = plugin; }

    // Printing interface. The plugin can support custom printing

    // (which means it controls the layout, number of pages etc).

    // Whether the plugin supports its own paginated print. The other print

    // interface methods are called only if this method returns true.

    bool supportsPaginatedPrint() const;

    // Sets up printing at the given print rect and printer DPI. printableArea

    // is in points (a point is 1/72 of an inch).Returns the number of pages to

    // be printed at these settings.

    int printBegin(const WebCore::IntRect& printableArea, int printerDPI) const;

    // Prints the page specified by pageNumber (0-based index) into the supplied canvas.

    bool printPage(int pageNumber, WebCore::GraphicsContext* gc);

    // Ends the print operation.

    void printEnd();

    // Copy the selected text.

    void copy();

    // Resource load events for the plugin's source data:

    void didReceiveResponse(const WebCore::ResourceResponse&);

    void didReceiveData(const char *data, int dataLength);

    void didFinishLoading();

    void didFailLoading(const WebCore::ResourceError&);

    NPObject* scriptableObject();

    void willDestroyPluginLoadObserver(WebPluginLoadObserver*);

private:

    WebPluginContainerImpl(WebCore::HTMLPlugInElement* element, WebPlugin* webPlugin)

        : m_element(element)

        , m_webPlugin(webPlugin) { }

    ~WebPluginContainerImpl();

    void handleMouseEvent(WebCore::MouseEvent*);

    void handleWheelEvent(WebCore::WheelEvent*);

    void handleKeyboardEvent(WebCore::KeyboardEvent*);

    void calculateGeometry(const WebCore::IntRect& frameRect,

                           WebCore::IntRect& windowRect,

                           WebCore::IntRect& clipRect,

                           Vector<WebCore::IntRect>& cutOutRects);

    WebCore::IntRect windowClipRect() const;

    void windowCutOutRects(const WebCore::IntRect& frameRect,

                           Vector<WebCore::IntRect>& cutOutRects);

    WebCore::HTMLPlugInElement* m_element;

    WebPlugin* m_webPlugin;

    Vector<WebPluginLoadObserver*> m_pluginLoadObservers;

};

} // namespace WebKit

#endif