6.6 The break exceptional–condition object

The break exceptional–condition object–type has the purpose of describing an exceptional condition used to break out of a loop or a function call; this object–type does not represent an error of any kind.

There should be only one break exceptional–condition object: the one predefined by CCExceptions and built into the library as statically allocated structure. Subtyping from this object–type is fine to represent different reasons for escaping.

All the following definitions are accessible from the header file ccexceptions.h.

Struct Typedef: cce_descriptor_break_t

Structure type representing the exceptional–condition object–type descriptor. This descriptor has the descriptor cce_descriptor_root_t as parent. It has the following public fields:

cce_descriptor_t descriptor

Core values of the exceptional–condition object–type descriptor.

Struct Typedef: cce_condition_break_t

Structure type representing the exceptional–condition object. It has the following public fields:

cce_condition_root_t root

Core values of the exceptional–condition object.

Function: cce_condition_t const * cce_condition_new_break (void)

Return a pointer to the predefined, statically allocated, structure representing the exceptional–condition object of type cce_condition_break_t.

Function: bool cce_condition_is_break (cce_condition_t const * C)

Return true if the exceptional–condition object referenced by C is of type cce_condition_break_t or it is derived from it; otherwise return false.

Facilities to derive an exceptional–condition object subtype

When deriving a subtype from cce_condition_break_t we need the following functions.

Function: void cce_descriptor_set_parent_to(cce_descriptor_break_t) (cce_descriptor_t * D)

Mutate the exceptional–condition object–type descriptor referenced by D so that its parent is the descriptor of cce_descriptor_break_t. We should call this function in the initialisation module of the derived type.

Function: void cce_condition_init_break (cce_condition_break_t * C)

Initialise an already allocated exceptional–condition object. We should call this function from the initialisation function of the derived type.

Subtyping example

To define a subtype of cce_condition_break_t we can copy the code in the files:

condition-subtyping-break.c
condition-subtyping-break-header.h
condition-subtyping-break-body.c

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

This document describes version 0.9.0-devel.3 of CCExceptions.