Changes between Version 8 and Version 9 of EFLWebKitCodingStyle

Timestamp:

Aug 13, 2012, 6:38:18 PM (13 years ago)

Author:

gyuyoung.kim@samsung.com

Comment:

Add new coding style related to double not operator(!!)

EFLWebKitCodingStyle

@@ -10 +10 @@
  * Use '''const''' keyword instead of '''#define''' when you define constant variable.
  * Use NULL in public C headers instead of 0
+ * Use '''double not operator(!!)''' when you modify a Eina Bool member variable which stores a value in a bit field.
 
 = Example =
 
 == Do not use abbreviation except for public APIs ==
-
 === Public APIs ===
-
 {{{
  EAPI void ewk_view_bg_color_set(Evas_Object *o, int r, int g, int b, int a);
@@ -41 +40 @@
 
 == Do not use Eina_Bool type except for public APIs ==
-
 === Public APIs ===
-
 {{{
 EAPI Eina_Bool ewk_view_scale_set(Evas_Object *o, float scale_factor, Evas_Coord cx, Evas_Coord cy);
@@ -49 +46 @@
 
 === Implementation ===
-
 {{{
 Eina_Bool ewk_view_scale_set(Evas_Object* ewkView, float scaleFactor, Evas_Coord centerX, Evas_Coord centerY)
@@ -70 +66 @@
 
 == Use "void" for empty parameter of public APIs ==
-
-=== Right ===
-
+=== Right ===
 {{{
 EAPI Ewk_Context *ewk_context_new(void);
@@ -78 +72 @@
 
 === Wrong ===
-
 {{{
 EAPI Ewk_Context *ewk_context_new();
@@ -84 +77 @@
 
 == Place '*' operator to data type ==
-
-=== Right ===
-
+=== Right ===
 {{{
 static void _ewk_view_smart_show(Evas_Object* ewkView)
@@ -92 +83 @@
 
 === Wrong ===
-
 {{{
 static void _ewk_view_smart_show(Evas_Object *ewkView)
@@ -98 +88 @@
 
 == Use C++ casting for type casting ==
-
-=== Right ===
-
+=== Right ===
 {{{
  Ewk_View_Smart_Data* smartData = static_cast<Ewk_View_Smart_Data*>(data);
@@ -106 +94 @@
 
 === Wrong ===
-
 {{{
  Ewk_View_Smart_Data* smartData = (Ewk_View_Smart_Data*)data;
@@ -174 +161 @@
 === Wrong ===
 {{{
-{{{
 /**
  * Query action for this intent.
@@ -184 +170 @@
 EAPI const char *ewk_intent_action_get(const Ewk_Intent *intent);
 }}}
-}}}
+
+== Use double not operator(!!) when you modify a Eina Bool member variable which stores a value in a bit field. ==
+=== Right ===
+{{{
+struct {
+    ...
+    bool pageCache : 1;
+    ...
+}
+
+Eina_Bool ewk_view_setting_page_cache_set(Evas_Object* ewkView, Eina_Bool enable)
+{
+    EWK_VIEW_SD_GET_OR_RETURN(ewkView, smartData, false);
+    EWK_VIEW_PRIV_GET_OR_RETURN(smartData, priv, false);
+    enable = !!enable;
+    if (priv->settings.pageCache != enable) {
+        priv->pageSettings->setUsesPageCache(enable);
+        priv->settings.pageCache = enable;
+    }
+    return true;
+}
+}}}
+=== Wrong ===
+{{{
+Eina_Bool ewk_settings_auto_load_images_set(Ewk_Settings* settings, Eina_Bool automatic)
+{
+    EINA_SAFETY_ON_NULL_RETURN_VAL(settings, false);
+
+    automatic = !!automatic;
+    WKPreferencesSetLoadsImagesAutomatically(settings->preferences.get(), automatic);
+
+    return true;
+}
+}}}