de.uka.ilkd.key.java

Interface SourceElement

All Superinterfaces:

SVSubstitute

All Known Subinterfaces:

AbstractProgramElement, Branch, ConstructorReference, Declaration, Expression, ExpressionContainer, ExpressionStatement, IExecutionContext, IForUpdates, IGuard, ILoopInit, IProgramMethod, IProgramVariable, Label, LoopInitializer, MemberDeclaration, MemberReference, MethodName, MethodOrConstructorReference, NamedProgramElement, NameReference, NonTerminalProgramElement, PackageReferenceContainer, ParameterContainer, ProgramConstruct, ProgramElement, ProgramPrefix, ProgramVariableName, Reference, ReferencePrefix, ReferenceSuffix, ScopeDefiningElement, Statement, StatementContainer, TerminalProgramElement, TypeDeclarationContainer, TypeReference, TypeReferenceContainer, TypeReferenceInfix, TypeScope, VariableScope

All Known Implementing Classes:

Abstract, AbstractIntegerLiteral, AllFields, AllObjects, AnnotationUseSpecification, ArrayDeclaration, ArrayInitializer, ArrayLength, ArrayLengthReference, ArrayPostDecl, ArrayReference, Assert, Assignment, BinaryAnd, BinaryAndAssignment, BinaryNot, BinaryOperator, BinaryOr, BinaryOrAssignment, BinaryXOr, BinaryXOrAssignment, BooleanLiteral, BranchImp, BranchStatement, Break, Case, Catch, CatchAllStatement, CharLiteral, ClassDeclaration, ClassInitializer, Comment, ComparativeOperator, CompilationUnit, Conditional, ConstructorCall, ConstructorDeclaration, ContextStatementBlock, Continue, CopyAssignment, CreateObject, Default, Divide, DivideAssignment, DLEmbeddedExpression, Do, DoBreak, DoubleLiteral, Else, EmptyMapLiteral, EmptySeqLiteral, EmptySetLiteral, EmptyStatement, EnhancedFor, EnhancedForElimination, EnumClassDeclaration, Equals, EvaluateArgs, ExactInstanceof, ExecutionContext, ExpandMethodBody, ExpressionJumpStatement, Extends, FieldDeclaration, FieldReference, FieldSpecification, Final, Finally, FloatLiteral, For, ForInitUnfoldTransformer, ForToWhile, ForUpdates, FreeLiteral, Ghost, GreaterOrEquals, GreaterThan, Guard, If, Implements, ImplicitFieldSpecification, Import, InheritanceSpecification, InitArray, InitArrayCreation, Instanceof, InterfaceDeclaration, Intersect, IntLiteral, IsStatic, JavaDeclaration, JavaNonTerminalProgramElement, JavaProgramElement, JavaSourceElement, JavaStatement, JumpStatement, LabeledStatement, LabelJumpStatement, LessOrEquals, LessThan, Literal, LocalVariableDeclaration, LocationVariable, LogicalAnd, LogicalNot, LogicalOr, LongLiteral, LoopInit, LoopScopeBlock, LoopStatement, MergePointStatement, MetaClassReference, MethodBodyStatement, MethodCall, MethodDeclaration, MethodFrame, MethodReference, Minus, MinusAssignment, Model, Modifier, Modulo, ModuloAssignment, MultipleVarDecl, Native, Negative, New, NewArray, NoState, NotEquals, NullLiteral, Operator, PackageReference, PackageSpecification, ParameterDeclaration, ParenthesizedExpression, PassiveExpression, Plus, PlusAssignment, Positive, PostDecrement, PostIncrement, PostWork, PreDecrement, PreIncrement, Private, ProgramConstant, ProgramElementName, ProgramMethod, ProgramSV, ProgramTransformer, ProgramVariable, Protected, Public, RealLiteral, Return, SchematicFieldReference, SchemaTypeReference, SeqConcat, SeqGet, SeqIndexOf, SeqLength, SeqReverse, SeqSingleton, SeqSub, SetMinus, SetUnion, ShiftLeft, ShiftLeftAssignment, ShiftRight, ShiftRightAssignment, SingleLineComment, Singleton, SpecialConstructorCall, SpecialConstructorReference, StatementBlock, Static, StaticInitialisation, StrictFp, StringLiteral, SuperArrayDeclaration, SuperConstructorReference, SuperReference, Switch, SwitchToIf, Synchronized, SynchronizedBlock, Then, ThisConstructorReference, ThisReference, Throw, Throws, Times, TimesAssignment, TransactionStatement, Transient, Try, TwoState, TypeCast, TypeDeclaration, TypeOf, TypeOperator, TypeRef, TypeReferenceImp, Unpack, UnsignedShiftRight, UnsignedShiftRightAssignment, UnwindLoop, VariableDeclaration, VariableNamer.IndProgramElementName, VariableNamer.PermIndProgramElementName, VariableNamer.TempIndProgramElementName, VariableReference, VariableSpecification, VisibilityModifier, Volatile, While

