- Loop
Array#Loop(timeout, times) ⇒
Object - AddRule(rule, oscdir, callback, opts)
Adds Rules for posterior execution or execution when the Editor changes.
- RemoveRule(rule)
Removes a rule.
- Range(start, end, callback) ⇒
Object function for working with text in ranges.
- Parse(rule, oscdir, callback, opts) ⇒
Array.<Object> Parses Regex patterns, if matches sends OSC messages.
- Parse
String#Parse(oscdir, callback, opts) ⇒
Array.<Object> - Parse
RegExp#Parse(oscdir, callback, opts) ⇒
Array.<Object> - Loop(timeout, sequence, times) ⇒
Object Loop function implementation, the loops are being declared with the exact sequence.
- Tinalla
Tinalla main mother object.
Array#Loop(timeout, times) ⇒ Object
Kind: global function
Returns: Object - - Object of functions for loop control.
| Param | Type | Default | Description |
|---|---|---|---|
| timeout | Int | Array.<Int> |
time delay, if the timeout changes while being played, the loop will change its timeout. | |
| times | Int | String |
"inf" |
times that the loop should be executed (not implemented yet). |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
resulting object |
| res.play | function |
play function for the loop, returns a loop object. |
| res.stop | function |
stops the loop. |
Adds Rules for posterior execution or execution when the Editor changes.
Kind: global function
| Param | Type | Default | Description |
|---|---|---|---|
| rule | RegExp | String | Object |
Regex Pattern, XRegExp is used here. | |
| rule.pat | RegExp | String |
regex Pattern | |
| rule.flags | String |
regex flags | |
| oscdir | String |
"/tinalla" |
OSC Address. |
| callback | function |
function that executes when the pattern matches, the function receives an array of the matches. | |
| opts | Object |
options object. | |
| opts.ip | String |
ip of OSC Server. | |
| opts.port | Int |
port of OSC Server. | |
| opts.start | Object |
starting position of text, in the Codemirror format. | |
| opts.start.line | Int |
0 |
line position number. |
| opts.start.ch | Int |
0 |
character position number. |
| opts.end | Object |
ending position of text, in the Codemirror format. | |
| opts.end.line | Int |
TextEditor.LineCount() |
line position number. |
| opts.end.ch | Int |
character position number. | |
| opts.onchange | Bool |
false |
parse when the text editor changes. |
| opts.iterable | Bool |
false |
calls the callback function per match, the function receives a res object instead of an array of matches. |
Removes a rule.
Kind: global function
| Param | Type | Description |
|---|---|---|
| rule | String |
Rule to be removed. |
function for working with text in ranges.
Kind: global function
Returns: Object - Object of functions.
| Param | Type | Default | Description |
|---|---|---|---|
| start | Int | Object |
start of range. | |
| start.line | Int |
0 |
line position number. |
| start.ch | Int |
0 |
character position number. |
| end | Int |
ending line number of range. | |
| end.line | Int |
TextEditor.LineCount() |
line position number. |
| end.ch | Int |
character position number. | |
| callback | function |
function that executes when the pattern matches, the function receives an array of the matches. |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
res result. |
| res.Parse | function |
Parse function into text range. |
| res.AddRule | function |
AddRule function into text range. |
Parses Regex patterns, if matches sends OSC messages.
Kind: global function
Returns: Array.<Object> - Array of matches
| Param | Type | Default | Description |
|---|---|---|---|
| rule | RegExp | String | Object |
Regex Pattern, XRegExp is used here. | |
| rule.pat | RegExp | String |
regex Pattern | |
| rule.flags | String |
regex flags | |
| oscdir | String |
"/tinalla" |
OSC Address. |
| callback | function |
function that executes when the pattern matches, the function receives an array of the matches. | |
| opts | Object |
options object. | |
| opts.ip | String |
ip of OSC Server. | |
| opts.port | Int |
port of OSC Server. | |
| opts.start | Object |
starting position of text, in the Codemirror format. | |
| opts.start.line | Int |
0 |
line position number. |
| opts.start.ch | Int |
0 |
character position number. |
| opts.end | Object |
ending position of text, in the Codemirror format. | |
| opts.end.line | Int |
TextEditor.LineCount() |
line position number. |
| opts.end.ch | Int |
character position number. | |
| opts.onchange | Bool |
false |
parse when the text editor changes. |
| opts.iterable | Bool |
false |
calls the callback function per match, the function receives a res object instead of an array of matches. |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
match result. |
| res.start | Object |
starting position of match, in the Codemirror format. |
| res.start.line | Int |
line position number. |
| res.start.ch | Int |
character position number. |
| res.end.line | Int |
line position number. |
| res.end.ch | Int |
character position number. |
| res.res | String |
string match result. |
| res.raw | Array |
resulting array in the XRegExp format. |
String#Parse(oscdir, callback, opts) ⇒ Array.<Object>
Kind: global function
Returns: Array.<Object> - Array of matches
| Param | Type | Default | Description |
|---|---|---|---|
| oscdir | String |
"/tinalla" |
OSC Address. |
| callback | function |
function that executes when the pattern matches, the function receives an array of the matches. | |
| opts | Object |
options object. | |
| opts.ip | String |
ip of OSC Server. | |
| opts.port | Int |
port of OSC Server. | |
| opts.start | Object |
starting position of text, in the Codemirror format. | |
| opts.start.line | Int |
0 |
line position number. |
| opts.start.ch | Int |
0 |
character position number. |
| opts.end | Object |
ending position of text, in the Codemirror format. | |
| opts.end.line | Int |
TextEditor.LineCount() |
line position number. |
| opts.end.ch | Int |
character position number. | |
| opts.onchange | Bool |
false |
parse when the text editor changes. |
| opts.iterable | Bool |
false |
calls the callback function per match, the function receives a res object instead of an array of matches. |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
match result. |
| res.start | Object |
starting position of match, in the Codemirror format. |
| res.start.line | Int |
line position number. |
| res.start.ch | Int |
character position number. |
| res.end.line | Int |
line position number. |
| res.end.ch | Int |
character position number. |
| res.res | String |
string match result. |
| res.raw | Array |
resulting array in the XRegExp format. |
RegExp#Parse(oscdir, callback, opts) ⇒ Array.<Object>
Kind: global function
Returns: Array.<Object> - Array of matches
| Param | Type | Default | Description |
|---|---|---|---|
| oscdir | String |
"/tinalla" |
OSC Address. |
| callback | function |
function that executes when the pattern matches, the function receives an array of the matches. | |
| opts | Object |
options object. | |
| opts.ip | String |
ip of OSC Server. | |
| opts.port | Int |
port of OSC Server. | |
| opts.start | Object |
starting position of text, in the Codemirror format. | |
| opts.start.line | Int |
0 |
line position number. |
| opts.start.ch | Int |
0 |
character position number. |
| opts.end | Object |
ending position of text, in the Codemirror format. | |
| opts.end.line | Int |
TextEditor.LineCount() |
line position number. |
| opts.end.ch | Int |
character position number. | |
| opts.onchange | Bool |
false |
parse when the text editor changes. |
| opts.iterable | Bool |
false |
calls the callback function per match, the function receives a res object instead of an array of matches. |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
match result. |
| res.start | Object |
starting position of match, in the Codemirror format. |
| res.start.line | Int |
line position number. |
| res.start.ch | Int |
character position number. |
| res.end.line | Int |
line position number. |
| res.end.ch | Int |
character position number. |
| res.res | String |
string match result. |
| res.raw | Array |
resulting array in the XRegExp format. |
Loop function implementation, the loops are being declared with the exact sequence.
Kind: global function
Returns: Object - - Object of functions for loop control.
| Param | Type | Default | Description |
|---|---|---|---|
| timeout | Int | Array.<Int> |
time delay, if the timeout changes while being played, the loop will change its timeout. | |
| sequence | Array.<function()> |
Array of functions to be executed, the exact sequence will define the loop, if the sequence changes, this will create another different loop. | |
| times | Int | String |
"inf" |
times that the loop should be executed (not implemented yet). |
Properties
| Name | Type | Description |
|---|---|---|
| res | Object |
resulting object |
| res.play | function |
play function for the loop, returns a loop object. |
| res.stop | function |
stops the loop. |
Tinalla main mother object.
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| Tinalla.loops | Proxy |
contains a reference of each loop created. |
| Tinalla.rules | Proxy |
contains a reference of each regex rule created. |