intradoc.common
Class GrammarParseState

java.lang.Object
  |
  +--intradoc.common.GrammarParseState

public class GrammarParseState

extends java.lang.Object

Holds active state while a character array is being parsed into GrammarElements

See Also:

GrammarElement

Field Summary

char[]	m_array Buffer being parsed.
int	m_curLineOffset Offset to first character of current line.
int	m_endOffset End offset where to terminate parsing.
boolean	m_ignoreLf Says whether to ignore a '\n' when checking for line terminators.
boolean	m_isXmlLiteralEscape Turn to true if the escaping mechanism in literal strings uses the XML/HTML &XXX; approach.
int	m_parseLines Number of lines that have been parsed in current array of characters being parsed.
java.lang.String	m_parseStr Original string used as basis for parsing.
int	m_parseStrOffset Offset in m_array at which m_parseStr starts.
int	m_startOffset Current offset into character buffer from which to start parsing.
char	m_terminateChar Character that terminated current grammar parsing.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

m_isXmlLiteralEscape

public boolean m_isXmlLiteralEscape

Turn to true if the escaping mechanism in literal strings uses the XML/HTML &XXX; approach.

m_array

public char[] m_array

Buffer being parsed.

m_startOffset

public int m_startOffset

Current offset into character buffer from which to start parsing.

m_endOffset

public int m_endOffset

End offset where to terminate parsing. Parsing terminates at an index of one less than this value.

m_parseStr

public java.lang.String m_parseStr

Original string used as basis for parsing. Used to create substrings. The substring method does not create a new string, it instead increases the reference count on the original string and sets an offset and length. This string is also used when reporting errors.

m_parseStrOffset

public int m_parseStrOffset

Offset in m_array at which m_parseStr starts. Note: m_parseStr is usually only a subpiece of 'm_array'.

m_parseLines

public int m_parseLines

Number of lines that have been parsed in current array of characters being parsed.

m_curLineOffset

public int m_curLineOffset

Offset to first character of current line. Computation starts at m_parseStrOffset.

m_ignoreLf

public boolean m_ignoreLf

Says whether to ignore a '\n' when checking for line terminators. Lasts one character.

m_terminateChar

public char m_terminateChar

Character that terminated current grammar parsing. Set to zero if parsing was not terminated before end of buffer.