8.10 Convenience signal

We can use the signal exceptional–condition object–type to signal some special test condition. We can instantiate this type and also derive new types from it. To catch this exceptional condition we can do:

cce_location_t        L[1];

if (cce_location(L)) {
  if (cctests_condition_is_signal(cce_condition(L))) {
    CCTESTS_PC(cctests_condition_signal_t, C, cce_condition(L));
    do_something_with(C);
  }
  cce_run_catch_handlers_final(L);
} else {
  do_something(L);
  cce_run_body_handlers(L);
}

If we raise an exception of this type, or one of its sub–types, then we must also catch it before it reaches CCTests’s functions; otherwise the currently executed test will be considered failed in an abnormal way.

Struct Typedef: cctests_descriptor_signal_t

Type of data structure representing the exceptional–condition descriptor. It has the following public fields:

cce_descriptor_t descriptor

The condition descriptor’s base values.

The parent of this type descriptor is the one referenced by cctests_descriptor_base_ptr, Base condition object.

Struct Typedef: cctests_condition_signal_t

Type of data structure representing the exceptional–condition object. It has the following public fields:

cctests_condition_base_t base

The condition object’s base values.

Function: void cce_descriptor_set_parent_to(cctests_condition_signal_t) (cce_descriptor_t * const D)

Set the parent of the descriptor referenced by D to the descriptor of the exceptional–condition object–type cctests_condition_signal_t.

Function: void cctests_condition_init_signal (cctests_condition_signal_t * C)

Initialisation function for the condition object. This function is meant to be called from the initialisation function of sub–types of cctests_condition_signal_t.

Function: cce_condition_t const * cctests_condition_new_signal (void)

Return a pointer to exceptional–condition object of type cctests_condition_signal_t made opaque in the type cce_condition_t.

Function: bool cctests_condition_is_signal (cce_condition_t const * C)

Return true if C if of type cctests_condition_signal_t; otherwise return false.

Sub–typing example

To define a sub–type of cctests_condition_signal_t we can copy the code in the files:

condition-signal-subtype.c
condition-signal-subtype-headear.h
condition-signal-subtype-body.c

under the tests directory of the source distribution; the code defines a new condition–object type my_condition_signal_subtype_t.

This document describes version 0.4.1-devel.1 of CCTests.