ReadLineEntry Class Reference

Public Member Functions
	ReadLineEntry ()
	Default constructor.
	ReadLineEntry (const string &strRegEx, ReadLineAppGenFunc_T fnAppGen, void *pAppArg)
	Initialization constructor. More...
	ReadLineEntry (const char *sRegEx, ReadLineAppGenFunc_T fnAppGen, void *pAppArg)
	Initialization constructor. More...
	ReadLineEntry (const ReadLineEntry &src)
	Copy constructor. More...
	~ReadLineEntry ()
	Default destructor.
bool	IsValid ()
	Check if entry is valid. More...
int	GetUid ()
	Get the unique id associated with this entry. More...

Protected Attributes
int	m_nUid
	unique id
RegEx	m_regex
	applicatin matching regular expression
ReadLineAppGenFunc_T	m_fnAppGen
	application-specific generator
void *	m_pAppArg
	application-specific argument

Friends
class	ReadLine

Detailed Description

Definition at line 105 of file dynashell_readline.h.

Constructor & Destructor Documentation

ReadLineEntry::ReadLineEntry	(	const string &	strRegEx,
		ReadLineAppGenFunc_T	fnAppGen,
		void *	pAppArg
	)

Initialization constructor.

Parameters

strRegEx	Regular expression applied to current readline buffer state.
fnAppGen	Application-specific generator function.
pAppArg	Optional application argument generator function.

Definition at line 92 of file dynashell_readline.cxx.

References ReadLine::NOT_REG.

{
  m_nUid      = ReadLine::NOT_REG;
  m_regex     = strRegEx;
  m_fnAppGen  = fnAppGen;
  m_pAppArg   = pAppArg;
}

ReadLineEntry::ReadLineEntry	(	const char *	sRegEx,
		ReadLineAppGenFunc_T	fnAppGen,
		void *	pAppArg
	)

Initialization constructor.

Parameters

sRegEx	Regular expression applied to current readline buffer state.
fnAppGen	Application-specific generator function.
pAppArg	Optional application argument generator function.

Definition at line 109 of file dynashell_readline.cxx.

References ReadLine::NOT_REG.

{
  m_nUid      = ReadLine::NOT_REG;
  m_regex     = sRegEx;
  m_fnAppGen  = fnAppGen;
  m_pAppArg   = pAppArg;
}

ReadLineEntry::ReadLineEntry

(

const ReadLineEntry &

src

)

Copy constructor.

Parameters

src	ReadLineEntry to copy.

Definition at line 124 of file dynashell_readline.cxx.

References m_fnAppGen, m_nUid, m_pAppArg, and m_regex.

{
  m_nUid      = src.m_nUid;
  m_regex     = src.m_regex;
  m_fnAppGen  = src.m_fnAppGen;
  m_pAppArg   = src.m_pAppArg;
}

Member Function Documentation

int ReadLineEntry::GetUid ( )

inline

Get the unique id associated with this entry.

Returns

Unique id.

Definition at line 137 of file dynashell_readline.h.

  {
    return m_nUid;
  }

bool ReadLineEntry::IsValid ( )

inline

Check if entry is valid.

Returns

Returns true or false.

Definition at line 127 of file dynashell_readline.h.

Referenced by ReadLine::RegisterGenerator().

  {
    return m_regex.IsValid();
  }

---

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

• dynashell/dynashell_readline.h
• dynashell/dynashell_readline.cxx