This class describes a character stream that maintains line and column number positions of the characters. 更多...

#include <CharStream.h>

vhdl::parser::CharStream 的协作图:

Public 成员函数
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)
	Backs up the input stream by amount steps. 更多...

virtual JJChar	BeginToken ()
	Returns the next character that marks the beginning of the next token. 更多...

virtual JJChar	readChar ()
	Returns the next character from the selected input. 更多...

virtual void	ExpandBuff (bool wrapAround)

virtual void	FillBuff ()

virtual JJString	GetImage ()
	Returns a string made up of characters from the marked token beginning to the current buffer position. 更多...

virtual JJString	GetSuffix (int len)
	Returns an array of characters that make up the suffix of length 'len' for the currently matched token. 更多...

virtual void	DeleteBuffers ()
	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. 更多...

virtual	~CharStream ()

bool	endOfInput ()

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

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

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

	CharStream (const JJString &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 JJString &str, int startline, int startcolumn, int buffersize)

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

virtual void	adjustBeginLineColumn (int newLine, int newCol)

Protected 成员函数
virtual void	UpdateLineColumn (JJChar c)

Protected 属性
int *	bufline

int *	bufcolumn

JJChar *	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 成员函数
int	getBufcolumn (int pos)

int	getBufline (int pos)

详细描述

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.

在文件 CharStream.h 第 31 行定义.

构造及析构函数说明

◆ ~CharStream()

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

inlinevirtual

在文件 CharStream.h 第 155 行定义.

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

引用了 DeleteBuffers(), deleteStream , 以及 inputStream.

◆ CharStream() [1/7]

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

inline

在文件 CharStream.h 第 166 行定义.

                                                        :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(JJString(buf, sz), startline, startcolumn, buffersize);
   }

引用了 ReInit().

◆ CharStream() [2/7]

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

inline

在文件 CharStream.h 第 175 行定义.

                                                                         :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(JJString(buf, sz), startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ CharStream() [3/7]

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

inline

在文件 CharStream.h 第 183 行定义.

                                                        :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(str, startline, startcolumn, buffersize);
   }

引用了 ReInit().

◆ CharStream() [4/7]

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

inline

在文件 CharStream.h 第 192 行定义.

                                                                   :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(str, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ CharStream() [5/7]

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

inline

在文件 CharStream.h 第 200 行定义.

                                               :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(input_stream, startline, startcolumn, buffersize);
   }

引用了 ReInit().

◆ CharStream() [6/7]

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

inline

在文件 CharStream.h 第 209 行定义.

                                                                          :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(input_stream, startline, startcolumn, INITIAL_BUFFER_SIZE);
   }

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ CharStream() [7/7]

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

inline

在文件 CharStream.h 第 217 行定义.

                                          :
     bufline(nullptr), bufcolumn(nullptr), buffer(nullptr), 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(nullptr), deleteStream(false) {
     ReInit(input_stream, 1, 1, INITIAL_BUFFER_SIZE);
   }

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

成员函数说明

◆ adjustBeginLineColumn()

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

virtual

◆ backup()

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.

在文件 CharStream.h 第 69 行定义.

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

引用了 bufpos, bufsize , 以及 inBuf.

◆ BeginToken()

virtual JJChar 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.

在文件 CharStream.h 第 82 行定义.

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

引用了 bufpos, readChar() , 以及 tokenBegin.

◆ DeleteBuffers()

virtual 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.

被这些函数引用 ~CharStream().

◆ endOfInput()

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

inline

在文件 CharStream.h 第 162 行定义.

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

引用了 bufpos, ReaderStream::endOfInput(), inBuf, inputStream , 以及 maxNextCharInd.

◆ ExpandBuff()

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

virtual

◆ FillBuff()

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

virtual

被这些函数引用 readChar().

◆ getBeginColumn()

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

inlinevirtual

在文件 CharStream.h 第 57 行定义.

57 { return getBufcolumn(tokenBegin); }

引用了 getBufcolumn() , 以及 tokenBegin.

◆ getBeginLine()

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

inlinevirtual

在文件 CharStream.h 第 58 行定义.

