Token

A bounded part of a text

(defined in /src/Token.coffee:7)

class Token

Constructor

Parameters

Name	Type	Description
`type`	String	type of text object
`index`	String	index of text object within containing text
`text`	String	string of this text

(defined in /src/Token.coffee:18)

constructor: (@type, @index, @text) ->
	# Store the text length as the length property of the text object
	@length = @text.length

Token::clone()

Create a new text object that is identical to this one

(defined in /src/Token.coffee:24)

clone: ->
	return new @constructor(@type, @index, @text)

Token::join()

Create a new Token that joins this and another Token

other (String|Token): Other text object or string

(defined in /src/Token.coffee:54)

join : (other) ->
	str = if typeof other is 'string' then other else other.text
	return new Token(@type, @index, @text + str)

Token::match(pat,flag)

Match a text object agains a pattern

Parameters

Name	Type	Description
`pat`	String	A regular expression
`flag`	String	An XRegExp flag such as `g`

(defined in /src/Token.coffee:32)

match : (pat, flags) ->
	flags or= 'x'
	XRegExp.match @text, new XRegExp(pat, flags)

Token::removeLeft([n=1])

Remove n characters from the left end (=beginning) of the text

Parameters

Name	Type	Description
`n=1`optional = 1	Number	Number of characters to remove

(defined in /src/Token.coffee:70)

removeLeft : (n) ->
	n or= 1
	return new Token(@type, @index, @text.substr(n))

Token::removeRight([n=1])

Remove n characters from the right end (=end) of the text

Parameters

Name	Type	Description
`n=1`optional = 1	Number	Number of characters to remove

(defined in /src/Token.coffee:78)

removeRight : (n) ->
	n or= 1
	max = if n < @text.length then @text.length - n else @text.length
	return new Token(@type, @index, @text.substr(0,max))

Token::replace()

Replace first occurrences of a regex

(defined in /src/Token.coffee:45)

replace : (pat, replacement) ->
	@text = XRegExp.replace @text, new XRegExp(pat), replacement
	# TODO
	return @

Token::replaceAll()

Replace all occurrences of a regex

(defined in /src/Token.coffee:38)

replaceAll : (pat, replacement) ->
	@text = XRegExp.replace @text, new XRegExp(pat), replacement, 'all'
	# TODO
	return @

Token::substr()

String.substr-like substring allowing negative indexes

(defined in /src/Token.coffee:60)

substr : (start, len) ->
	if start < 0
		start = @text.length + start
	len or= @text.length - start
	return @text.substr(start, len)