#include <output.h>

Data Fields
void(*	destructor )(explain_output_t *op)
void(*	message )(explain_output_t op, const char text)
void(*	exit )(explain_output_t *op, int status)
unsigned int	size

Detailed Description

The explain_output_vtable_t struct describes the methods of a class derived from the explain_output_t pure abstract class.

Definition at line 127 of file output.h.

Field Documentation

The destructor method is called when (if) the output instance is destroyed. May be NULL, if no cleanup is required.

Parameters:

op	Pointer to the explain_output_t instance to be operated on.

Definition at line 136 of file output.h.

The exit method is used to terminate execution. Different "classes" handle this differently. May be NULL, in which case exit(status) will be called.

Parameters:

op	Pointer to the explain_output_t instance to be operated on.
status	The exist status requested.

Note:: The "exit" method shall not return. if it does, exit(status) will be called anyway. This is because the rest of the libexplain code assumes that "exit" means "::exit".

Definition at line 165 of file output.h.

The message method is ised to print text. Different output "classes" handle this differently.

Parameters:

op	Pointer to the explain_output_t instance to be "printed" on.
text	The text of the message to be printed. It has not been wrapped.

Definition at line 148 of file output.h.

The size instance variable is used to remember how large this instance is, in bytes. Used by the explain_output_new function, below.

Definition at line 172 of file output.h.

The documentation for this struct was generated from the following file: