Source/WebKit2/UIProcess/API/efl/EwkView.h

/*
   Copyright (C) 2011 Samsung Electronics
   Copyright (C) 2012 Intel Corporation. All rights reserved.

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef EwkView_h
#define EwkView_h

#include "EflTypedefs.h"
#include "EwkViewCallbacks.h"
#include "PageViewportController.h"
#include "PageViewportControllerClientEfl.h"
#include "WKEinaSharedString.h"
#include "WKRetainPtr.h"
#include "WebView.h"
#include <WebCore/RefPtrCairo.h>
#include <WebCore/TextFlags.h>
#include <WebCore/Timer.h>
#include <WebKit/WKBase.h>

#if ENABLE(TOUCH_EVENTS)
#include "GestureRecognizer.h"
#include "ewk_touch.h"
#endif

#ifdef HAVE_ECORE_X
#include <Ecore_X.h>
#endif

typedef struct _cairo_surface cairo_surface_t;
typedef struct _Evas_GL Evas_GL;

namespace WebKit {
class ContextMenuClientEfl;
class FindClientEfl;
class FormClientEfl;
class InputMethodContextEfl;
class PageLoadClientEfl;
class PagePolicyClientEfl;
class PageUIClientEfl;
class ViewClientEfl;
class WebPageGroup;
class WebPageProxy;
class WebPopupItem;
class WebPopupMenuProxyEfl;

#if ENABLE(VIBRATION)
class VibrationClientEfl;
#endif

#if HAVE(ACCESSIBILITY) && defined(HAVE_ECORE_X)
class WebAccessibility;
#endif
}

namespace WebCore {
class AffineTransform;
class Color;
class CoordinatedGraphicsScene;
class Cursor;
class FloatPoint;
class EvasGLContext;
class EvasGLSurface;
class Image;
class IntSize;
class TransformationMatrix;
}

class EwkContext;
class EwkBackForwardList;
class EwkColorPicker;
class EwkContextMenu;
class EwkPageGroup;
class EwkPopupMenu;
class EwkUrlRequest;
class EwkWindowFeatures;

typedef struct Ewk_View_Smart_Data Ewk_View_Smart_Data;
typedef struct Ewk_View_Smart_Class Ewk_View_Smart_Class;

class EwkView {
public:
    static EwkView* create(WebKit::WebView*, Evas* canvas, Evas_Smart* smart = 0);

    static bool initSmartClassInterface(Ewk_View_Smart_Class&);

    static Evas_Object* toEvasObject(WKPageRef);

    Evas_Object* evasObject() { return m_evasObject; }

    WKPageRef wkPage() const;

    WebKit::WebPageProxy* page() { return webView()->page(); }
    EwkContext* ewkContext() { return m_context.get(); }
    EwkPageGroup* ewkPageGroup() { return m_pageGroup.get(); }
    EwkBackForwardList* backForwardList() { return m_backForwardList.get(); }
    EwkWindowFeatures* windowFeatures();

    WebKit::PageViewportController& pageViewportController() { return m_pageViewportController; }

    bool isVisible() const;
    void setVisible(bool);

    void setDeviceScaleFactor(float scale);
    float deviceScaleFactor() const;

    WebCore::AffineTransform transformToScreen() const;

    WebCore::IntSize contentsSize() const;

    const char* url() const { return m_url; }
    const char* title() const;
    WebKit::InputMethodContextEfl* inputMethodContext();

    const char* themePath() const;
    void setThemePath(const char* theme);
    const char* customTextEncodingName() const { return m_customEncoding; }
    void setCustomTextEncodingName(const char* customEncoding);
    const char* userAgent() const { return m_userAgent; }
    void setUserAgent(const char* userAgent);
    const char* applicationNameForUserAgent() const { return m_applicationNameForUserAgent; }
    void setApplicationNameForUserAgent(const char* applicationNameForUserAgent);

    bool mouseEventsEnabled() const { return m_mouseEventsEnabled; }
    void setMouseEventsEnabled(bool enabled);
#if ENABLE(TOUCH_EVENTS)
    void feedTouchEvent(Ewk_Touch_Event_Type type, const Eina_List* points, const Evas_Modifier* modifiers);
    bool touchEventsEnabled() const { return m_touchEventsEnabled; }
    void setTouchEventsEnabled(bool enabled);
    void doneWithTouchEvent(WKTouchEventRef, bool);
#endif

#ifdef HAVE_ECORE_X
    void updateCursor(Ecore_X_Window);
#endif
    void setCursor(const WebCore::Cursor& cursor);

    void scheduleUpdateDisplay();
    void setViewportPosition(const WebCore::FloatPoint& contentsPosition);

#if ENABLE(FULLSCREEN_API)
    void enterFullScreen();
    void exitFullScreen();
    bool requestExitFullScreen();
#endif

    WKRect windowGeometry() const;
    void setWindowGeometry(const WKRect&);

    bool createGLSurface();
    void setNeedsSurfaceResize() { m_pendingSurfaceResize = true; }

#if ENABLE(INPUT_TYPE_COLOR)
    void requestColorPicker(WKColorPickerResultListenerRef listener, const WebCore::Color&);
    void dismissColorPicker();
#endif

    WKPageRef createNewPage(PassRefPtr<EwkUrlRequest>, WKDictionaryRef windowFeatures);
    void close();

    void requestPopupMenu(WebKit::WebPopupMenuProxyEfl*, const WebCore::IntRect&, WebCore::TextDirection, double pageScaleFactor, const Vector<WebKit::WebPopupItem>&, int32_t selectedIndex);
    void closePopupMenu();

    void customContextMenuItemSelected(WKContextMenuItemRef contextMenuItem);
    void showContextMenu(WKPoint position, WKArrayRef items);
    void hideContextMenu();

    void updateTextInputState();

    void requestJSAlertPopup(const WKEinaSharedString& message);
    bool requestJSConfirmPopup(const WKEinaSharedString& message);
    WKEinaSharedString requestJSPromptPopup(const WKEinaSharedString& message, const WKEinaSharedString& defaultValue);
    bool requestJSBeforeUnloadConfirmPopup(const WKEinaSharedString& message);

    template<EwkViewCallbacks::CallbackType callbackType>
    EwkViewCallbacks::CallBack<callbackType> smartCallback() const
    {
        return EwkViewCallbacks::CallBack<callbackType>(m_evasObject);
    }

    unsigned long long informDatabaseQuotaReached(const String& databaseName, const String& displayName, unsigned long long currentQuota, unsigned long long currentOriginUsage, unsigned long long currentDatabaseUsage, unsigned long long expectedUsage);

    // FIXME: Remove when possible.
    WebKit::WebView* webView();

    // FIXME: needs refactoring (split callback invoke)
    void informURLChange();

    void updateScaleToPageViewportController(double scaleFactor, int x, int y);

    PassRefPtr<cairo_surface_t> takeSnapshot();
    bool scrollBy(const WebCore::IntSize&);

    void setBackgroundColor(int red, int green, int blue, int alpha);
    WebCore::Color backgroundColor();

    void didFindZoomableArea(const WKPoint&, const WKRect&);

    static const char smartClassName[];

#if HAVE(ACCESSIBILITY) && defined(HAVE_ECORE_X)
    WebKit::WebAccessibility* webAccessibility() { return m_webAccessibility.get(); }
#endif

private:
    EwkView(WebKit::WebView*, Evas_Object*);
    ~EwkView();

    void setDeviceSize(const WebCore::IntSize&);
    Ewk_View_Smart_Data* smartData() const;

    WebCore::IntSize size() const;
    WebCore::IntSize deviceSize() const;

    void displayTimerFired();

    // Evas_Smart_Class callback interface:
    static void handleEvasObjectAdd(Evas_Object*);
    static void handleEvasObjectDelete(Evas_Object*);
    static void handleEvasObjectMove(Evas_Object*, Evas_Coord x, Evas_Coord y);
    static void handleEvasObjectResize(Evas_Object*, Evas_Coord width, Evas_Coord height);
    static void handleEvasObjectShow(Evas_Object*);
    static void handleEvasObjectHide(Evas_Object*);
    static void handleEvasObjectColorSet(Evas_Object*, int red, int green, int blue, int alpha);
    static void handleEvasObjectCalculate(Evas_Object*);

    // Ewk_View_Smart_Class callback interface:
    static Eina_Bool handleEwkViewFocusIn(Ewk_View_Smart_Data* smartData);
    static Eina_Bool handleEwkViewFocusOut(Ewk_View_Smart_Data* smartData);
    static Eina_Bool handleEwkViewMouseWheel(Ewk_View_Smart_Data* smartData, const Evas_Event_Mouse_Wheel* wheelEvent);
    static Eina_Bool handleEwkViewMouseDown(Ewk_View_Smart_Data* smartData, const Evas_Event_Mouse_Down* downEvent);
    static Eina_Bool handleEwkViewMouseUp(Ewk_View_Smart_Data* smartData, const Evas_Event_Mouse_Up* upEvent);
    static Eina_Bool handleEwkViewMouseMove(Ewk_View_Smart_Data* smartData, const Evas_Event_Mouse_Move* moveEvent);
    static Eina_Bool handleEwkViewKeyDown(Ewk_View_Smart_Data* smartData, const Evas_Event_Key_Down* downEvent);
    static Eina_Bool handleEwkViewKeyUp(Ewk_View_Smart_Data* smartData, const Evas_Event_Key_Up* upEvent);

#if ENABLE(TOUCH_EVENTS)
    void feedTouchEvents(Ewk_Touch_Event_Type type, double timestamp);
    static void handleMouseDownForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
    static void handleMouseUpForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
    static void handleMouseMoveForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
    static void handleMultiDownForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
    static void handleMultiUpForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
    static void handleMultiMoveForTouch(void* data, Evas*, Evas_Object*, void* eventInfo);
#endif
    static void handleFaviconChanged(const char* pageURL, void* eventInfo);

private:
    // Note, initialization order matters.
    RefPtr<WebKit::WebView> m_webView;
    Evas_Object* m_evasObject;
    RefPtr<EwkContext> m_context;
    RefPtr<EwkPageGroup> m_pageGroup;
    Evas_GL* m_evasGL;
    std::unique_ptr<WebCore::EvasGLContext> m_evasGLContext;
    std::unique_ptr<WebCore::EvasGLSurface> m_evasGLSurface;
    bool m_pendingSurfaceResize;

    WebCore::TransformationMatrix m_userViewportTransform;
    std::unique_ptr<WebKit::PageLoadClientEfl> m_pageLoadClient;
    std::unique_ptr<WebKit::PagePolicyClientEfl> m_pagePolicyClient;
    std::unique_ptr<WebKit::PageUIClientEfl> m_pageUIClient;
    std::unique_ptr<WebKit::ContextMenuClientEfl> m_contextMenuClient;
    std::unique_ptr<WebKit::FindClientEfl> m_findClient;
    std::unique_ptr<WebKit::FormClientEfl> m_formClient;
    std::unique_ptr<WebKit::ViewClientEfl> m_viewClient;
#if ENABLE(VIBRATION)
    std::unique_ptr<WebKit::VibrationClientEfl> m_vibrationClient;
#endif
    std::unique_ptr<EwkBackForwardList> m_backForwardList;
    RefPtr<EwkWindowFeatures> m_windowFeatures;

#ifdef HAVE_ECORE_X
    Ecore_X_Cursor m_customCursor;
#endif

    union CursorIdentifier {
        CursorIdentifier()
            : image(nullptr)
        {
        }
        WebCore::Image* image;
        const char* group;
    } m_cursorIdentifier;

    WKEinaSharedString m_url;
    mutable WKEinaSharedString m_title;
    WKEinaSharedString m_theme;
    WKEinaSharedString m_customEncoding;
    WKEinaSharedString m_userAgent;
    WKEinaSharedString m_applicationNameForUserAgent;
    bool m_mouseEventsEnabled;
#if ENABLE(TOUCH_EVENTS)
    bool m_touchEventsEnabled;
    std::unique_ptr<WebKit::GestureRecognizer> m_gestureRecognizer;
#endif
    WebCore::Timer m_displayTimer;
    RefPtr<EwkContextMenu> m_contextMenu;
    std::unique_ptr<EwkPopupMenu> m_popupMenu;
    std::unique_ptr<WebKit::InputMethodContextEfl> m_inputMethodContext;
#if ENABLE(INPUT_TYPE_COLOR)
    std::unique_ptr<EwkColorPicker> m_colorPicker;
#endif

#if HAVE(ACCESSIBILITY) && defined(HAVE_ECORE_X)
    std::unique_ptr<WebKit::WebAccessibility> m_webAccessibility;
#endif

    WebKit::PageViewportControllerClientEfl m_pageViewportControllerClient;
    WebKit::PageViewportController m_pageViewportController;

    bool m_isAccelerated;
    bool m_isWaitingForNewPage;

    static Evas_Smart_Class parentSmartClass;
};

inline bool isEwkViewEvasObject(const Evas_Object* evasObject)
{
    ASSERT(evasObject);

    const Evas_Smart* evasSmart = evas_object_smart_smart_get(evasObject);
    if (EINA_UNLIKELY(!evasSmart)) {
        const char* evasObjectType = evas_object_type_get(evasObject);
        EINA_LOG_CRIT("%p (%s) is not a smart object!", evasObject, evasObjectType ? evasObjectType : "(null)");
        return false;
    }

    const Evas_Smart_Class* smartClass = evas_smart_class_get(evasSmart);
    if (EINA_UNLIKELY(!smartClass)) {
        const char* evasObjectType = evas_object_type_get(evasObject);
        EINA_LOG_CRIT("%p (%s) is not a smart class object!", evasObject, evasObjectType ? evasObjectType : "(null)");
        return false;
    }

    if (EINA_UNLIKELY(smartClass->data != EwkView::smartClassName)) {
        const char* evasObjectType = evas_object_type_get(evasObject);
        EINA_LOG_CRIT("%p (%s) is not of an ewk_view (need %p, got %p)!", evasObject, evasObjectType ? evasObjectType : "(null)",
            EwkView::smartClassName, smartClass->data);
        return false;
    }

    return true;
}

#endif // EwkView_h