LagartoParser (Jodd API Documentation)

java.lang.Object
- jodd.lagarto.LagartoParser

```
public class LagartoParser
extends java.lang.Object
```
HTML/XML content parser/tokenizer using TagVisitor for callbacks. Works by the HTML5 specs for tokenization, as described on WhatWG. Differences from the specs:
- text is emitted as a block of text, and not character by character.
- tags name case (and letter case of other entities) is not changed, but case-sensitive information exist for matching.
- the whole tokenization process is implemented here, without going into the tree building. This applies for switching to the RAWTEXT state.
- script tag is emitted separately
- conditional comments added
- xml states and callbacks added
There are two ways how text is passed back to the visitor. By default it is passed as CharBuffer, which gives excellent performances. However, if you need more Strings than enable it, and all text will be strings. This is faster then first converting to char buffer and then to strings.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`LagartoParser.ScriptEscape` Since escaping states inside the SCRIPT tag are rare, we want to use them lazy, only when really needed.
`protected class`	`LagartoParser.XmlDeclaration`
`static class`	`jodd.lagarto.Scanner.Position` Current position.

Field Summary

Fields
Modifier and Type	Field and Description
`protected State`	`AFTER_ATTRIBUTE_NAME`
`protected State`	`AFTER_ATTRIBUTE_VALUE_QUOTED`
`protected State`	`AFTER_DOCTYPE_PUBLIC_IDENTIFIER`
`protected State`	`AFTER_DOCTYPE_PUBLIC_KEYWORD`
`protected State`	`AFTER_DOCTYPE_SYSTEM_IDENTIFIER`
`protected State`	`AFTER_DOCTYPE_SYSTEM_KEYWORD`
`protected State`	`AFTER_DOCUMENT_NAME`
`protected State`	`ATTR_VALUE_DOUBLE_QUOTED`
`protected State`	`ATTR_VALUE_SINGLE_QUOTED`
`protected State`	`ATTR_VALUE_UNQUOTED`
`protected int`	`attrEndNdx`
`protected State`	`ATTRIBUTE_NAME`
`protected int`	`attrStartNdx`
`protected State`	`BEFORE_ATTRIBUTE_NAME`
`protected State`	`BEFORE_ATTRIBUTE_VALUE`
`protected State`	`BEFORE_DOCTYPE_NAME`
`protected State`	`BEFORE_DOCTYPE_PUBLIC_IDENTIFIER`
`protected State`	`BEFORE_DOCTYPE_SYSTEM_IDENTIFIER`
`protected State`	`BETWEEN_DOCTYPE_PUBLIC_AND_SYSTEM_IDENTIFIERS`
`protected State`	`BOGUS_COMMENT`
`protected State`	`BOGUS_DOCTYPE`
`protected State`	`COMMENT`
`protected State`	`COMMENT_END`
`protected State`	`COMMENT_END_BANG`
`protected State`	`COMMENT_END_DASH`
`protected State`	`COMMENT_START`
`protected State`	`COMMENT_START_DASH`
`protected int`	`commentStart`
`protected LagartoParserConfig`	`config`
`protected State`	`DATA_STATE` Data state.
`protected ParsedDoctype`	`doctype`
`protected State`	`DOCTYPE`
`protected State`	`DOCTYPE_NAME`
`protected State`	`DOCTYPE_PUBLIC_IDENTIFIER_DOUBLE_QUOTED`
`protected State`	`DOCTYPE_PUBLIC_IDENTIFIER_SINGLE_QUOTED`
`protected State`	`DOCTYPE_SYSTEM_IDENTIFIER_DOUBLE_QUOTED`
`protected State`	`DOCTYPE_SYSTEM_IDENTIFIER_SINGLE_QUOTED`
`protected int`	`doctypeIdNameStart`
`protected boolean`	`emitStrings`
`protected static java.nio.CharBuffer`	`EMPTY_CHAR_BUFFER`
`protected State`	`END_TAG_OPEN`
`protected char[]`	`input`
`protected State`	`MARKUP_DECLARATION_OPEN`
`protected int`	`ndx`
`protected boolean`	`parsing`
`protected long`	`parsingTime`
`protected char[]`	`rawTagName`
`protected State`	`RAWTEXT`
`protected State`	`RAWTEXT_END_TAG_NAME`
`protected State`	`RAWTEXT_END_TAG_OPEN`
`protected State`	`RAWTEXT_LESS_THAN_SIGN`
`protected int`	`rawTextEnd`
`protected int`	`rawTextStart`
`protected State`	`RCDATA`
`protected State`	`RCDATA_END_TAG_NAME`
`protected State`	`RCDATA_END_TAG_OPEN`
`protected State`	`RCDATA_LESS_THAN_SIGN`
`protected char[]`	`rcdataTagName`
`protected int`	`rcdataTagStart`
`protected State`	`SCRIPT_DATA`
`protected State`	`SCRIPT_DATA_END_TAG_NAME`
`protected State`	`SCRIPT_DATA_END_TAG_OPEN`
`protected State`	`SCRIPT_DATA_LESS_THAN_SIGN`
`protected int`	`scriptEndNdx`
`protected int`	`scriptEndTagName`
`protected LagartoParser.ScriptEscape`	`scriptEscape`
`protected int`	`scriptStartNdx`
`protected State`	`SELF_CLOSING_START_TAG`
`protected State`	`state`
`protected jodd.lagarto.ParsedTag`	`tag`
`protected State`	`TAG_NAME`
`protected State`	`TAG_OPEN`
`protected char[]`	`text`
`protected int`	`textLen`
`protected int`	`total`
`protected TagVisitor`	`visitor`
`protected LagartoParser.XmlDeclaration`	`xmlDeclaration`

