Assert first page in QtUserSearchWindow wizard based on type

Converted enum to C++11 enum class in process. Coverity raised this issue. Test-Information: All unit tests pass. Using the “Add Contact…” and “Start Chat…” dialogs did not crash. Tested on macOS 10.12.4 with Qt 5.4.2. Change-Id: I0409688b001d1eaaf5fa77a25b1158ce9e611c77
author: Tobias Markmann <tm@ayena.de> 2017-04-12 09:05:33 (GMT)
committer: Tobias Markmann <tm@ayena.de> 2017-04-12 09:05:33 (GMT)
commit: 4024517891d3a222e71e6632c3609fcda08c875e (patch)
tree: 690020d1a9c1a4c3fd8bff0f59d196ee23b05d60
parent: 43b85e93c7acd865be2de009651e146e9faece96 (diff)
download: swift-4024517891d3a222e71e6632c3609fcda08c875e.zip
swift-4024517891d3a222e71e6632c3609fcda08c875e.tar.bz2
7 files changed, 68 insertions, 57 deletions
diff --git a/Swift/Controllers/Chat/UserSearchController.cpp b/Swift/Controllers/Chat/UserSearchController.cpp
index 91de670..30c3c77 100644
--- a/Swift/Controllers/Chat/UserSearchController.cpp
+++ b/Swift/Controllers/Chat/UserSearchController.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2016 Isode Limited.
+ * Copyright (c) 2010-2017 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -83,17 +83,17 @@ void UserSearchController::handleUIEvent(std::shared_ptr<UIEvent> event) {
     std::shared_ptr<RequestAddUserDialogUIEvent> addUserRequest = std::shared_ptr<RequestAddUserDialogUIEvent>();
     auto inviteToMUCRequest = RequestInviteToMUCUIEvent::ref();
     switch (type_) {
-        case AddContact:
+        case Type::AddContact:
             if ((addUserRequest = std::dynamic_pointer_cast<RequestAddUserDialogUIEvent>(event))) {
                 handle = true;
             }
             break;
-        case StartChat:
+        case Type::StartChat:
             if (std::dynamic_pointer_cast<RequestChatWithUserDialogUIEvent>(event)) {
                 handle = true;
             }
             break;
-        case InviteToChat:
+        case Type::InviteToChat:
             if ((inviteToMUCRequest = std::dynamic_pointer_cast<RequestInviteToMUCUIEvent>(event))) {
                 handle = true;
             }
@@ -241,7 +241,7 @@ void UserSearchController::handleContactSuggestionsRequested(std::string text) {
         }
 
         // remove contact suggestions which are already on the contact list in add-contact-mode
-        if (type_ == AddContact) {
+        if (type_ == Type::AddContact) {
             if (!found && !!rosterController_->getItem((*i)->jid)) {
                 found = true;
             }
@@ -327,16 +327,16 @@ void UserSearchController::handleDiscoWalkFinished() {
 
 void UserSearchController::initializeUserWindow() {
     if (!window_) {
-        UserSearchWindow::Type windowType = UserSearchWindow::AddContact;
+        auto windowType = UserSearchWindow::Type::AddContact;
         switch(type_) {
-            case AddContact:
-                windowType = UserSearchWindow::AddContact;
+            case Type::AddContact:
+                windowType = UserSearchWindow::Type::AddContact;
                 break;
-            case StartChat:
-                windowType = UserSearchWindow::ChatToContact;
+            case Type::StartChat:
+                windowType = UserSearchWindow::Type::ChatToContact;
                 break;
-            case InviteToChat:
-                windowType = UserSearchWindow::InviteToChat;
+            case Type::InviteToChat:
+                windowType = UserSearchWindow::Type::InviteToChat;
                 break;
         }
 
diff --git a/Swift/Controllers/Chat/UserSearchController.h b/Swift/Controllers/Chat/UserSearchController.h
index 4658301..49bb63c 100644
--- a/Swift/Controllers/Chat/UserSearchController.h
+++ b/Swift/Controllers/Chat/UserSearchController.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2016 Isode Limited.
+ * Copyright (c) 2010-2017 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -49,7 +49,7 @@ namespace Swift {
 
     class UserSearchController {
         public:
-            enum Type {AddContact, StartChat, InviteToChat};
+            enum class Type {AddContact, StartChat, InviteToChat};
             UserSearchController(Type type, const JID& jid, UIEventStream* uiEventStream, VCardManager* vcardManager, UserSearchWindowFactory* userSearchWindowFactory, IQRouter* iqRouter, RosterController* rosterController, ContactSuggester* contactSuggester, AvatarManager* avatarManager, PresenceOracle* presenceOracle, ProfileSettingsProvider* settings);
             ~UserSearchController();
 
diff --git a/Swift/Controllers/MainController.cpp b/Swift/Controllers/MainController.cpp
index e64b23d..b22e467 100644
--- a/Swift/Controllers/MainController.cpp
+++ b/Swift/Controllers/MainController.cpp
@@ -366,7 +366,7 @@ void MainController::handleConnected() {
         contactSuggesterWithoutRoster_ = new ContactSuggester();
         contactSuggesterWithRoster_ = new ContactSuggester();
 
-        userSearchControllerInvite_ = new UserSearchController(UserSearchController::InviteToChat, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
+        userSearchControllerInvite_ = new UserSearchController(UserSearchController::Type::InviteToChat, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
 #ifdef SWIFT_EXPERIMENTAL_HISTORY
         historyController_ = new HistoryController(storages_->getHistoryStorage());
         historyViewController_ = new HistoryViewController(jid_, uiEventStream_, historyController_, client_->getNickResolver(), client_->getAvatarManager(), client_->getPresenceOracle(), uiFactory_);
@@ -405,8 +405,8 @@ void MainController::handleConnected() {
         client_->getDiscoManager()->setCapsNode(CLIENT_NODE);
         client_->getDiscoManager()->setDiscoInfo(discoInfo);
 
-        userSearchControllerChat_ = new UserSearchController(UserSearchController::StartChat, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
-        userSearchControllerAdd_ = new UserSearchController(UserSearchController::AddContact, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithoutRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
+        userSearchControllerChat_ = new UserSearchController(UserSearchController::Type::StartChat, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
+        userSearchControllerAdd_ = new UserSearchController(UserSearchController::Type::AddContact, jid_, uiEventStream_, client_->getVCardManager(), uiFactory_, client_->getIQRouter(), rosterController_, contactSuggesterWithoutRoster_, client_->getAvatarManager(), client_->getPresenceOracle(), profileSettings_);
         adHocManager_ = new AdHocManager(JID(boundJID_.getDomain()), uiFactory_, client_->getIQRouter(), uiEventStream_, rosterController_->getWindow());
 
         chatsManager_->onImpromptuMUCServiceDiscovered.connect(boost::bind(&UserSearchController::setCanInitiateImpromptuMUC, userSearchControllerChat_, _1));
diff --git a/Swift/Controllers/UIInterfaces/UserSearchWindow.h b/Swift/Controllers/UIInterfaces/UserSearchWindow.h
index 279f4f3..c13e376 100644
--- a/Swift/Controllers/UIInterfaces/UserSearchWindow.h
+++ b/Swift/Controllers/UIInterfaces/UserSearchWindow.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2016 Isode Limited.
+ * Copyright (c) 2010-2017 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -20,7 +20,7 @@ namespace Swift {
 
     class UserSearchWindow {
         public:
-            enum Type {AddContact, ChatToContact, InviteToChat};
+            enum class Type {AddContact, ChatToContact, InviteToChat};
             virtual ~UserSearchWindow() {}
 
             virtual void clear() = 0;
diff --git a/Swift/QtUI/UserSearch/QtUserSearchFirstMultiJIDPage.cpp b/Swift/QtUI/UserSearch/QtUserSearchFirstMultiJIDPage.cpp
index 1327a8f..8656db7 100644
--- a/Swift/QtUI/UserSearch/QtUserSearchFirstMultiJIDPage.cpp
+++ b/Swift/QtUI/UserSearch/QtUserSearchFirstMultiJIDPage.cpp
@@ -5,7 +5,7 @@
  */
 
 /*
- * Copyright (c) 2014-2016 Isode Limited.
+ * Copyright (c) 2014-2017 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -29,13 +29,13 @@ QtUserSearchFirstMultiJIDPage::QtUserSearchFirstMultiJIDPage(UserSearchWindow::T
     setTitle(title);
     QString introText = "";
     switch (type) {
-        case UserSearchWindow::AddContact:
+        case UserSearchWindow::Type::AddContact:
             introText = tr("Add another user to your contact list");
             break;
-        case UserSearchWindow::ChatToContact:
+        case UserSearchWindow::Type::ChatToContact:
             introText = tr("Chat to another user");
             break;
-        case UserSearchWindow::InviteToChat:
+        case UserSearchWindow::Type::InviteToChat:
             introText = tr("Invite contact to chat");
             break;
     }
diff --git a/Swift/QtUI/UserSearch/QtUserSearchFirstPage.cpp b/Swift/QtUI/UserSearch/QtUserSearchFirstPage.cpp
index 5d0c9fa..24e79e4 100644
--- a/Swift/QtUI/UserSearch/QtUserSearchFirstPage.cpp
+++ b/Swift/QtUI/UserSearch/QtUserSearchFirstPage.cpp
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2010-2016 Isode Limited.
+ * Copyright (c) 2010-2017 Isode Limited.
  * All rights reserved.
  * See the COPYING file for more information.
  */
@@ -15,7 +15,7 @@ namespace Swift {
 QtUserSearchFirstPage::QtUserSearchFirstPage(UserSearchWindow::Type type, const QString& title, SettingsProvider* settings) {
     setupUi(this);
     setTitle(title);
-    setSubTitle(QString(tr("%1. If you know their address you can enter it directly, or you can search for them.")).arg(type == UserSearchWindow::AddContact ? tr("Add another user to your contact list") : tr("Chat to another user")));
+    setSubTitle(QString(tr("%1. If you know their address you can enter it directly, or you can search for them.")).arg(type == UserSearchWindow::Type::AddContact ? tr("Add another user to your contact list") : tr("Chat to another user")));
     jid_ = new QtSuggestingJIDInput(this, settings);
     horizontalLayout_2->addWidget(jid_);
     jidWarning_ = new QLabel(this);
diff --git a/Swift/QtUI/UserSearch/QtUserSearchWindow.cpp b/Swift/QtUI/UserSearch/QtUserSearchWindow.cpp
index f150557..e770186 100644
--- a/Swift/QtUI/UserSearch/QtUserSearchWindow.cpp
+++ b/Swift/QtUI/UserSearch/QtUserSearchWindow.cpp
@@ -34,7 +34,7 @@
 
 namespace Swift {
 
-QtUserSearchWindow::QtUserSearchWindow(UIEventStream* eventStream, UserSearchWindow::Type type, const std::set<std::string>& groups, SettingsProvider* settingsProvider) : eventStream_(eventStream), type_(type), model_(nullptr), firstMultiJIDPage_(nullptr), settings_(settingsProvider), searchNext_(false), supportsImpromptu_(false) {
+QtUserSearchWindow::QtUserSearchWindow(UIEventStream* eventStream, UserSearchWindow::Type type, const std::set<std::string>& groups, SettingsProvider* settingsProvider) : eventStream_(eventStream), type_(type), model_(nullptr), firstPage_(nullptr), firstMultiJIDPage_(nullptr), settings_(settingsProvider), searchNext_(false), supportsImpromptu_(false) {
     setupUi(this);
 #ifndef Q_OS_MAC
 #ifdef  Q_OS_WIN32
@@ -45,13 +45,13 @@ QtUserSearchWindow::QtUserSearchWindow(UIEventStream* eventStream, UserSearchWin
 #endif
     QString title;
     switch(type) {
-        case AddContact:
+        case Type::AddContact:
             title = tr("Add Contact");
             break;
-        case ChatToContact:
+        case Type::ChatToContact:
             title = tr("Chat to Users");
             break;
-        case InviteToChat:
+        case Type::InviteToChat:
             title = tr("Add Users to Chat");
             break;
     }
@@ -77,11 +77,22 @@ QtUserSearchWindow::~QtUserSearchWindow() {
 
 void QtUserSearchWindow::handleCurrentChanged(int page) {
     searchNext_ = false;
-    if (type_ != AddContact) {
+
+    // Check preconditions per type.
+    if (type_ == Type::AddContact) {
+        assert(firstPage_);
+        assert(!firstMultiJIDPage_);
+    }
+    else {
+        assert(!firstPage_);
+        assert(firstMultiJIDPage_);
+    }
+
+    if (type_ != Type::AddContact) {
         firstMultiJIDPage_->reset();
     }
     resultsPage_->emitCompletenessCheck();
-    if (firstMultiJIDPage_ && page == 1 && lastPage_ == 3) {
+    if (type_ != Type::AddContact && page == 1 && lastPage_ == 3) {
         addSearchedJIDToList(getContact());
         setSecondPage();
     }
@@ -97,7 +108,7 @@ void QtUserSearchWindow::handleCurrentChanged(int page) {
         JID server = getServerToSearch();
         handleSearch();
 
-        if (type_ == AddContact) {
+        if (type_ == Type::AddContact) {
             bool remote = firstPage_->byRemoteSearch_->isChecked();
             firstPage_->byRemoteSearch_->setChecked(remote);
             firstPage_->service_->setEditText(P2QSTRING(server.toString()));
@@ -119,7 +130,7 @@ void QtUserSearchWindow::handleCurrentChanged(int page) {
 }
 
 JID QtUserSearchWindow::getServerToSearch() {
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         return firstPage_->byRemoteSearch_->isChecked() ? JID(Q2PSTRING(firstPage_->service_->currentText().trimmed())) : myServer_;
     }
     else {
@@ -131,11 +142,11 @@ void QtUserSearchWindow::handleAccepted() {
     JID jid;
     std::vector<JID> jids;
     switch(type_) {
-        case AddContact:
+        case Type::AddContact:
             jid = getContactJID();
             eventStream_->send(std::make_shared<AddContactUIEvent>(jid, detailsPage_->getName(), detailsPage_->getSelectedGroups()));
             break;
-        case ChatToContact:
+        case Type::ChatToContact:
             if (contactVector_.size() == 1) {
                 std::shared_ptr<UIEvent> event(new RequestChatUIEvent(contactVector_[0]->jid));
                 eventStream_->send(event);
@@ -148,7 +159,7 @@ void QtUserSearchWindow::handleAccepted() {
 
             eventStream_->send(std::make_shared<CreateImpromptuMUCUIEvent>(jids, Q2PSTRING(firstMultiJIDPage_->reason_->text())));
             break;
-        case InviteToChat:
+        case Type::InviteToChat:
             for (Contact::ref contact : contactVector_) {
                 jids.push_back(contact->jid);
             }
@@ -171,7 +182,7 @@ void QtUserSearchWindow::addContact() {
 
     firstMultiJIDPage_->contactList_->setList(contactVector_);
     firstMultiJIDPage_->emitCompletenessCheck();
-    if (type_ == ChatToContact) {
+    if (type_ == Type::ChatToContact) {
         firstMultiJIDPage_->groupBox->setEnabled(supportsImpromptu_ ? 1 : (contactVector_.size() < 1));
     }
 
@@ -195,11 +206,11 @@ void QtUserSearchWindow::setWarning(const boost::optional<std::string>& message)
 }
 
 int QtUserSearchWindow::nextId() const {
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         switch (currentId()) {
-            case 1: return firstPage_->byJID_->isChecked() ? (type_ == AddContact ? 4 : -1) : 2;
+            case 1: return firstPage_->byJID_->isChecked() ? (type_ == Type::AddContact ? 4 : -1) : 2;
             case 2: return 3;
-            case 3: return type_ == AddContact ? 4 : -1;
+            case 3: return type_ == Type::AddContact ? 4 : -1;
             case 4: return -1;
             default: return -1;
         }
@@ -261,7 +272,7 @@ JID QtUserSearchWindow::getContactJID() const {
     JID jid;
 
     bool useSearchResult;
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         useSearchResult = !firstPage_->byJID_->isChecked();
     } else {
         useSearchResult = true;
@@ -315,7 +326,7 @@ void QtUserSearchWindow::handleOnSearchedJIDSelected(const Contact::ref& contact
 
 void QtUserSearchWindow::show() {
     clear();
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         setWarning(boost::optional<std::string>());
     }
     QWidget::show();
@@ -323,7 +334,7 @@ void QtUserSearchWindow::show() {
 }
 
 void QtUserSearchWindow::addSavedServices(const std::vector<JID>& services) {
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         firstPage_->service_->clear();
         for (auto&& jid : services) {
             firstPage_->service_->addItem(P2QSTRING(jid.toString()));
@@ -374,7 +385,7 @@ void QtUserSearchWindow::prepopulateJIDAndName(const JID& jid, const std::string
 }
 
 void QtUserSearchWindow::setContactSuggestions(const std::vector<Contact::ref>& suggestions) {
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         firstPage_->jid_->setSuggestions(suggestions);
     } else {
         firstMultiJIDPage_->jid_->setSuggestions(suggestions);
@@ -410,19 +421,19 @@ std::vector<JID> QtUserSearchWindow::getJIDs() const {
 
 void QtUserSearchWindow::setCanStartImpromptuChats(bool supportsImpromptu) {
     supportsImpromptu_ = supportsImpromptu;
-    if (type_ == ChatToContact) {
+    if (type_ == Type::ChatToContact) {
         firstMultiJIDPage_->contactList_->setMaximumNoOfContactsToOne(!supportsImpromptu_);
     }
 }
 
 void QtUserSearchWindow::updateContacts(const std::vector<Contact::ref>& contacts) {
-    if (type_ != AddContact) {
+    if (type_ != Type::AddContact) {
         firstMultiJIDPage_->contactList_->updateContacts(contacts);
     }
 }
 
 void QtUserSearchWindow::addContacts(const std::vector<Contact::ref>& contacts) {
-    if (type_ != AddContact) {
+    if (type_ != Type::AddContact) {
         /* prevent duplicate JIDs from appearing in the contact list */
         for (Contact::ref newContact : contacts) {
             bool found = false;
@@ -436,12 +447,12 @@ void QtUserSearchWindow::addContacts(const std::vector<Contact::ref>& contacts)
                 contactVector_.push_back(newContact);
             }
         }
-        if (type_ != InviteToChat && !supportsImpromptu_ && contactVector_.size() > 1) {
+        if (type_ != Type::InviteToChat && !supportsImpromptu_ && contactVector_.size() > 1) {
             contactVector_.resize(1); /* can't chat with more than one user */
         }
         firstMultiJIDPage_->contactList_->setList(contactVector_);
         firstMultiJIDPage_->emitCompletenessCheck();
-        if (type_ == ChatToContact) {
+        if (type_ == Type::ChatToContact) {
             firstMultiJIDPage_->groupBox->setEnabled(supportsImpromptu_ ? true : (contactVector_.size() < 1));
         }
     }
@@ -459,7 +470,7 @@ void QtUserSearchWindow::handleAddViaSearch() {
 
 void QtUserSearchWindow::handleListChanged(std::vector<Contact::ref> list) {
     contactVector_ = list;
-    if (type_ == ChatToContact) {
+    if (type_ == Type::ChatToContact) {
         firstMultiJIDPage_->groupBox->setEnabled(supportsImpromptu_ ? 1 : (contactVector_.size() < 1));
     }
 }
@@ -509,7 +520,7 @@ void QtUserSearchWindow::setFirstPage(QString title) {
     if (page(1) != nullptr) {
         removePage(1);
     }
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         firstPage_ = new QtUserSearchFirstPage(type_, title.isEmpty() ? firstPage_->title() : title, settings_);
         connect(firstPage_->jid_, SIGNAL(textEdited(QString)), this, SLOT(handleContactSuggestionRequested(QString)));
         connect(firstPage_->jid_, SIGNAL(textEdited(QString)), this, SLOT(handleJIDEditingDone()), Qt::UniqueConnection);
@@ -554,7 +565,7 @@ void QtUserSearchWindow::setThirdPage() {
 #ifdef SWIFT_PLATFORM_MACOSX
     resultsPage_->results_->setAlternatingRowColors(true);
 #endif
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         connect(resultsPage_, SIGNAL(onUserTriggersContinue()), this, SLOT(next()));
     }
     else {
@@ -579,7 +590,7 @@ void QtUserSearchWindow::clearForm() {
 
 void QtUserSearchWindow::clear() {
     QString howText;
-    if (type_ == AddContact) {
+    if (type_ == Type::AddContact) {
         firstPage_->errorLabel_->setVisible(false);
         howText = QString(tr("How would you like to find the user to add?"));
         firstPage_->howLabel_->setText(howText);
@@ -589,9 +600,9 @@ void QtUserSearchWindow::clear() {
         contactVector_.clear();
         firstMultiJIDPage_->contactList_->setList(contactVector_);
         firstMultiJIDPage_->errorLabel_->setVisible(false);
-        if (type_ == ChatToContact) {
+        if (type_ == Type::ChatToContact) {
             howText = QString(tr("List of participants:"));
-        } else if (type_ == InviteToChat) {
+        } else if (type_ == Type::InviteToChat) {
             howText = QString(tr("Who do you want to invite to the chat?"));
         }
         firstMultiJIDPage_->howLabel_->setText(howText);
@@ -606,14 +617,14 @@ void QtUserSearchWindow::clear() {
 
 void QtUserSearchWindow::setError(const QString& error) {
     if (error.isEmpty()) {
-        if (type_ == AddContact) {
+        if (type_ == Type::AddContact) {
             firstPage_->errorLabel_->hide();
         } else {
             firstMultiJIDPage_->errorLabel_->hide();
         }
     }
     else {
-        if (type_ == AddContact) {
+        if (type_ == Type::AddContact) {
             firstPage_->errorLabel_->setText(QString("<font color='red'>%1</font>").arg(error));
             firstPage_->errorLabel_->show();
         } else {
author	Tobias Markmann <tm@ayena.de>	2017-04-12 09:05:33 (GMT)
committer	Tobias Markmann <tm@ayena.de>	2017-04-12 09:05:33 (GMT)
commit	4024517891d3a222e71e6632c3609fcda08c875e (patch)
tree	690020d1a9c1a4c3fd8bff0f59d196ee23b05d60
parent	43b85e93c7acd865be2de009651e146e9faece96 (diff)
download	swift-4024517891d3a222e71e6632c3609fcda08c875e.zip swift-4024517891d3a222e71e6632c3609fcda08c875e.tar.bz2