com.aptana.ide.editor.scriptdoc.parsing
Class ScriptDocParser

java.lang.Object
  com.aptana.ide.parsing.AbstractParser
      com.aptana.ide.editors.unified.parsing.AbstractUnifiedParser
          com.aptana.ide.editor.scriptdoc.parsing.ScriptDocParser

All Implemented Interfaces:

IParser

public class ScriptDocParser
extends AbstractUnifiedParser

Author:

Robin Debreuil

Field Summary

Fields inherited from class com.aptana.ide.parsing.AbstractParser

currentLexeme, EOS

Constructor Summary

ScriptDocParser()
Parses ScriptDoc comments, converting them to IDocumentation objects.

Method Summary

protected void	advance() Advance to the next lexeme in the lexeme stream
protected ITokenList	createLanguageTokenList() createLanguageTokenList
IParseState	createParseState(IParseState parent) Create a single parse state for this language.
protected Lexeme	getNextLexemeInLanguage() getNextLexemeInLanguage
FunctionDocumentation	getParsedObject() Returns the last parsed Object
void	initializeLexer() Perform any initializations on the lexer now that it has been created
void	parseAll(IParseNode parentNode) parseOneStatement
void	setSource(java.lang.String source) Set the source code to parse
protected void	throwParseError(java.lang.String message) Throw a parse exception

Methods inherited from class com.aptana.ide.editors.unified.parsing.AbstractUnifiedParser

addLexerGrammar

Methods inherited from class com.aptana.ide.parsing.AbstractParser

addChildParser, addChildParsers, addGrammars, addLexeme, assertAndAdvance, assertInSet, assertType, changeLanguage, flushCache, getEndingOffset, getLanguage, getLanguageChangeListener, getLexemeList, getLexer, getParseNodeFactory, getParserForMimeType, getParseState, hasParent, initializeLexers, inSet, isEOS, isType, parse, removeLexeme, setLanguageChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

ScriptDocParser

public ScriptDocParser()
                throws ParserInitializationException

Parses ScriptDoc comments, converting them to IDocumentation objects.

Throws:

ParserInitializationException

Method Detail

createLanguageTokenList

protected ITokenList createLanguageTokenList()

Description copied from class: AbstractParser

createLanguageTokenList

Specified by:

createLanguageTokenList in class AbstractParser

Returns:

ITokenList

See Also:

AbstractParser.createLanguageTokenList()

createParseState

public IParseState createParseState(IParseState parent)

Description copied from interface: IParser

Create a single parse state for this language. Note that sub-language parse states will be included in the returned parse state

Specified by:

createParseState in interface IParser

Specified by:

createParseState in class AbstractParser

Returns:

IParseState

See Also:

AbstractParser.createParseState(com.aptana.ide.parsing.IParseState)

parseAll

public void parseAll(IParseNode parentNode)
              throws LexerException

Description copied from class: AbstractParser

parseOneStatement

Specified by:

parseAll in interface IParser

Specified by:

parseAll in class AbstractParser

Throws:

LexerException

See Also:

AbstractParser.parseAll(com.aptana.ide.parsing.nodes.IParseNode)

initializeLexer

public void initializeLexer()
                     throws LexerException

Description copied from class: AbstractParser

Perform any initializations on the lexer now that it has been created

Specified by:

initializeLexer in interface IParser

Specified by:

initializeLexer in class AbstractParser

Throws:

LexerException

See Also:

AbstractParser.initializeLexer()

getParsedObject

public FunctionDocumentation getParsedObject()

Returns the last parsed Object

Returns:

Returns the last parsed Object

setSource

public void setSource(java.lang.String source)

Set the source code to parse

Parameters:

source - The source of this Documentation.

advance

protected void advance()
                throws LexerException

Advance to the next lexeme in the lexeme stream

Overrides:

advance in class AbstractParser

Throws:

LexerException

getNextLexemeInLanguage

protected Lexeme getNextLexemeInLanguage()
                                  throws LexerException

Description copied from class: AbstractParser

getNextLexemeInLanguage

Overrides:

getNextLexemeInLanguage in class AbstractParser

Returns:

Lexeme

Throws:

LexerException

See Also:

AbstractParser.getNextLexemeInLanguage()

throwParseError

protected void throwParseError(java.lang.String message)
                        throws java.text.ParseException

Throw a parse exception

Overrides:

throwParseError in class AbstractParser

Parameters:

message - The exception message

Throws:

java.text.ParseException