58 { return getBufline(tokenBegin); }

引用了 getBufline() , 以及 tokenBegin.

◆ getBufcolumn()

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

inlineprivate

在文件 CharStream.h 第 37 行定义.

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

引用了 bufcolumn , 以及 trackLineColumn.

被这些函数引用 getBeginColumn(), getColumn() , 以及 getEndColumn().

◆ getBufline()

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

inlineprivate

在文件 CharStream.h 第 44 行定义.

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

引用了 bufline , 以及 trackLineColumn.

被这些函数引用 getBeginLine(), getEndLine() , 以及 getLine().

◆ getColumn()

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

inlinevirtual

在文件 CharStream.h 第 53 行定义.

53 { return getBufcolumn(bufpos); }

引用了 bufpos , 以及 getBufcolumn().

◆ getEndColumn()

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

inlinevirtual

在文件 CharStream.h 第 55 行定义.

55 { return getBufcolumn(bufpos); }

引用了 bufpos , 以及 getBufcolumn().

◆ getEndLine()

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

inlinevirtual

在文件 CharStream.h 第 56 行定义.

56 { return getBufline(bufpos); }

引用了 bufpos , 以及 getBufline().

◆ GetImage()

virtual JJString 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.

在文件 CharStream.h 第 129 行定义.

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

引用了 buffer, bufpos, bufsize , 以及 tokenBegin.

◆ getLine()

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

inlinevirtual

在文件 CharStream.h 第 54 行定义.

54 { return getBufline(bufpos); }

引用了 bufpos , 以及 getBufline().

◆ GetSuffix()

virtual JJString 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 :

在文件 CharStream.h 第 142 行定义.

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

引用了 buffer, bufpos , 以及 bufsize.

◆ getTabSize()

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

inline

在文件 CharStream.h 第 34 行定义.

34 { return tabSize; }

引用了 tabSize.

◆ getTrackLineColumn()

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

inlinevirtual

在文件 CharStream.h 第 60 行定义.

60 { return trackLineColumn; }

引用了 trackLineColumn.

◆ readChar()

virtual JJChar 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.

在文件 CharStream.h 第 95 行定义.

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

引用了 buffer, bufpos, bufsize, FillBuff(), inBuf, maxNextCharInd, trackLineColumn , 以及 UpdateLineColumn().

被这些函数引用 BeginToken().

◆ ReInit() [1/5]

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

inlinevirtual

在文件 CharStream.h 第 238 行定义.

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

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ ReInit() [2/5]

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

virtual

◆ ReInit() [3/5]

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

inlinevirtual

在文件 CharStream.h 第 231 行定义.

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

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ ReInit() [4/5]

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

inlinevirtual

在文件 CharStream.h 第 227 行定义.

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

引用了 INITIAL_BUFFER_SIZE , 以及 ReInit().

◆ ReInit() [5/5]

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

virtual

被这些函数引用 CharStream() , 以及 ReInit().

◆ setTabSize()

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

inline

在文件 CharStream.h 第 33 行定义.

33 { tabSize = i; }

引用了 tabSize.

◆ setTrackLineColumn()

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

inlinevirtual

在文件 CharStream.h 第 61 行定义.

61 { trackLineColumn = val; }

引用了 trackLineColumn.

◆ UpdateLineColumn()

virtual void vhdl::parser::CharStream::UpdateLineColumn ( JJChar c )

protectedvirtual

被这些函数引用 readChar().

类成员变量说明

◆ available

int vhdl::parser::CharStream::available

protected

在文件 CharStream.h 第 258 行定义.

◆ bufcolumn

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

protected

在文件 CharStream.h 第 249 行定义.

被这些函数引用 getBufcolumn().

◆ buffer

JJChar* vhdl::parser::CharStream::buffer

protected

在文件 CharStream.h 第 250 行定义.

被这些函数引用 GetImage(), GetSuffix() , 以及 readChar().

◆ bufline

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

protected

在文件 CharStream.h 第 248 行定义.

被这些函数引用 getBufline().

◆ bufpos

int vhdl::parser::CharStream::bufpos

