Rena.action

method

Parameters

Name	Type	Description
action	Object	action an action

Return

Type	Description
Rena	this instance

execute the given action and sets the return value as the attribute.

Rena.action

static method

Parameters

Name	Type	Description
action	Object	action an action

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().action()'.

Rena.atLeast

method

Parameters

Name	Type	Description
count	Number	count minimum of repetation
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns at least the given count.
This instance cannot chain matching after this call except br() and isEnd().

Rena.atLeast

static method

Parameters

Name	Type	Description
count	Number	count minimum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenAtLeast()'.

Rena.atLeastArray

method

Parameters

Name	Type	Description
count	Number	count minimum of repetation
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

repeats the given patterns at least the given count with accumlating an attribute into array.
This instance cannot chain matching after this call except br() and isEnd().

Rena.atLeastArray

static method

Parameters

Name	Type	Description
count	Number	count minimum of repetation
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().atLeastArray()'.

Rena.atMost

method

Parameters

Name	Type	Description
count	Number	count maximum of repetation
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns at most the given count.
This instance cannot chain matching after this call except br() and isEnd().

Rena.atMost

static method

Parameters

Name	Type	Description
count	Number	count maximum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenAtMost()'.

Rena.atMostArray

method

Parameters

Name	Type	Description
count	Number	count maximum of repetation
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

repeats the given patterns at most the given count with accumlating an attribute into array.
This instance cannot chain matching after this call except br() and isEnd().

Rena.atMostArray

static method

a shortcut for 'Rena().atMostArray()'.

Rena.attr

method

Parameters

Name	Type	Description
attr	Object	attr an attribute

Return

Type	Description
Rena	this instance

sets the given value as the attribute.

Rena.attr

static method

Parameters

Name	Type	Description
attr	Object	attr an attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().attr()'.

Rena.br

method

Return

Type	Description
Rena	this instance

matches a newline.

Rena.br

static method

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().br()'.

Rena.cond

method

Parameters

Name	Type	Description
cond	Function	cond the condition

Return

Type	Description
Rena	this instance

matches the pattern if the given condition is truthy.

Rena.cond

static method

Parameters

Name	Type	Description
pattern	Function	cond the condition

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().cond()'.

Rena.createKey

static method

Return

Type	Description
Trie	a trie tree of keywords

creates the keywords.

Rena.delimit

method

Parameters

Name	Type	Description
delimiter	Object	delimiter a pattern of delimiter
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

matches a string which is delimited by the given string.
This instance cannot chain matching after this call except br() and isEnd().

Rena.delimit

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
delimiter	Object	delimiter a pattern of delimiter
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenDelimit()'.

Rena.delimitArray

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
delimiter	Object	delimiter a pattern of delimiter

Return

Type	Description
Rena	this instance

matches a string which is delimited by the given string with accumlating an attribute into array.
This instance cannot chain matching after this call except br() and isEnd().

Rena.delimitArray

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
delimiter	Object	delimiter a pattern of delimiter

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().delimitArray()'.

Rena.equalsId

method

Parameters

Name	Type	Description
id	String	id identifier to match

Return

Type	Description
Rena	this instance

matches the identifier.

Rena.equalsId

static method

Parameters

Name	Type	Description
id	String	id identifier to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().equalsId()'.

Rena.F

static method

a function which returns second argument.

Rena.first

static method

a function which returns first argument.

Rena.I

static method

a function which returns first argument.

Rena.ignore

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to be ignored

sets the pattern to be ignored locally.

Rena.ignoreDefault

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to be ignored
	RenaModule	this Rena module

sets the pattern to be ignored.

Rena.isEnd

method

Return

Type	Description
Rena	this instance

matches end of string

Rena.isEnd

static method

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().isEnd()'.

Rena.key

method

Parameters

Name	Type	Description
word	String	word a keyword to be matched
trie	Trie	trie a trie tree to match

Return

Type	Description
Rena	this instance

matches a keyword.

Rena.key

static method

Parameters

Name	Type	Description
word	String	word a keyword to be matched
trie	Trie	trie a trie tree to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().key()'.

Rena.letrec

static method

An alias of Rena.Yn().

Rena.lookahead

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
positive	Boolean	positive succeed when the pattern does not match if this value is falsy

Return

Type	Description
Rena	this instance

matches the pattern not consuming the string to be matched.

Rena.lookahead

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
positive	Boolean	positive succeed when the pattern does not match if this value is falsy

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().lookahead()'.

Rena.lookaheadNot

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'lookahead(pattern, false)'.

Rena.lookaheadNot

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().lookaheadNot()'.

Rena.maybe

method

Parameters

Name	Type	Description
action	Function	action an action to be invoked

Return

Type	Description
Rena	this instance

matches zero or one of the given patterns.
This instance cannot chain matching after this call except br() and isEnd().

Rena.maybe

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenMaybe()'.

Rena.notKey

method

Parameters

Name	Type	Description
trie	Trie	trie a trie tree to match

Return

Type	Description
Rena	this instance

checks whether any keywords are not matched.

Rena.notKey

static method

Parameters

Name	Type	Description
trie	Trie	trie a trie tree to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().notKey()'.

Rena.oneOrMore

method

Parameters

Name	Type	Description
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

a shortcut of 'atLeast(1, pattern, action, init)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.oneOrMore

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenOneOrMore()'.

Rena.oneOrMoreArray

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'atLeastArray(1, pattern)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.oneOrMoreArray

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().oneOrMoreArray()'.

Rena.or

method

Return

Type	Description
Rena	this instance

matches one of the given patterns.

Rena.or

static method

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().or()'.

Rena.parse

method

