#include <CharStream.h>

Public Member Functions
void	setTabSize (int i)

int	getTabSize (int i)

virtual int	getColumn ()

virtual int	getLine ()

virtual int	getEndColumn ()

virtual int	getEndLine ()

virtual int	getBeginColumn ()

virtual int	getBeginLine ()

virtual bool	getTrackLineColumn ()

virtual void	setTrackLineColumn (bool val)

virtual void	backup (int amount)

virtual JAVACC_CHAR_TYPE	BeginToken ()

virtual JAVACC_CHAR_TYPE	readChar ()

virtual void	ExpandBuff (bool wrapAround)

virtual void	FillBuff ()

virtual JAVACC_STRING_TYPE	GetImage ()

virtual JAVACC_STRING_TYPE	GetSuffix (int len)

virtual void	DeleteBuffers ()

virtual	~CharStream ()

bool	endOfInput ()

	CharStream (const JAVACC_CHAR_TYPE *buf, int sz, int startline, int startcolumn, int buffersize)

	CharStream (const JAVACC_CHAR_TYPE *buf, int sz, int startline, int startcolumn)

	CharStream (const JAVACC_STRING_TYPE &str, int startline, int startcolumn, int buffersize)

	CharStream (const JAVACC_STRING_TYPE &str, int startline, int startcolumn)

	CharStream (ReaderStream *input_stream, int startline, int startcolumn, int buffersize)

	CharStream (ReaderStream *input_stream, int startline, int startcolumn)

	CharStream (ReaderStream *input_stream)

virtual void	ReInit (ReaderStream *input_stream, int startline, int startcolumn, int buffersize)

virtual void	ReInit (ReaderStream *input_stream, int startline, int startcolumn)

virtual void	ReInit (ReaderStream *input_stream)

virtual void	ReInit (const JAVACC_STRING_TYPE &str, int startline, int startcolumn, int buffersize)

virtual void	ReInit (const JAVACC_STRING_TYPE &str, int startline, int startcolumn)

virtual void	adjustBeginLineColumn (int newLine, int newCol)

Protected Member Functions
virtual void	UpdateLineColumn (JAVACC_CHAR_TYPE c)

Protected Attributes
int *	bufline

int *	bufcolumn

JAVACC_CHAR_TYPE *	buffer

int	bufpos

int	bufsize

int	tokenBegin

int	column

int	line

bool	prevCharIsCR

bool	prevCharIsLF

int	available

int	maxNextCharInd

int	inBuf

int	tabSize

bool	trackLineColumn

ReaderStream *	inputStream

bool	deleteStream

Private Member Functions
int	getBufcolumn (int pos)

int	getBufline (int pos)

Detailed Description

This class describes a character stream that maintains line and column number positions of the characters. It also has the capability to backup the stream to some extent. An implementation of this class is used in the TokenManager implementation generated by JavaCCParser.

All the methods except backup can be implemented in any fashion. backup needs to be implemented correctly for the correct operation of the lexer. Rest of the methods are all used to get information like line number, column number and the string that constitutes a token and are not used by the lexer. Hence their implementation won't affect the generated lexer's operation.

Definition at line 30 of file CharStream.h.

Constructor & Destructor Documentation

virtual vhdl::parser::CharStream::~CharStream ( )

inlinevirtual

Definition at line 152 of file CharStream.h.

                         {
     if (deleteStream) {
      delete inputStream;
     }
     DeleteBuffers();
   }

vhdl::parser::CharStream::CharStream	(	const JAVACC_CHAR_TYPE *	buf,
		int	sz,
		int	startline,
		int	startcolumn,
		int	buffersize
	)

inline

Definition at line 163 of file CharStream.h.

                                                        :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(JAVACC_STRING_TYPE(buf, sz), startline, startcolumn, buffersize);
   }

vhdl::parser::CharStream::CharStream	(	const JAVACC_CHAR_TYPE *	buf,
		int	sz,
		int	startline,
		int	startcolumn
	)

inline

Definition at line 172 of file CharStream.h.

                                                                                   :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(JAVACC_STRING_TYPE(buf, sz), startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

vhdl::parser::CharStream::CharStream	(	const JAVACC_STRING_TYPE &	str,
		int	startline,
		int	startcolumn,
		int	buffersize
	)

inline

Definition at line 180 of file CharStream.h.

                                                        :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(str, startline, startcolumn, buffersize);
   }

