adam/znc
1
0
Fork 0
mirror of https://github.com/znc/znc.git synced 2026-08-07 09:22:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename new On...Message modules callbacks to be more consistent.

Browse Source 
OnPrivMessage -> OnPrivTextMessage
OnChanMessage -> OnChanTextMessage

Fix #1191
This commit is contained in:
Alexey Sokolov
2016-12-25 15:46:22 +00:00
parent 30cd0584a1
commit c803a85e13
10 changed files with 44 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/znc/Modules.h
+12 -12
View File
@@ -844,7 +844,7 @@ class CModule {
/// @deprecated Use OnUserActionMessage() instead.
virtual EModRet OnUserAction(CString& sTarget, CString& sMessage);
/** This module hook is called when a user sends a normal IRC message.
/** This module hook is called when a user sends a PRIVMSG message.
* @since 1.7.0
* @param Message The message which was sent.
* @return See CModule::EModRet.
@@ -853,7 +853,7 @@ class CModule {
/// @deprecated Use OnUserTextMessage() instead.
virtual EModRet OnUserMsg(CString& sTarget, CString& sMessage);
/** This module hook is called when a user sends a notice message.
/** This module hook is called when a user sends a NOTICE message.
* @since 1.7.0
* @param Message The message which was sent.
* @return See CModule::EModRet.
@@ -950,25 +950,25 @@ class CModule {
virtual EModRet OnChanAction(CNick& Nick, CChan& Channel,
CString& sMessage);
/** Called when we receive a private message <em>from IRC</em>.
/** Called when we receive a private PRIVMSG message <em>from IRC</em>.
* @since 1.7.0
* @param Message The private message.
* @return See CModule::EModRet.
*/
virtual EModRet OnPrivMessage(CTextMessage& Message);
/// @deprecated Use OnPrivMessage() instead.
virtual EModRet OnPrivTextMessage(CTextMessage& Message);
/// @deprecated Use OnPrivTextMessage() instead.
virtual EModRet OnPrivMsg(CNick& Nick, CString& sMessage);
/** Called when we receive a channel message <em>from IRC</em>.
/** Called when we receive a channel PRIVMSG message <em>from IRC</em>.
* @since 1.7.0
* @param Message The channel message.
* @return See CModule::EModRet.
*/
virtual EModRet OnChanMessage(CTextMessage& Message);
/// @deprecated Use OnChanMessage() instead.
virtual EModRet OnChanTextMessage(CTextMessage& Message);
/// @deprecated Use OnChanTextMessage() instead.
virtual EModRet OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage);
/** Called when we receive a private notice.
/** Called when we receive a private NOTICE message <em>from IRC</em>.
* @since 1.7.0
* @param Message The notice message.
* @return See CModule::EModRet.
@@ -977,7 +977,7 @@ class CModule {
/// @deprecated Use OnPrivNoticeMessage() instead.
virtual EModRet OnPrivNotice(CNick& Nick, CString& sMessage);
/** Called when we receive a channel notice.
/** Called when we receive a channel NOTICE message <em>from IRC</em>.
* @since 1.7.0
* @param Message The notice message.
* @return See CModule::EModRet.
@@ -1505,9 +1505,9 @@ class CModules : public std::vector<CModule*> {
bool OnChanAction(CNick& Nick, CChan& Channel, CString& sMessage);
bool OnChanActionMessage(CActionMessage& Message);
bool OnPrivMsg(CNick& Nick, CString& sMessage);
bool OnPrivMessage(CTextMessage& Message);
bool OnPrivTextMessage(CTextMessage& Message);
bool OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage);
bool OnChanMessage(CTextMessage& Message);
bool OnChanTextMessage(CTextMessage& Message);
bool OnPrivNotice(CNick& Nick, CString& sMessage);
bool OnPrivNoticeMessage(CNoticeMessage& Message);
bool OnChanNotice(CNick& Nick, CChan& Channel, CString& sMessage);
modules/modperl/functions.in
+2 -2
View File
@@ -92,8 +92,8 @@ EModRet OnPrivCTCPMessage(CCTCPMessage& Message)
EModRet OnChanCTCPMessage(CCTCPMessage& Message)
EModRet OnPrivActionMessage(CActionMessage& Message)
EModRet OnChanActionMessage(CActionMessage& Message)
EModRet OnPrivMessage(CTextMessage& Message)
EModRet OnChanMessage(CTextMessage& Message)
EModRet OnPrivTextMessage(CTextMessage& Message)
EModRet OnChanTextMessage(CTextMessage& Message)
EModRet OnPrivNoticeMessage(CNoticeMessage& Message)
EModRet OnChanNoticeMessage(CNoticeMessage& Message)
EModRet OnTopicMessage(CTopicMessage& Message)
modules/modperl/module.h
+2 -2
View File
@@ -148,8 +148,8 @@ class ZNC_EXPORT_LIB_EXPORT CPerlModule : public CModule {
EModRet OnChanCTCPMessage(CCTCPMessage& Message) override;
EModRet OnPrivActionMessage(CActionMessage& Message) override;
EModRet OnChanActionMessage(CActionMessage& Message) override;
EModRet OnPrivMessage(CTextMessage& Message) override;
EModRet OnChanMessage(CTextMessage& Message) override;
EModRet OnPrivTextMessage(CTextMessage& Message) override;
EModRet OnChanTextMessage(CTextMessage& Message) override;
EModRet OnPrivNoticeMessage(CNoticeMessage& Message) override;
EModRet OnChanNoticeMessage(CNoticeMessage& Message) override;
EModRet OnTopicMessage(CTopicMessage& Message) override;
modules/modpython/functions.in
+2 -2
View File
@@ -92,8 +92,8 @@ EModRet OnPrivCTCPMessage(CCTCPMessage& Message)
EModRet OnChanCTCPMessage(CCTCPMessage& Message)
EModRet OnPrivActionMessage(CActionMessage& Message)
EModRet OnChanActionMessage(CActionMessage& Message)
EModRet OnPrivMessage(CTextMessage& Message)
EModRet OnChanMessage(CTextMessage& Message)
EModRet OnPrivTextMessage(CTextMessage& Message)
EModRet OnChanTextMessage(CTextMessage& Message)
EModRet OnPrivNoticeMessage(CNoticeMessage& Message)
EModRet OnChanNoticeMessage(CNoticeMessage& Message)
EModRet OnTopicMessage(CTopicMessage& Message)
modules/modpython/module.h
+2 -2
View File
@@ -168,8 +168,8 @@ class ZNC_EXPORT_LIB_EXPORT CPyModule : public CModule {
EModRet OnChanCTCPMessage(CCTCPMessage& Message) override;
EModRet OnPrivActionMessage(CActionMessage& Message) override;
EModRet OnChanActionMessage(CActionMessage& Message) override;
EModRet OnPrivMessage(CTextMessage& Message) override;
EModRet OnChanMessage(CTextMessage& Message) override;
EModRet OnPrivTextMessage(CTextMessage& Message) override;
EModRet OnChanTextMessage(CTextMessage& Message) override;
EModRet OnPrivNoticeMessage(CNoticeMessage& Message) override;
EModRet OnChanNoticeMessage(CNoticeMessage& Message) override;
EModRet OnTopicMessage(CTopicMessage& Message) override;
src/IRCSock.cpp
+2 -2
View File
@@ -1050,7 +1050,7 @@ bool CIRCSock::OnTextMessage(CTextMessage& Message) {
CString sTarget = Message.GetTarget();
if (sTarget.Equals(GetNick())) {
IRCSOCKMODULECALL(OnPrivMessage(Message), &bResult);
IRCSOCKMODULECALL(OnPrivTextMessage(Message), &bResult);
if (bResult) return true;
if (!m_pNetwork->IsUserOnline() ||
@@ -1071,7 +1071,7 @@ bool CIRCSock::OnTextMessage(CTextMessage& Message) {
if (pChan) {
Message.SetChan(pChan);
FixupChanNick(Message.GetNick(), pChan);
IRCSOCKMODULECALL(OnChanMessage(Message), &bResult);
IRCSOCKMODULECALL(OnChanTextMessage(Message), &bResult);
if (bResult) return true;
if (!pChan->AutoClearChanBuffer() || !m_pNetwork->IsUserOnline() ||
src/Modules.cpp
+6 -6
View File
@@ -933,7 +933,7 @@ CModule::EModRet CModule::OnChanActionMessage(CActionMessage& Message) {
CModule::EModRet CModule::OnPrivMsg(CNick& Nick, CString& sMessage) {
return CONTINUE;
}
CModule::EModRet CModule::OnPrivMessage(CTextMessage& Message) {
CModule::EModRet CModule::OnPrivTextMessage(CTextMessage& Message) {
CString sText = Message.GetText();
EModRet ret = OnPrivMsg(Message.GetNick(), sText);
Message.SetText(sText);
@@ -943,7 +943,7 @@ CModule::EModRet CModule::OnChanMsg(CNick& Nick, CChan& Channel,
CString& sMessage) {
return CONTINUE;
}
CModule::EModRet CModule::OnChanMessage(CTextMessage& Message) {
CModule::EModRet CModule::OnChanTextMessage(CTextMessage& Message) {
CString sText = Message.GetText();
EModRet ret = OnChanMsg(Message.GetNick(), *Message.GetChan(), sText);
Message.SetText(sText);
@@ -1412,14 +1412,14 @@ bool CModules::OnChanActionMessage(CActionMessage& Message) {
bool CModules::OnPrivMsg(CNick& Nick, CString& sMessage) {
MODHALTCHK(OnPrivMsg(Nick, sMessage));
}
bool CModules::OnPrivMessage(CTextMessage& Message) {
MODHALTCHK(OnPrivMessage(Message));
bool CModules::OnPrivTextMessage(CTextMessage& Message) {
MODHALTCHK(OnPrivTextMessage(Message));
}
bool CModules::OnChanMsg(CNick& Nick, CChan& Channel, CString& sMessage) {
MODHALTCHK(OnChanMsg(Nick, Channel, sMessage));
}
bool CModules::OnChanMessage(CTextMessage& Message) {
MODHALTCHK(OnChanMessage(Message));
bool CModules::OnChanTextMessage(CTextMessage& Message) {
MODHALTCHK(OnChanTextMessage(Message));
}
bool CModules::OnPrivNotice(CNick& Nick, CString& sMessage) {
MODHALTCHK(OnPrivNotice(Nick, sMessage));
test/IRCSockTest.cpp
+2 -2
View File
@@ -366,7 +366,7 @@ TEST_F(IRCSockTest, OnTextMessage) {
m_pTestModule->eAction = CModule::HALT;
m_pTestSock->ReadLine(msg.ToString());
EXPECT_THAT(m_pTestModule->vsHooks, ElementsAre("OnChanMessage"));
EXPECT_THAT(m_pTestModule->vsHooks, ElementsAre("OnChanTextMessage"));
EXPECT_THAT(m_pTestModule->vsMessages, ElementsAre(msg.ToString()));
EXPECT_THAT(m_pTestModule->vNetworks, ElementsAre(m_pTestNetwork));
EXPECT_THAT(m_pTestModule->vChannels, ElementsAre(m_pTestChan));
@@ -384,7 +384,7 @@ TEST_F(IRCSockTest, OnTextMessage) {
m_pTestModule->eAction = CModule::HALT;
m_pTestSock->ReadLine(msg.ToString());
EXPECT_THAT(m_pTestModule->vsHooks, ElementsAre("OnPrivMessage"));
EXPECT_THAT(m_pTestModule->vsHooks, ElementsAre("OnPrivTextMessage"));
EXPECT_THAT(m_pTestModule->vsMessages, ElementsAre(msg.ToString()));
EXPECT_THAT(m_pTestModule->vNetworks, ElementsAre(m_pTestNetwork));
EXPECT_THAT(m_pTestModule->vChannels, ElementsAre(nullptr));
test/IRCTest.h
+4 -4
View File
@@ -82,12 +82,12 @@ class TestModule : public CModule {
vsHooks.push_back("OnChanActionMessage");
return OnMessage(msg);
}
EModRet OnPrivMessage(CTextMessage& msg) override {
vsHooks.push_back("OnPrivMessage");
EModRet OnPrivTextMessage(CTextMessage& msg) override {
vsHooks.push_back("OnPrivTextMessage");
return OnMessage(msg);
}
EModRet OnChanMessage(CTextMessage& msg) override {
vsHooks.push_back("OnChanMessage");
EModRet OnChanTextMessage(CTextMessage& msg) override {
vsHooks.push_back("OnChanTextMessage");
return OnMessage(msg);
}
EModRet OnPrivNoticeMessage(CNoticeMessage& msg) override {
test/ModulesTest.cpp
+10 -10
View File
@@ -208,14 +208,14 @@ class CMessageModule : public CModule {
Message.SetText("CMessageModule::OnChanActionMessage");
return eAction;
}
EModRet OnPrivMessage(CTextMessage& Message) override {
EModRet OnPrivTextMessage(CTextMessage& Message) override {
Message.GetNick().SetNick("nick");
Message.SetText("CMessageModule::OnPrivMessage");
Message.SetText("CMessageModule::OnPrivTextMessage");
return eAction;
}
EModRet OnChanMessage(CTextMessage& Message) override {
EModRet OnChanTextMessage(CTextMessage& Message) override {
Message.GetNick().SetNick("nick");
Message.SetText("CMessageModule::OnChanMessage");
Message.SetText("CMessageModule::OnChanTextMessage");
return eAction;
}
EModRet OnPrivNoticeMessage(CNoticeMessage& Message) override {
@@ -392,23 +392,23 @@ TEST_F(ModulesTest, Hooks) {
CTextMessage PrivMsg;
LegacyMod.eAction = CModule::HALT;
Modules.OnPrivMessage(PrivMsg);
Modules.OnPrivTextMessage(PrivMsg);
EXPECT_EQ("legacy", PrivMsg.GetNick().GetNick());
EXPECT_EQ("CLegacyModule::OnPrivMsg", PrivMsg.GetText());
LegacyMod.eAction = CModule::CONTINUE;
Modules.OnPrivMessage(PrivMsg);
Modules.OnPrivTextMessage(PrivMsg);
EXPECT_EQ("nick", PrivMsg.GetNick().GetNick());
EXPECT_EQ("CMessageModule::OnPrivMessage", PrivMsg.GetText());
EXPECT_EQ("CMessageModule::OnPrivTextMessage", PrivMsg.GetText());
CTextMessage ChanMsg;
LegacyMod.eAction = CModule::HALT;
Modules.OnChanMessage(ChanMsg);
Modules.OnChanTextMessage(ChanMsg);
EXPECT_EQ("legacy", ChanMsg.GetNick().GetNick());
EXPECT_EQ("CLegacyModule::OnChanMsg", ChanMsg.GetText());
LegacyMod.eAction = CModule::CONTINUE;
Modules.OnChanMessage(ChanMsg);
Modules.OnChanTextMessage(ChanMsg);
EXPECT_EQ("nick", ChanMsg.GetNick().GetNick());
EXPECT_EQ("CMessageModule::OnChanMessage", ChanMsg.GetText());
EXPECT_EQ("CMessageModule::OnChanTextMessage", ChanMsg.GetText());
CNoticeMessage PrivNotice;
LegacyMod.eAction = CModule::HALT;