This "utility" class maintains a pointer containing the address of the current review‐failure handler function (of type Review::ViolationHandler) and provides methods to administer this function pointer. The invokeHandler method calls the currently‐installed failure handler. The default installed handler is the Review::failByLog function.

Synopsis

Declared in <bsls_review.h>

class Review;

Description

This class also provides a suite of standard failure‐handler functions that are suitable to be installed as the current Review::ViolationHandler function. Note that clients are free to install any of these ("off‐the‐shelf") handlers, or to provide their own ("custom") review‐failure handler function when using this facility. Also note that review‐failure handlers CAN return, unlike assertion failure handlers, though not returning (thus escalating review behavior implicitly to the level of asserts) is acceptable.

Finally, this class defines the constant strings that are used as the reviewLevel in ReviewViolation`s associated with failed `BSLS_REVIEW invocations.

Type Aliases

Name

Description

Count

Count is an alias for an atomic integer. All bsls_review macros declare a static local Count variable that is used to track how many times that review has failed. This count gets updated through the bsls::Review::updateCount function.

ViolationHandler

ViolationHandler is an alias for a pointer to a function returning void, and taking, as a parameter, a const reference to a ReviewViolation instance. For example: ` void myHandler(const ReviewViolation& violation); `

Static Member Functions

Name

Description

failByAbort [noreturn]

Emulate the invocation of the standard assert macro with a false argument, using the specified violation to generate an output message and then, after logging, unconditionally abort.

failByLog

Log a message to stdout that an assertion has failed with information on the failure from the specified violation. A suitably formatted "cheap stack" is included in the log message that identifies the call site where the failure occurred.

failBySleep [noreturn]

Use the specified violation to generate an output message and then, after logging, spin in an infinite loop. Note that this handler function is useful for hanging a process so that a debugger may be attached to it.

failByThrow [noreturn]

Throw an AssertTestException (whose attributes are comment, filename, and lineNumber from the specified violation), provided that BDE_BUILD_TARGET_EXC is defined; otherwise, log an appropriate message and abort the program (similar to failByAbort).

invokeHandler

Invoke the currently installed review‐failure handler function with the specified violation as its argument. Note that this function is intended for use by the (BSLS) "REVIEW" macros, but may also be called by clients directly as needed.

lockReviewAdministration

Disable all subsequent calls to setViolationHandler. Note that this method has no effect on the behavior of a ReviewFailureHandlerGuard object.

setViolationHandler

Make the specified handler function the current review‐failure handler. This method has no effect if the lockReviewAdministration method has been called.

updateCount

Increment the specified count and return the new value. Instead of overflowing, when the value is sufficiently large, decrement the value so that large values repeat periodically.

violationHandler

Return the address of the currently installed review‐failure handler function. Note that the initial value of the review‐failure handler is the Review::failByLog method.

Static Data Members

Name

Description

k_LEVEL_INVOKE

String identifier ("R‐INV") for BSLS_REVIEW_INVOKE failures.

k_LEVEL_OPT

Command‐line option name for the review level setting.

k_LEVEL_REVIEW

String identifier ("R‐DBG") for BSLS_REVIEW failures.

k_LEVEL_SAFE

String identifier for the safe review level.

Friends

Name

Description

BloombergLP::bsls::ReviewFailureHandlerGuard

An object of this class saves the current review handler and installs the one specified on construction. On destruction, the original review handler is restored. Note that two objects of this class cannot be safely used concurrently from two separate threads (but may of course appear sequentially, including in nested blocks and function invocations within a single thread). Note that the behavior of objects of this class is unaffected by the (static) Review::lockReviewAdministration method (i.e., the temporary replacement will occur, regardless of whether that method has been invoked).

Created with MrDocs