org.eclipse.ocl.lpg

Class AbstractAnalyzer

java.lang.Object

org.eclipse.ocl.lpg.AbstractAnalyzer

Direct Known Subclasses:

AbstractOCLAnalyzer

public abstract class AbstractAnalyzer
extends Object

The AbstractAnalyzer supports semantic analysis of a CST produced by an AbstractParser to create a corresponding AST. It is necessary that syntactic parsing and semantic analysis are performed in two steps because LPG is a bottom up parser and cannot provide enough contextual information to create the AST on the first pass. Derived classes should extend the abstract support for AST from CST from tokens from text parsing and analysis to support the AST and CST classes appropriate to a particular language.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAnalyzer(AbstractParser parser)

Method Summary

Modifier and Type	Method and Description
String	computeInputString(CSTNode node) Obtains the text from which the specified CST node was parsed.
void	dumpTokens()
void	ERROR(List<?> problemObjects, String rule, String problemMessage)
void	ERROR(Object problemObject, String rule, String problemMessage)
void	ERROR(String problemMessage)
String	formatClass(Object object)
String	formatEClassName(EObject object)
String	formatName(Object object)
String	formatPath(List<String> pathName)
String	formatPath(List<String> pathName, String name)
String	formatQualifiedName(Object object)
String	formatString(String string)
String	formatType(Object object)
AbstractParser	getAbstractParser() Obtains the parser that I use to transform the OCL text into the Concrete Syntax Model.
int	getCharOffset()
BasicEnvironment	getEnvironment()
FormattingHelper	getFormatter() Get the message formatting assistant, returning the value set by setFormatter, if non-null, else that provided by the environment, if non-null, else AbstractFormattingHelper.INSTANCE.
AbstractLexer	getLexer()
AbstractParser	getParser() Deprecated. Since 1.3, use the getAbstractParser() method, instead.
boolean	getTraceFlag()
void	initialize(char[] buffer) Deprecated. clients should invoke reset(char[], String)
void	initialize(Reader reader) Deprecated. clients should invoke reset(Reader, String)
protected void	initPropertyPositions(CallingASTNode callingASTNode, CSTNode cstNode) Initializes the start and end positions of the property name in the specified calling AST node.
protected void	initStartEndPositions(ASTNode astNode, CSTNode cstNode) Initializes the start and end positions of the specified AST node from the given CST node
protected void	initTypePositions(TypedASTNode typedASTNode, CSTNode cstNode) Initializes the type start and end positions of the specified typed AST node from the given CST node
protected String	makeName(<any> namelist) Creates a string by joining the given string list elements with ::.
protected String	makeString(<any> namelist) Creates a string by joining the given string list elements with spaces.
void	reset(char[] buffer, String fileName) Define the input text as a given array of characters.
void	reset(Reader reader, String fileName) Define the input text by reading from a reader.
void	setCharacterOffset(int offset) Sets the character index offset of the input.
void	setFileName(String filename)
void	setTab(int tab)
void	setTraceFlag(boolean flag)
protected void	TRACE(String rule, String message)
protected void	TRACE(String rule, String message, <any> namelist)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAnalyzer

protected AbstractAnalyzer(AbstractParser parser)

Method Detail

computeInputString

public String computeInputString(CSTNode node)

Obtains the text from which the specified CST node was parsed.

Parameters:

node - a concrete syntax node

Returns:

its text

dumpTokens

public void dumpTokens()

formatClass

public String formatClass(Object object)

formatEClassName

public String formatEClassName(EObject object)

formatName

public String formatName(Object object)

formatQualifiedName

public String formatQualifiedName(Object object)

formatPath

public String formatPath(List<String> pathName)

formatPath

public String formatPath(List<String> pathName,
                         String name)

formatString

public String formatString(String string)

formatType

public String formatType(Object object)

getAbstractParser

public AbstractParser getAbstractParser()

Obtains the parser that I use to transform the OCL text into the Concrete Syntax Model.

Since:

1.3

getCharOffset

public int getCharOffset()

getEnvironment

public BasicEnvironment getEnvironment()

getFormatter

public FormattingHelper getFormatter()

Get the message formatting assistant, returning the value set by setFormatter, if non-null, else that provided by the environment, if non-null, else AbstractFormattingHelper.INSTANCE.

Returns:

A non-null message formatting helper

getLexer

public AbstractLexer getLexer()

getParser

@Deprecated
public AbstractParser getParser()

Deprecated. Since 1.3, use the getAbstractParser() method, instead.

Obtains my parser.

Returns:

my parser

getTraceFlag

public boolean getTraceFlag()

initPropertyPositions

protected void initPropertyPositions(CallingASTNode callingASTNode,
                                     CSTNode cstNode)

Initializes the start and end positions of the property name in the specified calling AST node.

Parameters:

callingASTNode - a calling AST node

cstNode - a CST node

initStartEndPositions

protected void initStartEndPositions(ASTNode astNode,
                                     CSTNode cstNode)

Initializes the start and end positions of the specified AST node from the given CST node

Parameters:

astNode - an AST node

cstNode - a CST node

initTypePositions

protected void initTypePositions(TypedASTNode typedASTNode,
                                 CSTNode cstNode)

Initializes the type start and end positions of the specified typed AST node from the given CST node

Parameters:

typedASTNode - a typed AST node

cstNode - a CST node

makeName

protected String makeName(<any> namelist)

Creates a string by joining the given string list elements with ::.

Parameters:

namelist - list of names to make string out of

Returns:

the qualified name comprising the list of name elements

makeString

protected String makeString(<any> namelist)

Creates a string by joining the given string list elements with spaces.

Parameters:

namelist - list of names to make string out of

Returns:

string representation of the list of string elements

setCharacterOffset

public void setCharacterOffset(int offset)

Sets the character index offset of the input.

Parameters:

offset -

setFileName

public void setFileName(String filename)

initialize

@Deprecated
public void initialize(char[] buffer)

Deprecated. clients should invoke reset(char[], String)

Define the input text as a given array of characters.

Parameters:

buffer - the characters

initialize

@Deprecated
public void initialize(Reader reader)
                             throws IOException

Deprecated. clients should invoke reset(Reader, String)

Define the input text by reading from a reader.

Parameters:

reader - providing the source text

Throws:

IOException - if reading fails

reset

public void reset(char[] buffer,
                  String fileName)

Define the input text as a given array of characters.

Parameters:

buffer - the characters

fileName - the associated finleName of the input, or null if none.

Since:

3.0

reset

public void reset(Reader reader,
                  String fileName)
           throws IOException

Define the input text by reading from a reader.

Parameters:

reader - providing the source text

fileName - the associated finleName of the input, or null if none.

Throws:

IOException - if reading fails

Since:

3.0

setTab

public void setTab(int tab)

setTraceFlag

public void setTraceFlag(boolean flag)

ERROR

public void ERROR(String problemMessage)

ERROR

public void ERROR(Object problemObject,
                  String rule,
                  String problemMessage)

ERROR

public void ERROR(List<?> problemObjects,
                  String rule,
                  String problemMessage)

TRACE

protected void TRACE(String rule,
                     String message)

TRACE

protected void TRACE(String rule,
                     String message,
                     <any> namelist)