Class Indentation

java.lang.Object

org.jparsec.Indentation

public final class Indentation
extends Object

Processes indentation based lexical structure according to the Off-side rule.

Author:

Ben Yu

Field Summary

Fields

Modifier and Type	Field	Description
static final Parser<Void>	WHITESPACES	A Parser that recognizes 1 or more whitespace characters on the same line.

Constructor Summary

Constructors

Constructor	Description
Indentation()	Creates a Indentation object that generates default indent and outdent tokens.
Indentation(Object indent, Object outdent)	Creates an Indentation object that uses indent and outdent as the token values for indentation and outdentation.

Method Summary

Modifier and Type	Method	Description
Parser<Token>	indent()	A Parser that recognizes the generated indent token.
Parser<List<Token>>	lexer(Parser<?> tokenizer, Parser<?> delim)	A Parser that greedily runs tokenizer, and translates line feed characters ('\n') to indent and outdent tokens.
Parser<Token>	outdent()	A Parser that recognizes the generated outdent token.

Methods inherited from class Object

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

Field Details

WHITESPACES

public static final Parser<Void> WHITESPACES

A Parser that recognizes 1 or more whitespace characters on the same line. Line continutation (escaped by a backslash character '\') is considered the same line.

Constructor Details

Indentation

public Indentation(Object indent,
 Object outdent)

Creates an Indentation object that uses indent and outdent as the token values for indentation and outdentation.

Indentation

public Indentation()

Creates a Indentation object that generates default indent and outdent tokens.

Method Details

indent

public Parser<Token> indent()

A Parser that recognizes the generated indent token.

outdent

public Parser<Token> outdent()

A Parser that recognizes the generated outdent token.

lexer

public Parser<List<Token>> lexer(Parser<?> tokenizer,
 Parser<?> delim)

A Parser that greedily runs tokenizer, and translates line feed characters ('\n') to indent and outdent tokens. Return values are wrapped in Token objects and collected in a List. Patterns recognized by delim are ignored.