ReadLine class provides a c++ wrapper around the readline c library. More...

#include <dynashell_readline.h>

Public Member Functions
	ReadLine (const string &strName)
	Initialization constructor.

	ReadLine (const char *sName)
	Initialization constructor.

virtual	~ReadLine ()
	Destructor.

int	RegisterGenerator (const string strRegEx, ReadLineAppGenFunc_T fnAppGen, void *pAppArg)
	Register application-specific tab-completion generator associated. More...

int	RegisterGenerator (const char sRegEx, ReadLineAppGenFunc_T fnAppGen, void pAppArg)
	Register application-specific tab-completion generator associated. More...

void	UnregisterGenerator (int nUid)
	Unregister application-specific generator associated with path. More...

char *	iReadLine (const char *sPrompt)
	Interactively read a line of input from standard input. More...

void	AddToHistory (const char *sInput)
	Add line to history. More...

Static Public Member Functions
static char *	fReadLine (FILE fp, const char sPrompt)
	Read one input line from the given input stream. More...

static char *	FileCompletionGenerator (const char *sText, int nState)
	File name tab completion generator. More...

static char *	UserCompletionGenerator (const char *sText, int nState)
	User name tab completion generator. More...

static char *	dupstr (const string &str)
	Duplicate string. More...

static char *	dupstr (const char *s)
	Duplicate string. More...

static string	strip (string &str)
	Strip string of leading and trailing white space. More...

static char *	strip (char *s)
	Strip string of leading and trailing white space. More...

static string	c14n (const string &str, size_t nLen)
	Canonicalization of a string. More...

static string	c14n (const char *s, size_t nLen)
	Canonicalization of a string. More...

static int	tokenize (char s, char tokv[], size_t tokmax)
	Tokenize input. More...

static int	wc (const string &str)
	Count the words in the string. More...

static int	wc (const char *s)
	Count the words in the string. More...

Static Public Attributes
static const int	FIRST = 0
	first state

static const int	NOT_REG = -1
	not registered return value

static ReadLine *	ReadLineThis
	static pointer this single instance More...

Protected Types
typedef vector< ReadLineEntry >	VecAppEntry
	Internal registered generator map type.

Protected Member Functions
char **	Completion (const char *sText, int nStart, int nEnd)
	Command completion callback function. More...

void	MatchGenerator (int nEnd)
	Find application-specific generator associated with the first characters in the readline buffer. More...

Static Protected Member Functions
static char **	CompletionWrap (const char *sText, int nStart, int nEnd)
	Command completion callback function wrapper. More...

static char *	GeneratorWrap (const char *sText, int nState)
	Generator wrapper. More...

Protected Attributes
char *	m_sName
	readline name

int	m_nUidCounter
	unique id counter

VecAppEntry	m_vecGenerators
	map of generators

VecAppEntry::iterator	m_posMatched
	matched entry position

string	m_strContext
	current readline buffer context

size_t	m_uTextLen
	text length of text to generator

Detailed Description

ReadLine class provides a c++ wrapper around the readline c library.

Features:

line input
tab completion
history

If libreadline is not available, then only line input is available.

Definition at line 166 of file dynashell_readline.h.

Member Function Documentation

void ReadLine::AddToHistory ( const char * sLine )

Add line to history.

The line is added if the line is not empty and does not match the last command.

Parameters

Line to add.

Definition at line 320 of file dynashell_readline.cxx.

Referenced by DynaShell::AddToHistory().

 {
 #ifdef HAVE_READLINE
   string      str = sLine;
   HIST_ENTRY *pCurHist;
 
   str =  strip(str);
 
   if( !str.empty() )
   {
     pCurHist = previous_history();
 
     if( (pCurHist == NULL) || strcmp(pCurHist->line, str.c_str()) )
     {
       add_history(sLine);
     }
   }
 #endif // HAVE_READLINE
 }

static string ReadLine::c14n	(	const string &	str,
		size_t	nLen
	)

inlinestatic

Canonicalization of a string.

Parameters

s	Null-terminated string to canonicalize.
uLen	(Sub)length of string to canonicalize.

Returns: Return string holding canonical form.

Definition at line 304 of file dynashell_readline.h.

Referenced by MatchGenerator().

   {
     return ReadLine::c14n(str.c_str(), nLen);
   }

string ReadLine::c14n	(	const char *	s,
		size_t	uLen
	)

static

Canonicalization of a string.

Note: c14n is an cute abbreviation where 14 represents the number of letters between the c and n.

Parameters

s	Null-terminated string to canonicalize.
uLen	(Sub)length of string to canonicalize.

Returns: Return string holding canonical form.

Definition at line 441 of file dynashell_readline.cxx.

References strip().

 {
   string  str(s, uLen);
   size_t  pos;
 
   // strip leading and trailing whitespace
   str = ReadLine::strip(str);
 
   // convert multiple whitespace sequences to a single blank
   if( str.length() != 0 )
   {
     while( (pos = str.find("  ")) != str.npos )
     {
       str = str.replace(pos, 2, " ");
     }
   }
 
   //cout << "  (" << str << ")" << endl;
 
   return str;
 }

char ** ReadLine::Completion	(	const char *	sText,
		int	nStart,
		int	nEnd
	)

protected

Command completion callback function.

Parameters

sText	Text string to complete as a command.
nStart	Start index of text string in line.
nEnd	End index of text string in line.

Returns: Array of matches, NULL if none.

Definition at line 577 of file dynashell_readline.cxx.

 {
 #ifdef HAVE_READLINE
   MatchGenerator(nStart);
 
   return rl_completion_matches(sText, GeneratorWrap);
 
 #else
   return NULL;
 #endif // HAVE_READLINE
 }

char ** ReadLine::CompletionWrap	(	const char *	sText,
		int	nStart,
		int	nEnd
	)

staticprotected

Command completion callback function wrapper.

Attempt to complete on the contents of text. The start and end bound the region of rl_line_buffer that contains the word to complete. Text is the word to complete. We can use the entire contents of rl_line_buffer in case we want to do some simple parsing.

Parameters

sText	Text string to complete as a command.
nStart	Start index of text string in line.
nEnd	End index of text string in line.

Returns: Array of matches, NULL if none.

Definition at line 563 of file dynashell_readline.cxx.

 {
   return ReadLineThis->Completion(sText, nStart, nEnd);
 }

static char* ReadLine::dupstr ( const string & str )

inlinestatic

Duplicate string.

Parameters

str	String to dup.

Returns: Duplicated, allocated char *.

Definition at line 285 of file dynashell_readline.h.

   {
     return ReadLine::dupstr(str.c_str());
   }

char * ReadLine::dupstr ( const char * s )

static

Duplicate string.

Parameters

s	Null-terminated string to dup.

Returns: Duplicated, allocated char *.

Definition at line 347 of file dynashell_readline.cxx.

 {
   char *t = new char[strlen(s)+1];
   strcpy(t, s);
   return t;
 }

static char* ReadLine::FileCompletionGenerator	(	const char *	sText,
		int	nState
	)

inlinestatic

File name tab completion generator.

Parameters

sText	Partial text string to complete.
nState	Generator state. If FIRST,then initialize any statics.

Returns: If a first/next match is made, return allocated completed match.
Otherwise return NULL.

Definition at line 245 of file dynashell_readline.h.

Referenced by DynaShellCmdCreate::TabCompletion(), DynaShellCmdLoadRecording::TabCompletion(), DynaShellCmdScript::TabCompletion(), DynaShellCmdMegaScan::TabCompletion(), DynaShellCmdSaveRecording::TabCompletion(), and DynaShellCmdPlay::TabCompletion().

   {
 #ifdef HAVE_READLINE
     return rl_filename_completion_function(sText, nState);
 #else
     return NULL;
 #endif // HAVE_READLINE
   }

char * ReadLine::fReadLine	(	FILE *	fp,
		const char *	sPrompt
	)

static

Read one input line from the given input stream.

The freadline functions will read one line of input from the given input file pointer using the prompt string to prompt the user. If the prompt is NULL or an empty string then no prompt is issued. The line returned is allocated, so the caller must free it when finished.

The line returned has the final newline removed, so only the text of the line remains.

Parameters

fp	File pointer to input steam.
sPrompt	Optional user prompt string.

Returns: If no errors occurred and EOF is not encountered, an allocated, null-terminated line buffer is return. Else NULL is return.

Definition at line 281 of file dynashell_readline.cxx.

Referenced by DynaShell::GetInputLine().

 {
   static size_t   BufSize = 4096;
 
   char   *bufLine;
   size_t  n;
 
   bufLine = new char[BufSize];
 
   if( sPrompt && *sPrompt )
   {
     fprintf(stdout, "%s", sPrompt);
     fflush(stdout);
   }
 
   if( fgets(bufLine, BufSize, fp) == NULL )
   {
     delete[] bufLine;
     return NULL;
   }
 
   bufLine[BufSize-1] = 0;
   n = strlen(bufLine);
   if( (n > 0) && (bufLine[n-1] == '\n') )
   {
     bufLine[n-1] = 0;
   }
 
   return bufLine;
 }

char * ReadLine::GeneratorWrap	(	const char *	sText,
		int	nState
	)

