Assertions with GLib support

Assertions with GLib support — Checks that your program works as you expect with GLib support.

Synopsis

#define             gcut_assert_equal_type              (expected, actual, ...)
#define             cut_assert_equal_g_type             (expected, actual, ...)
#define             gcut_assert_equal_value             (expected, actual, ...)
#define             cut_assert_equal_g_value            (expected, actual, ...)
#define             gcut_assert_equal_list_int          (expected, actual, ...)
#define             cut_assert_equal_g_list_int         (expected, actual, ...)
#define             gcut_assert_equal_list_uint         (expected, actual, ...)
#define             gcut_assert_equal_list_string       (expected, actual, ...)
#define             cut_assert_equal_g_list_string      (expected, actual, ...)
#define             gcut_assert_equal_list_object       (expected, actual, ...)
#define             gcut_assert_equal_list_object_custom(expected, actual,
                                                         equal_function, ...)
#define             gcut_assert_equal_list_enum         (type, expected, actual, ...)
#define             gcut_assert_equal_list_flags        (type, expected, actual, ...)
#define             gcut_assert_equal_hash_table_string_string(expected, actual,
                                                         ...)
#define             gcut_assert_error                   (error, ...)
#define             cut_assert_g_error                  (error, ...)
#define             gcut_assert_equal_error             (expected, actual, ...)
#define             gcut_assert_remove_path             (path, ...)
#define             gcut_assert_remove_path_helper      (path, ...)
#define             cut_assert_remove_path              (path, ...)
#define             gcut_assert_equal_time_val          (expected, actual, ...)
#define             gcut_assert_equal_time_val_helper   (expected, actual, ...)
#define             gcut_assert_equal_enum              (enum_type, expected, actual, ...)
#define             gcut_assert_equal_flags             (flags_type, expected, actual, ...)
#define             gcut_assert_equal_object            (expected, actual, ...)
#define             gcut_assert_equal_object_custom     (expected, actual,
                                                         equal_function, ...)
#define             gcut_assert_equal_int64             (expected, actual, ...)
#define             gcut_assert_equal_uint64            (expected, actual, ...)

Description

Details

gcut_assert_equal_type()

#define             gcut_assert_equal_type(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GType.

actual :

an actual GType.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


cut_assert_equal_g_type()

#define             cut_assert_equal_g_type(expected, actual, ...)

Warning

cut_assert_equal_g_type has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_equal_type() instead.

Passes if expected == actual.

expected :

an expected GType.

actual :

an actual GType.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

gcut_assert_equal_value()

#define             gcut_assert_equal_value(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GValue *.

actual :

an actual GValue *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


cut_assert_equal_g_value()

#define             cut_assert_equal_g_value(expected, actual, ...)

Warning

cut_assert_equal_g_value has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_equal_value() instead.

Passes if expected == actual.

expected :

an expected GValue *.

actual :

an actual GValue *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

gcut_assert_equal_list_int()

#define             gcut_assert_equal_list_int(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GList * of integer.

actual :

an actual GList * of integer.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


cut_assert_equal_g_list_int()

#define             cut_assert_equal_g_list_int(expected, actual, ...)

Warning

cut_assert_equal_g_list_int has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_equal_list_int() instead.

Passes if expected == actual.

expected :

an expected GList * of integer.

actual :

an actual GList * of integer.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 0.8


gcut_assert_equal_list_uint()

#define             gcut_assert_equal_list_uint(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GList * of unsigned integer.

actual :

an actual GList * of unsigned integer.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


gcut_assert_equal_list_string()

#define             gcut_assert_equal_list_string(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GList * of string.

actual :

an actual GList * of string.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


cut_assert_equal_g_list_string()

#define             cut_assert_equal_g_list_string(expected, actual, ...)

Warning

cut_assert_equal_g_list_string has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_equal_list_string() instead.

Passes if expected == actual.

expected :

an expected GList * of string.

actual :

an actual GList * of string.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 0.8


gcut_assert_equal_list_object()

#define             gcut_assert_equal_list_object(expected, actual, ...)

Passes if expected and actual has same GObject * in same order.

expected :

an expected GList * of GObject *.

actual :

an actual GList * of GObject *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_list_object_custom()

#define             gcut_assert_equal_list_object_custom(expected, actual,          \
                                                         equal_function, ...)

Passes if expected and actual has same GObject * in same order. Each comparison of GObject * uses equal_function.

expected :

an expected GList * of GObject *.

actual :

an actual GList * of GObject *.

equal_function :

a function that compares two GObject *. (GEqualFunc)

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_list_enum()

#define             gcut_assert_equal_list_enum(type, expected, actual, ...)

Passes if expected and actual has same enum values in same order.

type :

a GEnum type.

expected :

an expected GList * of enum value.

actual :

an actual GList * of enum value.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_list_flags()

#define             gcut_assert_equal_list_flags(type, expected, actual, ...)

Passes if expected and actual has same flags values in same order.

type :

a GFlags type.

expected :

an expected GList * of flags value.

actual :

an actual GList * of flags value.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_hash_table_string_string()

#define             gcut_assert_equal_hash_table_string_string(expected, actual,    \
                                                               ...)

Passes if expected == actual.

expected :

an expected GHashTable * of string.

actual :

an actual GHashTable * of string.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.4


gcut_assert_error()

#define             gcut_assert_error(error, ...)

Passes if error == NULL.

error :

a target GError *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.3


cut_assert_g_error()

#define             cut_assert_g_error(error, ...)

Warning

cut_assert_g_error has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_error() instead.

Passes if error == NULL.

error :

a target GError *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0


gcut_assert_equal_error()

#define             gcut_assert_equal_error(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GError *.

actual :

an actual GError *.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_remove_path()

#define             gcut_assert_remove_path(path, ...)

Passes if cut_utils_build_path(path, ...) is removed successfully.

path :

a first element of the path to the removed path.

... :

remaining elements in path.

Since 1.0.3


gcut_assert_remove_path_helper()

#define             gcut_assert_remove_path_helper(path, ...)

path :

... :


cut_assert_remove_path()

#define             cut_assert_remove_path(path, ...)

Warning

cut_assert_remove_path has been deprecated since version 1.0.3 and should not be used in newly-written code. Use gcut_assert_remove_path() instead.

Passes if cut_utils_build_path(path, ...) is removed successfully.

path :

a first element of the path to the removed path.

... :

remaining elements in path.

Since 1.0.2


gcut_assert_equal_time_val()

#define             gcut_assert_equal_time_val(expected, actual, ...)

Passes if expected == actual.

expected :

an expected GTimeVal.

actual :

an actual GTimeVal.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.4


gcut_assert_equal_time_val_helper()

#define             gcut_assert_equal_time_val_helper(expected, actual, ...)

expected :

actual :

... :


gcut_assert_equal_enum()

#define             gcut_assert_equal_enum(enum_type, expected, actual, ...)

Passes if expected == actual.

e.g.:

gcut_assert_equal_enum(GTK_TYPE_DIRECTION_TYPE,
                          GTK_DIR_LEFT, GTK_DIR_LEFT); -> Pass
gcut_assert_equal_enum(GTK_TYPE_DIRECTION_TYPE,
                          GTK_DIR_DOWN, GTK_DIR_LEFT); -> Fail

enum_type :

a GEnum type.

expected :

an expected enum value.

actual :

an actual enum value.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_flags()

#define             gcut_assert_equal_flags(flags_type, expected, actual, ...)

Passes if expected == actual.

e.g.:

gcut_assert_equal_flags(GTK_TYPE_DIALOG_FLAGS,
                        GTK_DIALOG_DESTROY_MODAL |
                          GTK_DIALOG_DESTROY_WITH_PARENT,
                        GTK_DIALOG_DESTROY_MODAL |
                          GTK_DIALOG_DESTROY_WITH_PARENT); -> Pass
gcut_assert_equal_flags(GTK_TYPE_DIALOG_FLAGS,
                        GTK_DIALOG_DESTROY_MODAL |
                          GTK_DIALOG_DESTROY_WITH_PARENT,
                        GTK_DIALOG_DESTROY_MODAL); -> Fail

flags_type :

a GFlags type.

expected :

an expected flags value.

actual :

an actual flags value.

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_object()

#define             gcut_assert_equal_object(expected, actual, ...)

Passes if expected == actual. See gcut_assert_equal_object_custom() when you need to customize equality check.

e.g.:

gcut_assert_equal_object(object, object);   -> Pass
gcut_assert_equal_object(object1, object2); -> Fail
gcut_assert_equal_object(NULL, NULL);       -> Pass
gcut_assert_equal_object(object1, NULL);    -> Fail

expected :

an expected object. (GObject *)

actual :

an actual object. (GObject *)

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_object_custom()

#define             gcut_assert_equal_object_custom(expected, actual,               \
                                                    equal_function, ...)

Passes if equal_function(expected, actual) == TRUE.

e.g.:

static gboolean
equal_name (gconstpointer data1, gconstpointer data2)
{
    return g_str_equal(my_object_get_name(MY_OBJECT(data1)),
                       my_object_get_name(MY_OBJECT(data2)));
}

gcut_assert_equal_object_custom(object, object, equal_name);   -> Pass
gcut_assert_equal_object_custom(same_name_object1,
                                same_name_object2,
                                equal_name);                   -> Pass
gcut_assert_equal_object_custom(different_name_object1,
                                different_name_object2,
                                equal_name);                   -> Fail

expected :

an expected object. (GObject *)

actual :

an actual object. (GObject *)

equal_function :

a function that compare two object. (GEqualFunc)

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_int64()

#define             gcut_assert_equal_int64(expected, actual, ...)

Passes if expected == actual.

expected :

an expected 64 bit integer value. (gint64)

actual :

an actual 64 bit integer value. (gint64)

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5


gcut_assert_equal_uint64()

#define             gcut_assert_equal_uint64(expected, actual, ...)

Passes if expected == actual.

expected :

an expected unsigned integer value. (guint64)

actual :

an actual unsigned integer value. (guint64)

... :

optional format string, followed by parameters to insert into the format string (as with printf())

Since 1.0.5