CTextHistory Class Reference

#include <TextHistory.h>

Public Member Functions
	CTextHistory ()
virtual	~CTextHistory ()
BOOL	Init (DWORD dwMaxHistoryLineSize, DWORD dwMaxHistoryLines)
const TCHAR *	GetHistoryLine (DWORD dwIndex)
void	AddHistoryLine (const TCHAR *pchLine)

Private Attributes
TCHAR *	m_pHistoryBuffer
DWORD	m_dwMaxHistoryLines
DWORD	m_dwMaxHistoryLineSize
DWORD	m_dwFirstHistoryIndex
DWORD	m_dwLastHistoryIndex
DWORD	m_dwHisoryFull

Detailed Description

Definition at line 9 of file TextHistory.h.

Constructor & Destructor Documentation

CTextHistory()

CTextHistory::CTextHistory

(

)

Definition at line 33 of file TextHistory.cpp.

{
    m_pHistoryBuffer = NULL;
    m_dwMaxHistoryLines = 0;
}

~CTextHistory()

CTextHistory::~CTextHistory ( )

virtual

Definition at line 39 of file TextHistory.cpp.

{
    if (m_pHistoryBuffer) delete[] m_pHistoryBuffer;
}

Member Function Documentation

AddHistoryLine()

void CTextHistory::AddHistoryLine

(

const TCHAR *

pchLine

)

Definition at line 62 of file TextHistory.cpp.

{
    if (!m_pHistoryBuffer) return;
    if (_tcslen(pchLine) == 0) return;
    if (_tcslen(pchLine) >= m_dwMaxHistoryLineSize)
    {
        ASSERT(FALSE);
        return;
    }
    if (m_dwHisoryFull == m_dwMaxHistoryLines)  // if buffer is full, replace last
    {
        ASSERT(m_dwFirstHistoryIndex == m_dwLastHistoryIndex);
        m_dwLastHistoryIndex = (m_dwLastHistoryIndex+1)%m_dwMaxHistoryLines;
    }
    ASSERT(m_dwFirstHistoryIndex < m_dwMaxHistoryLines);
    _tcscpy(m_pHistoryBuffer+m_dwFirstHistoryIndex*m_dwMaxHistoryLineSize,pchLine);
    m_dwFirstHistoryIndex = (m_dwFirstHistoryIndex+1)%m_dwMaxHistoryLines;
    ASSERT(m_dwHisoryFull <= m_dwMaxHistoryLines);
    if (m_dwHisoryFull < m_dwMaxHistoryLines) m_dwHisoryFull++;
}

Referenced by CConsole::ReadLine().

GetHistoryLine()

const TCHAR * CTextHistory::GetHistoryLine

(

DWORD

dwIndex

)

Definition at line 83 of file TextHistory.cpp.

{
    if (!m_pHistoryBuffer) return NULL;
    ASSERT(m_dwHisoryFull <= m_dwMaxHistoryLines);
    if (dwIndex >= m_dwHisoryFull) return NULL;
    dwIndex = m_dwHisoryFull - dwIndex - 1;
    dwIndex = (dwIndex+m_dwLastHistoryIndex) % m_dwMaxHistoryLines;
    ASSERT(dwIndex < m_dwMaxHistoryLines);
    return m_pHistoryBuffer+dwIndex*m_dwMaxHistoryLineSize;
}

Referenced by CConsole::ReadLine().

Init()

BOOL CTextHistory::Init	(	DWORD	dwMaxHistoryLineSize,
		DWORD	dwMaxHistoryLines
	)

Definition at line 44 of file TextHistory.cpp.

{
    if (!dwMaxHistoryLines)
    {
        ASSERT(FALSE);
        return FALSE;
    }
    if (m_pHistoryBuffer) delete[] m_pHistoryBuffer;
    m_dwFirstHistoryIndex = 0;
    m_dwLastHistoryIndex = 0;
    m_dwHisoryFull = 0;
    m_dwMaxHistoryLines = dwMaxHistoryLines;
    m_dwMaxHistoryLineSize = dwMaxHistoryLineSize;
    m_pHistoryBuffer = new (std::nothrow) TCHAR [m_dwMaxHistoryLines*dwMaxHistoryLineSize];
    if (!m_pHistoryBuffer) return FALSE;
    return TRUE;
}

Referenced by CConsole::Init().

Member Data Documentation

m_dwFirstHistoryIndex

DWORD CTextHistory::m_dwFirstHistoryIndex

private

Definition at line 21 of file TextHistory.h.

Referenced by AddHistoryLine(), and Init().

m_dwHisoryFull

DWORD CTextHistory::m_dwHisoryFull

private

Definition at line 23 of file TextHistory.h.

Referenced by AddHistoryLine(), GetHistoryLine(), and Init().

m_dwLastHistoryIndex

DWORD CTextHistory::m_dwLastHistoryIndex

private

Definition at line 22 of file TextHistory.h.

Referenced by AddHistoryLine(), GetHistoryLine(), and Init().

m_dwMaxHistoryLines

DWORD CTextHistory::m_dwMaxHistoryLines

private

Definition at line 19 of file TextHistory.h.

Referenced by AddHistoryLine(), CTextHistory(), GetHistoryLine(), and Init().

m_dwMaxHistoryLineSize

DWORD CTextHistory::m_dwMaxHistoryLineSize

private

Definition at line 20 of file TextHistory.h.

Referenced by AddHistoryLine(), GetHistoryLine(), and Init().

m_pHistoryBuffer

TCHAR* CTextHistory::m_pHistoryBuffer

private

Definition at line 18 of file TextHistory.h.

Referenced by AddHistoryLine(), CTextHistory(), GetHistoryLine(), Init(), and ~CTextHistory().

---

The documentation for this class was generated from the following files:

• modules/rosapps/applications/sysutils/regexpl/TextHistory.h
• modules/rosapps/applications/sysutils/regexpl/TextHistory.cpp