48 lines
1.3 KiB
Plaintext
Executable File
48 lines
1.3 KiB
Plaintext
Executable File
.TH "liberror" "cware" "June 11, 2023" "" "C-Ware Manuals"
|
|
|
|
.SH NAME
|
|
liberror - error reporting library
|
|
.br
|
|
.SH DESCRIPTION
|
|
liberror is the resident library under C-Ware for reporting error
|
|
.br
|
|
messages in a structured, computer-readable format. As described in
|
|
.br
|
|
\fBcware\fR(cware), liberror produces error messages in the format:
|
|
.br
|
|
|
|
.br
|
|
\fB {TYPE}\\t{FUNCTION}\\t{ERROR-MESSSAGE}\\t{FILE}\\t{LINE}\fR
|
|
.br
|
|
|
|
.br
|
|
Liberror is intended to be used to allow togglable safety mechanisms
|
|
.br
|
|
in C-Ware code, like checking for NULL pointers. By design, the various
|
|
.br
|
|
components of the library are designed to be composed together into
|
|
.br
|
|
larger error checking operations to validate entire structures, for
|
|
.br
|
|
example. Also provided is a basic API for adding additional runtime
|
|
.br
|
|
error checks such as whether or not a structure has been passed through
|
|
.br
|
|
an operation that releases it from memory. All of this can be enabled
|
|
.br
|
|
through the definition of the \fBCWARE_SAFETY_CHECKS\fR macro. The manuals for the
|
|
.br
|
|
operations can be found below:
|
|
.br
|
|
|
|
.br
|
|
MANUAL SYNOPSIS
|
|
.br
|
|
-----------------------------------------------------------------------
|
|
.br
|
|
LIBERROR_ASSERT(cware) assert a condition with debugging information
|
|
.br
|
|
LIBERROR_TEST(cware) wrapper over LIBERROR_ASSERT for testcases
|
|
.br
|
|
.SH SEE ALSO
|
|
\fBcware\fR(cware) |