userrequest.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_CORE_ZYPPNG_USERREQUEST_H
#define ZYPP_CORE_ZYPPNG_USERREQUEST_H
 
#include <zypp-core/zyppng/base/Base>
#include <zypp-core/zyppng/base/Signals>
#include <zypp-core/UserData.h>
#include <vector>
namespace zyppng {
 
  using UserData    = zypp::callback::UserData;
  using ContentType = zypp::ContentType;
 
 
  ZYPP_FWD_DECL_TYPE_WITH_REFS( UserRequest );
  ZYPP_FWD_DECL_TYPE_WITH_REFS( ShowMessageRequest );
  ZYPP_FWD_DECL_TYPE_WITH_REFS( ListChoiceRequest );
  ZYPP_FWD_DECL_TYPE_WITH_REFS( BooleanChoiceRequest );
 
  /*
  constexpr std::string_view CTYPE_SHOW_MESSAGE_REQUEST ("userreq/show-message");
  constexpr std::string_view CTYPE_LIST_CHOICE_REQUEST  ("userreq/list-choice");
  constexpr std::string_view CTYPE_BOOLEAN_COICE_REQUEST("userreq/boolean-choice");
  */
 
 
  enum class UserRequestType : uint {
    Message,        // simple message to the user, no input or predefined like y/n
    ListChoice,     // request to select from a list of options
    BooleanChoice,  // request user to say yes or no
    KeyTrust,       // request to the user to trust a key
    Custom = 512
  };

  class UserRequest : public Base
  {
  public:
    UserRequest( UserData userData = {} );
    ~UserRequest() override;
    virtual UserRequestType type() const = 0;
    const UserData &userData() const;
    UserData &userData();
 
  private:
    UserData    _userData;
  };
 
 

  class ShowMessageRequest : public UserRequest
  {
    ZYPP_ADD_CREATE_FUNC(ShowMessageRequest)
  public:
 
    enum class MType {
      Debug, Info, Warning, Error, Important, Data
    };
 
    ZYPP_DECL_PRIVATE_CONSTR_ARGS(ShowMessageRequest, std::string message, MType mType = MType::Info, UserData data = {} );
    UserRequestType type() const override;
 
    MType messageType();
    const std::string &message() const;
 
  private:
    MType _type = MType::Info;
    std::string _message;
  };
 
 

  class ListChoiceRequest : public UserRequest
  {
    ZYPP_ADD_CREATE_FUNC(ListChoiceRequest)
  public:
 
    struct Choice {
      std::string opt;
      std::string detail;
    };
 
    using index_type = std::vector<Choice>::size_type;
 
    ZYPP_DECL_PRIVATE_CONSTR_ARGS(ListChoiceRequest, std::string label, std::vector<Choice> answers, index_type defaultAnswer, UserData userData = {} );
    UserRequestType type() const override;
 
    const std::string &label() const;
 
    void setChoice ( const index_type sel );
    index_type choice() const;
 
    index_type defaultAnswer() const;
 
    const std::vector<Choice> &answers() const;
 
 
  private:
    std::string _label;
    std::vector<Choice> _answers;
    index_type _answer = 0;
    index_type _default = 0;
  };
 
 
  class BooleanChoiceRequest : public UserRequest
  {
    ZYPP_ADD_CREATE_FUNC(BooleanChoiceRequest)
 
  public:
    ZYPP_DECL_PRIVATE_CONSTR_ARGS(BooleanChoiceRequest, std::string label, const bool defaultAnswer = false, UserData userData = {} );
    UserRequestType type() const override;
 
    const std::string &label() const;
 
    void setChoice ( const bool sel );
    bool choice() const;
 
  private:
    std::string _label;
    bool _answer = false;
 
  };
 
}
 
 
#endif