zypp::Exception Class Reference

Base class for Exception. More...

#include <Exception.h>

Inheritance diagram for zypp::Exception:

Public Types
typedef exception_detail::CodeLocation	CodeLocation
typedef std::list< std::string >	History
typedef History::const_iterator	HistoryIterator
typedef History::size_type	HistorySize

Public Member Functions
	Exception ()
	Default ctor. More...
	Exception (const std::string &msg_r)
	Ctor taking a message. More...
	Exception (std::string &&msg_r)
	Exception (const std::string &msg_r, const Exception &history_r)
	Ctor taking a message and an exception to remember as history. More...
	Exception (std::string &&msg_r, const Exception &history_r)
	Exception (const std::string &msg_r, Exception &&history_r)
	Exception (std::string &&msg_r, Exception &&history_r)
virtual	~Exception () throw ()
	Dtor. More...
const CodeLocation &	where () const
	Return CodeLocation. More...
void	relocate (const CodeLocation &where_r) const
	Exchange location on rethrow. More...
const std::string &	msg () const
	Return the message string provided to the ctor. More...
std::string	asString () const
	Error message provided by dumpOn as string. More...
std::string	asUserString () const
	Translated error message as string suitable for the user. More...
History list of message strings.
Maintain a simple list of individual error messages, that lead to this Exception. The Exceptions message itself is not included in the history. The History list stores the most recent message fist.
void	remember (const Exception &old_r)
	Store an other Exception as history. More...
void	remember (Exception &&old_r)
void	addHistory (const std::string &msg_r)
	Add some message text to the history. More...
void	addHistory (std::string &&msg_r)
template<class TContainer >
void	addToHistory (const TContainer &msgc_r)
	addHistory from string container types (oldest first) More...
template<class TContainer >
void	moveToHistory (TContainer &&msgc_r)
	addHistory from string container types (oldest first) moving More...
HistoryIterator	historyBegin () const
	Iterator pointing to the most recent message. More...
HistoryIterator	historyEnd () const
	Iterator pointing behind the last message. More...
bool	historyEmpty () const
	Whether the history list is empty. More...
HistorySize	historySize () const
	The size of the history list. More...
std::string	historyAsString () const
	The history as string. More...
std::string	asUserHistory () const
	A single (multiline) string composed of asUserString and historyAsString. More...

Static Public Member Functions
static std::string	strErrno (int errno_r)
	Make a string from errno_r. More...
static std::string	strErrno (int errno_r, const std::string &msg_r)
	Make a string from errno_r and msg_r. More...
static std::string	strErrno (int errno_r, std::string &&msg_r)
static void	log (const Exception &excpt_r, const CodeLocation &where_r, const char *const prefix_r)
	Drop a logline on throw, catch or rethrow. More...
static void	log (const char *typename_r, const CodeLocation &where_r, const char *const prefix_r)
	for not-Exception types thrown via ZYPP_THROW More...

Protected Member Functions
virtual std::ostream &	dumpOn (std::ostream &str) const
	Overload this to print a proper error message. More...

Private Member Functions
virtual const char *	what () const throw ()
	Return message string. More...
std::ostream &	dumpError (std::ostream &str) const
	Called by std::ostream & operator<<. More...

Private Attributes
CodeLocation	_where
std::string	_msg
History	_history

Friends
std::ostream &	operator<< (std::ostream &str, const Exception &obj)

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &str, const Exception &obj)

Detailed Description

Base class for Exception.

Exception offers to store a message string passed to the ctor. Derived classes may provide additional information. Overload dumpOn to provide a proper error text.

• Use ZYPP_THROW macros to throw exceptions.
• Use ZYPP_CAUGHT If you caught an exceptions in order to handle it.
• Use ZYPP_RETHROW to rethrow a caught exception.

The use of these macros is not mandatory. but ZYPP_THROW and ZYPP_RETHROW will adjust the code location information stored in the Exception. All three macros will drop a line in the logfile.

43   try
44     {
45       try
46         {
47           ZYPP_THROW( Exception("Something bad happened.") );
48         }
49       catch ( Exception & excpt )
50         {
51           ZYPP_RETHROW( excpt );
52         }
53
54     }
55   catch ( Exception & excpt )
56     {
57       ZYPP_CAUGHT( excpt );
58     }

The above produces the following log lines:

Main.cc(main):47 THROW:    Main.cc(main):47: Something bad happened.
Main.cc(main):51 RETHROW:  Main.cc(main):47: Something bad happened.
Main.cc(main):57 CAUGHT:   Main.cc(main):51: Something bad happened.

Class Exception now offers a history list of message strings. These messages should describe what lead to the exception.

The Exceptions message itself is NOT included in the history.

Rethrow, remembering an old exception:

try
{
  ....
}
catch( const Exception & olderr_r )
{
   ZYPP_CAUGHT( olderr_r )
   HighLevelException newerr( "Something failed." );
   newerr.rember( olderr_r );
   ZYPP_THROW( newerr );
}