Constructor Summary

Constructors
Constructor and Description
`LagartoParser(char[] charArray, boolean emitStrings)` Creates parser on char array.
`LagartoParser(java.lang.String string, boolean emitStrings)` Creates parser on a String.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`_error(java.lang.String message)` Prepares error message and reports it to the visitor.
`protected java.lang.CharSequence`	`charSequence(int from, int to)` Creates char sub-sequence from the input.
`protected void`	`consumeCharacterReference()`
`protected void`	`consumeCharacterReference(char allowedChar)`
`protected void`	`emitCData(java.lang.CharSequence charSequence)`
`protected void`	`emitComment(int from, int to)` Emits a comment.
`protected void`	`emitDoctype()`
`protected void`	`emitScript(int from, int to)`
`protected void`	`emitTag()`
`protected void`	`emitText()` Emits text if there is some content.
`protected void`	`emitXml()`
`protected void`	`errorCharReference()`
`protected void`	`errorEOF()`
`protected void`	`errorInvalidToken()`
`protected int`	`find(char[] target, int from, int end)` Finds character buffer in some range and returns its index.
`protected int`	`find(char target, int from, int end)` Finds a character in some range and returns its index.
`LagartoParserConfig`	`getConfig()` Returns `configuration` for the parser.
`long`	`getParsingTime()` Returns parsing time in milliseconds.
`protected void`	`initialize(char[] input)` Initializes parser.
`protected boolean`	`isEOF()` Returns `true` if EOF.
`boolean`	`match(char[] target)` Matches char buffer with content at current location case-sensitive.
`protected boolean`	`match(char[] target, int ndx)` Matches char buffer with content on given location.
`boolean`	`matchUpperCase(char[] uppercaseTarget)` Matches char buffer given in uppercase with content at current location, that will be converted to upper case to make case-insensitive matching.
`void`	`parse(TagVisitor visitor)` Parses content and callback provided `TagVisitor`.
`protected jodd.lagarto.Scanner.Position`	`position(int position)` Calculates `current position`: offset, line and column.
`void`	`setConfig(LagartoParserConfig config)` Sets parser configuration.
`protected void`	`textEmitChar(char c)` Emits characters into the local text buffer.
`protected void`	`textEmitChars(char[] buffer)`
`protected void`	`textEmitChars(int from, int to)`
`protected void`	`textStart()` Resets text buffer.
`protected java.lang.CharSequence`	`textWrap()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

visitor
```
protected TagVisitor visitor
```

tag
```
protected jodd.lagarto.ParsedTag tag
```

doctype
```
protected ParsedDoctype doctype
```

parsingTime
```
protected long parsingTime
```

config
```
protected LagartoParserConfig config
```

parsing
```
protected boolean parsing
```

DATA_STATE
```
protected State DATA_STATE
```
Data state.

TAG_OPEN
```
protected State TAG_OPEN
```

END_TAG_OPEN
```
protected State END_TAG_OPEN
```

TAG_NAME
```
protected State TAG_NAME
```

BEFORE_ATTRIBUTE_NAME
```
protected State BEFORE_ATTRIBUTE_NAME
```

ATTRIBUTE_NAME
```
protected State ATTRIBUTE_NAME
```

AFTER_ATTRIBUTE_NAME
```
protected State AFTER_ATTRIBUTE_NAME
```

BEFORE_ATTRIBUTE_VALUE
```
protected State BEFORE_ATTRIBUTE_VALUE
```

ATTR_VALUE_UNQUOTED
```
protected State ATTR_VALUE_UNQUOTED
```

ATTR_VALUE_SINGLE_QUOTED

protected State ATTR_VALUE_SINGLE_QUOTED

ATTR_VALUE_DOUBLE_QUOTED

protected State ATTR_VALUE_DOUBLE_QUOTED

AFTER_ATTRIBUTE_VALUE_QUOTED

protected State AFTER_ATTRIBUTE_VALUE_QUOTED

SELF_CLOSING_START_TAG
```
protected State SELF_CLOSING_START_TAG
```

BOGUS_COMMENT
```
protected State BOGUS_COMMENT
```

MARKUP_DECLARATION_OPEN

protected State MARKUP_DECLARATION_OPEN

rawTextStart
```
protected int rawTextStart
```

rawTextEnd
```
protected int rawTextEnd
```

rawTagName
```
protected char[] rawTagName
```

RAWTEXT
```
protected State RAWTEXT
```

RAWTEXT_LESS_THAN_SIGN
```
protected State RAWTEXT_LESS_THAN_SIGN
```

RAWTEXT_END_TAG_OPEN
```
protected State RAWTEXT_END_TAG_OPEN
```

RAWTEXT_END_TAG_NAME
```
protected State RAWTEXT_END_TAG_NAME
```

rcdataTagStart
```
protected int rcdataTagStart
```

rcdataTagName
```
protected char[] rcdataTagName
```

RCDATA
```
protected State RCDATA
```

RCDATA_LESS_THAN_SIGN
```
protected State RCDATA_LESS_THAN_SIGN
```

RCDATA_END_TAG_OPEN
```
protected State RCDATA_END_TAG_OPEN
```

RCDATA_END_TAG_NAME
```
protected State RCDATA_END_TAG_NAME
```

commentStart
```
protected int commentStart
```

COMMENT_START
```
protected State COMMENT_START
```

COMMENT_START_DASH
```
protected State COMMENT_START_DASH
```

COMMENT
```
protected State COMMENT
```

COMMENT_END_DASH
```
protected State COMMENT_END_DASH
```

COMMENT_END
```
protected State COMMENT_END
```

COMMENT_END_BANG
```
protected State COMMENT_END_BANG
```

DOCTYPE
```
protected State DOCTYPE
```

BEFORE_DOCTYPE_NAME
```
protected State BEFORE_DOCTYPE_NAME
```

DOCTYPE_NAME
```
protected State DOCTYPE_NAME
```

AFTER_DOCUMENT_NAME
```
protected State AFTER_DOCUMENT_NAME
```

doctypeIdNameStart
```
protected int doctypeIdNameStart
```

AFTER_DOCTYPE_PUBLIC_KEYWORD

protected State AFTER_DOCTYPE_PUBLIC_KEYWORD

BEFORE_DOCTYPE_PUBLIC_IDENTIFIER

protected State BEFORE_DOCTYPE_PUBLIC_IDENTIFIER

DOCTYPE_PUBLIC_IDENTIFIER_DOUBLE_QUOTED

protected State DOCTYPE_PUBLIC_IDENTIFIER_DOUBLE_QUOTED

DOCTYPE_PUBLIC_IDENTIFIER_SINGLE_QUOTED

protected State DOCTYPE_PUBLIC_IDENTIFIER_SINGLE_QUOTED

AFTER_DOCTYPE_PUBLIC_IDENTIFIER

protected State AFTER_DOCTYPE_PUBLIC_IDENTIFIER

BETWEEN_DOCTYPE_PUBLIC_AND_SYSTEM_IDENTIFIERS

protected State BETWEEN_DOCTYPE_PUBLIC_AND_SYSTEM_IDENTIFIERS

BOGUS_DOCTYPE
```
protected State BOGUS_DOCTYPE
```

AFTER_DOCTYPE_SYSTEM_KEYWORD

protected State AFTER_DOCTYPE_SYSTEM_KEYWORD

BEFORE_DOCTYPE_SYSTEM_IDENTIFIER

protected State BEFORE_DOCTYPE_SYSTEM_IDENTIFIER

DOCTYPE_SYSTEM_IDENTIFIER_DOUBLE_QUOTED

protected State DOCTYPE_SYSTEM_IDENTIFIER_DOUBLE_QUOTED

DOCTYPE_SYSTEM_IDENTIFIER_SINGLE_QUOTED

protected State DOCTYPE_SYSTEM_IDENTIFIER_SINGLE_QUOTED

AFTER_DOCTYPE_SYSTEM_IDENTIFIER

protected State AFTER_DOCTYPE_SYSTEM_IDENTIFIER

scriptStartNdx
```
protected int scriptStartNdx
```

scriptEndNdx
```
protected int scriptEndNdx
```

scriptEndTagName
```
protected int scriptEndTagName
```

SCRIPT_DATA
```
protected State SCRIPT_DATA
```

SCRIPT_DATA_LESS_THAN_SIGN

protected State SCRIPT_DATA_LESS_THAN_SIGN

SCRIPT_DATA_END_TAG_OPEN

protected State SCRIPT_DATA_END_TAG_OPEN

SCRIPT_DATA_END_TAG_NAME

protected State SCRIPT_DATA_END_TAG_NAME

scriptEscape

protected LagartoParser.ScriptEscape scriptEscape

xmlDeclaration

protected LagartoParser.XmlDeclaration xmlDeclaration

text
```
protected char[] text
```

textLen
```
protected int textLen
```

attrStartNdx
```
protected int attrStartNdx
```

attrEndNdx
```
protected int attrEndNdx
```

state
```
protected State state
```

emitStrings
```
protected final boolean emitStrings
```

input
```
protected char[] input
```

ndx
```
protected int ndx
```

total
```
protected int total
```

EMPTY_CHAR_BUFFER

protected static java.nio.CharBuffer EMPTY_CHAR_BUFFER

Constructor Detail

LagartoParser

public LagartoParser(char[] charArray,
             boolean emitStrings)

Creates parser on char array.

LagartoParser

public LagartoParser(java.lang.String string,
             boolean emitStrings)

Creates parser on a String.

Method Detail

initialize

protected void initialize(char[] input)

Initializes parser.

getConfig

public LagartoParserConfig getConfig()

Returns configuration for the parser.

setConfig

public void setConfig(LagartoParserConfig config)

Sets parser configuration.

parse
```
public void parse(TagVisitor visitor)
```
Parses content and callback provided TagVisitor.

getParsingTime
```
public long getParsingTime()
```
Returns parsing time in milliseconds.

consumeCharacterReference

protected void consumeCharacterReference(char allowedChar)

consumeCharacterReference

protected void consumeCharacterReference()

textEmitChar
```
protected void textEmitChar(char c)
```
Emits characters into the local text buffer.

textStart
```
protected void textStart()
```
Resets text buffer.

textEmitChars

protected void textEmitChars(int from,
                 int to)

textEmitChars

protected void textEmitChars(char[] buffer)

textWrap

protected java.lang.CharSequence textWrap()

emitTag
```
protected void emitTag()
```

emitComment
```
protected void emitComment(int from,
               int to)