vhdl::parser::CharStream::CharStream	(	const JAVACC_STRING_TYPE &	str,
		int	startline,
		int	startcolumn
	)

inline

Definition at line 189 of file CharStream.h.

                                                                             :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(str, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

vhdl::parser::CharStream::CharStream	(	ReaderStream *	input_stream,
		int	startline,
		int	startcolumn,
		int	buffersize
	)

inline

Definition at line 197 of file CharStream.h.

                                               :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(input_stream, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

vhdl::parser::CharStream::CharStream	(	ReaderStream *	input_stream,
		int	startline,
		int	startcolumn
	)

inline

Definition at line 206 of file CharStream.h.

                                                                          :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(input_stream, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

vhdl::parser::CharStream::CharStream ( ReaderStream * input_stream )

inline

Definition at line 214 of file CharStream.h.

                                          :
     bufline(NULL), bufcolumn(NULL), buffer(NULL), bufpos(0), bufsize(0), 
     tokenBegin(0), column(0), line(0), prevCharIsCR(false), prevCharIsLF(false),
     available(0), maxNextCharInd(0), inBuf(0), tabSize(1), trackLineColumn(true),
     inputStream(NULL), deleteStream(false) {
     ReInit(input_stream, 1, 1, INITIAL_BUFFER_SIZE);
   }

Member Function Documentation

void vhdl::parser::CharStream::adjustBeginLineColumn	(	int	newLine,
		int	newCol
	)

virtual

Definition at line 73 of file CharStream.cc.

                                                               {
   int start = tokenBegin;
   int len;
 
   if (bufpos >= tokenBegin) {
     len = bufpos - tokenBegin + inBuf + 1;
   } else {
     len = bufsize - tokenBegin + bufpos + 1 + inBuf;
   }
 
   int i = 0, j = 0, k = 0;
   int nextColDiff = 0, columnDiff = 0;
 
   while (i < len && bufline[j = start % bufsize] ==
          bufline[k = (start + 1) % bufsize]) {
     bufline[j] = newLine;
     nextColDiff = columnDiff + bufcolumn[k] - bufcolumn[j];
     bufcolumn[j] = newCol + columnDiff;
     columnDiff = nextColDiff;
     i++;
     start++;
   }
 
   if (i < len) {
     bufline[j] = newLine++;
     bufcolumn[j] = newCol + columnDiff;
 
     while (i++ < len) {
       if (bufline[j = start % bufsize] != bufline[(start + 1) % bufsize])
         bufline[j] = newLine++;
       else
         bufline[j] = newLine;
       start++;
     }
   }
 
   line = bufline[j];
   column = bufcolumn[j];
 }

virtual void vhdl::parser::CharStream::backup ( int amount )

inlinevirtual

Backs up the input stream by amount steps. Lexer calls this method if it had already read some characters, but could not use them to match a (longer) token. So, they will be used again as the prefix of the next token and it is the implemetation's responsibility to do this right.

Definition at line 66 of file CharStream.h.

                                          {
     inBuf += amount;
     bufpos -= amount;
     if (bufpos < 0) {
       bufpos += bufsize;
     }
   }

virtual JAVACC_CHAR_TYPE vhdl::parser::CharStream::BeginToken ( )

inlinevirtual

Returns the next character that marks the beginning of the next token. All characters must remain in the buffer between two successive calls to this method to implement backup correctly.

Definition at line 79 of file CharStream.h.

                                                {
     tokenBegin = -1;
     JAVACC_CHAR_TYPE c = readChar();
     tokenBegin = bufpos;
     return c;
   }

void vhdl::parser::CharStream::DeleteBuffers ( )

virtual

The lexer calls this function to indicate that it is done with the stream and hence implementations can free any resources held by this class.

Definition at line 67 of file CharStream.cc.

                                {
   delete[] buffer;
   delete[] bufline;
   delete[] bufcolumn;
 }

bool vhdl::parser::CharStream::endOfInput ( )

inline

Definition at line 159 of file CharStream.h.

                     {
     return inBuf == 0 && bufpos + 1 >= maxNextCharInd && inputStream->endOfInput();
   }

void vhdl::parser::CharStream::ExpandBuff ( bool wrapAround )

virtual

Definition at line 113 of file CharStream.cc.

                                            {
   JAVACC_CHAR_TYPE *newbuffer = new JAVACC_CHAR_TYPE[bufsize + 2048];
   int *newbufline = new int[bufsize + 2048];
   int *newbufcolumn = new int[bufsize + 2048];
 
   if (wrapAround) {
     ArrayCopy(buffer, tokenBegin, newbuffer, 0, bufsize - tokenBegin);
     ArrayCopy(buffer, 0, newbuffer, bufsize - tokenBegin, bufpos);
     ArrayCopy(bufline, tokenBegin, newbufline, 0, bufsize - tokenBegin);
     ArrayCopy(bufline, 0, newbufline, bufsize - tokenBegin, bufpos);
     ArrayCopy(bufcolumn, tokenBegin, newbufcolumn, 0, bufsize - tokenBegin);
     ArrayCopy(bufcolumn, 0, newbufcolumn, bufsize - tokenBegin, bufpos);
     bufpos += (bufsize - tokenBegin);
   } else {
     ArrayCopy(buffer, tokenBegin, newbuffer, 0, bufsize - tokenBegin);
     ArrayCopy(bufline, tokenBegin, newbufline, 0, bufsize - tokenBegin);
     ArrayCopy(bufcolumn, tokenBegin, newbufcolumn, 0, bufsize - tokenBegin);
     bufpos -= tokenBegin;
   }
 
   maxNextCharInd = bufpos;
   DeleteBuffers();
   buffer = newbuffer;
   bufline = newbufline;
   bufcolumn = newbufcolumn;
   bufsize += 2048;
   available = bufsize;
   tokenBegin = 0;
 }

void vhdl::parser::CharStream::FillBuff ( )

virtual

Definition at line 143 of file CharStream.cc.

                           {
   if (maxNextCharInd == available) {
     if (available == bufsize) {
       if (tokenBegin > 2048) {
         bufpos = maxNextCharInd = 0;
         available = tokenBegin;
       } else if (tokenBegin < 0) {
         bufpos = maxNextCharInd = 0;
       } else {
         ExpandBuff(false);
       }
     } else if (available > tokenBegin) {
       available = bufsize;
     } else if ((tokenBegin - available) < 2048) {
       ExpandBuff(true);
     } else {
       available = tokenBegin;
     }
   }
 
   int i = inputStream->read(buffer, maxNextCharInd, available - maxNextCharInd);
   if (i > 0) {
     maxNextCharInd += i;
   } else {
     --bufpos;
     backup(0);
     if (tokenBegin == -1) {
       tokenBegin = bufpos;
     }
   }
 }

virtual int vhdl::parser::CharStream::getBeginColumn ( )

inlinevirtual

Definition at line 54 of file CharStream.h.

54 { return getBufcolumn(tokenBegin); }

vhdl::parser::CharStream::tokenBegin

int tokenBegin

Definition: CharStream.h:250

vhdl::parser::CharStream::getBufcolumn

int getBufcolumn(int pos)

Definition: CharStream.h:35

virtual int vhdl::parser::CharStream::getBeginLine ( )

inlinevirtual

Definition at line 55 of file CharStream.h.

55 { return getBufline(tokenBegin); }

vhdl::parser::CharStream::tokenBegin

int tokenBegin

Definition: CharStream.h:250

vhdl::parser::CharStream::getBufline

int getBufline(int pos)

Definition: CharStream.h:42

int vhdl::parser::CharStream::getBufcolumn ( int pos )

inlineprivate

Definition at line 35 of file CharStream.h.

                             {
     if (trackLineColumn && pos>=0) {
       return bufcolumn[pos];
     } else {
       return -1;
     }
   }

int vhdl::parser::CharStream::getBufline ( int pos )

inlineprivate

Definition at line 42 of file CharStream.h.

                           {
     if (trackLineColumn && pos>=0) {
       return bufline[pos];
     } else {
       return -1;
     }
   }

virtual int vhdl::parser::CharStream::getColumn ( )

inlinevirtual

Definition at line 50 of file CharStream.h.

50 { return getBufcolumn(bufpos); }

vhdl::parser::CharStream::bufpos

int bufpos

Definition: CharStream.h:248

vhdl::parser::CharStream::getBufcolumn

int getBufcolumn(int pos)

Definition: CharStream.h:35

virtual int vhdl::parser::CharStream::getEndColumn ( )

inlinevirtual

Definition at line 52 of file CharStream.h.

52 { return getBufcolumn(bufpos); }

vhdl::parser::CharStream::bufpos

int bufpos

Definition: CharStream.h:248

vhdl::parser::CharStream::getBufcolumn

int getBufcolumn(int pos)

Definition: CharStream.h:35

virtual int vhdl::parser::CharStream::getEndLine ( )

inlinevirtual

Definition at line 53 of file CharStream.h.

53 { return getBufline(bufpos); }

vhdl::parser::CharStream::getBufline

int getBufline(int pos)

Definition: CharStream.h:42

vhdl::parser::CharStream::bufpos

int bufpos

Definition: CharStream.h:248

virtual JAVACC_STRING_TYPE vhdl::parser::CharStream::GetImage ( )

inlinevirtual

Returns a string made up of characters from the marked token beginning to the current buffer position. Implementations can return anything that they want to. For example, for efficiency, one might decide to just return NULL, which is a valid implementation.

Definition at line 126 of file CharStream.h.

                                         {
     if (bufpos >= tokenBegin)
       return JAVACC_STRING_TYPE(buffer + tokenBegin, bufpos - tokenBegin + 1);
     else
       return JAVACC_STRING_TYPE(buffer + tokenBegin, bufsize - tokenBegin).append(buffer, bufpos + 1);
   }

virtual int vhdl::parser::CharStream::getLine ( )

inlinevirtual

Definition at line 51 of file CharStream.h.

51 { return getBufline(bufpos); }

vhdl::parser::CharStream::getBufline

int getBufline(int pos)

Definition: CharStream.h:42

vhdl::parser::CharStream::bufpos

int bufpos

Definition: CharStream.h:248

virtual JAVACC_STRING_TYPE vhdl::parser::CharStream::GetSuffix ( int len )

inlinevirtual

Returns an array of characters that make up the suffix of length 'len' for the currently matched token. This is used to build up the matched string for use in actions in the case of MORE. A simple and inefficient implementation of this is as follows :

Definition at line 139 of file CharStream.h.

                                                 {
     if ((bufpos + 1) >= len) {
       return JAVACC_STRING_TYPE(buffer + bufpos - len + 1, len);
     }
     return JAVACC_STRING_TYPE(buffer + bufsize - (len - bufpos - 1), len - bufpos - 1).append(buffer, bufpos + 1);
   }

int vhdl::parser::CharStream::getTabSize ( int i )

inline

Definition at line 33 of file CharStream.h.

33 { return tabSize; }

vhdl::parser::CharStream::tabSize

int tabSize

Definition: CharStream.h:258

virtual bool vhdl::parser::CharStream::getTrackLineColumn ( )

inlinevirtual

Definition at line 57 of file CharStream.h.

57 { return trackLineColumn; }

vhdl::parser::CharStream::trackLineColumn

bool trackLineColumn

Definition: CharStream.h:259

virtual JAVACC_CHAR_TYPE vhdl::parser::CharStream::readChar ( )

inlinevirtual

Returns the next character from the selected input. The method of selecting the input is the responsibility of the class implementing this class.

Definition at line 92 of file CharStream.h.

                                              {
     if (inBuf > 0) {
       --inBuf;
       ++bufpos;
       if (bufpos == bufsize) {
         bufpos = 0;
       }
       return buffer[bufpos];
     }
 
     ++bufpos;
     if (bufpos >= maxNextCharInd) {
       FillBuff();
     }
 
     JAVACC_CHAR_TYPE c = buffer[bufpos];
 
     if (trackLineColumn) {
       UpdateLineColumn(c);
     }
 
     return c;
   }

void vhdl::parser::CharStream::ReInit	(	ReaderStream *	input_stream,
		int	startline,
		int	startcolumn,
		int	buffersize
	)

virtual

Definition at line 43 of file CharStream.cc.

                                                          {
   if (deleteStream) {
    delete inputStream;
   }
 
   if (buffer != NULL) {
     DeleteBuffers();
   }
 
   available = bufsize = buffersize;
   buffer = new JAVACC_CHAR_TYPE[buffersize];
   bufline = new int[buffersize];
   bufcolumn = new int[buffersize];
 
   column = startcolumn - 1;
   inputStream = input_stream;
   line = startline;
   prevCharIsLF = prevCharIsCR = false;
   tokenBegin = inBuf = maxNextCharInd = 0;
   bufpos = -1;
   deleteStream = false;
 }

virtual void vhdl::parser::CharStream::ReInit	(	ReaderStream *	input_stream,
		int	startline,
		int	startcolumn
	)

inlinevirtual

Definition at line 224 of file CharStream.h.

                                                                                   {
     ReInit(input_stream, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

virtual void vhdl::parser::CharStream::ReInit ( ReaderStream * input_stream )

inlinevirtual

Definition at line 228 of file CharStream.h.

                                                   {
     ReInit(input_stream, 1, 1, INITIAL_BUFFER_SIZE);
   }

void vhdl::parser::CharStream::ReInit	(	const JAVACC_STRING_TYPE &	str,
		int	startline,
		int	startcolumn,
		int	buffersize
	)

virtual

Definition at line 36 of file CharStream.cc.

                                                          {
   StringReaderStream *stream = new StringReaderStream(str);
   ReInit(stream, startline, startcolumn, buffersize);
   deleteStream = true;
 }

virtual void vhdl::parser::CharStream::ReInit	(	const JAVACC_STRING_TYPE &	str,
		int	startline,
		int	startcolumn
	)

inlinevirtual

Definition at line 235 of file CharStream.h.

                                        {
     ReInit(str, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

void vhdl::parser::CharStream::setTabSize ( int i )

inline

Definition at line 32 of file CharStream.h.

32 { tabSize = i; }

vhdl::parser::CharStream::tabSize

int tabSize

Definition: CharStream.h:258

virtual void vhdl::parser::CharStream::setTrackLineColumn ( bool val )

inlinevirtual

Definition at line 58 of file CharStream.h.

58 { trackLineColumn = val; }

vhdl::parser::CharStream::trackLineColumn

bool trackLineColumn

Definition: CharStream.h:259

testsqlite3.val

list val

Definition: testsqlite3.py:13

void vhdl::parser::CharStream::UpdateLineColumn ( JAVACC_CHAR_TYPE c )

protectedvirtual

Definition at line 175 of file CharStream.cc.

                                                     {
   column++;
   if (prevCharIsLF) {
     prevCharIsLF = false;
     column = 1;
     line++;
   } else if (prevCharIsCR) {
     prevCharIsCR = false;
     if (c == '\n') {
       prevCharIsLF = true;
     } else {
       column = 1;
       line++;
     }
   }
 
   switch (c) {
     case '\r' :
       prevCharIsCR = true;
       break;
     case '\n' :
       prevCharIsLF = true;
       break;
     case '\t' :
       column--;
       column += (tabSize - (column % tabSize));
       break;
     default :
       break;
   }
 
   bufline[bufpos] = line;
   bufcolumn[bufpos] = column;
 }

Member Data Documentation

int vhdl::parser::CharStream::available

protected

Definition at line 255 of file CharStream.h.

int* vhdl::parser::CharStream::bufcolumn

protected

Definition at line 246 of file CharStream.h.

JAVACC_CHAR_TYPE* vhdl::parser::CharStream::buffer

protected

Definition at line 247 of file CharStream.h.

int* vhdl::parser::CharStream::bufline

protected

Definition at line 245 of file CharStream.h.

int vhdl::parser::CharStream::bufpos

protected

Definition at line 248 of file CharStream.h.

int vhdl::parser::CharStream::bufsize

protected

Definition at line 249 of file CharStream.h.

int vhdl::parser::CharStream::column

protected

Definition at line 251 of file CharStream.h.

bool vhdl::parser::CharStream::deleteStream

protected

Definition at line 261 of file CharStream.h.

int vhdl::parser::CharStream::inBuf

protected

Definition at line 257 of file CharStream.h.

ReaderStream* vhdl::parser::CharStream::inputStream

protected

Definition at line 260 of file CharStream.h.

int vhdl::parser::CharStream::line

protected

Definition at line 252 of file CharStream.h.

int vhdl::parser::CharStream::maxNextCharInd

protected

Definition at line 256 of file CharStream.h.

bool vhdl::parser::CharStream::prevCharIsCR

protected

Definition at line 253 of file CharStream.h.

bool vhdl::parser::CharStream::prevCharIsLF

protected

Definition at line 254 of file CharStream.h.

int vhdl::parser::CharStream::tabSize

protected

Definition at line 258 of file CharStream.h.

int vhdl::parser::CharStream::tokenBegin

protected

Definition at line 250 of file CharStream.h.

bool vhdl::parser::CharStream::trackLineColumn

protected

Definition at line 259 of file CharStream.h.

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

doxygen-1.8.11/vhdlparser/CharStream.h
doxygen-1.8.11/vhdlparser/CharStream.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation