org.vishia.zbnf

Class ZbnfParserStore

java.lang.Object

org.vishia.zbnf.ZbnfParserStore

class ZbnfParserStore
extends java.lang.Object

This class stores an syntax tested item.

Syntax	SyntaxPrescript.	ParserStore.	add...
Terminal Symbols	String	kTerminalSymbol	add??
[<?Semantic>		<kMaxAlternate	addOption
<syntax?semantic>		kComponent	add??
<?semantic>		kOnlySemantic	add??
[...]		kSingleOption	add??
{...		kRepetition	add??
{..?...}		kRepetitionRepeat	add??
<#?semantic>		kIntegerNumber	add??
<#-?semantic>		kIntegerNumber	add??
<#x?semantic>		kIntegerNumber	add??
<#f?semantic>		kFloatNumber	add??
<$?semantic>		kIdentifier	add??
<*endchars?semantic>		kString	add??
<!regex?semantic>		kString	add??
<""?semantic>		kString	add??
<''?semantic>		kString	add??
<*""endchars?semantic>		kString	add??

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	ZbnfParserStore.BuilderTreeNodeXml
private static class	ZbnfParserStore.ConvertWikiStyle
(package private) static class	ZbnfParserStore.ParseResultItemImplement One item to store in the list.
static interface	ZbnfParserStore.PrepareXmlNode

Field Summary

Fields

Modifier and Type	Field and Description
private int[]	column Temporary store for column.
(package private) static ZbnfParserStore.ConvertWikiStyle	convertWikiformat The index to read out the parse results.
(package private) ZbnfParserStore.ParseResultItemImplement	item The last item, useable for set...
(package private) java.util.ArrayList<ZbnfParserStore.ParseResultItemImplement>	items List of items to store, instaceof ParseResultItem
(package private) static int	kComponent Constant to detect the entry describes a component assigned to a non-teminal syntax symbol. -32766
(package private) static int	kFloatNumber Constant to detect an integer number. -32758
(package private) static int	kIdentifier Constant to detect an identifier. -32757
(package private) static int	kIntegerNumber Constant to detect an integer number. -32759
(package private) static int	kMaxRepetition A number between this constant an -1 detects, it is a repetition.
(package private) static int	kOnlySemantic Constant to detect the entry describes a single option. -32764
(package private) static int	kOption Constant to detect the entry describes a only semantiv entry. -32763
(package private) static int	kString Constant to detect an identifier. -32756
(package private) static int	kTerminalSymbol Constant to detect the entry describes a terminate symbol. -32767
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
ZbnfParserStore() Constructs a new empty ParserStore.

Method Summary

Modifier and Type	Method and Description
(package private) ZbnfParserStore.ParseResultItemImplement	add(java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, ZbnfSyntaxPrescript componentSyntax, java.lang.CharSequence sInput, int nAlternative, long start, long end, int srcLine, int srcColumn, java.lang.String srcFile, ZbnfParseResultItem parent) Adds a new item If this is a components item, on end setAlternativeAndOffsetToEnd(int, int) should be called.
(package private) ZbnfParserStore.ParseResultItemImplement	addConstantSyntax(ZbnfSyntaxPrescript elementSyntax, java.lang.String sInput, long start, long end, int nLine, int nColumn, java.lang.String sFile, ZbnfParseResultItem parent)
(package private) void	addFloatNumber(java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, double number, ZbnfParseResultItem parent)
(package private) void	addIdentifier(java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, java.lang.String sIdent, ZbnfParseResultItem parent, int srcLine, int srcColumn, java.lang.String srcFile)
(package private) void	addIntegerNumber(java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, long number, java.lang.String[] sNumber, ZbnfParseResultItem parent)
(package private) ZbnfParserStore.ParseResultItemImplement	addRepetition(int countRepetition, java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, long start, long end, int nLine, int nColumn, java.lang.String sFile, ZbnfParseResultItem parent) Sets the src of the parsing.
(package private) ZbnfParserStore.ParseResultItemImplement	addRepetitionRepeat(int countRepetition, java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, long start, long end, int nLine, int nColumn, java.lang.String sFile, ZbnfParseResultItem parent)
(package private) ZbnfParserStore.ParseResultItemImplement	addSemantic(java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, ZbnfParseResultItem parent, int srcLine, int srcColumn, java.lang.String srcFile)
(package private) ZbnfParserStore.ParseResultItemImplement	addString(java.lang.CharSequence src, java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, StringPart spInput, ZbnfParseResultItem parent, int srcLine, int srcColumn, java.lang.String srcFile) Adds a founded string to the parsers store.
(package private) ZbnfParserStore.ParseResultItemImplement	addString(StringPart spInput, java.lang.String sSemantic, ZbnfSyntaxPrescript elementSyntax, ZbnfParseResultItem parent) Adds a founded string to the parsers store.
ZbnfParseResultItem	getFirstParseResult() Returns the first parse result item to start stepping to the results.
(package private) ZbnfParseResultItem	getItem(int idx)
java.util.Iterator<ZbnfParserStore.ParseResultItemImplement>	getIterator() Gets the next item to step through the items.
(package private) int	getNextPosition() Gets the position for the next entry, useable for rewind().
(package private) int	insert(ZbnfParserStore addStore, int idxStore, ZbnfParseResultItem parent) adds items form another ParserStore.
(package private) void	setAlternativeAndOffsetToEnd(int idxStore, int alternative) Sets the spread of the item (@link ZbnfParserStore.ParseResultItemImplement.offsetAfterEnd and the number of the alternative into a existing item.
(package private) void	setCurrentPosition(int pos) Removes all entries start from position.
(package private) void	stop() It's a debug helper.
java.lang.String	toString()
(package private) void	writeContentAsList(java.lang.Appendable out) This is called from ZbnfParser.writeResultAsTextList(Appendable) as wrapper.

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2022-04-28 Hartmut addIdentifier(String, ZbnfSyntaxPrescript, String, ZbnfParseResultItem, int, int, String) and writeContentAsList(Appendable): enhanced to store the source of numeric values.
• 2022-02-08 Hartmut
  • ZbnfParserStore.ParseResultItemImplement.elementSyntax renamed from "parentSyntaxElement". It is not the parent.
  • componentSyntax removed, because it is referenced in the elementSyntax (improved in ZbnfSyntaxPrescript
  • add(String, ZbnfSyntaxPrescript, ZbnfSyntaxPrescript, CharSequence, int, long, long, int, int, String, ZbnfParseResultItem) and other add: Change of ZbnfParserStore.ParseResultItemImplement.offsetAfterEnd in the parent's items is removed. This was an old concept, no more necessary, and confusing.
  • in setAlternativeAndOffsetToEnd(int, int): Here important change, see description.
• 2022-02-08 Hartmut new: ZbnfParserStore.ParseResultItemImplement.componentSyntax() now references immediately from the result to the component for syntax. This gives more information. The data are not too much because there are lesser Syntax definitions as result items.
• % renaming ParseResultItemImplement#parentSyntaxElement from syntaxElement to prevent confusion. The meaning of that element was originally, before 2019, that of ZbnfParserStore.ParseResultItemImplement.componentSyntax() but with lesser usage. It was a inconsequently change.
• % ZbnfParserStore.ParseResultItemImplement.getSuperItemType() uses the change in ZbnfSyntaxPrescript.sSuperItemType
• % writeContentAsList(Appendable) as output to check (usual data debug).
• 2019-05-22 Hartmut chg: ZbnfParserStore.ParseResultItemImplement.getText() improved while testing ZBNF/testAllConecpts (from 2009).
  BuilderTreeNodeXml#createXmlNode(XmlNode, ParseResultItemImplement): On repetition item an XmlNode for {<?semantic>... should be created anywhere, because elsewhere only one node exists.
• 2017-03-25 Hartmut chg: The syntax item for a parse result is stored in the ZbnfParserStore.ParseResultItemImplement.syntaxItem().
• 2014-06-17 Hartmut chg: new ZbnfParserStore.BuilderTreeNodeXml with attributes ZbnfParserStore.BuilderTreeNodeXml.bXmlSrcline and bXmlSrctext controls whether srcline="xx" and srctext="text" will be written to a XML output.
• 2014-05-23 Hartmut chg: use StringPart.getLineAndColumn(int[]) instead getLineCt() and StringPart.getCurrentColumn() because it is faster.
• 2014-05-22 Hartmut new: Save srcFile in ZbnfParserStore.ParseResultItemImplement.sFile, for information in written results, especially with ZbnfJavaOutput.
• 2014-04-21 Hartmut new: #createXmlNode(XmlNode, ParseResultItemImplement): writes src-line, src-col and start of src in the xml element.
• 2013-09-12 Hartmut chg: #buildTreeNodeRepresentationXml(XmlNode, ParseResultItemImplement, boolean) now returns and works with the interface reference XmlNode instead the implementation instance reference XmlNodeSimple. The implementation is the same. All references are adapted.
• 2013-09-11 Hartmut new ZbnfParserStore.PrepareXmlNode, ZbnfParserStore.ConvertWikiStyle, #buildTreeNodeRepresentationXml(XmlNode, ParseResultItemImplement, boolean): All capabilities which were located in ZbnfXmlOutput are implemented here. The class ZbnfXmlOutput is not necessary any more because the intrinsic format of data stored as parse result is XML now.
• 2013-09-12 Hartmut chg
• 2012-11-02 Hartmut new ZbnfParserStore.ParseResultItemImplement.getText() to get a textual projection of the content. used for XML presentation.
• 2012-11-02 Hartmut: The ParseResultItem has gotten an element ZbnfParserStore.ParseResultItemImplement.treeNodeXml. It refers to an tree-like result store, whereby the XmlNodeSimple is used as node. Therewith the conversion to XML is obviously. As well too, the access to treed data able to use for direct text conversion using org.vishia.zbatch.ZbatchExecuter. A new method #buildTreeNodeRepresentationXml(XmlNodeSimple, ParseResultItemImplement, boolean) is offered to use.
• 2008-03-28 JcHartmut: The ParserStore is not cleared, only the reference is assigned new. So outside the ParserStore can be used from an older parsing.
• 2006-12-15 JcHartmut: regular expressions should be handled after white spaces trimming, error correction.
• 2006-06-00 JcHartmut: fixed a lot of simple problems in development.
• 2006-05-00 JcHartmut: creation

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL ist not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

kTerminalSymbol

static final int kTerminalSymbol

Constant to detect the entry describes a terminate symbol. -32767

See Also:

Constant Field Values

kComponent

static final int kComponent

Constant to detect the entry describes a component assigned to a non-teminal syntax symbol. -32766

See Also:

Constant Field Values

kOnlySemantic

static final int kOnlySemantic

Constant to detect the entry describes a single option. -32764

See Also:

Constant Field Values

kOption

static final int kOption

Constant to detect the entry describes a only semantiv entry. -32763

See Also:

Constant Field Values

kIntegerNumber

static final int kIntegerNumber

Constant to detect an integer number. -32759

See Also:

Constant Field Values

kFloatNumber

static final int kFloatNumber

Constant to detect an integer number. -32758

See Also:

Constant Field Values

kIdentifier

static final int kIdentifier

Constant to detect an identifier. -32757

See Also:

Constant Field Values

kString

static final int kString

Constant to detect an identifier. -32756

See Also:

Constant Field Values

kMaxRepetition

static final int kMaxRepetition

A number between this constant an -1 detects, it is a repetition.

See Also:

Constant Field Values

item

ZbnfParserStore.ParseResultItemImplement item

The last item, useable for set...

items

final java.util.ArrayList<ZbnfParserStore.ParseResultItemImplement> items

List of items to store, instaceof ParseResultItem

column

private final int[] column

Temporary store for column.

convertWikiformat

static ZbnfParserStore.ConvertWikiStyle convertWikiformat

The index to read out the parse results. See getNextParseResult().

Constructor Detail

ZbnfParserStore

public ZbnfParserStore()

Constructs a new empty ParserStore.

Method Detail

getFirstParseResult

public ZbnfParseResultItem getFirstParseResult()

Returns the first parse result item to start stepping to the results. See samples at interface ParseResultItem.

Returns:

The first parse result item.

add

ZbnfParserStore.ParseResultItemImplement add(java.lang.String sSemantic,
                                             ZbnfSyntaxPrescript elementSyntax,
                                             ZbnfSyntaxPrescript componentSyntax,
                                             java.lang.CharSequence sInput,
                                             int nAlternative,
                                             long start,
                                             long end,
                                             int srcLine,
                                             int srcColumn,
                                             java.lang.String srcFile,
                                             ZbnfParseResultItem parent)

Adds a new item If this is a components item, on end setAlternativeAndOffsetToEnd(int, int) should be called.

Parameters:

sSemantic -

sInput -

nAlternative -

start -

end -

nLine -

nColumn -

Returns:

The position of this entry, using for rewind(posititon);

setAlternativeAndOffsetToEnd

void setAlternativeAndOffsetToEnd(int idxStore,
                                  int alternative)

Sets the spread of the item (@link ZbnfParserStore.ParseResultItemImplement.offsetAfterEnd and the number of the alternative into a existing item. The item is to be added on begin of parsing the part, and the number of alternative is to be added at the end of it. The number of alternative is ascertained only at the end. Also at the end it is possible to add the offsetAfterEnd-offset. It is done here. If the item isn't a type of alternative, a RuntimeException is thrown.
New since 2022-02: If a component is finished, and the parent component has the same super type and contains only this only one element, then the parent is removed.

Parameters:

idxStore - The index where find the alternative item in the store

alternative - The number of founded, alternative from 1, 0 if it is the empty option.

addRepetition

ZbnfParserStore.ParseResultItemImplement addRepetition(int countRepetition,
                                                       java.lang.String sSemantic,
                                                       ZbnfSyntaxPrescript elementSyntax,
                                                       long start,
                                                       long end,
                                                       int nLine,
                                                       int nColumn,
                                                       java.lang.String sFile,
                                                       ZbnfParseResultItem parent)

Sets the src of the parsing. It is the return value from getParsedText();

Parameters:

sInput - the parsed text

addRepetitionRepeat

ZbnfParserStore.ParseResultItemImplement addRepetitionRepeat(int countRepetition,
                                                             java.lang.String sSemantic,
                                                             ZbnfSyntaxPrescript elementSyntax,
                                                             long start,
                                                             long end,
                                                             int nLine,
                                                             int nColumn,
                                                             java.lang.String sFile,
                                                             ZbnfParseResultItem parent)

addConstantSyntax

ZbnfParserStore.ParseResultItemImplement addConstantSyntax(ZbnfSyntaxPrescript elementSyntax,
                                                           java.lang.String sInput,
                                                           long start,
                                                           long end,
                                                           int nLine,
                                                           int nColumn,
                                                           java.lang.String sFile,
                                                           ZbnfParseResultItem parent)

addSemantic

ZbnfParserStore.ParseResultItemImplement addSemantic(java.lang.String sSemantic,
                                                     ZbnfSyntaxPrescript elementSyntax,
                                                     ZbnfParseResultItem parent,
                                                     int srcLine,
                                                     int srcColumn,
                                                     java.lang.String srcFile)

addString

ZbnfParserStore.ParseResultItemImplement addString(StringPart spInput,
                                                   java.lang.String sSemantic,
                                                   ZbnfSyntaxPrescript elementSyntax,
                                                   ZbnfParseResultItem parent)

Adds a founded string to the parsers store. It is called at as the issue of parsing some special string tests, such as <!regex?..> or <""?...>.

Parameters:

spInput -

Returns:

addString

ZbnfParserStore.ParseResultItemImplement addString(java.lang.CharSequence src,
                                                   java.lang.String sSemantic,
                                                   ZbnfSyntaxPrescript elementSyntax,
                                                   StringPart spInput,
                                                   ZbnfParseResultItem parent,
                                                   int srcLine,
                                                   int srcColumn,
                                                   java.lang.String srcFile)

Adds a founded string to the parsers store. It is called at as the issue of parsing some special string tests, such as <!regex?..> or <""?...>.

Parameters:

spInput -

Returns:

addIdentifier

void addIdentifier(java.lang.String sSemantic,
                   ZbnfSyntaxPrescript elementSyntax,
                   java.lang.String sIdent,
                   ZbnfParseResultItem parent,
                   int srcLine,
                   int srcColumn,
                   java.lang.String srcFile)

addIntegerNumber

void addIntegerNumber(java.lang.String sSemantic,
                      ZbnfSyntaxPrescript elementSyntax,
                      long number,
                      java.lang.String[] sNumber,
                      ZbnfParseResultItem parent)

addFloatNumber

void addFloatNumber(java.lang.String sSemantic,
                    ZbnfSyntaxPrescript elementSyntax,
                    double number,
                    ZbnfParseResultItem parent)

getItem

ZbnfParseResultItem getItem(int idx)

insert

int insert(ZbnfParserStore addStore,
           int idxStore,
           ZbnfParseResultItem parent)

adds items form another ParserStore. This is used especially to transfer parse results to another component.

Parameters:

addStore -

Returns:

nrof items added.

getNextPosition

int getNextPosition()

Gets the position for the next entry, useable for rewind().

Returns:

The size of content equals index of next position.

setCurrentPosition

void setCurrentPosition(int pos)

Removes all entries start from position.

Parameters:

pos - following position after last valid result. If pos is negative, no action is done.

getIterator

public java.util.Iterator<ZbnfParserStore.ParseResultItemImplement> getIterator()

Gets the next item to step through the items.

Returns:

Iterator, usind like List.iterator().

writeContentAsList

void writeContentAsList(java.lang.Appendable out)
                 throws java.io.IOException

This is called from ZbnfParser.writeResultAsTextList(Appendable) as wrapper.

Parameters:

out -

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

stop

void stop()

It's a debug helper. The method is empty, but it is a mark to set a breakpoint.