From 71349b575b97169a8ab47abddb51bd4feb185172 Mon Sep 17 00:00:00 2001 From: Tobias Fella Date: Sun, 22 Dec 2024 20:45:51 +0100 Subject: [PATCH] Refactor action definition - Make an empty message type optional mean "no message" - Set message type for all actions that send a message through the normal mechanism - Remove now redundant bool specifying whether a message should be sent --- autotests/actionstest.cpp | 16 +++++++------- src/chatbarcache.cpp | 5 ++--- src/models/actionsmodel.cpp | 42 +++++++------------------------------ src/models/actionsmodel.h | 10 +-------- 4 files changed, 19 insertions(+), 54 deletions(-) diff --git a/autotests/actionstest.cpp b/autotests/actionstest.cpp index e2dab3b20..e8989d45f 100644 --- a/autotests/actionstest.cpp +++ b/autotests/actionstest.cpp @@ -37,18 +37,20 @@ void ActionsTest::testActions_data() QTest::addColumn>("resultText"); QTest::addColumn>("type"); - QTest::newRow("shrug") << u"/shrug Hello"_s << std::make_optional(u"¯\\\\_(ツ)_/¯ Hello"_s) << std::optional(); - QTest::newRow("lenny") << u"/lenny Hello"_s << std::make_optional(u"( ͡° ͜ʖ ͡°) Hello"_s) << std::optional(); + QTest::newRow("shrug") << u"/shrug Hello"_s << std::make_optional(u"¯\\\\_(ツ)_/¯ Hello"_s) + << std::make_optional(Quotient::RoomMessageEvent::MsgType::Text); + QTest::newRow("lenny") << u"/lenny Hello"_s << std::make_optional(u"( ͡° ͜ʖ ͡°) Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Text); QTest::newRow("tableflip") << u"/tableflip Hello"_s << std::make_optional(u"(╯°□°）╯︵ ┻━┻ Hello"_s) - << std::optional(); - QTest::newRow("unflip") << u"/unflip Hello"_s << std::make_optional(u"┬──┬ ノ( ゜-゜ノ) Hello"_s) << std::optional(); + << std::make_optional(Quotient::RoomMessageEvent::MsgType::Text); + QTest::newRow("unflip") << u"/unflip Hello"_s << std::make_optional(u"┬──┬ ノ( ゜-゜ノ) Hello"_s) + << std::make_optional(Quotient::RoomMessageEvent::MsgType::Text); QTest::newRow("rainbow") << u"/rainbow Hello"_s << std::optional() << std::optional(); QTest::newRow("rainbowme") << u"/rainbowme Hello"_s << std::optional() << std::optional(); QTest::newRow("plain") << u"/plain Hello"_s << std::optional() << std::optional(); QTest::newRow("spoiler") << u"/spoiler Hello"_s << std::optional() << std::optional(); - QTest::newRow("me") << u"/me Hello"_s << std::make_optional(u"Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Emote), - QTest::newRow("notice") << u"/notice Hello"_s << std::make_optional(u"Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Notice), - QTest::newRow("message") << u"Hello"_s << std::make_optional(u"Hello"_s) << std::optional(); + QTest::newRow("me") << u"/me Hello"_s << std::make_optional(u"Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Emote); + QTest::newRow("notice") << u"/notice Hello"_s << std::make_optional(u"Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Notice); + QTest::newRow("message") << u"Hello"_s << std::make_optional(u"Hello"_s) << std::make_optional(Quotient::RoomMessageEvent::MsgType::Text); } void ActionsTest::testActions() diff --git a/src/chatbarcache.cpp b/src/chatbarcache.cpp index 716ef48db..c1f90a53f 100644 --- a/src/chatbarcache.cpp +++ b/src/chatbarcache.cpp @@ -309,7 +309,7 @@ void ChatBarCache::postMessage() } const auto result = ActionsModel::handleAction(room, this); - if (!result.first.has_value()) { + if (!result.second.has_value()) { return; } @@ -338,8 +338,7 @@ void ChatBarCache::postMessage() relatesTo = Quotient::EventRelation::replyTo(replyId()); } - const auto type = std::get>(result); - room->post(text(), type ? *type : Quotient::RoomMessageEvent::MsgType::Text, std::move(content), relatesTo); + room->post(text(), *std::get>(result), std::move(content), relatesTo); clearCache(); } diff --git a/src/models/actionsmodel.cpp b/src/models/actionsmodel.cpp index df8af4f8c..bc64501d2 100644 --- a/src/models/actionsmodel.cpp +++ b/src/models/actionsmodel.cpp @@ -66,8 +66,7 @@ QList actions{ [](const QString &message, NeoChatRoom *, ChatBarCache *) { return u"¯\\\\_(ツ)_/¯ %1"_s.arg(message); }, - true, - std::nullopt, + Quotient::RoomMessageEvent::MsgType::Text, kli18n(""), kli18n("Prepends ¯\\_(ツ)_/¯ to a plain-text message"), }, @@ -76,8 +75,7 @@ QList actions{ [](const QString &message, NeoChatRoom *, ChatBarCache *) { return u"( ͡° ͜ʖ ͡°) %1"_s.arg(message); }, - true, - std::nullopt, + Quotient::RoomMessageEvent::MsgType::Text, kli18n(""), kli18n("Prepends ( ͡° ͜ʖ ͡°) to a plain-text message"), }, @@ -86,8 +84,7 @@ QList actions{ [](const QString &message, NeoChatRoom *, ChatBarCache *) { return u"(╯°□°）╯︵ ┻━┻ %1"_s.arg(message); }, - true, - std::nullopt, + Quotient::RoomMessageEvent::MsgType::Text, kli18n(""), kli18n("Prepends (╯°□°）╯︵ ┻━┻ to a plain-text message"), }, @@ -96,8 +93,7 @@ QList actions{ [](const QString &message, NeoChatRoom *, ChatBarCache *) { return u"┬──┬ ノ( ゜-゜ノ) %1"_s.arg(message); }, - true, - std::nullopt, + Quotient::RoomMessageEvent::MsgType::Text, kli18n(""), kli18n("Prepends ┬──┬ ノ( ゜-゜ノ) to a plain-text message"), }, @@ -115,7 +111,6 @@ QList actions{ room->post("/rainbow %1"_L1.arg(text), MessageEventType::Text, std::move(content), relatesTo); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Sends the given message colored as a rainbow"), @@ -134,7 +129,6 @@ QList actions{ room->post(u"/rainbow %1"_s.arg(text), MessageEventType::Emote, std::move(content), relatesTo); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Sends the given emote colored as a rainbow"), @@ -145,7 +139,6 @@ QList actions{ room->postPlainText(text.toHtmlEscaped()); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Sends the given message as plain text"), @@ -160,7 +153,6 @@ QList actions{ room->post(u"/spoiler %1"_s.arg(text), MessageEventType::Text, std::move(content), relatesTo); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Sends the given message as a spoiler"), @@ -170,7 +162,6 @@ QList actions{ [](const QString &text, NeoChatRoom *, ChatBarCache *) { return text; }, - true, RoomMessageEvent::MsgType::Emote, kli18n(""), kli18n("Sends the given emote"), @@ -180,7 +171,6 @@ QList actions{ [](const QString &text, NeoChatRoom *, ChatBarCache *) { return text; }, - true, RoomMessageEvent::MsgType::Notice, kli18n(""), kli18n("Sends the given message as a notice"), @@ -216,7 +206,6 @@ QList actions{ Q_EMIT room->showMessage(MessageType::Positive, i18nc(" was invited into this room", "%1 was invited into this room", text)); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Invites the user to this room"), @@ -240,7 +229,6 @@ QList actions{ RoomManager::instance().resolveResource(text, "join"_L1); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Joins the given room"), @@ -272,7 +260,6 @@ QList actions{ } return QString(); }, - false, std::nullopt, kli18n(" []"), kli18n("Requests to join the given room"), @@ -295,7 +282,6 @@ QList actions{ RoomManager::instance().resolveResource(text, "join"_L1); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Joins the given room"), @@ -303,7 +289,6 @@ QList actions{ Action{ u"part"_s, leaveRoomLambda, - false, std::nullopt, kli18n("[]"), kli18n("Leaves the given room or this room, if there is none given"), @@ -311,7 +296,6 @@ QList actions{ Action{ u"leave"_s, leaveRoomLambda, - false, std::nullopt, kli18n("[]"), kli18n("Leaves the given room or this room, if there is none given"), @@ -326,7 +310,6 @@ QList actions{ } return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Changes your global display name"), @@ -334,7 +317,6 @@ QList actions{ Action{ u"roomnick"_s, roomNickLambda, - false, std::nullopt, kli18n(""), kli18n("Changes your display name in this room"), @@ -342,7 +324,6 @@ QList actions{ Action{ u"myroomnick"_s, roomNickLambda, - false, std::nullopt, kli18n(""), kli18n("Changes your display name in this room"), @@ -365,7 +346,6 @@ QList actions{ return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Ignores the given user"), @@ -387,7 +367,6 @@ QList actions{ Q_EMIT room->showMessage(MessageType::Positive, i18nc(" is no longer ignored.", "%1 is no longer ignored.", text)); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Unignores the given user"), @@ -407,7 +386,6 @@ QList actions{ room->toggleReaction(chatBarCache->replyId(), text); return QString(); }, - false, std::nullopt, kli18n(""), kli18n("React to the message with the given text"), @@ -446,7 +424,6 @@ QList actions{ Q_EMIT room->showMessage(MessageType::Positive, i18nc(" was banned from this room.", "%1 was banned from this room.", parts[0])); return QString(); }, - false, std::nullopt, kli18n(" []"), kli18n("Bans the given user"), @@ -478,7 +455,6 @@ QList actions{ return QString(); }, - false, std::nullopt, kli18n(""), kli18n("Removes the ban of the given user"), @@ -521,7 +497,6 @@ QList actions{ Q_EMIT room->showMessage(MessageType::Positive, i18nc(" was kicked from this room.", "%1 was kicked from this room.", parts[0])); return QString(); }, - false, std::nullopt, kli18n(" []"), kli18n("Removes the user from the room"), @@ -622,7 +597,7 @@ std::pair, std::optional messageType = std::nullopt; + std::optional messageType = Quotient::RoomMessageEvent::MsgType::Text; if (sendText.startsWith(QLatin1Char('/'))) { for (const auto &action : ActionsModel::instance().allActions()) { if (sendText.indexOf(action.prefix) == 1 @@ -630,15 +605,12 @@ std::pair, std::optional handle; - /** - * @brief Whether the action is a message type action. - * - * If this is true, a message action will be sent. If this is false, this - * message does some action on the client and should not be sent as a message. - */ - bool messageAction; /** * @brief The new message type of a message being sent. * - * For a non-message action or a message action that outputs the same type - * as its input, it's nullopt. + * For a non-message action, it's nullopt. */ std::optional messageType = std::nullopt; KLazyLocalizedString parameters; /**< The input parameters expected by the action. */