1 files changed, 445 insertions, 0 deletions
diff --git a/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp b/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
new file mode 100644
index 000000000..25023cf94
--- /dev/null
+++ b/Source/WebKit2/UIProcess/API/gtk/WebKitWebInspector.cpp
@@ -0,0 +1,445 @@
+/*
+ * Copyright (C) 2012 Igalia S.L.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2,1 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.
+ */
+
+#include "config.h"
+#include "WebKitWebInspector.h"
+
+#include "WebInspectorProxy.h"
+#include "WebKitMarshal.h"
+#include "WebKitWebInspectorPrivate.h"
+#include <glib/gi18n-lib.h>
+#include <wtf/gobject/GRefPtr.h>
+#include <wtf/text/CString.h>
+
+using namespace WebKit;
+
+enum {
+    OPEN_WINDOW,
+    BRING_TO_FRONT,
+    CLOSED,
+    ATTACH,
+    DETACH,
+
+    LAST_SIGNAL
+};
+
+enum {
+    PROP_0,
+
+    PROP_INSPECTED_URI,
+    PROP_ATTACHED_HEIGHT
+};
+
+struct _WebKitWebInspectorPrivate {
+    WKRetainPtr<WKInspectorRef> wkInspector;
+    CString inspectedURI;
+    unsigned attachedHeight;
+};
+
+static guint signals[LAST_SIGNAL] = { 0, };
+
+G_DEFINE_TYPE(WebKitWebInspector, webkit_web_inspector, G_TYPE_OBJECT)
+
+static void webkitWebInspectorGetProperty(GObject* object, guint propId, GValue* value, GParamSpec* paramSpec)
+{
+    WebKitWebInspector* inspector = WEBKIT_WEB_INSPECTOR(object);
+
+    switch (propId) {
+    case PROP_INSPECTED_URI:
+        g_value_set_string(value, webkit_web_inspector_get_inspected_uri(inspector));
+        break;
+    case PROP_ATTACHED_HEIGHT:
+        g_value_set_uint(value, webkit_web_inspector_get_attached_height(inspector));
+        break;
+    default:
+        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, propId, paramSpec);
+    }
+}
+
+static void webkitWebInspectorFinalize(GObject* object)
+{
+    WebKitWebInspectorPrivate* priv = WEBKIT_WEB_INSPECTOR(object)->priv;
+    WKInspectorSetInspectorClientGtk(priv->wkInspector.get(), 0);
+    priv->~WebKitWebInspectorPrivate();
+    G_OBJECT_CLASS(webkit_web_inspector_parent_class)->finalize(object);
+}
+
+static void webkit_web_inspector_init(WebKitWebInspector* inspector)
+{
+    WebKitWebInspectorPrivate* priv = G_TYPE_INSTANCE_GET_PRIVATE(inspector, WEBKIT_TYPE_WEB_INSPECTOR, WebKitWebInspectorPrivate);
+    inspector->priv = priv;
+    new (priv) WebKitWebInspectorPrivate();
+}
+
+static void webkit_web_inspector_class_init(WebKitWebInspectorClass* findClass)
+{
+    GObjectClass* gObjectClass = G_OBJECT_CLASS(findClass);
+    gObjectClass->finalize = webkitWebInspectorFinalize;
+    gObjectClass->get_property = webkitWebInspectorGetProperty;
+
+    g_type_class_add_private(findClass, sizeof(WebKitWebInspectorPrivate));
+
+    /**
+     * WebKitWebInspector:inspected-uri:
+     *
+     * The URI that is currently being inspected.
+     */
+    g_object_class_install_property(gObjectClass,
+                                    PROP_INSPECTED_URI,
+                                    g_param_spec_string("inspected-uri",
+                                                        _("Inspected URI"),
+                                                        _("The URI that is currently being inspected"),
+                                                        0,
+                                                        WEBKIT_PARAM_READABLE));
+    /**
+     * WebKitWebInspector:attached-height:
+     *
+     * The height that the inspector view should have when it is attached.
+     */
+    g_object_class_install_property(gObjectClass,
+                                    PROP_ATTACHED_HEIGHT,
+                                    g_param_spec_uint("attached-height",
+                                                      _("Attached Height"),
+                                                      _("The height that the inspector view should have when it is attached"),
+                                                      0, G_MAXUINT, 0,
+                                                      WEBKIT_PARAM_READABLE));
+
+    /**
+     * WebKitWebInspector::open-window:
+     * @inspector: the #WebKitWebInspector on which the signal is emitted
+     *
+     * Emitted when the inspector is requested to open in a separate window.
+     * If this signal is not handled, a #GtkWindow with the inspector will be
+     * created and shown, so you only need to handle this signal if you want
+     * to use your own window.
+     * This signal is emitted after #WebKitWebInspector::detach to show
+     * the inspector in a separate window after being detached.
+     *
+     * To prevent the inspector from being shown you can connect to this
+     * signal and simply return %TRUE
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *    %FALSE to propagate the event further.
+     */
+    signals[OPEN_WINDOW] =
+        g_signal_new("open-window",
+                     G_TYPE_FROM_CLASS(gObjectClass),
+                     G_SIGNAL_RUN_LAST,
+                     0,
+                     g_signal_accumulator_true_handled, 0,
+                     webkit_marshal_BOOLEAN__VOID,
+                     G_TYPE_BOOLEAN, 0);
+
+    /**
+     * WebKitWebInspector::bring-to-front:
+     * @inspector: the #WebKitWebInspector on which the signal is emitted
+     *
+     * Emitted when the inspector should be shown.
+     *
+     * If the inspector is not attached the inspector window should be shown
+     * on top of any other windows.
+     * If the inspector is attached the inspector view should be made visible.
+     * For example, if the inspector view is attached using a tab in a browser
+     * window, the browser window should be raised and the tab containing the
+     * inspector view should be the active one.
+     * In both cases, if this signal is not handled, the default implementation
+     * calls gtk_window_present() on the current toplevel #GtkWindow of the
+     * inspector view.
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *    %FALSE to propagate the event further.
+     */
+    signals[BRING_TO_FRONT] =
+        g_signal_new("bring-to-front",
+                     G_TYPE_FROM_CLASS(gObjectClass),
+                     G_SIGNAL_RUN_LAST,
+                     0,
+                     g_signal_accumulator_true_handled, 0,
+                     webkit_marshal_BOOLEAN__VOID,
+                     G_TYPE_BOOLEAN, 0);
+
+    /**
+     * WebKitWebInspector::closed:
+     * @inspector: the #WebKitWebInspector on which the signal is emitted
+     *
+     * Emitted when the inspector page is closed. If you are using your own
+     * inspector window, you should connect to this signal and destroy your
+     * window.
+     */
+    signals[CLOSED] =
+        g_signal_new("closed",
+                     G_TYPE_FROM_CLASS(gObjectClass),
+                     G_SIGNAL_RUN_LAST,
+                     0, 0, 0,
+                     g_cclosure_marshal_VOID__VOID,
+                     G_TYPE_NONE, 0);
+
+    /**
+     * WebKitWebInspector::attach:
+     * @inspector: the #WebKitWebInspector on which the signal is emitted
+     *
+     * Emitted when the inspector is requested to be attached to the window
+     * where the inspected web view is.
+     * If this signal is not handled the inspector view will be automatically
+     * attached to the inspected view, so you only need to handle this signal
+     * if you want to attach the inspector view yourself (for example, to add
+     * the inspector view to a browser tab).
+     *
+     * To prevent the inspector vew from being attached you can connect to this
+     * signal and simply return %TRUE.
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *    %FALSE to propagate the event further.
+     */
+    signals[ATTACH] =
+        g_signal_new("attach",
+                     G_TYPE_FROM_CLASS(gObjectClass),
+                     G_SIGNAL_RUN_LAST,
+                     0,
+                     g_signal_accumulator_true_handled, 0,
+                     webkit_marshal_BOOLEAN__VOID,
+                     G_TYPE_BOOLEAN, 0);
+
+    /**
+     * WebKitWebInspector::detach:
+     * @inspector: the #WebKitWebInspector on which the signal is emitted
+     *
+     * Emitted when the inspector is requested to be detached from the window
+     * it is currently attached to. The inspector is detached when the inspector page
+     * is about to be closed, and this signal is emitted right before
+     * #WebKitWebInspector::closed, or when the user clicks on the detach button
+     * in the inspector view to show the inspector in a separate window. In this case
+     * the signal #WebKitWebInspector::open-window is emitted after this one.
+     *
+     * To prevent the inspector vew from being detached you can connect to this
+     * signal and simply return %TRUE.
+     *
+     * Returns: %TRUE to stop other handlers from being invoked for the event.
+     *    %FALSE to propagate the event further.
+     */
+    signals[DETACH] =
+        g_signal_new("detach",
+                     G_TYPE_FROM_CLASS(gObjectClass),
+                     G_SIGNAL_RUN_LAST,
+                     0,
+                     g_signal_accumulator_true_handled, 0,
+                     webkit_marshal_BOOLEAN__VOID,
+                     G_TYPE_BOOLEAN, 0);
+}
+
+static bool openWindow(WKInspectorRef, const void* clientInfo)
+{
+    gboolean returnValue;
+    g_signal_emit(WEBKIT_WEB_INSPECTOR(clientInfo), signals[OPEN_WINDOW], 0, &returnValue);
+    return returnValue;
+}
+
+static void didClose(WKInspectorRef, const void* clientInfo)
+{
+    g_signal_emit(WEBKIT_WEB_INSPECTOR(clientInfo), signals[CLOSED], 0);
+}
+
+static bool bringToFront(WKInspectorRef, const void* clientInfo)
+{
+    gboolean returnValue;
+    g_signal_emit(WEBKIT_WEB_INSPECTOR(clientInfo), signals[BRING_TO_FRONT], 0, &returnValue);
+    return returnValue;
+}
+
+static void inspectedURLChanged(WKInspectorRef, WKStringRef url, const void* clientInfo)
+{
+    WebKitWebInspector* inspector = WEBKIT_WEB_INSPECTOR(clientInfo);
+    CString uri = toImpl(url)->string().utf8();
+    if (uri == inspector->priv->inspectedURI)
+        return;
+    inspector->priv->inspectedURI = uri;
+    g_object_notify(G_OBJECT(inspector), "inspected-uri");
+}
+
+static bool attach(WKInspectorRef, const void* clientInfo)
+{
+    gboolean returnValue;
+    g_signal_emit(WEBKIT_WEB_INSPECTOR(clientInfo), signals[ATTACH], 0, &returnValue);
+    return returnValue;
+}
+
+static bool detach(WKInspectorRef inspector, const void* clientInfo)
+{
+    gboolean returnValue;
+    g_signal_emit(WEBKIT_WEB_INSPECTOR(clientInfo), signals[DETACH], 0, &returnValue);
+    return returnValue;
+}
+
+static void didChangeAttachedHeight(WKInspectorRef, unsigned height, const void* clientInfo)
+{
+    WebKitWebInspector* inspector = WEBKIT_WEB_INSPECTOR(clientInfo);
+    if (inspector->priv->attachedHeight == height)
+        return;
+    inspector->priv->attachedHeight = height;
+    g_object_notify(G_OBJECT(inspector), "attached-height");
+}
+
+WebKitWebInspector* webkitWebInspectorCreate(WKInspectorRef wkInspector)
+{
+    WebKitWebInspector* inspector = WEBKIT_WEB_INSPECTOR(g_object_new(WEBKIT_TYPE_WEB_INSPECTOR, NULL));
+    inspector->priv->wkInspector = wkInspector;
+
+    WKInspectorClientGtk wkInspectorClientGtk = {
+        kWKInspectorClientGtkCurrentVersion,
+        inspector, // clientInfo
+        openWindow,
+        didClose,
+        bringToFront,
+        inspectedURLChanged,
+        attach,
+        detach,
+        didChangeAttachedHeight
+    };
+    WKInspectorSetInspectorClientGtk(wkInspector, &wkInspectorClientGtk);
+
+    return inspector;
+}
+
+/**
+ * webkit_web_inspector_get_web_view:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Get the #WebKitWebViewBase used to display the inspector.
+ * This might be %NULL if the inspector hasn't been loaded yet,
+ * or it has been closed.
+ *
+ * Returns: (transfer none): the #WebKitWebViewBase used to display the inspector or %NULL
+ */
+WebKitWebViewBase* webkit_web_inspector_get_web_view(WebKitWebInspector* inspector)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector), 0);
+
+    return WEBKIT_WEB_VIEW_BASE(toImpl(inspector->priv->wkInspector.get())->inspectorView());
+}
+
+/**
+ * webkit_web_inspector_get_inspected_uri:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Get the URI that is currently being inspected. This can be %NULL if
+ * nothing has been loaded yet in the inspected view, if the inspector
+ * has been closed or when inspected view was loaded from a HTML string
+ * instead of a URI.
+ *
+ * Returns: the URI that is currently being inspected or %NULL
+ */
+const char* webkit_web_inspector_get_inspected_uri(WebKitWebInspector* inspector)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector), 0);
+
+    return inspector->priv->inspectedURI.data();
+}
+
+/**
+ * webkit_web_inspector_is_attached:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Whether the @inspector view is currently attached to the same window that contains
+ * the inspected view.
+ *
+ * Returns: %TRUE if @inspector is currently attached or %FALSE otherwise
+ */
+gboolean webkit_web_inspector_is_attached(WebKitWebInspector* inspector)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector), FALSE);
+
+    return WKInspectorIsAttached(inspector->priv->wkInspector.get());
+}
+
+/**
+ * webkit_web_inspector_attach:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Request @inspector to be attached. The signal #WebKitWebInspector::attach
+ * will be emitted. If the inspector is already attached it does nothing.
+ */
+void webkit_web_inspector_attach(WebKitWebInspector* inspector)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector));
+
+    if (WKInspectorIsAttached(inspector->priv->wkInspector.get()))
+        return;
+    WKInspectorAttach(inspector->priv->wkInspector.get());
+}
+
+/**
+ * webkit_web_inspector_detach:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Request @inspector to be detached. The signal #WebKitWebInspector::detach
+ * will be emitted. If the inspector is already detached it does nothing.
+ */
+void webkit_web_inspector_detach(WebKitWebInspector* inspector)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector));
+
+    if (!WKInspectorIsAttached(inspector->priv->wkInspector.get()))
+        return;
+    WKInspectorDetach(inspector->priv->wkInspector.get());
+}
+
+/**
+ * webkit_web_inspector_show:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Request @inspector to be shown.
+ */
+void webkit_web_inspector_show(WebKitWebInspector* inspector)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector));
+
+    WKInspectorShow(inspector->priv->wkInspector.get());
+}
+
+/**
+ * webkit_web_inspector_close:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Request @inspector to be closed.
+ */
+void webkit_web_inspector_close(WebKitWebInspector* inspector)
+{
+    g_return_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector));
+
+    WKInspectorClose(inspector->priv->wkInspector.get());
+}
+
+/**
+ * webkit_web_inspector_get_attached_height:
+ * @inspector: a #WebKitWebInspector
+ *
+ * Get the height that the inspector view should have when
+ * it's attached. If the inspector view is not attached this
+ * returns 0.
+ *
+ * Returns: the height of the inspector view when attached
+ */
+guint webkit_web_inspector_get_attached_height(WebKitWebInspector* inspector)
+{
+    g_return_val_if_fail(WEBKIT_IS_WEB_INSPECTOR(inspector), 0);
+
+    if (!WKInspectorIsAttached(inspector->priv->wkInspector.get()))
+        return 0;
+    return inspector->priv->attachedHeight;
+}