1 files changed, 85 insertions, 9 deletions

diff --git a/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebExtension.cpp b/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebExtension.cpp
index a8dbb55dc..344fb22ea 100644
--- a/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebExtension.cpp
+++ b/Source/WebKit2/WebProcess/InjectedBundle/API/gtk/WebKitWebExtension.cpp
@@ -20,19 +20,95 @@
 #include "config.h"
 #include "WebKitWebExtension.h"
 
+#include "APIDictionary.h"
 #include "APIString.h"
-#include "ImmutableDictionary.h"
 #include "WKBundleAPICast.h"
 #include "WKBundlePage.h"
 #include "WebKitPrivate.h"
 #include "WebKitWebExtensionPrivate.h"
 #include "WebKitWebPagePrivate.h"
-#include <WebCore/DNS.h>
+#include "WebProcess.h"
 #include <wtf/HashMap.h>
-#include <wtf/gobject/GRefPtr.h>
+#include <wtf/glib/GRefPtr.h>
 
 using namespace WebKit;
 
+/**
+ * SECTION: WebKitWebExtension
+ * @Short_description: Represents a WebExtension of the WebProcess
+ * @Title: WebKitWebExtension
+ *
+ * WebKitWebExtension is a loadable module for the WebProcess. It allows you to execute code in the
+ * WebProcess and being able to use the DOM API, to change any request or to inject custom
+ * JavaScript code, for example.
+ *
+ * To create a WebKitWebExtension you should write a module with an initialization function that could
+ * be either webkit_web_extension_initialize() with prototype #WebKitWebExtensionInitializeFunction or
+ * webkit_web_extension_initialize_with_user_data() with prototype #WebKitWebExtensionInitializeWithUserDataFunction.
+ * This function has to be public and it has to use the #G_MODULE_EXPORT macro. It is called when the
+ * web process is initialized.
+ *
+ * <informalexample><programlisting>
+ * static void
+ * web_page_created_callback (WebKitWebExtension *extension,
+ *                            WebKitWebPage      *web_page,
+ *                            gpointer            user_data)
+ * {
+ *     g_print ("Page %d created for %s\n",
+ *              webkit_web_page_get_id (web_page),
+ *              webkit_web_page_get_uri (web_page));
+ * }
+ *
+ * G_MODULE_EXPORT void
+ * webkit_web_extension_initialize (WebKitWebExtension *extension)
+ * {
+ *     g_signal_connect (extension, "page-created",
+ *                       G_CALLBACK (web_page_created_callback),
+ *                       NULL);
+ * }
+ * </programlisting></informalexample>
+ *
+ * The previous piece of code shows a trivial example of an extension that notifies when
+ * a #WebKitWebPage is created.
+ *
+ * WebKit has to know where it can find the created WebKitWebExtension. To do so you
+ * should use the webkit_web_context_set_web_extensions_directory() function. The signal
+ * #WebKitWebContext::initialize-web-extensions is the recommended place to call it.
+ *
+ * To provide the initialization data used by the webkit_web_extension_initialize_with_user_data()
+ * function, you have to call webkit_web_context_set_web_extensions_initialization_user_data() with
+ * the desired data as parameter. You can see an example of this in the following piece of code:
+ *
+ * <informalexample><programlisting>
+ * #define WEB_EXTENSIONS_DIRECTORY /<!-- -->* ... *<!-- -->/
+ *
+ * static void
+ * initialize_web_extensions (WebKitWebContext *context,
+ *                            gpointer          user_data)
+ * {
+ *   /<!-- -->* Web Extensions get a different ID for each Web Process *<!-- -->/
+ *   static guint32 unique_id = 0;
+ *
+ *   webkit_web_context_set_web_extensions_directory (
+ *      context, WEB_EXTENSIONS_DIRECTORY);
+ *   webkit_web_context_set_web_extensions_initialization_user_data (
+ *      context, g_variant_new_uint32 (unique_id++));
+ * }
+ *
+ * int main (int argc, char **argv)
+ * {
+ *   g_signal_connect (webkit_web_context_get_default (),
+ *                    "initialize-web-extensions",
+ *                     G_CALLBACK (initialize_web_extensions),
+ *                     NULL);
+ *
+ *   GtkWidget *view = webkit_web_view_new ();
+ *
+ *   /<!-- -->* ... *<!-- -->/
+ * }
+ * </programlisting></informalexample>
+ */
+
 enum {
     PAGE_CREATED,
 
@@ -81,32 +157,32 @@ static void webkitWebExtensionPageDestroy(WebKitWebExtension* extension, WebPage
     extension->priv->pages.remove(page);
 }
 
-static void webkitWebExtensionDidReceiveMessage(WebKitWebExtension* extension, const String& messageName, ImmutableDictionary& message)
+static void webkitWebExtensionDidReceiveMessage(WebKitWebExtension*, const String& messageName, API::Dictionary& message)
 {
     if (messageName == String::fromUTF8("PrefetchDNS")) {
         API::String* hostname = static_cast<API::String*>(message.get(String::fromUTF8("Hostname")));
-        WebCore::prefetchDNS(hostname->string());
+        WebProcess::singleton().prefetchDNS(hostname->string());
     } else
         ASSERT_NOT_REACHED();
 }
 
-static void didCreatePage(WKBundleRef bundle, WKBundlePageRef page, const void* clientInfo)
+static void didCreatePage(WKBundleRef, WKBundlePageRef page, const void* clientInfo)
 {
     webkitWebExtensionPageCreated(WEBKIT_WEB_EXTENSION(clientInfo), toImpl(page));
 }
 
-static void willDestroyPage(WKBundleRef bundle, WKBundlePageRef page, const void* clientInfo)
+static void willDestroyPage(WKBundleRef, WKBundlePageRef page, const void* clientInfo)
 {
     webkitWebExtensionPageDestroy(WEBKIT_WEB_EXTENSION(clientInfo), toImpl(page));
 }
 
-static void didReceiveMessage(WKBundleRef bundle, WKStringRef name, WKTypeRef messageBody, const void* clientInfo)
+static void didReceiveMessage(WKBundleRef, WKStringRef name, WKTypeRef messageBody, const void* clientInfo)
 {
     ASSERT(WKGetTypeID(messageBody) == WKDictionaryGetTypeID());
     webkitWebExtensionDidReceiveMessage(WEBKIT_WEB_EXTENSION(clientInfo), toImpl(name)->string(), *toImpl(static_cast<WKDictionaryRef>(messageBody)));
 }
 
-static void didReceiveMessageToPage(WKBundleRef bundle, WKBundlePageRef page, WKStringRef name, WKTypeRef messageBody, const void* clientInfo)
+static void didReceiveMessageToPage(WKBundleRef, WKBundlePageRef page, WKStringRef name, WKTypeRef messageBody, const void* clientInfo)
 {
     ASSERT(WKGetTypeID(messageBody) == WKDictionaryGetTypeID());
     if (WebKitWebPage* webPage = WEBKIT_WEB_EXTENSION(clientInfo)->priv->pages.get(toImpl(page)).get())