Changeset 1724

Timestamp:

03/14/07 20:18:57

Author:

pvanhoof

Message:

Design by contract with tinymail, first idea

Files:

• trunk/README (modified) (1 diff)
• trunk/libtinymail/tny-device.c (modified) (5 diffs)

trunk/README

@@ -28 +28 @@
-You'll need it if you build with --enable-unit-tests which will compile the
-unit tests. Check the sources of the unit tests for more information.
+
+It's highly recommended to set the CFLAGS environment to include -DDEBUG and 
+-DDBC: CFLAGS="-DDBC -DDEBUG" ./autogen.sh --enable-unit-tests ....
+
+The DBC define will enable Design By Contract assertions, the DEBUG define will
+enable certain debugging checks, assertions, features and messages.
-
-Run all unit tests with 'make check'.

trunk/libtinymail/tny-device.c

@@ -33 +33 @@
-tny_device_reset (TnyDevice *self)
-{
-EBUG
-if (!TNY_DEVICE_GET_IFACE (self)->reset_func)
-       g_critical ("You must implement tny_device_reset\n"
+BC /* require */
+g_assert (TNY_IS_DEVICE (self));
+g_assert (TNY_DEVICE_GET_IFACE (self)->reset_func != NULL
-#endif
-
-        TNY_DEVICE_GET_IFACE (self)->reset_func (self);
+
+#ifdef DBC /* ensure */
+#endif
+
-        return;
-}
@@ -60 +64 @@
-tny_device_force_online (TnyDevice *self)
-{
-EBUG
-if (!TNY_DEVICE_GET_IFACE (self)->force_online_func)
-       g_critical ("You must implement tny_device_force_online\n"
+BC /* require */
+g_assert (TNY_IS_DEVICE (self));
+g_assert (TNY_DEVICE_GET_IFACE (self)->force_online_func != NULL
-#endif
-
-        TNY_DEVICE_GET_IFACE (self)->force_online_func (self);
+
+#ifdef DBC /* ensure */
+        g_assert (tny_device_is_online (self) == TRUE);
+#endif
+
-        return;
-}
@@ -78 +87 @@
-tny_device_force_offline (TnyDevice *self)
-{
-EBUG
-if (!TNY_DEVICE_GET_IFACE (self)->force_offline_func)
-       g_critical ("You must implement tny_device_force_offline\n"
+BC /* require */
+g_assert (TNY_IS_DEVICE (self));
+g_assert (TNY_DEVICE_GET_IFACE (self)->force_offline_func != NULL
-#endif
-
-        TNY_DEVICE_GET_IFACE (self)->force_offline_func (self);
+
+#ifdef DBC /* ensure */
+        g_assert (tny_device_is_online (self) == FALSE);
+#endif
+
-        return;
-}
@@ -109 +123 @@
-tny_device_is_online (TnyDevice *self)
-{
-
-
-
+
+
+
+
+
-#endif
-
-
+
+
+
+
+
+
-}
-
@@ -165 +186 @@
-                  NULL
-                };
-
+
-                type = g_type_register_static (G_TYPE_INTERFACE, 
-                        "TnyDevice", &info, 0);