net.java.textilej.parser.Locator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of textile-j

The newest version!

package net.java.textilej.parser;

/**
 * An interface that provides information about the location of the current parser activity.
 * Note that parsers may make a best-effort attempt at determining the location.
 * 
 * @author dgreen
 */
public interface Locator {
	/**
	 * get the 1-based number of the current line.
	 * 
	 * @return the line number or -1 if unknown
	 */
	public int getLineNumber();
	
	/**
	 * get the 0-based character offset of the current line from the start of the document
	 * 
	 * @return the offset or -1 if unknown
	 */
	public int getLineDocumentOffset();
	
	/**
	 * get the 0-based character offset of the current character from the start of the document.
	 * Equivalent to getLineDocumentOffset()+getLineCharacterOffset()
	 */
	public int getDocumentOffset();
	
	/**
	 * get the length of the current line in characters, not including the line terminator
	 */
	public int getLineLength();
	
	/**
	 * get the 0-based offset of the current character in the current line
	 */
	public int getLineCharacterOffset();
	
	/**
	 * Get the 0-based offset of the end of the current line segment being processed, exclusive.
	 * 
	 * Generally a phrase modifier starts at {@link #getLineCharacterOffset()} and ends on
	 * the character preceding this offset, [s,e) where s is the start and e is the end.
	 */
	public int getLineSegmentEndOffset();
}