userrequestexception.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_CORE_BASE_USERREQUESTEXCEPTION_H
#define ZYPP_CORE_BASE_USERREQUESTEXCEPTION_H
 
#include <iosfwd>
 
#include <zypp/base/Exception.h>

namespace zypp
{ 

  //
  //    CLASS NAME : UserRequestException
  //
  class ZYPP_API UserRequestException : public Exception
  {
    public:
      enum Kind { UNSPECIFIED, IGNORE, SKIP, RETRY, ABORT };
    public:
      explicit
      UserRequestException( const std::string & msg_r = std::string() );
      UserRequestException( const std::string & msg_r, const Exception & history_r );
      explicit
      UserRequestException( Kind kind_r, const std::string & msg_r = std::string() );
      UserRequestException( Kind kind_r, const std::string & msg_r, const Exception & history_r );
    public:
      Kind kind() const
      { return _kind; }
    protected:
      std::ostream & dumpOn( std::ostream & str ) const override;
    private:
      Kind _kind;
  };


#define declException( EXCP, KIND )                                     \
  struct ZYPP_API EXCP : public UserRequestException {                          \
    explicit                                                            \
    EXCP( const std::string & msg_r = std::string() )                   \
      : UserRequestException( KIND, msg_r )                             \
    {}                                                                  \
    EXCP( const std::string & msg_r, const Exception & history_r )      \
      : UserRequestException( KIND, msg_r, history_r )                  \
    {}                                                                  \
  }
 
  declException( IgnoreRequestException, IGNORE );
  declException( SkipRequestException, SKIP );
  declException( RetryRequestException, RETRY );
  declException( AbortRequestException, ABORT );
 
#undef declException

} // namespace zypp
#endif // ZYPP_CORE_BASE_USERREQUESTEXCEPTION_H