srecord::quit Class Reference

The quit class is an abstract class for reporting error messages, both fatal and non-fatal. More...

#include <quit.h>

Inheritance diagram for srecord::quit:

Public Member Functions
virtual	~quit ()
	The destructor.
	quit ()
	The default constructor.
	quit (const quit &)
	The copy constructor.
quit &	operator= (const quit &)
	The assignment operator.
virtual void	exit (int)=0
	The fatal_error method is used to report fatal errors.

Detailed Description

The quit class is an abstract class for reporting error messages, both fatal and non-fatal.

Definition at line 32 of file quit.h.

Constructor & Destructor Documentation

~quit()

virtual srecord::quit::~quit ( )

virtual

The destructor.

quit() [1/2]

srecord::quit::quit

(

)

The default constructor.

Referenced by exit(), srecord::quit_prefix::message_v(), operator=(), quit(), srecord::quit_prefix::quit_prefix(), and srecord::quit_prefix::quit_prefix().

quit() [2/2]

srecord::quit::quit

(

const quit &

)

The copy constructor.

References quit().

Member Function Documentation

operator=()

quit & srecord::quit::operator=

(

const quit &

)

The assignment operator.

References FORMAT_PRINTF, and quit().

exit()

virtual void srecord::quit::exit ( int )

pure virtual

The fatal_error method is used to report fatal errors.

The fmt' string is in the same style a standard C printf function. It calls the fatal_error_v method. This method does not return. */ virtual void fatal_error(const char *fmt, ...) FORMAT_PRINTF(2, 3); /** The fatal_error_v method is used to report fatal errors. The fmt' string is in the same style a standard C vprintf function. It calls the message_v and exit methods. This method does not return. */ virtual void fatal_error_v(const char *, va_list);

/** The fatal_error_errno method is used to report fatal errors, and append the string equivalent of errno. The fmt' string is in the same style a standard C printf function. It calls the fatal_error_errno_v method. This method does not return. */ virtual void fatal_error_errno(const char *fmt, ...) FORMAT_PRINTF(2, 3); /** The fatal_error_errno_v method is used to report fatal errors. The fmt' string is in the same style a standard C vprintf function. It calls the message_v and exit methods. This method does not return. */ virtual void fatal_error_errno_v(const char *, va_list);

/** The warning method is used to likely but non-fatal errors. The fmt' string is in the same style a standard C printf function. It calls the warning_v method. */ virtual void warning(const char *fmt, ...) FORMAT_PRINTF(2, 3); /** The warning_v method is used to report likely but non-fatal errors. The fmt' string is in the same style a standard C vprintf function. It calls the message_v method. */ virtual void warning_v(const char *, va_list);

/** The message method is used to send an error message to a suitable destination. The fmt' string is in the same style a standard C printf function. The message_v method is called. */ virtual void message(const char *fmt, ...) FORMAT_PRINTF(2, 3); /** The message_v method is used to send an error message to a suitable destination. The fmt' string is in the same style a standard C vprintf function. Derived classes are required to supply this method. */ virtual void message_v(const char *, va_list) = 0;

/** The exit method is used to terminate execution. It could call the global exit function, or it could throw an exception, or some other action, but it shall NOT return. Derived classes are required to supply this method.

Implemented in srecord::quit_exception, srecord::quit_normal, and srecord::quit_prefix.

References exit(), quit(), and srecord::quit_default.

Referenced by exit().

---

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

• quit.h