Class Matcher

Inheritance
Object
Matcher
Inherited Members
Namespace: Microsoft.DocAsCode.MarkdownLite.Matchers
Assembly: Microsoft.DocAsCode.MarkdownLite.dll
Syntax
public abstract class Matcher

Fields

| Improve this Doc View Source

NotMatch

Declaration
public const int NotMatch = -1
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

AnyChar

Declaration
public static Matcher AnyChar { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

AnyStringInSingleLine

Declaration
public static Matcher AnyStringInSingleLine { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

AnyStringInSingleLineOrEmpty

Declaration
public static Matcher AnyStringInSingleLineOrEmpty { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

AnyWordCharacter

Declaration
public static Matcher AnyWordCharacter { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

Blank

Declaration
public static Matcher Blank { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

BlankCharacter

Declaration
public static Matcher BlankCharacter { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

BlankOrEmpty

Declaration
public static Matcher BlankOrEmpty { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

EndOfString

Declaration
public static Matcher EndOfString { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

NewLine

Declaration
public static Matcher NewLine { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

WhiteSpace

Declaration
public static Matcher WhiteSpace { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

WhiteSpaces

Declaration
public static Matcher WhiteSpaces { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

WhiteSpacesOrEmpty

Declaration
public static Matcher WhiteSpacesOrEmpty { get; }
Property Value
Type Description
Matcher
| Improve this Doc View Source

WordBoundary

Declaration
public static Matcher WordBoundary { get; }
Property Value
Type Description
Matcher

Methods

| Improve this Doc View Source

Any(Matcher[])

Declaration
public static Matcher Any(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher
| Improve this Doc View Source

AnyCharIn(Char[])

Declaration
public static Matcher AnyCharIn(params char[] ch)
Parameters
Type Name Description
Char[] ch
Returns
Type Description
Matcher
| Improve this Doc View Source

AnyCharInRange(Char, Char)

Declaration
public static Matcher AnyCharInRange(char start, char end)
Parameters
Type Name Description
Char start
Char end
Returns
Type Description
Matcher
| Improve this Doc View Source

AnyCharNot(Char)

Declaration
public static Matcher AnyCharNot(char ch)
Parameters
Type Name Description
Char ch
Returns
Type Description
Matcher
| Improve this Doc View Source

AnyCharNotIn(Char[])

Declaration
public static Matcher AnyCharNotIn(params char[] ch)
Parameters
Type Name Description
Char[] ch
Returns
Type Description
Matcher
| Improve this Doc View Source

BackReference(String)

Declaration
public static Matcher BackReference(string groupName)
Parameters
Type Name Description
String groupName
Returns
Type Description
Matcher
| Improve this Doc View Source

CaptureGroup(String, Matcher)

Declaration
public static Matcher CaptureGroup(string name, Matcher matcher)
Parameters
Type Name Description
String name
Matcher matcher
Returns
Type Description
Matcher
| Improve this Doc View Source

CaseInsensitiveString(String)

Declaration
public static Matcher CaseInsensitiveString(string text)
Parameters
Type Name Description
String text
Returns
Type Description
Matcher
| Improve this Doc View Source

Char(Char)

Declaration
public static Matcher Char(char ch)
Parameters
Type Name Description
Char ch
Returns
Type Description
Matcher
| Improve this Doc View Source

CompareLength(Matcher, LengthComparison, String)

Declaration
public static Matcher CompareLength(Matcher inner, LengthComparison comparsion, string groupName)
Parameters
Type Name Description
Matcher inner
LengthComparison comparsion
String groupName
Returns
Type Description
Matcher
| Improve this Doc View Source

EscapeText(String)

Declaration
protected string EscapeText(string text)
Parameters
Type Name Description
String text
Returns
Type Description
String
| Improve this Doc View Source

Match(MatchContent)

Match string in content.

Declaration
public abstract int Match(MatchContent content)
Parameters
Type Name Description
MatchContent content

The content.
Returns
Type Description
Int32

Char count of match, -1 is not match.
| Improve this Doc View Source

Maybe(Matcher)

Declaration
public static Matcher Maybe(Matcher matcher)
Parameters
Type Name Description
Matcher matcher
Returns
Type Description
Matcher
| Improve this Doc View Source

NegativeTest(Matcher[])

Declaration
public static Matcher NegativeTest(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher
| Improve this Doc View Source

Repeat(Matcher, Int32)

Declaration
public static Matcher Repeat(Matcher matcher, int minOccur)
Parameters
Type Name Description
Matcher matcher
Int32 minOccur
Returns
Type Description
Matcher
| Improve this Doc View Source

Repeat(Matcher, Int32, Int32)

Declaration
public static Matcher Repeat(Matcher matcher, int minOccur, int maxOccur)
Parameters
Type Name Description
Matcher matcher
Int32 minOccur
Int32 maxOccur
Returns
Type Description
Matcher
| Improve this Doc View Source

ReverseNegativeTest(Matcher[])

Declaration
public static Matcher ReverseNegativeTest(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher
| Improve this Doc View Source

ReverseTest(Matcher[])

Declaration
public static Matcher ReverseTest(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher
| Improve this Doc View Source

Sequence(Matcher[])

Declaration
public static Matcher Sequence(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher
| Improve this Doc View Source

String(String)

Declaration
public static Matcher String(string text)
Parameters
Type Name Description
String text
Returns
Type Description
Matcher
| Improve this Doc View Source

Test(Matcher[])

Declaration
public static Matcher Test(params Matcher[] matchers)
Parameters
Type Name Description
Matcher[] matchers
Returns
Type Description
Matcher

Operators

| Improve this Doc View Source

Addition(Matcher, Matcher)

Sequence.

Declaration
public static Matcher operator +(Matcher left, Matcher right)
Parameters
Type Name Description
Matcher left
Matcher right
Returns
Type Description
Matcher
| Improve this Doc View Source

Addition(Matcher, Char)

Sequence.

Declaration
public static Matcher operator +(Matcher left, char right)
Parameters
Type Name Description
Matcher left
Char right
Returns
Type Description
Matcher
| Improve this Doc View Source

Addition(Matcher, String)

Sequence.

Declaration
public static Matcher operator +(Matcher left, string right)
Parameters
Type Name Description
Matcher left
String right
Returns
Type Description
Matcher
| Improve this Doc View Source

BitwiseOr(Matcher, Matcher)

Any.

Declaration
public static Matcher operator |(Matcher left, Matcher right)
Parameters
Type Name Description
Matcher left
Matcher right
Returns
Type Description
Matcher
| Improve this Doc View Source

Explicit(Char to Matcher)

Declaration
public static explicit operator Matcher(char ch)
Parameters
Type Name Description
Char ch
Returns
Type Description
Matcher
| Improve this Doc View Source

Explicit(String to Matcher)

Declaration
public static explicit operator Matcher(string text)
Parameters
Type Name Description
String text
Returns
Type Description
Matcher
| Improve this Doc View Source

Multiply(Matcher, Int32)

Repeat.

Declaration
public static Matcher operator *(Matcher matcher, int count)
Parameters
Type Name Description
Matcher matcher
Int32 count
Returns
Type Description
Matcher

Extension Methods