Pidgin

Class CommentParser

Contains functions to build parsers which skip over comments.

Inheritance
Inherited Members
Declaration
public static class CommentParser

Methods

SkipBlockComment<T, U>(Parser<char, T>, Parser<char, U>)

Creates a parser which runs blockCommentStart, then skips everything until blockCommentEnd.

Declaration
public static Parser<char, Unit> SkipBlockComment<T, U>(Parser<char, T> blockCommentStart, Parser<char, U> blockCommentEnd)
Parameters
Type Name Description

Parser<char, T>

blockCommentStart

A parser to recognise a lexeme which starts a multi-line block comment.

Parser<char, U>

blockCommentEnd

A parser to recognise a lexeme which ends a multi-line block comment.
Returns
Type Description

Parser<char, Unit>

A parser which runs blockCommentStart, then skips everything until blockCommentEnd.
Type Parameters
Name Description

T

The return type of the blockCommentStart parser.

U

The return type of the blockCommentEnd parser.

SkipLineComment<T>(Parser<char, T>)

Creates a parser which runs lineCommentStart, then skips the rest of the line.

Declaration
public static Parser<char, Unit> SkipLineComment<T>(Parser<char, T> lineCommentStart)
Parameters
Type Name Description

Parser<char, T>

lineCommentStart

A parser to recognise a lexeme which starts a line comment.
Returns
Type Description

Parser<char, Unit>

A parser which runs lineCommentStart, then skips the rest of the line.
Type Parameters
Name Description

T

The return type of the lineCommentStart parser.

SkipNestedBlockComment<T, U>(Parser<char, T>, Parser<char, U>)

Creates a parser which runs blockCommentStart, then skips everything until blockCommentEnd, accounting for nested comments.

Declaration
public static Parser<char, Unit> SkipNestedBlockComment<T, U>(Parser<char, T> blockCommentStart, Parser<char, U> blockCommentEnd)
Parameters
Type Name Description

Parser<char, T>

blockCommentStart

A parser to recognise a lexeme which starts a multi-line block comment.

Parser<char, U>

blockCommentEnd

A parser to recognise a lexeme which ends a multi-line block comment.
Returns
Type Description

Parser<char, Unit>

A parser which runs blockCommentStart, then skips everything until blockCommentEnd, accounting for nested comments.
Type Parameters
Name Description

T

The return type of the blockCommentStart parser.

U

The return type of the blockCommentEnd parser.
In This Article