Print an Exception followed by it's history if available:

Exception error;
ERR << error << endl << error.historyAsString();

Todo:

That's a draft to have a common way of throwing exceptions. Most probabely we'll finally use blocxx exceptions. Here, but not in the remaining code of zypp. If we can we should try to wrap the blocxx macros and typedef the classes in here.

Definition at line 145 of file Exception.h.

Member Typedef Documentation

CodeLocation

typedef exception_detail::CodeLocation zypp::Exception::CodeLocation

Definition at line 150 of file Exception.h.

History

typedef std::list<std::string> zypp::Exception::History

Definition at line 151 of file Exception.h.

HistoryIterator

typedef History::const_iterator zypp::Exception::HistoryIterator

Definition at line 152 of file Exception.h.

HistorySize

typedef History::size_type zypp::Exception::HistorySize

Definition at line 153 of file Exception.h.

Constructor & Destructor Documentation

Exception() [1/7]

zypp::Exception::Exception

(

)

Default ctor.

Use ZYPP_THROW macros to throw exceptions.

Definition at line 45 of file Exception.cc.

Exception() [2/7]

zypp::Exception::Exception

(

const std::string &

msg_r

)

Ctor taking a message.

Use ZYPP_THROW macros to throw exceptions.

Definition at line 48 of file Exception.cc.

Exception() [3/7]

zypp::Exception::Exception