staticprotected

Generator wrapper.

Calls the matched, registered application-specific generator.

Parameters

sText	Partial text string to complete.
nState	Generator state. If FIRST,then initialize any statics.

Returns: If a first/next match is made, return allocated completed match.
Otherwise return NULL.

Definition at line 601 of file dynashell_readline.cxx.

References FIRST.

 {
   // no registered generator match current path
   if( ReadLineThis->m_posMatched == ReadLineThis->m_vecGenerators.end() )
   {
     return NULL;
   }
 
   // first time through
   if( nState == ReadLine::FIRST )
   {
     ReadLineThis->m_uTextLen = strlen(sText);
   }
 
   // call application-specific generator
   return ReadLineThis->m_posMatched->m_fnAppGen(
                               ReadLineThis->m_posMatched->GetUid(),
                               sText,
                               ReadLineThis->m_uTextLen,
                               nState,
                               ReadLineThis->m_strContext.c_str(),
                               ReadLineThis->m_posMatched->m_pAppArg);
 }

char* ReadLine::iReadLine ( const char * sPrompt )

inline

Interactively read a line of input from standard input.

If the readline library feature is enabled, then the input is controlled by the readline() call along with history and tab completion.

Parameters

sPrompt Optional user prompt string.

Returns: If no errors occurred and EOF is not encountered, an allocated, null-terminated line buffer is return. Else NULL is return.

Definition at line 217 of file dynashell_readline.h.

Referenced by DynaShell::GetInputLine().

   {
 #ifdef HAVE_READLINE
     return readline(sPrompt);          // fixed at stdin
 #else
     retrun fReadLine(stdin, sPrompt);  // so then so are we
 #endif // HAVE_READLINE
   }

void ReadLine::MatchGenerator ( int nLen )

protected

Find application-specific generator associated with the first characters in the readline buffer.

Parameters

nLen	Length in readline buffer.

Definition at line 631 of file dynashell_readline.cxx.

References c14n(), and ReadLineThis.

 {
   m_posMatched = m_vecGenerators.end();
 
   m_strContext.clear();
 
 #ifdef HAVE_READLINE
 
   if( nLen > 0 )
   {
     m_strContext = ReadLine::c14n(rl_line_buffer, (size_t)nLen);
   }
   else
   {
     m_strContext = "";
   }
 
   //fprintf(stderr, "\nDBG: matching '%s' ", m_strContext.c_str());
 
   for(m_posMatched = m_vecGenerators.begin();
       m_posMatched != m_vecGenerators.end();
       ++m_posMatched)
   {
     //fprintf(stderr, "DBG: %d: regex(%s) ",
     //    m_posMatched->GetUid(), m_posMatched->m_regex.GetRegEx());
 
     if( m_posMatched->m_regex.Match(m_strContext) )
     {
       //fprintf(stderr, "matched regex(%s)",  m_posMatched->m_regex.GetRegEx());
       break;
     }
   }
   //fprintf(stderr, "\n");
 #endif // HAVE_READLINE
 }

int ReadLine::RegisterGenerator	(	const string	strRegEx,
		ReadLineAppGenFunc_T	fnAppGen,
		void *	pAppArg
	)

inline

Register application-specific tab-completion generator associated.

Parameters

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

Returns: On successful registration, a unique id ≥ 0 is returned.
On regular expression evalution failure, the generator is not registered and ReadLine::NOT_REG is returned.

Definition at line 193 of file dynashell_readline.h.

Referenced by DynaShell::InputInit(), DynaShell::PublishCommand(), and DynaShell::PublishMap().

   {
     return RegisterGenerator(strRegEx.c_str(), fnAppGen, pAppArg);
   }

int ReadLine::RegisterGenerator	(	const char *	sRegEx,
		ReadLineAppGenFunc_T	fnAppGen,
		void *	pAppArg
	)

Register application-specific tab-completion generator associated.

Parameters

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

Returns: On successful registration, a unique id ≥ 0 is returned.
On regular expression evalution failure, the generator is not registered and ReadLine::NOT_REG is returned.

Definition at line 223 of file dynashell_readline.cxx.

References ReadLineEntry::IsValid(), and ReadLineEntry::m_nUid.

 {
   string        str;
   ReadLineEntry entry(sRegEx, fnAppGen, pAppArg);
 
   if( entry.IsValid() )
   {
     entry.m_nUid = m_nUidCounter;
     m_vecGenerators.push_back(entry);
     //fprintf(stderr, "DBG: %d: regex(%s)\n", m_nUidCounter, sRegEx);
     return m_nUidCounter++;
   }
   else
   {
     return NOT_REG;
   }
 }

