%PDF- %PDF-
| Direktori : /data/old/usr/local/include/znc/ |
| Current File : //data/old/usr/local/include/znc/Buffer.h |
/*
* Copyright (C) 2004-2018 ZNC, see the NOTICE file for details.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ZNC_BUFFER_H
#define ZNC_BUFFER_H
#include <znc/zncconfig.h>
#include <znc/ZNCString.h>
#include <znc/Message.h>
#include <sys/time.h>
#include <deque>
// Forward Declarations
class CClient;
// !Forward Declarations
class CBufLine {
public:
CBufLine() : CBufLine("") {
throw 0;
} // shouldn't be called, but is needed for compilation
CBufLine(const CMessage& Format, const CString& sText = "");
/// @deprecated
CBufLine(const CString& sFormat, const CString& sText = "",
const timeval* ts = nullptr,
const MCString& mssTags = MCString::EmptyMap);
~CBufLine();
CMessage ToMessage(const CClient& Client, const MCString& mssParams) const;
/// @deprecated Use ToMessage() instead
CString GetLine(const CClient& Client, const MCString& mssParams) const;
/// @deprecated
void UpdateTime();
bool Equals(const CMessage& Format) const {
return m_Message.Equals(Format);
}
// Setters
void SetFormat(const CString& sFormat) { m_Message.Parse(sFormat); }
void SetText(const CString& sText) { m_sText = sText; }
void SetTime(const timeval& ts) { m_Message.SetTime(ts); }
void SetTags(const MCString& mssTags) { m_Message.SetTags(mssTags); }
// !Setters
// Getters
const CString& GetCommand() const { return m_Message.GetCommand(); }
CString GetFormat() const {
return m_Message.ToString(CMessage::ExcludeTags);
}
const CString& GetText() const { return m_sText; }
timeval GetTime() const { return m_Message.GetTime(); }
const MCString& GetTags() const { return m_Message.GetTags(); }
// !Getters
private:
protected:
CMessage m_Message;
CString m_sText;
};
class CBuffer : private std::deque<CBufLine> {
public:
CBuffer(unsigned int uLineCount = 100);
~CBuffer();
size_type AddLine(const CMessage& Format, const CString& sText = "");
size_type UpdateLine(const CString& sCommand, const CMessage& Format,
const CString& sText = "");
size_type UpdateExactLine(const CMessage& Format,
const CString& sText = "");
size_type AddLine(const CString& sFormat, const CString& sText = "",
const timeval* ts = nullptr,
const MCString& mssTags = MCString::EmptyMap);
/// Same as AddLine, but replaces a line whose format string starts with sMatch if there is one.
size_type UpdateLine(const CString& sMatch, const CString& sFormat,
const CString& sText = "");
/// Same as UpdateLine, but does nothing if this exact line already exists.
/// We need this because "/version" sends us the 005 raws again
size_type UpdateExactLine(const CString& sFormat,
const CString& sText = "");
const CBufLine& GetBufLine(unsigned int uIdx) const;
CString GetLine(size_type uIdx, const CClient& Client,
const MCString& msParams = MCString::EmptyMap) const;
size_type Size() const { return size(); }
bool IsEmpty() const { return empty(); }
void Clear() { clear(); }
// Setters
bool SetLineCount(unsigned int u, bool bForce = false);
// !Setters
// Getters
unsigned int GetLineCount() const { return m_uLineCount; }
// !Getters
private:
protected:
unsigned int m_uLineCount;
};
#endif // !ZNC_BUFFER_H