org.gramar.ast

Class SourceRegion

java.lang.Object

org.gramar.ast.SourceRegion

public class SourceRegion
extends Object

A SourceRegion represents a substring of a template's source. When the parser parses a template, the parser produces an array of SourceRegions which together represent the entire template source. The information within a SourceRegion is consumed by compression and DOM construction. It is also intended to be used by colorization logic in template editors

Author:

chrisgerken

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_COMMENT
static int	TYPE_DIRECTIVE
static int	TYPE_EMPTY_TAG
static int	TYPE_END_TAG
static int	TYPE_TAG
static int	TYPE_TEXT

Constructor Summary

Constructors

Constructor and Description
SourceRegion(String content, int start, int end, int type)

Method Summary

Methods

Modifier and Type	Method and Description
SourceRegion	append(SourceRegion sr)
boolean	closes(SourceRegion region)
boolean	firstLineEntirelyWhitespace()
HashMap<String,String>	getAttributes()
String	getContent()
int	getEnd()
int	getStart()
TagInfo	getTagInfo()
int	getType()
boolean	isComment()
boolean	isControlTag()
boolean	isDirective()
boolean	isEmptyTag()
boolean	isEndTag()
boolean	isTag()
boolean	isText()
boolean	lastLineEntirelyWhitespace()
void	setStart(int linenum, int col)
void	setTagInfo(TagInfo tagInfo)
String	toString()
void	truncateLeadingWhitespace()
void	truncateTrailingWhitespace()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_TEXT

public static int TYPE_TEXT

TYPE_TAG

public static int TYPE_TAG

TYPE_END_TAG

public static int TYPE_END_TAG

TYPE_EMPTY_TAG

public static int TYPE_EMPTY_TAG

TYPE_DIRECTIVE

public static int TYPE_DIRECTIVE

TYPE_COMMENT

public static int TYPE_COMMENT

Constructor Detail

SourceRegion

public SourceRegion(String content,
            int start,
            int end,
            int type)

Method Detail

getContent

public String getContent()

getStart

public int getStart()

getEnd

public int getEnd()

getType

public int getType()

setStart

public void setStart(int linenum,
            int col)

toString

public String toString()

Overrides:

toString in class Object

getAttributes

public HashMap<String,String> getAttributes()
                                     throws IllFormedTemplateException

Throws:

IllFormedTemplateException

isText

public boolean isText()

isTag

public boolean isTag()

isEndTag

public boolean isEndTag()

isEmptyTag

public boolean isEmptyTag()

isDirective

public boolean isDirective()

isComment

public boolean isComment()

closes

public boolean closes(SourceRegion region)

append

public SourceRegion append(SourceRegion sr)

getTagInfo

public TagInfo getTagInfo()

setTagInfo

public void setTagInfo(TagInfo tagInfo)

firstLineEntirelyWhitespace

public boolean firstLineEntirelyWhitespace()

lastLineEntirelyWhitespace

public boolean lastLineEntirelyWhitespace()

isControlTag

public boolean isControlTag()

truncateTrailingWhitespace

public void truncateTrailingWhitespace()

truncateLeadingWhitespace

public void truncateLeadingWhitespace()