```
Emits a comment. Also checks for conditional comments!

emitText
```
protected void emitText()
```
Emits text if there is some content.

emitScript

protected void emitScript(int from,
              int to)

emitDoctype
```
protected void emitDoctype()
```

emitXml
```
protected void emitXml()
```

emitCData

protected void emitCData(java.lang.CharSequence charSequence)

errorEOF
```
protected void errorEOF()
```

errorInvalidToken
```
protected void errorInvalidToken()
```

errorCharReference
```
protected void errorCharReference()
```

_error
```
protected void _error(java.lang.String message)
```
Prepares error message and reports it to the visitor.

find
```
protected final int find(char target,
       int from,
       int end)
```
Finds a character in some range and returns its index. Returns -1 if character is not found.

find
```
protected final int find(char[] target,
       int from,
       int end)
```
Finds character buffer in some range and returns its index. Returns -1 if character is not found.

match

protected final boolean match(char[] target,
            int ndx)

Matches char buffer with content on given location.

match
```
public final boolean match(char[] target)
```
Matches char buffer with content at current location case-sensitive.

matchUpperCase
```
public final boolean matchUpperCase(char[] uppercaseTarget)
```
Matches char buffer given in uppercase with content at current location, that will be converted to upper case to make case-insensitive matching.

charSequence
```
protected final java.lang.CharSequence charSequence(int from,
                                  int to)