string ReadLine::strip ( string & str )

static

Strip string of leading and trailing white space.

Parameters

[in] str Input string to strip.

Returns: Stripped string.

Definition at line 361 of file dynashell_readline.cxx.

Referenced by c14n().

 {
   string  t = str;
   int     i;
 
   // strip leading blanks
   for(i=0; i<t.length(); ++i)
   {
     if( !isspace((int)t[i]) )
     {
       break;
     }
   }
 
   if( i != 0 )
   {
     t = t.substr(i);
   }
 
   // strip trailing blanks
   for(i=t.length()-1; i>0; --i)
   {
     if( !isspace((int)t[i]) )
     {
       break;
     }
   }
 
   if( i != t.length()-1 )
   {
     t = t.substr(0, i+1);
   }
 
   return t;
 }

char * ReadLine::strip ( char * s )

static

Strip string of leading and trailing white space.

A null character '\0' is inserted after the last non-white space character.

Parameters

[in,out] s Null-terminated char*.

Returns: Pointer to first non-white space character in s or to null-terminator if no non-white space characters are found.

Definition at line 407 of file dynashell_readline.cxx.

 {
   char *left, *right;
 
   for(left = s; isspace((int)*left); left++) ;
     
   if( *left == 0 )
   {
     return left;
   }
 
   right = left + strlen(left) - 1;
 
   while( (right > left) && isspace((int)*right) )
   {
     right--;
   }
 
   *++right = '\0';
 
   return left;
 }

int ReadLine::tokenize	(	char *	s,
		char *	tokv[],
		size_t	tokmax
	)

static

Tokenize input.

Parameters

[in,out]	s	Input string to tokenize.
[out]	tokv	Array of tokens (pointer to locations in s).
	tokmax	Maximum number of tokens.

Returns: Number of tokens.

Definition at line 472 of file dynashell_readline.cxx.

Referenced by DynaShell::Run().

 {
   int       tokc = 0;
 
   while( tokc < (int)tokmax )
   {
     // find start of the next token
     while( *s && isspace((int)*s) )
     {
       s++;
     }
 
     // no more tokens
     if( *s == 0 )
     {
       return tokc;
     }
 
     // new token
     tokv[tokc++] = s;
 
     // find end of the token
     while( *s && !isspace((int)*s) )
     {
       s++;
     }
 
     // end of the line
     if( *s == 0 )
     {
       return tokc;
     }
 
     // null terminate
     *s++ = 0;
   }
 
   return tokc;
 }

void ReadLine::UnregisterGenerator ( int nUid )

Unregister application-specific generator associated with path.

Parameters

strPath Unique path string.

Definition at line 248 of file dynashell_readline.cxx.

 {
   VecAppEntry::iterator iter;
 
   for(iter = m_vecGenerators.begin();
       iter != m_vecGenerators.begin();
       ++iter)
   {
     if( iter->GetUid() == nUid )
     {
       m_vecGenerators.erase(iter);
       return;
     }
   }
 }

static char* ReadLine::UserCompletionGenerator	(	const char *	sText,
		int	nState
	)

inlinestatic

User name tab completion generator.

Parameters

sText	Partial text string to complete.
nState	Generator state. If FIRST,then initialize any statics.

Returns: If a first/next match is made, return allocated completed match.
Otherwise return NULL.

Definition at line 264 of file dynashell_readline.h.

   {
 #ifdef HAVE_READLINE
     return rl_username_completion_function(sText, nState);
 #else
     return NULL;
 #endif // HAVE_READLINE
   }

static int ReadLine::wc ( const string & str )

inlinestatic

Count the words in the string.

Parameters

str	String to count.

Returns: Number of words.

Definition at line 320 of file dynashell_readline.h.

   {
     return ReadLine::wc(str.c_str());
   }

int ReadLine::wc ( const char * s )

static

Count the words in the string.

Parameters

str	String to count.

Returns: Number of words.

Definition at line 519 of file dynashell_readline.cxx.

 {
   int   wc = 0;
 
   while( *s )
   {
     // find start of the next word
     while( *s && isspace((int)*s) )
     {
       s++;
     }
 
     // no more words
     if( *s == 0 )
     {
       break;
     }
 
     ++wc;
 
     // find end of the word
     while( *s && !isspace((int)*s) )
     {
       s++;
     }
   }
 
   return wc;
 }

Member Data Documentation

ReadLine * ReadLine::ReadLineThis

static

static pointer this single instance

Pointer to the only instance of readline supported per application.

Definition at line 172 of file dynashell_readline.h.

Referenced by MatchGenerator().

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

dynashell/dynashell_readline.h
dynashell/dynashell_readline.cxx

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation