Class ConventionSyntaxColorisation

Namespace

Utils.Parser.Runtime

Assembly

Utils.Parser.dll

Provides convention-based syntax colorization rules for grammars that do not declare explicit mappings.

public sealed class ConventionSyntaxColorisation : ISyntaxColorisation

Inheritance

object

ConventionSyntaxColorisation

Implements

ISyntaxColorisation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

DataUtils.ToDbValue(object?)

MathEx.Clamp<T>(T, T, T, IComparer<T>)

FluentExtensions.Failure<T>(T)

FluentExtensions.IsEqualTo<T, CT>(T, CT)

FluentExtensions.IsGreaterOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsGreaterThan<T, CT>(T, CT)

FluentExtensions.IsIn<T>(T, params T[])

FluentExtensions.IsLowerOrEqualsThan<T, CT>(T, CT)

FluentExtensions.IsLowerThan<T, CT>(T, CT)

FluentExtensions.IsNotIn<T>(T, params T[])

FluentExtensions.IsNotNull<T>(T)

FluentExtensions.IsNull<T>(T)

FluentExtensions.Success<T>(T)

FluentExtensions.Test<T>(T, Func<T, bool>)

ObjectUtils.Between<T>(T, IComparer<T>, T, T)

ObjectUtils.Between<T>(T, IComparer<T>, T, T, bool, bool)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Func<Task<Result>>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Task<Result>>, Result)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.DoAsync<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Func<Result>)

ObjectUtils.Do<T, Result>(T, Func<T, Result>, Result)

ObjectUtils.In<T>(T, params T[])

ObjectUtils.NotIn<T>(T, params T[])

Validations.ArgMustBe<T>(T, Func<T, bool>, string, string)

Validations.ArgMustNotBe<T>(T, Func<T, bool>, string, string)

Validations.Arg<T>(T, string)

Validations.ValueMustNotBeNull<T>(T, string)

Validations.Variable<T>(T, string)

Constructors

ConventionSyntaxColorisation(IEnumerable<string>, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>)

Initializes a new instance of the ConventionSyntaxColorisation class.

public ConventionSyntaxColorisation(IEnumerable<string> fileExtensions, IEnumerable<string> stringSyntaxExtensions, IEnumerable<string> keywordRules, IEnumerable<string> numberRules, IEnumerable<string> stringRules)

Parameters

fileExtensions IEnumerable<string>

Supported file extensions.

stringSyntaxExtensions IEnumerable<string>

Supported string syntax names.

keywordRules IEnumerable<string>

Rules classified as keywords.

numberRules IEnumerable<string>

Rules classified as numbers.

stringRules IEnumerable<string>

Rules classified as strings.

Properties

FileExtensions

Gets the file extensions supported by this colorization profile.

public IReadOnlyList<string> FileExtensions { get; }

Property Value

IReadOnlyList<string>

StringSyntaxExtensions

Gets the StringSyntaxAttribute names supported by this profile.

public IReadOnlyList<string> StringSyntaxExtensions { get; }

Property Value

IReadOnlyList<string>

Methods

FromGrammarConventions(IEnumerable<string>, string, IEnumerable<string>, IEnumerable<string>, IEnumerable<string>)

Creates a convention colorization profile from a generated grammar helper.

public static ConventionSyntaxColorisation FromGrammarConventions(IEnumerable<string> fileExtensions, string stringSyntaxName, IEnumerable<string> keywordRules, IEnumerable<string> numberRules, IEnumerable<string> stringRules)

Parameters

fileExtensions IEnumerable<string>

Supported file extensions.

stringSyntaxName string

String syntax extension associated with the grammar.

keywordRules IEnumerable<string>

Grammar keyword rules.

numberRules IEnumerable<string>

Grammar numeric rules.

stringRules IEnumerable<string>

Grammar string rules.

Returns

ConventionSyntaxColorisation

A new convention-based colorization profile.

GetClassification(IEnumerable<string>)

Gets the Visual Studio classification name for a grammar rule path. The path must be ordered from parent rule to most specific rule.

public string? GetClassification(IEnumerable<string> rulePath)

Parameters

rulePath IEnumerable<string>

Ordered rule path from root to leaf.

Returns

string

The classification name to use, or null when no mapping exists.

GetClassification(string)

Gets the Visual Studio classification name for a single grammar rule.

public string? GetClassification(string ruleName)

Parameters

ruleName string

Grammar rule name.

Returns

string

The classification name to use, or null when no mapping exists.