Changes between Version 6 and Version 7 of WebKitGTK/AddingNewWebKit2API

Timestamp:

Nov 23, 2012, 6:24:28 AM (12 years ago)

Author:

Carlos Garcia Campos

Comment:

Document WEBKIT_DEFINE_ macros

WebKitGTK/AddingNewWebKit2API

@@ -21 +21 @@
   * Use WebKit coding style for all other code, including unit tests, See http://www.webkit.org/coding/coding-style.html
   * You can use check-webkit-style script to make sure your patch follows the WebKit coding style
- * Use the placement new syntax for private structures
-  * Let glib allocate the private structure using g_type_class_add_private() as usual
-  * In the init method use the following syntax
+ * Use WEBKIT_DEFINE_ macros instead of G_DEFINE_ ones. There some small differences:
+  * The private struct is allocated by the macro using the placement new syntax, so you can use smart pointers in the private struct.
+  * You only need to define a class_init method but not init() nor finalize().
+  * Don't call g_type_class_add_private() in class_init() since it's already done by the macro.
+  * If you need to add some initialization for instances, override GObjectClass::constructor() or use the private struct constructor
   {{{
-static void webkit_foo_init(WebKitFoo* foo)
-{
-    WebKitFooPrivate* priv = G_TYPE_INSTANCE_GET_PRIVATE(foo, WEBKIT_TYPE_FOO, WebKitFooPrivate);
-    foo->priv = priv;
-    new (priv) WebKitFooPrivate();
-}
+struct _WebKitSettingsPrivate {
+    _WebKitSettingsPrivate()
+        : preferences(WebPreferences::create())
+    {
+        defaultFontFamily = preferences->standardFontFamily().utf8();
+        monospaceFontFamily = preferences->fixedFontFamily().utf8();
+        serifFontFamily = preferences->serifFontFamily().utf8();
+        sansSerifFontFamily = preferences->sansSerifFontFamily().utf8();
+        cursiveFontFamily = preferences->cursiveFontFamily().utf8();
+        fantasyFontFamily = preferences->fantasyFontFamily().utf8();
+        pictographFontFamily = preferences->pictographFontFamily().utf8();
+        defaultCharset = preferences->defaultTextEncodingName().utf8();
+    }
+
+    RefPtr<WebPreferences> preferences;
+    CString defaultFontFamily;
+    CString monospaceFontFamily;
+    CString serifFontFamily;
+    CString sansSerifFontFamily;
+    CString cursiveFontFamily;
+    CString fantasyFontFamily;
+    CString pictographFontFamily;
+    CString defaultCharset;
+    CString userAgent;
+    bool allowModalDialogs;
+    bool zoomTextOnly;
+};
   }}}
-  * And in finalize method call the destructor manually
+  * The same way, if you need to add destruction code, you can override GObjectClass::dispose() or use the private struct destructor. Note that dispose can be called multiple times, so if you want to make sure the destruction code is only called once, use the private struct destructor.
   {{{
-static void webkitFooFinalize(GObject* object)
-{
-    WEBKIT_FOO(object)->priv->~WebKitFooPrivate();
-    G_OBJECT_CLASS(webkit_foo_parent_class)->finalize(object);
-}
+struct _WebKitCookieManagerPrivate {
+    ~_WebKitCookieManagerPrivate()
+    {
+        webCookieManager->stopObservingCookieChanges();
+    }
+
+    RefPtr<WebCookieManagerProxy> webCookieManager;
+};
   }}}
  * Use wtf classes (CString, HashMap, etc.) and GRefPtr/GOwnPtr for attributes so that they are automatically freed by the private structure destructor