libzypp: zypp/base/UserRequestException.h Source File

libzypp 17.25.10

UserRequestException.h
Go to the documentation of this file.
1 /*---------------------------------------------------------------------\
2 | ____ _ __ __ ___ |
3 | |__ / \ / / . \ . \ |
4 | / / \ V /| _/ _/ |
5 | / /__ | | | | | | |
6 | /_____||_| |_| |_| |
7 | |
8 \---------------------------------------------------------------------*/
12 #ifndef ZYPP_BASE_USERREQUESTEXCEPTION_H
13 #define ZYPP_BASE_USERREQUESTEXCEPTION_H
14
15 #include <iosfwd>
16
17 #include <zypp/base/Exception.h>
18
20 namespace zypp
21 {
22
24 //
25 // CLASS NAME : UserRequestException
26 //
64 class UserRequestException : public Exception
65 {
66 public:
67 enum Kind { UNSPECIFIED, IGNORE, SKIP, RETRY, ABORT };
68 public:
69 explicit
70 UserRequestException( const std::string & msg_r = std::string() );
71 UserRequestException( const std::string & msg_r, const Exception & history_r );
72 explicit
73 UserRequestException( Kind kind_r, const std::string & msg_r = std::string() );
74 UserRequestException( Kind kind_r, const std::string & msg_r, const Exception & history_r );
75 public:
76 Kind kind() const
77 { return _kind; }
78 protected:
79 virtual std::ostream & dumpOn( std::ostream & str ) const;
80 private:
81 Kind _kind;
82 };
84
86 #define declException( EXCP, KIND ) \
87 struct EXCP : public UserRequestException { \
88 explicit \
89 EXCP( const std::string & msg_r = std::string() ) \
90 : UserRequestException( KIND, msg_r ) \
91 {} \
92 EXCP( const std::string & msg_r, const Exception & history_r ) \
93 : UserRequestException( KIND, msg_r, history_r ) \
94 {} \
95 }
96
97 declException( IgnoreRequestException, IGNORE );
98 declException( SkipRequestException, SKIP );
99 declException( RetryRequestException, RETRY );
100 declException( AbortRequestException, ABORT );
101
102 #undef declException
103
105 } // namespace zypp
107 #endif // ZYPP_BASE_USERREQUESTEXCEPTION_H
Exception.h
zypp::Exception
Base class for Exception.
Definition: Exception.h:146
zypp::UserRequestException
Base for exceptions caused by explicit user request.
Definition: UserRequestException.h:65
zypp::UserRequestException::Kind
Kind
Definition: UserRequestException.h:67
zypp::UserRequestException::ABORT
@ ABORT
Definition: UserRequestException.h:67
zypp::UserRequestException::SKIP
@ SKIP
Definition: UserRequestException.h:67
zypp::UserRequestException::UNSPECIFIED
@ UNSPECIFIED
Definition: UserRequestException.h:67
zypp::UserRequestException::RETRY
@ RETRY
Definition: UserRequestException.h:67
zypp::UserRequestException::IGNORE
@ IGNORE
Definition: UserRequestException.h:67
zypp::UserRequestException::UserRequestException
UserRequestException(const std::string &msg_r=std::string())
Definition: UserRequestException.cc:28
zypp::UserRequestException::kind
Kind kind() const
Definition: UserRequestException.h:76
zypp::UserRequestException::dumpOn
virtual std::ostream & dumpOn(std::ostream &str) const
Overload this to print a proper error message.
Definition: UserRequestException.cc:49
zypp::UserRequestException::_kind
Kind _kind
Definition: UserRequestException.h:81
str
String related utilities and Regular expression matching.
zypp
Easy-to use interface to the ZYPP dependency resolver.
Definition: CodePitfalls.doc:2
zypp::declException
declException(IgnoreRequestException, IGNORE)