protected

在文件 CharStream.h 第 251 行定义.

被这些函数引用 backup(), BeginToken(), endOfInput(), getColumn(), getEndColumn(), getEndLine(), GetImage(), getLine(), GetSuffix() , 以及 readChar().

◆ bufsize

int vhdl::parser::CharStream::bufsize

protected

在文件 CharStream.h 第 252 行定义.

被这些函数引用 backup(), GetImage(), GetSuffix() , 以及 readChar().

◆ column

int vhdl::parser::CharStream::column

protected

在文件 CharStream.h 第 254 行定义.

◆ deleteStream

bool vhdl::parser::CharStream::deleteStream

protected

在文件 CharStream.h 第 264 行定义.

被这些函数引用 ~CharStream().

◆ inBuf

int vhdl::parser::CharStream::inBuf

protected

在文件 CharStream.h 第 260 行定义.

被这些函数引用 backup(), endOfInput() , 以及 readChar().

◆ inputStream

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

protected

在文件 CharStream.h 第 263 行定义.

被这些函数引用 endOfInput() , 以及 ~CharStream().

◆ line

int vhdl::parser::CharStream::line

protected

在文件 CharStream.h 第 255 行定义.

◆ maxNextCharInd

int vhdl::parser::CharStream::maxNextCharInd

protected

在文件 CharStream.h 第 259 行定义.

被这些函数引用 endOfInput() , 以及 readChar().

◆ prevCharIsCR

bool vhdl::parser::CharStream::prevCharIsCR

protected

在文件 CharStream.h 第 256 行定义.

◆ prevCharIsLF

bool vhdl::parser::CharStream::prevCharIsLF

protected

在文件 CharStream.h 第 257 行定义.

◆ tabSize

int vhdl::parser::CharStream::tabSize

protected

在文件 CharStream.h 第 261 行定义.

被这些函数引用 getTabSize() , 以及 setTabSize().

◆ tokenBegin

int vhdl::parser::CharStream::tokenBegin

protected

在文件 CharStream.h 第 253 行定义.

被这些函数引用 BeginToken(), getBeginColumn(), getBeginLine() , 以及 GetImage().

◆ trackLineColumn

bool vhdl::parser::CharStream::trackLineColumn

protected

在文件 CharStream.h 第 262 行定义.

被这些函数引用 getBufcolumn(), getBufline(), getTrackLineColumn(), readChar() , 以及 setTrackLineColumn().

该类的文档由以下文件生成:

vhdlparser/CharStream.h

Public 成员函数

Protected 成员函数

Protected 属性

Private 成员函数

详细描述

构造及析构函数说明

◆ ~CharStream()

◆ CharStream() [1/7]

◆ CharStream() [2/7]

◆ CharStream() [3/7]

◆ CharStream() [4/7]

◆ CharStream() [5/7]

◆ CharStream() [6/7]

◆ CharStream() [7/7]

成员函数说明

◆ adjustBeginLineColumn()

◆ backup()

◆ BeginToken()

◆ DeleteBuffers()

◆ endOfInput()

◆ ExpandBuff()

◆ FillBuff()

◆ getBeginColumn()

◆ getBeginLine()

◆ getBufcolumn()

◆ getBufline()

◆ getColumn()

◆ getEndColumn()

◆ getEndLine()

◆ GetImage()

◆ getLine()

◆ GetSuffix()

◆ getTabSize()

◆ getTrackLineColumn()

◆ readChar()

◆ ReInit() [1/5]

◆ ReInit() [2/5]

◆ ReInit() [3/5]

◆ ReInit() [4/5]

◆ ReInit() [5/5]

◆ setTabSize()

◆ setTrackLineColumn()

◆ UpdateLineColumn()

类成员变量说明

◆ available

◆ bufcolumn

◆ buffer

◆ bufline

◆ bufpos

◆ bufsize

◆ column

◆ deleteStream

◆ inBuf

◆ inputStream

◆ line

◆ maxNextCharInd

◆ prevCharIsCR

◆ prevCharIsLF

◆ tabSize

◆ tokenBegin

◆ trackLineColumn