```
Creates char sub-sequence from the input. It may return a String of CharBuffer. Use String for DOM builder, but for visitor use CharBuffer for better performances.

isEOF
```
protected final boolean isEOF()
```
Returns true if EOF.

position

protected jodd.lagarto.Scanner.Position position(int position)

Calculates current position: offset, line and column.

Class LagartoParser

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

visitor

tag

doctype

parsingTime

config

parsing

DATA_STATE

TAG_OPEN

END_TAG_OPEN

TAG_NAME

BEFORE_ATTRIBUTE_NAME

ATTRIBUTE_NAME

AFTER_ATTRIBUTE_NAME

BEFORE_ATTRIBUTE_VALUE

ATTR_VALUE_UNQUOTED

ATTR_VALUE_SINGLE_QUOTED

ATTR_VALUE_DOUBLE_QUOTED

AFTER_ATTRIBUTE_VALUE_QUOTED

SELF_CLOSING_START_TAG

BOGUS_COMMENT

MARKUP_DECLARATION_OPEN

rawTextStart

rawTextEnd

rawTagName

RAWTEXT

RAWTEXT_LESS_THAN_SIGN

RAWTEXT_END_TAG_OPEN

RAWTEXT_END_TAG_NAME

rcdataTagStart

rcdataTagName

RCDATA

RCDATA_LESS_THAN_SIGN

RCDATA_END_TAG_OPEN

RCDATA_END_TAG_NAME

commentStart

COMMENT_START

COMMENT_START_DASH

COMMENT

COMMENT_END_DASH

COMMENT_END

COMMENT_END_BANG

DOCTYPE

BEFORE_DOCTYPE_NAME

DOCTYPE_NAME

AFTER_DOCUMENT_NAME

doctypeIdNameStart

AFTER_DOCTYPE_PUBLIC_KEYWORD

BEFORE_DOCTYPE_PUBLIC_IDENTIFIER

DOCTYPE_PUBLIC_IDENTIFIER_DOUBLE_QUOTED

DOCTYPE_PUBLIC_IDENTIFIER_SINGLE_QUOTED

AFTER_DOCTYPE_PUBLIC_IDENTIFIER

BETWEEN_DOCTYPE_PUBLIC_AND_SYSTEM_IDENTIFIERS

BOGUS_DOCTYPE

AFTER_DOCTYPE_SYSTEM_KEYWORD

BEFORE_DOCTYPE_SYSTEM_IDENTIFIER

DOCTYPE_SYSTEM_IDENTIFIER_DOUBLE_QUOTED

DOCTYPE_SYSTEM_IDENTIFIER_SINGLE_QUOTED

AFTER_DOCTYPE_SYSTEM_IDENTIFIER

scriptStartNdx

scriptEndNdx

scriptEndTagName

SCRIPT_DATA

SCRIPT_DATA_LESS_THAN_SIGN

SCRIPT_DATA_END_TAG_OPEN

SCRIPT_DATA_END_TAG_NAME

scriptEscape

xmlDeclaration

text

textLen

attrStartNdx

attrEndNdx

state

emitStrings