(

std::string &&

msg_r

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 52 of file Exception.cc.

Exception() [4/7]

zypp::Exception::Exception	(	const std::string &	msg_r,
		const Exception &	history_r
	)

Ctor taking a message and an exception to remember as history.

See also

remember Use ZYPP_THROW macros to throw exceptions.

Definition at line 56 of file Exception.cc.

Exception() [5/7]

zypp::Exception::Exception	(	std::string &&	msg_r,
		const Exception &	history_r
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 60 of file Exception.cc.

Exception() [6/7]

zypp::Exception::Exception	(	const std::string &	msg_r,
		Exception &&	history_r
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 64 of file Exception.cc.

Exception() [7/7]

zypp::Exception::Exception	(	std::string &&	msg_r,
		Exception &&	history_r
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 68 of file Exception.cc.

~Exception()

zypp::Exception::~Exception ( ) throw ( )

virtual

Dtor.

Definition at line 72 of file Exception.cc.

Member Function Documentation

where()

const CodeLocation& zypp::Exception::where ( ) const

inline

Return CodeLocation.

Definition at line 183 of file Exception.h.

relocate()

void zypp::Exception::relocate ( const CodeLocation &  where_r ) const

inline

Exchange location on rethrow.

Definition at line 187 of file Exception.h.

msg()

const std::string& zypp::Exception::msg ( ) const

inline

Return the message string provided to the ctor.

Note

This is not necessarily the complete error message. The whole error message is provided by asString or dumpOn.

Definition at line 195 of file Exception.h.

asString()

std::string zypp::Exception::asString

(

)

const

Error message provided by dumpOn as string.

Definition at line 75 of file Exception.cc.

asUserString()

std::string zypp::Exception::asUserString

(

)

const

Translated error message as string suitable for the user.

See also

asUserStringHistory

Definition at line 82 of file Exception.cc.

remember() [1/2]

void zypp::Exception::remember

(

const Exception &

old_r

)

Store an other Exception as history.

Definition at line 105 of file Exception.cc.

remember() [2/2]

void zypp::Exception::remember

(

Exception &&

old_r

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 115 of file Exception.cc.

addHistory() [1/2]

void zypp::Exception::addHistory

(

const std::string &

msg_r

)

Add some message text to the history.

Definition at line 125 of file Exception.cc.

addHistory() [2/2]

void zypp::Exception::addHistory

(

std::string &&

msg_r

)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 128 of file Exception.cc.

addToHistory()

template<class TContainer >

void zypp::Exception::addToHistory ( const TContainer &  msgc_r )

inline

addHistory from string container types (oldest first)

Definition at line 227 of file Exception.h.

moveToHistory()

template<class TContainer >

void zypp::Exception::moveToHistory ( TContainer &&  msgc_r )

inline

addHistory from string container types (oldest first) moving

Definition at line 234 of file Exception.h.

historyBegin()

HistoryIterator zypp::Exception::historyBegin ( ) const

inline

Iterator pointing to the most recent message.

Definition at line 241 of file Exception.h.

historyEnd()

HistoryIterator zypp::Exception::historyEnd ( ) const

inline

Iterator pointing behind the last message.

Definition at line 245 of file Exception.h.

historyEmpty()

bool zypp::Exception::historyEmpty ( ) const

inline

Whether the history list is empty.

Definition at line 249 of file Exception.h.

historySize()

HistorySize zypp::Exception::historySize ( ) const

inline

The size of the history list.

Definition at line 253 of file Exception.h.

historyAsString()

std::string zypp::Exception::historyAsString

(

)

const

The history as string.

Empty if historyEmpty. Otherwise:

History:
 - most recent message
 - 2nd message
...
 - oldest message

Definition at line 131 of file Exception.cc.

asUserHistory()

std::string zypp::Exception::asUserHistory

(

)

const

A single (multiline) string composed of asUserString and historyAsString.

Definition at line 91 of file Exception.cc.

dumpOn()

std::ostream & zypp::Exception::dumpOn ( std::ostream &  str ) const

protectedvirtual

Overload this to print a proper error message.

Reimplemented in zypp::media::MediaBadCAException, zypp::media::MediaTemporaryProblemException, zypp::media::MediaFileSizeExceededException, zypp::media::MediaTimeoutException, zypp::media::MediaForbiddenException, zypp::media::MediaUnauthorizedException, zypp::media::MediaNotEjectedException, zypp::media::MediaIsSharedException, zypp::media::MediaNotDesiredException, zypp::media::MediaCurlSetOptException, zypp::media::MediaCurlException, zypp::media::MediaNotSupportedException, zypp::media::MediaUnsupportedUrlSchemeException, zypp::media::MediaBadUrlEmptyDestinationException, zypp::media::MediaBadUrlEmptyFilesystemException, zypp::media::MediaBadUrlEmptyHostException, zypp::media::MediaBadUrlException, zypp::media::MediaNotADirException, zypp::media::MediaNotAFileException, zypp::target::rpm::RpmNullDatabaseException, zypp::media::MediaSystemException, zypp::target::rpm::RpmDbConvertException, zypp::media::MediaCurlInitException, zypp::target::rpm::RpmDbNotOpenException, zypp::media::MediaBadAttachPointException, zypp::target::rpm::RpmDbAlreadyOpenException, zypp::repo::ServiceException, zypp::media::MediaNotAttachedException, zypp::target::rpm::RpmDbOpenException, zypp::media::MediaWriteException, zypp::media::MediaFileNotFoundException, zypp::target::rpm::RpmInitException, zypp::media::MediaNotOpenException, zypp::target::rpm::RpmSubprocessException, zypp::media::MediaBadFilenameException, zypp::target::rpm::RpmAccessBlockedException, zypp::media::MediaUnmountException, zypp::target::rpm::RpmInvalidRootException, zypp::target::hal::HalException, zypp::media::MediaMountException, zypp::UserRequestException, zypp::target::TargetAbortedException, zypp::repo::RepoException, and zypp::parser::ParseException.

Definition at line 141 of file Exception.cc.

strErrno() [1/3]

std::string zypp::Exception::strErrno ( int  errno_r )

static

Make a string from errno_r.

Definition at line 151 of file Exception.cc.

strErrno() [2/3]

std::string zypp::Exception::strErrno ( int  errno_r, const std::string &  msg_r  )

static

Make a string from errno_r and msg_r.

Definition at line 154 of file Exception.cc.

strErrno() [3/3]

std::string zypp::Exception::strErrno ( int  errno_r, std::string &&  msg_r  )

static

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 157 of file Exception.cc.

log() [1/2]

void zypp::Exception::log ( const Exception &  excpt_r, const CodeLocation &  where_r, const char *const  prefix_r  )

static

Drop a logline on throw, catch or rethrow.

Used by ZYPP_THROW macros macros.

Definition at line 163 of file Exception.cc.

log() [2/2]

void zypp::Exception::log ( const char *  typename_r, const CodeLocation &  where_r, const char *const  prefix_r  )

static

for not-Exception types thrown via ZYPP_THROW

Definition at line 169 of file Exception.cc.

what()

virtual const char* zypp::Exception::what ( ) const throw ( )

inlineprivatevirtual

Return message string.

Definition at line 300 of file Exception.h.

dumpError()

std::ostream & zypp::Exception::dumpError ( std::ostream &  str ) const

private

Called by std::ostream & operator<<.

Prints CodeLocation and the error message provided by dumpOn.

Definition at line 144 of file Exception.cc.

Friends And Related Function Documentation

operator<< [1/2]

std::ostream& operator<< ( std::ostream &  str, const Exception &  obj  )

friend

Definition at line 147 of file Exception.cc.

operator<<() [2/2]

std::ostream & operator<< ( std::ostream &  str, const Exception &  obj  )

related

Stream output

Definition at line 147 of file Exception.cc.

Member Data Documentation

_where

CodeLocation zypp::Exception::_where

mutableprivate

Definition at line 295 of file Exception.h.

_msg

std::string zypp::Exception::_msg

private

Definition at line 296 of file Exception.h.

_history

History zypp::Exception::_history

private

Definition at line 297 of file Exception.h.

---

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

• zypp/base/Exception.h
• zypp/base/Exception.cc