Group (Farkle)

Group Type

Namespace: Farkle.Builder
Assembly: Farkle.dll
Base Type: obj

A helper static class to create groups. Groups are used to define lexical elements that start and end with specified literals, and contain arbitrary characters. Groups are a tokenizer's construct, and their content is considered to be a terminal by the parser. Comments are essentially groups, but this class creates groups that have significant content.

Static members

Static member	Description
`Group.Block(name, groupStart, groupEnd)` Full Usage: `Group.Block(name, groupStart, groupEnd)` Parameters: name : `string` - The group's name. groupStart : `string` - The sequence of characters that specify the beginning of the group. groupEnd : `string` - The sequence of characters that specify the end of the group. Returns: `DesigntimeFarkle`	Creates a line group that does not contain any significant information for the parsing application. name : `string` The group's name. groupStart : `string` The sequence of characters that specify the beginning of the group. groupEnd : `string` The sequence of characters that specify the end of the group. Returns: `DesigntimeFarkle`
`Group.Block(name, groupStart, groupEnd, fTransform)` Full Usage: `Group.Block(name, groupStart, groupEnd, fTransform)` Parameters: name : `string` - The group's name. groupStart : `string` - The sequence of characters that specify the beginning of the group. groupEnd : `string` - The sequence of characters that specify the end of the group. fTransform : `T<'T>` - The function that transforms the group's position and data to . Must not be null. The given position is the position where groupStart starts and the group's data do include groupEnd. Returns: `DesigntimeFarkle<'T>`	Creates a block group. Block groups end with a string literal. name : `string` The group's name. groupStart : `string` The sequence of characters that specify the beginning of the group. groupEnd : `string` The sequence of characters that specify the end of the group. fTransform : `T<'T>` The function that transforms the group's position and data to . Must not be null. The given position is the position where groupStart starts and the group's data do include groupEnd. Returns: `DesigntimeFarkle<'T>`
`Group.Line(name, groupStart)` Full Usage: `Group.Line(name, groupStart)` Parameters: name : `string` - The group's name. groupStart : `string` - The sequence of characters that specify the beginning of the group. Returns: `DesigntimeFarkle`	Creates a line group that does not contain any significant information for the parsing application. name : `string` The group's name. groupStart : `string` The sequence of characters that specify the beginning of the group. Returns: `DesigntimeFarkle`
`Group.Line(name, groupStart, fTransform)` Full Usage: `Group.Line(name, groupStart, fTransform)` Parameters: name : `string` - The group's name. groupStart : `string` - The sequence of characters that specify the beginning of the group. fTransform : `T<'T>` - The function that transforms the group's position and data to . Must not be null. The given position is the position where groupStart starts and the group's data do not include the new line that end it. Returns: `DesigntimeFarkle<'T>`	Creates a line group. As the name says, it ends with a new line. name : `string` The group's name. groupStart : `string` The sequence of characters that specify the beginning of the group. fTransform : `T<'T>` The function that transforms the group's position and data to . Must not be null. The given position is the position where groupStart starts and the group's data do not include the new line that end it. Returns: `DesigntimeFarkle<'T>`