Parameters

Name	Type	Description
str	String	str a string to be parsed
attribute	Object	attribute an initial attribute

parses the given string entirely.

Rena.parsePart

method

Parameters

Name	Type	Description
str	String	str a string to be parsed
attribute	Object	attribute an initial attribute

parses the given string partially.

Rena.parsePartGlobal

method

Parameters

Name	Type	Description
str	String	str a string to be parsed
init	Object	init an initial attribute
action	Function	action a function to accumlate attributes

Return

Type	Description
Object	accumlated attribute

parses the given string continuously.

Rena.parsePartGlobalArray

method

Parameters

Name	Type	Description
str	String	str a string to be parsed

Return

Type	Description
Object	array of accumlated attribute

parses the given string continuously and accumlate to an array.

Rena.parseStart

method

Parameters

Name	Type	Description
str	String	str a string to be parsed
index	Number	index an index to start
attribute	Object	attribute an initial attribute

parses the given string from the given index.

Rena.passAll

method

Return

Type	Description
Rena	this instance

ignores all action after this.

Rena.passAll

static method

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().passAll()'.

Rena.real

method

Parameters

Name	Type	Description
signum	Boolean	signum matches sign if signum is true

Return

Type	Description
Rean	this instance

matches a float number and sets the number as an attribute.

Rena.real

static method

Parameters

Name	Type	Description
signum	Boolean	signum matches sign if signum is true

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().real()'.

Rena.second

static method

a function which returns second argument.

Rena.setKey

static method

sets the keywords.

Rena.SK

static method

a function which returns second argument.

Rena.t

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	this instance

a shortcut of 'then'.

Rena.t

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().t()'.

Rena.then

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	this instance

matches to the pattern simply.
A simple string, a regular expression, a function or a Rena object can be specified as a pattern.
The matching function must have two arguments, first argument is the string to match and second argument is the position to match, and return an object if it matches or null if it does not match.
The object to be returned has two properties, one of this is the matched string which named "match", another is the matched last position which named "lastMatch".
The given action will be called back with two or three arguments, first argument is the matched string, second argument is the inherited attribute, third argument is the synthesized attribute.

Rena.then

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().then()'.

Rena.thenAtLeast

method

Parameters

Name	Type	Description
count	Number	count minimum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns at least the given count.
This instance cannot chain matching after this call except br() and isEnd().

Rena.thenAtMost

method

Parameters

Name	Type	Description
count	Number	count maximum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns at most the given count.
This instance cannot chain matching after this call except br() and isEnd().

Rena.thenDelimit

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
delimiter	Object	delimiter a pattern of delimiter
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

matches a string which is delimited by the given string.
This instance cannot chain matching after this call except br() and isEnd().

Rena.thenFloat

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'then(pattern, function(x) { return parseFloat(x); })'.

Rena.thenFloat

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenFloat()'.

Rena.thenInt

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'then(pattern, function(x) { return parseInt(x); })'.

Rena.thenInt

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenInt()'.

Rena.thenMaybe

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked

Return

Type	Description
Rena	this instance

matches zero or one of the given patterns.
This instance cannot chain matching after this call except br() and isEnd().

Rena.thenOneOrMore

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

a shortcut of 'atLeast(1, pattern, action, init)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.thenPass

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'then(pattern, Rena.pass)'.

Rena.thenPass

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenPass()'.

Rena.thenTimes

method

Parameters

Name	Type	Description
countmin	Number	countmin minimum of repetation
countmax	Number	countmax maximum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns to the given count.
This instance cannot chain matching after this call except br() and isEnd().
The given action will be called back with three arguments,
first argument is the matched string, second argument is the attribute of repeating pattern, third argument is the inherited attribute.

Rena.thenZeroOrMore

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

a shortcut of 'atLeast(0, pattern, action, init)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.times

method

Parameters

Name	Type	Description
countmin	Number	countmin minimum of repetation
countmax	Number	countmax maximum of repetation
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

repeats the given patterns to the given count.
This instance cannot chain matching after this call except br() and isEnd().
The given action will be called back with three arguments, first argument is the matched string, second argument is the attribute of repeating pattern, third argument is the inherited attribute.

Rena.times

static method

Parameters

Name	Type	Description
countmin	Number	countmin minimum of repetation
countmax	Number	countmax maximum of repetation
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenTimes()'.

Rena.timesArray

method

Parameters

Name	Type	Description
countmin	Number	countmin minimum of repetation
countmax	Number	countmax maximum of repetation
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

repeats the given patterns to the given count with accumlating an attribute into array.
This instance cannot chain matching after this call except br() and isEnd().

Rena.timesArray

static method

Parameters

Name	Type	Description
countmin	Number	countmin minimum of repetation
countmax	Number	countmax maximum of repetation
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().timesArray()'.

Rena.Y

static method

a fixed point combinator.

Rena.Yn

static method

a multiple fixed point combinator.
http://okmij.org/ftp/Computation/fixed-point-combinators.html

Rena.zeroOrMore

method

Parameters

Name	Type	Description
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	this instance

a shortcut of 'atLeast(0, pattern, action, init)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.zeroOrMore

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match
action	Function	action an action to be invoked
init	Object	init an initial attribute

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().thenZeroOrMore()'.

Rena.zeroOrMoreArray

method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	this instance

a shortcut of 'atLeastArray(0, pattern)'.
This instance cannot chain matching after this call except br() and isEnd().

Rena.zeroOrMoreArray

static method

Parameters

Name	Type	Description
pattern	Object	pattern a pattern to match

Return

Type	Description
Rena	new instance

a shortcut for 'Rena().zeroOrMoreArray()'.