public interface SourceElement
extends SVSubstitute

A source element is a piece of syntax. It does not necessarily have a semantics, at least none that is machinable, for instance a Comment. taken from RECODER and changed to achieve an immutable structure

Method Summary

Modifier and Type	Method and Description
boolean	equalsModRenaming(SourceElement se, NameAbstractionTable nat) This method returns true if two program parts are equal modulo renaming.
Position	getEndPosition() Returns the end position of the primary token of this element.
SourceElement	getFirstElement() Finds the source element that occurs first in the source.
SourceElement	getFirstElementIncludingBlocks() Finds the source element that occurs first in the source.
SourceElement	getLastElement() Finds the source element that occurs last in the source.
PositionInfo	getPositionInfo() complete position information
Position	getRelativePosition() Returns the relative position (number of blank heading lines and columns) of the primary token of this element.
Position	getStartPosition() Returns the start position of the primary token of this element.
void	prettyPrint(PrettyPrinter w) Pretty print.
void	visit(Visitor v) calls the corresponding method of a visitor in order to perform some action/transformation on this element

Method Detail

getFirstElement

SourceElement getFirstElement()

Finds the source element that occurs first in the source.

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

getStartPosition()

getFirstElementIncludingBlocks

SourceElement getFirstElementIncludingBlocks()

Finds the source element that occurs first in the source.

Returns:

the first source element in the syntactical representation of this element, may be equals to this element.

See Also:

getStartPosition()

getLastElement

SourceElement getLastElement()

Finds the source element that occurs last in the source.

Returns:

the last source element in the syntactical representation of this element, may be equals to this element.

See Also:

getEndPosition()

getStartPosition

Position getStartPosition()

Returns the start position of the primary token of this element. To get the start position of the syntactical first token, call the corresponding method of getFirstElement().

Returns:

the start position of the primary token.

getEndPosition

Position getEndPosition()

Returns the end position of the primary token of this element. To get the end position of the syntactical first token, call the corresponding method of getLastElement().

Returns:

the end position of the primary token.

getRelativePosition

Position getRelativePosition()

Returns the relative position (number of blank heading lines and columns) of the primary token of this element. To get the relative position of the syntactical first token, call the corresponding method of getFirstElement().

Returns:

the relative position of the primary token.

getPositionInfo

PositionInfo getPositionInfo()

complete position information

visit

void visit(Visitor v)

calls the corresponding method of a visitor in order to perform some action/transformation on this element

Parameters:

v - the Visitor

prettyPrint

void prettyPrint(PrettyPrinter w)
          throws java.io.IOException

Pretty print.

Parameters:

w - a pretty printer.

Throws:

java.io.IOException - occasionally thrown.

equalsModRenaming

boolean equalsModRenaming(SourceElement se,
                          NameAbstractionTable nat)

This method returns true if two program parts are equal modulo renaming. The equality is mainly a syntactical equality with some exceptions: if a variable is declared we abstract from the name of the variable, so the first declared variable gets e.g. the name decl_1, the second declared decl_2 and so on. Look at the following programs: {int i; i=0;} and { int j; j=0;} these would be seen like {int decl_1; decl_1=0;} and {int decl_1; decl_1=0;} which are syntactical equal and therefore true is returned (same thing for labels). But {int i; i=0;} and {int j; i=0;} (in the second block the variable i is declared somewhere outside) would be seen as {int decl_1; decl_1=0;} for the first one but {int decl_1; i=0;} for the second one. These are not syntactical equal, therefore false is returned.