21 #define ZNC_MSG_DEPRECATED(msg)
23 #define ZNC_MSG_DEPRECATED(msg) __attribute__((deprecated(msg)))
26 #include <znc/zncconfig.h>
135 const timeval&
GetTime()
const {
return m_time; }
136 void SetTime(
const timeval& ts) { m_time = ts; }
155 template <
typename M>
157 static_assert(std::is_base_of<CMessage, M>{},
158 "Must be subclass of CMessage");
159 static_assert(
sizeof(M) ==
sizeof(
CMessage),
160 "No data members allowed in CMessage subclasses.");
161 return static_cast<M&
>(*this);
164 template <
typename M>
165 const M&
As() const& {
166 static_assert(std::is_base_of<CMessage, M>{},
167 "Must be subclass of CMessage");
168 static_assert(
sizeof(M) ==
sizeof(
CMessage),
169 "No data members allowed in CMessage subclasses.");
170 return static_cast<const M&
>(*this);
173 template <
typename M,
typename =
typename std::enable_if<
174 std::is_base_of<CMessage, M>{}>::type>
178 template <
typename M,
typename =
typename std::enable_if<
179 std::is_base_of<CMessage, M>{}>::type>
180 operator const M&()
const& {
184 #define REGISTER_ZNC_MESSAGE(M)
188 template <
typename M>
203 CChan* m_pChan =
nullptr;
205 bool m_bColon =
false;
210 template <
typename M,
typename =
typename std::enable_if<
211 std::is_base_of<CMessage, M>{}>::type>
212 inline ::std::ostream& operator<<(::std::ostream& os,
const M& msg) {
235 SetParam(1,
"\001ACTION " + sText +
"\001");
#define REGISTER_ZNC_MESSAGE(M)
Definition: Message.h:184
#define ZNC_MSG_DEPRECATED(msg)
Definition: Message.h:23
std::vector< CString > VCString
Definition: ZNCString.h:38
Definition: Message.h:229
CString GetText() const
Definition: Message.h:231
void SetText(const CString &sText)
Definition: Message.h:234
Definition: Message.h:240
bool IsReply() const
Definition: Message.h:242
CString GetText() const
Definition: Message.h:243
void SetText(const CString &sText)
Definition: Message.h:246
Definition: IRCNetwork.h:40
Definition: Message.h:250
void SetKey(const CString &sKey)
Definition: Message.h:253
CString GetKey() const
Definition: Message.h:252
Definition: Message.h:291
CString GetReason() const
Definition: Message.h:295
void SetKickedNick(const CString &sNick)
Definition: Message.h:294
CString GetKickedNick() const
Definition: Message.h:293
void SetText(const CString &sText)
Definition: Message.h:298
void SetReason(const CString &sReason)
Definition: Message.h:296
CString GetText() const
Definition: Message.h:297
Here is a small explanation of how messages on IRC work, and how you can use this class to get useful...
Definition: Message.h:57
void SetTag(const CString &sKey, const CString &sValue)
FormatFlags
Definition: Message.h:144
@ ExcludePrefix
Definition: Message.h:146
@ ExcludeTags
Definition: Message.h:147
@ IncludeAll
Definition: Message.h:145
Type
Definition: Message.h:64
const timeval & GetTime() const
Definition: Message.h:135
void SetNick(const CNick &Nick)
Definition: Message.h:105
void Clone(const CMessage &Other)
void SetClient(CClient *pClient)
Definition: Message.h:98
void SetTime(const timeval &ts)
Definition: Message.h:136
const MCString & GetTags() const
Definition: Message.h:138
Type GetType() const
Definition: Message.h:87
CString ToString(unsigned int uFlags=IncludeAll) const
CClient * GetClient() const
Definition: Message.h:97
CString GetParamsColon(unsigned int uIdx, unsigned int uLen=-1) const
CNick & GetNick()
Definition: Message.h:103
VCString GetParamsSplit(unsigned int uIdx, unsigned int uLen=-1) const
Get a subset of the message parameters.
CChan * GetChan() const
Definition: Message.h:100
bool Equals(const CMessage &Other) const
CString GetParam(unsigned int uIdx) const
CString GetParams(unsigned int uIdx, unsigned int uLen=-1) const ZNC_MSG_DEPRECATED("Use GetParamsColon() instead")
Definition: Message.h:126
CString GetTag(const CString &sKey) const
const VCString & GetParams() const
Definition: Message.h:110
const CNick & GetNick() const
Definition: Message.h:104
void SetChan(CChan *pChan)
Definition: Message.h:101
M & As() &
Definition: Message.h:156
void SetCommand(const CString &sCommand)
CMessage(const CNick &Nick, const CString &sCommand, const VCString &vsParams=VCString(), const MCString &mssTags=MCString::EmptyMap)
CIRCNetwork * GetNetwork() const
Definition: Message.h:93
void SetTags(const MCString &mssTags)
Definition: Message.h:139
const M & As() const &
Definition: Message.h:165
const CString & GetCommand() const
Definition: Message.h:107
CMessage(const CString &sMessage="")
void SetNetwork(CIRCNetwork *pNetwork)
Definition: Message.h:94
void SetParams(const VCString &vsParams)
void SetParam(unsigned int uIdx, const CString &sParam)
void Parse(const CString &sMessage)
Definition: Message.h:257
bool HasModes() const
Definition: Message.h:266
VCString GetModeParams() const
Definition: Message.h:264
CString GetModeList() const
Definition: Message.h:262
CString GetModes() const
Definition: Message.h:260
Definition: Message.h:270
void SetNewNick(const CString &sNick)
Definition: Message.h:274
CString GetNewNick() const
Definition: Message.h:273
CString GetOldNick() const
Definition: Message.h:272
const CString & GetNick() const
Definition: Message.h:278
CString GetText() const
Definition: Message.h:280
void SetText(const CString &sText)
Definition: Message.h:281
Definition: Message.h:285
unsigned int GetCode() const
Definition: Message.h:287
Definition: Message.h:302
void SetText(const CString &sText)
Definition: Message.h:307
void SetReason(const CString &sReason)
Definition: Message.h:305
CString GetReason() const
Definition: Message.h:304
CString GetText() const
Definition: Message.h:306
Definition: Message.h:311
CString GetReason() const
Definition: Message.h:313
void SetText(const CString &sText)
Definition: Message.h:316
CString GetText() const
Definition: Message.h:315
void SetReason(const CString &sReason)
Definition: Message.h:314
String class that is used inside ZNC.
Definition: ZNCString.h:68
unsigned int ToUInt() const
@ EDEBUG
Definition: ZNCString.h:76
CString TrimSuffix_n(const CString &sSuffix) const
Trim a given suffix.
CString TrimPrefix_n(const CString &sPrefix=":") const
Trim a given prefix.
bool Equals(const CString &s, CaseSensitivity cs=CaseInsensitive) const
Check if this string is equal to some other string.
Definition: Message.h:222
CString GetTarget() const
Definition: Message.h:224
void SetTarget(const CString &sTarget)
Definition: Message.h:225
Definition: Message.h:320
void SetText(const CString &sText)
Definition: Message.h:323
CString GetText() const
Definition: Message.h:322
Definition: Message.h:327
void SetTopic(const CString &sTopic)
Definition: Message.h:330
CString GetTopic() const
Definition: Message.h:329
void SetText(const CString &sText)
Definition: Message.h:332
CString GetText() const
Definition: Message.h:331
A dictionary for strings.
Definition: ZNCString.h:595
static const MCString EmptyMap
A static instance of an empty map.
Definition: ZNCString.h:606