Meziantou.FrameworkSyntaxNodeExtensions Class
Extensions for SyntaxNode.
public static class SyntaxNodeExtensionsMethods
| Name | Description |
|---|---|
| Add(SyntaxList<KeyValueSyntax>, string, DateTimeValueSyntax) | Adds a date/time value node to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, bool) | Adds a boolean key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, double) | Adds a floating-point key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, int) | Adds an integer key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, int[]) | Adds an integer array key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, long) | Adds a long key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, string) | Adds a string key/value pair to a list of key/value nodes. |
| Add(SyntaxList<KeyValueSyntax>, string, string[]) | Adds a string array key/value pair to a list of key/value nodes. |
| AddLeadingComment<T>(T, string) | Adds a leading comment to the node. |
| AddLeadingTrivia<T>(T, SyntaxTrivia) | Adds leading trivia to the node. |
| AddLeadingTriviaNewLine<T>(T) | Adds a leading newline trivia to the node. |
| AddLeadingWhitespace<T>(T) | Adds leading whitespace trivia to the node. |
| AddTrailingComment(KeyValueSyntax, string) | Adds a trailing comment to a key/value node. |
| AddTrailingComment<T>(T, string) | Adds a trailing comment to the node. |
| AddTrailingTrivia<T>(T, SyntaxTrivia) | Adds trailing trivia to the node. |
| AddTrailingTriviaNewLine<T>(T) | Adds a trailing newline trivia to the node. |
| AddTrailingWhitespace<T>(T) | Adds trailing whitespace trivia to the node. |
| Descendants(SyntaxNode, bool) | Get all descendants in Depth-First-Search order of the node. Note that this method returns the node itself (last). |
| Tokens(SyntaxNode, bool) | Get all SyntaxToken and SyntaxTrivia in Depth-First-Search order of the node. |
Add overloads
Add(SyntaxList<KeyValueSyntax>, string, DateTimeValueSyntax)
SyntaxNodeExtensions.csAdds a date/time value node to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, DateTimeValueSyntax value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valueDateTimeValueSyntax- The date/time value node.
Add(SyntaxList<KeyValueSyntax>, string, bool)
SyntaxNodeExtensions.csAdds a boolean key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, bool value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuebool- The boolean value.
Add(SyntaxList<KeyValueSyntax>, string, double)
SyntaxNodeExtensions.csAdds a floating-point key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, double value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuedouble- The floating-point value.
Add(SyntaxList<KeyValueSyntax>, string, int)
SyntaxNodeExtensions.csAdds an integer key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, int value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valueint- The integer value.
Add(SyntaxList<KeyValueSyntax>, string, int[])
SyntaxNodeExtensions.csAdds an integer array key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, int[] values)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuesint[]- The array of integers.
Add(SyntaxList<KeyValueSyntax>, string, long)
SyntaxNodeExtensions.csAdds a long key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, long value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuelong- The long value.
Add(SyntaxList<KeyValueSyntax>, string, string)
SyntaxNodeExtensions.csAdds a string key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, string value)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuestring- The string value.
Add(SyntaxList<KeyValueSyntax>, string, string[])
SyntaxNodeExtensions.csAdds a string array key/value pair to a list of key/value nodes.
public static void Add(this SyntaxList<KeyValueSyntax> list, string name, string[] values)Parameters
listSyntaxList<KeyValueSyntax>- The target list.
namestring- The key name.
valuesstring[]- The array of strings.
AddLeadingComment<T>(T, string)
SyntaxNodeExtensions.csAdds a leading comment to the node.
public static T AddLeadingComment<T>(this T node, string comment) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
commentstring- The comment text.
Returns
T The same node.
AddLeadingTrivia<T>(T, SyntaxTrivia)
SyntaxNodeExtensions.csAdds leading trivia to the node.
public static T AddLeadingTrivia<T>(this T node, SyntaxTrivia trivia) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
triviaSyntaxTrivia- The trivia to add.
Returns
T The same node.
AddLeadingTriviaNewLine<T>(T)
SyntaxNodeExtensions.csAdds a leading newline trivia to the node.
public static T AddLeadingTriviaNewLine<T>(this T node) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
Returns
T The same node.
AddLeadingWhitespace<T>(T)
SyntaxNodeExtensions.csAdds leading whitespace trivia to the node.
public static T AddLeadingWhitespace<T>(this T node) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
Returns
T The same node.
AddTrailingComment overloads
AddTrailingComment(KeyValueSyntax, string)
SyntaxNodeExtensions.csAdds a trailing comment to a key/value node.
public static KeyValueSyntax AddTrailingComment(this KeyValueSyntax keyValue, string comment)Parameters
keyValueKeyValueSyntax- The key/value node.
commentstring- The comment text.
Returns
KeyValueSyntax The same key/value node.
AddTrailingComment<T>(T, string)
SyntaxNodeExtensions.csAdds a trailing comment to the node.
public static T AddTrailingComment<T>(this T node, string comment) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
commentstring- The comment text.
Returns
T The same node.
AddTrailingTrivia<T>(T, SyntaxTrivia)
SyntaxNodeExtensions.csAdds trailing trivia to the node.
public static T AddTrailingTrivia<T>(this T node, SyntaxTrivia trivia) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
triviaSyntaxTrivia- The trivia to add.
Returns
T The same node.
AddTrailingTriviaNewLine<T>(T)
SyntaxNodeExtensions.csAdds a trailing newline trivia to the node.
public static T AddTrailingTriviaNewLine<T>(this T node) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
Returns
T The same node.
AddTrailingWhitespace<T>(T)
SyntaxNodeExtensions.csAdds trailing whitespace trivia to the node.
public static T AddTrailingWhitespace<T>(this T node) where T : SyntaxNodeType parameters
T- The node type.
Parameters
nodeT- The target node.
Returns
T The same node.
Descendants(SyntaxNode, bool)
SyntaxNodeExtensions.csGet all descendants in Depth-First-Search order of the node. Note that this method returns the node itself (last).
public static IEnumerable<SyntaxNodeBase> Descendants(this SyntaxNode node, bool includeTokensCommentsAndWhitespaces = false)Parameters
nodeSyntaxNode- The node to collect all descendants
includeTokensCommentsAndWhitespacesbooltrueto include tokens, comments and whitespaces.
Returns
IEnumerable<SyntaxNodeBase> All descendants in Depth-First-Search order of the node.
Tokens(SyntaxNode, bool)
SyntaxNodeExtensions.csGet all SyntaxToken and SyntaxTrivia in Depth-First-Search order of the node.
public static IEnumerable<SyntaxNodeBase> Tokens(this SyntaxNode node, bool includeCommentsAndWhitespaces = true)Parameters
nodeSyntaxNode- The node to collect all tokens from
includeCommentsAndWhitespacesbooltrueto include comments and whitespaces.
Returns
IEnumerable<SyntaxNodeBase> All descendants in Depth-First-Search order of the node.