| java.lang.Object
 org.makumba.analyser.engine.SyntaxPoint
| SyntaxPoint | | abstract public class SyntaxPoint implements Comparable(Code) | | Keeps track of important points in a file. Syntax points are typically stored in a sorted set, and used for syntax
colouring. A syntax colourer would load the file, then go through the syntax points and change the coloring context
at each syntax point. This is an abstract class, but can be easily instantiated with an anonymous inner class like
this: SyntaxPoint comment=new SyntaxPoint(position) { public String getType(){ return "JSPcomment";}};
idea: the class can also find identifiers in the text and ask the owners of other enclosing syntax points (or the
owner of the whole text info) if they can account for them. For example in the case of a makumba JSP, a LIST tag can
account for a OQL label, an MDD field, a MDD name or a $attribute). If yes, syntax points are produced by the
respective entity, and presented in different colours or as links
idea: a syntax point walker that goes through a text and invokes methods of a syntax colourer like beginText(),
beginJSPComment, endJspComment, beginTag... etc
author:
Cristian Bogdan
version:
$Id: SyntaxPoint.java 1600 2007-09-17 17:06:30Z manuel_gay $ |
| Inner Class :public static class End extends SyntaxPoint | |
| begin | | boolean begin(Code) | | Is this point a begin or an end of something (where applicable)
|
| column | | int column(Code) | | Redundant but useful data: column of the position in the text
|
| line | | int line(Code) | | Redundant but useful data: line of the position in the text
|
| offset | | int offset(Code) | | The offset sufferred due to includes
|
| position | | int position(Code) | | The position in the file
|
| SyntaxPoint | | public SyntaxPoint(int position, boolean begin)(Code) | | Default constructor
Parameters:
position - the position of this SyntaxPoint
Parameters:
begin - is this SyntaxPoint the beginning |
| SyntaxPoint | | public SyntaxPoint(int position)(Code) | | Simpler constructor
|
| compareTo | | public int compareTo(Object o)(Code) | | Compares two objects, for sorting in the syntaxPoints collection
Parameters:
o - object to be compared with -1 if this is before, 1 if after |
| equals | | public boolean equals(Object o)(Code) | | Performs a simple comparison, for hashing reasons
Parameters:
o - the object to be compared with true if the two objects are equal, false otherwise |
| getColumn | | public int getColumn()(Code) | | Gets the column number in the file
the column number in the file |
| getIncludeOffset | | public int getIncludeOffset()(Code) | | Gets the offset by which this SyntaxPoint has moved from the original position due to includes
the offset caused by inclusions |
| getLine | | public int getLine()(Code) | | Gets the line number in the file
|
| getOriginalColumn | | public int getOriginalColumn(int lineLength)(Code) | | This is a temporary workaround for '@included' files not having their syntaxpoints & offsets detected correctly.
Parameters:
lineLength - the length of the line the correct column |
| getOriginalPosition | | public int getOriginalPosition()(Code) | | |
| getOtherInfo | | public Object getOtherInfo()(Code) | | Additional information which can be returned by subclasses
|
| getPosition | | public int getPosition()(Code) | | Gets the position in the file
the position in the file |
| getType | | abstract public String getType()(Code) | | The type of this point, will be defined by the subclass
|
| hashCode | | public int hashCode()(Code) | | Generates the hashcode of the SyntaxPoint
The computed hashcode |
| isBegin | | public boolean isBegin()(Code) | | Checks whether this this point is the beginning of the end of something. Ends are stored one position after the
last character of the entity so substring() works right away
true if this is a beginning, false otherwise |
| makeEnd | | public static SyntaxPoint makeEnd(SyntaxPoint begin, int position)(Code) | | Makes an end for a given syntax point
Parameters:
begin - the begin SyntaxPoint
Parameters:
position - the position of the end |
| moveByInclude | | void moveByInclude(int delta)(Code) | | Adjusts the offset and position at inclusion of a file
Parameters:
delta - the length of the included file |
| toString | | public String toString()(Code) | | Prints the position and type of the SyntaxPoint, for debugging
A String that can be used for debugging |
|
|