Meziantou.Framework

SyntaxFactory Class

Namespace
Meziantou.Framework.Language.Shell
Assembly
Meziantou.Framework.Language.Shell.dll
Package
Meziantou.Framework.Language.Shell 3.0.7
Source
SyntaxFactory.cs
Available in package assets
net10.0net11.0

Builds shell nodes, tokens, and trivia.

public static class SyntaxFactory

Remarks

A node built here is not part of any script, so its span starts at zero. Putting it into a tree with SyntaxNodeExtensions.ReplaceNode gives it a real position, without re-reading any text.

Example

// Arguments are quoted when the dialect requires it
var command = SyntaxFactory.Command(ShellDialect.Bash, "echo", "hello world");
Assert.Equal("echo 'hello world'", command.ToFullString());

Properties

NameDescription
SpaceA single space.

Space

SyntaxFactory.cs

A single space.

public static SyntaxTrivia Space { get; }

Property value

SyntaxTrivia

Methods

NameDescription
Assignment(string, ShellWordSyntax?)
CmdCallStatement(SyntaxToken, ShellStatementSyntax)Builds a CmdCallStatementSyntax from its parts.
CmdElseClause(SyntaxToken, ShellStatementSyntax)Builds a CmdElseClauseSyntax from its parts.
CmdForStatement(SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementSyntax)Builds a CmdForStatementSyntax from its parts.
CmdGotoStatement(SyntaxToken, SyntaxToken)Builds a CmdGotoStatementSyntax from its parts.
CmdIfStatement(SyntaxToken, SyntaxToken, SyntaxToken, ShellExpressionSyntax, ShellStatementSyntax, CmdElseClauseSyntax?)Builds a CmdIfStatementSyntax from its parts.
CmdLabelStatement(SyntaxToken, SyntaxToken)Builds a CmdLabelStatementSyntax from its parts.
CmdParenthesizedBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a CmdParenthesizedBlockSyntax from its parts.
CmdParenthesizedBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken, SyntaxList<ShellRedirectionSyntax>)Builds a CmdParenthesizedBlockSyntax from its parts.
CmdSetStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellWordSyntax?)Builds a CmdSetStatementSyntax from its parts.
CmdSetStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellWordSyntax?, SyntaxList<ShellRedirectionSyntax>)Builds a CmdSetStatementSyntax from its parts.
CmdVariableReference(SyntaxToken, SyntaxToken, SyntaxToken)Builds a CmdVariableReferenceSyntax from its parts.
Command(ShellDialect, string, string[])Creates a command whose name and arguments are quoted for dialect as needed.
Command(ShellWordSyntax, ShellWordSyntax[])Creates a command from existing words, separated by single spaces.
Comment(string, ShellDialect)Creates comment trivia, adding the dialect's comment marker when text omits it.
EndOfLine(string)
Literal(string)Creates an unquoted literal word part. The text is used verbatim.
MissingToken(SyntaxKind)Creates a zero-width token standing in for one the source does not have.
Pipeline(ShellStatementSyntax[])Creates a pipeline joining commands with |.
PosixArithmeticExpansion(SyntaxToken, ShellExpressionSyntax, SyntaxToken)Builds a PosixArithmeticExpansionSyntax from its parts.
PosixArrayAssignment(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken)Builds a PosixArrayAssignmentSyntax from its parts.
PosixCaseClause(SyntaxToken, SeparatedSyntaxList<ShellWordSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixCaseClauseSyntax from its parts.
PosixCaseStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxList<PosixCaseClauseSyntax>, SyntaxToken)Builds a PosixCaseStatementSyntax from its parts.
PosixCaseStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxToken, SyntaxList<PosixCaseClauseSyntax>, SyntaxToken)Builds a PosixCaseStatementSyntax from its parts.
PosixCompoundStatement(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixCompoundStatementSyntax from its parts.
PosixDelimitedExpressionStatement(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)Builds a PosixDelimitedExpressionStatementSyntax from its parts.
PosixElifClause(SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax)Builds a PosixElifClauseSyntax from its parts.
PosixElseClause(SyntaxToken, ShellStatementListSyntax)Builds a PosixElseClauseSyntax from its parts.
PosixForStatement(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixForStatementSyntax from its parts.
PosixForStatement(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxTokenList, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixForStatementSyntax from its parts.
PosixFunctionDefinition(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellStatementSyntax)Builds a PosixFunctionDefinitionSyntax from its parts.
PosixHereDocument(SyntaxToken, SyntaxToken)Builds a PosixHereDocumentSyntax from its parts.
PosixIfStatement(SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax, SyntaxList<PosixElifClauseSyntax>, PosixElseClauseSyntax?, SyntaxToken)Builds a PosixIfStatementSyntax from its parts.
PosixPrefixedStatement(SyntaxKind, SyntaxToken, SyntaxToken, ShellStatementSyntax)Builds a PosixPrefixedStatementSyntax from its parts.
PosixProcessSubstitution(SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixProcessSubstitutionSyntax from its parts.
PosixRedirectedStatement(ShellStatementSyntax, SyntaxList<ShellRedirectionSyntax>)Builds a PosixRedirectedStatementSyntax from its parts.
PosixWhileStatement(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PosixWhileStatementSyntax from its parts.
PowerShellArrayLiteral(SeparatedSyntaxList<ShellExpressionSyntax>)Builds a PowerShellArrayLiteralSyntax from its parts.
PowerShellAssignmentExpression(ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode)Builds a PowerShellAssignmentExpressionSyntax from its parts.
PowerShellAttribute(SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<ShellExpressionSyntax>, SyntaxToken, SyntaxToken)Builds a PowerShellAttributeSyntax from its parts.
PowerShellBinaryExpression(SyntaxKind, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)Builds a PowerShellBinaryExpressionSyntax from its parts.
PowerShellCastExpression(PowerShellTypeLiteralSyntax, ShellExpressionSyntax)Builds a PowerShellCastExpressionSyntax from its parts.
PowerShellCatchClause(SyntaxToken, SeparatedSyntaxList<PowerShellTypeLiteralSyntax>, PowerShellScriptBlockSyntax)Builds a PowerShellCatchClauseSyntax from its parts.
PowerShellDataStatement(SyntaxToken, SyntaxToken, SyntaxTokenList, PowerShellScriptBlockSyntax)Builds a PowerShellDataStatementSyntax from its parts.
PowerShellDoStatement(SyntaxToken, PowerShellScriptBlockSyntax, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PowerShellDoStatementSyntax from its parts.
PowerShellElseClause(SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellElseClauseSyntax from its parts.
PowerShellElseIfClause(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellElseIfClauseSyntax from its parts.
PowerShellExpandableString(SyntaxKind, SyntaxToken, SyntaxList<ShellSyntaxNode>, SyntaxToken)Builds a PowerShellExpandableStringSyntax from its parts.
PowerShellExpressionStatement(ShellSyntaxNode, SyntaxList<ShellRedirectionSyntax>)Builds a PowerShellExpressionStatementSyntax from its parts.
PowerShellFinallyClause(SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellFinallyClauseSyntax from its parts.
PowerShellFlowStatement(SyntaxKind, SyntaxToken, ShellSyntaxNode?)Builds a PowerShellFlowStatementSyntax from its parts.
PowerShellForEachStatement(SyntaxToken, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellForEachStatementSyntax from its parts.
PowerShellForStatement(SyntaxToken, SyntaxToken, ShellSyntaxNode?, SyntaxToken, ShellSyntaxNode?, SyntaxToken, ShellSyntaxNode?, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellForStatementSyntax from its parts.
PowerShellFunctionDefinition(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellParameterSyntax>, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellFunctionDefinitionSyntax from its parts.
PowerShellHashEntry(ShellSyntaxNode, SyntaxToken, ShellSyntaxNode, SyntaxToken)Builds a PowerShellHashEntrySyntax from its parts.
PowerShellHashLiteral(SyntaxToken, SyntaxList<PowerShellHashEntrySyntax>, SyntaxToken)Builds a PowerShellHashLiteralSyntax from its parts.
PowerShellIfStatement(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax, SyntaxList<PowerShellElseIfClauseSyntax>, PowerShellElseClauseSyntax?)Builds a PowerShellIfStatementSyntax from its parts.
PowerShellIndexExpression(ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode, SyntaxToken)Builds a PowerShellIndexExpressionSyntax from its parts.
PowerShellInvocationExpression(ShellExpressionSyntax, SyntaxToken, SeparatedSyntaxList<ShellExpressionSyntax>, SyntaxToken)Builds a PowerShellInvocationExpressionSyntax from its parts.
PowerShellLabeledStatement(SyntaxToken, ShellStatementSyntax)Builds a PowerShellLabeledStatementSyntax from its parts.
PowerShellLiteralExpression(SyntaxKind, SyntaxToken)Builds a PowerShellLiteralExpressionSyntax from its parts.
PowerShellMemberAccessExpression(ShellExpressionSyntax, SyntaxToken, SyntaxToken)Builds a PowerShellMemberAccessExpressionSyntax from its parts.
PowerShellNamedBlock(SyntaxKind, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellNamedBlockSyntax from its parts.
PowerShellParamBlock(SyntaxList<PowerShellAttributeSyntax>, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellParameterSyntax>, SyntaxToken)Builds a PowerShellParamBlockSyntax from its parts.
PowerShellParameter(SyntaxList<PowerShellAttributeSyntax>, ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode?)Builds a PowerShellParameterSyntax from its parts.
PowerShellParenthesizedExpression(SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PowerShellParenthesizedExpressionSyntax from its parts.
PowerShellScriptBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PowerShellScriptBlockSyntax from its parts.
PowerShellSubExpression(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PowerShellSubExpressionSyntax from its parts.
PowerShellSwitchClause(ShellSyntaxNode, PowerShellScriptBlockSyntax)Builds a PowerShellSwitchClauseSyntax from its parts.
PowerShellSwitchClause(ShellSyntaxNode, PowerShellScriptBlockSyntax, SyntaxToken)Builds a PowerShellSwitchClauseSyntax from its parts.
PowerShellSwitchStatement(SyntaxToken, SyntaxTokenList, SyntaxToken, ShellStatementListSyntax, SyntaxToken, SyntaxToken, SyntaxList<PowerShellSwitchClauseSyntax>, SyntaxToken)Builds a PowerShellSwitchStatementSyntax from its parts.
PowerShellTernaryExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)Builds a PowerShellTernaryExpressionSyntax from its parts.
PowerShellTrapStatement(SyntaxToken, PowerShellTypeLiteralSyntax?, PowerShellScriptBlockSyntax)Builds a PowerShellTrapStatementSyntax from its parts.
PowerShellTryStatement(SyntaxToken, PowerShellScriptBlockSyntax, SyntaxList<PowerShellCatchClauseSyntax>, PowerShellFinallyClauseSyntax?)Builds a PowerShellTryStatementSyntax from its parts.
PowerShellTypeDefinition(SyntaxKind, SyntaxList<PowerShellAttributeSyntax>, SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellTypeLiteralSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a PowerShellTypeDefinitionSyntax from its parts.
PowerShellTypeLiteral(SyntaxToken, SyntaxToken, SyntaxToken)Builds a PowerShellTypeLiteralSyntax from its parts.
PowerShellUnaryExpression(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)Builds a PowerShellUnaryExpressionSyntax from its parts.
PowerShellUsingStatement(SyntaxToken, SyntaxToken, ShellSyntaxNode)Builds a PowerShellUsingStatementSyntax from its parts.
PowerShellVariableExpression(SyntaxToken, SyntaxToken)Builds a PowerShellVariableExpressionSyntax from its parts.
PowerShellWhileStatement(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax)Builds a PowerShellWhileStatementSyntax from its parts.
QuotedString(string, ShellDialect)Creates a quoted string that reproduces value literally in dialect.
RawExpression(string)
Redirection(SyntaxKind, string, ShellWordSyntax)
RequiresQuoting(string, ShellDialect)Returns whether text would change meaning if written unquoted.
Script(ShellStatementListSyntax)
ShellAssignment(SyntaxToken, SyntaxToken, ShellWordSyntax?)Builds a ShellAssignmentSyntax from its parts.
ShellBinaryExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)Builds a ShellBinaryExpressionSyntax from its parts.
ShellCommand(SyntaxList<ShellSyntaxNode>)Builds a ShellCommandSyntax from its parts.
ShellCommandList(SeparatedSyntaxList<ShellStatementSyntax>)Builds a ShellCommandListSyntax from its parts.
ShellCommandSubstitution(SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a ShellCommandSubstitutionSyntax from its parts.
ShellConditionalExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)Builds a ShellConditionalExpressionSyntax from its parts.
ShellEmbeddedExpression(ShellSyntaxNode)Builds a ShellEmbeddedExpressionSyntax from its parts.
ShellEmptyStatement()Builds a ShellEmptyStatementSyntax from its parts.
ShellEscapeSequence(SyntaxToken)Builds a ShellEscapeSequenceSyntax from its parts.
ShellGlob(SyntaxToken)Builds a ShellGlobSyntax from its parts.
ShellGroupedExpression(SyntaxToken, ShellExpressionSyntax, SyntaxToken)Builds a ShellGroupedExpressionSyntax from its parts.
ShellLiteralWordPart(SyntaxToken)Builds a ShellLiteralWordPartSyntax from its parts.
ShellOperandExpression(ShellWordSyntax)Builds a ShellOperandExpressionSyntax from its parts.
ShellPipeline(SyntaxToken, SeparatedSyntaxList<ShellStatementSyntax>)Builds a ShellPipelineSyntax from its parts.
ShellQuotedString(SyntaxToken, SyntaxList<ShellWordPartSyntax>, SyntaxToken)Builds a ShellQuotedStringSyntax from its parts.
ShellRawExpression(SyntaxToken)Builds a ShellRawExpressionSyntax from its parts.
ShellRedirection(SyntaxToken, SyntaxToken, ShellWordSyntax?)Builds a ShellRedirectionSyntax from its parts.
ShellScript(ShellStatementListSyntax, SyntaxToken)Builds a ShellScriptSyntax from its parts.
ShellSkippedText(SyntaxTokenList)Builds a ShellSkippedTextSyntax from its parts.
ShellStatementList(SeparatedSyntaxList<ShellStatementSyntax>)Builds a ShellStatementListSyntax from its parts.
ShellUnaryExpression(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)Builds a ShellUnaryExpressionSyntax from its parts.
ShellVariableReference(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken)Builds a ShellVariableReferenceSyntax from its parts.
ShellWord(SyntaxList<ShellWordPartSyntax>)Builds a ShellWordSyntax from its parts.
SkippedText(string)
StatementList(ShellStatementSyntax[])
Token(SyntaxKind)Creates a token of kind, spelled the only way that kind can be.
Token(SyntaxKind, string, string?)Creates a token of kind spelled text.
Trivia(SyntaxKind, string)
VariableReference(string, ShellDialect, bool)Creates a reference to name using the syntax of dialect.
Whitespace(string)
Word(ShellWordPartSyntax[])Creates a word from parts.
Word(string, ShellDialect)Creates a word holding text, quoting it for dialect only when the text would otherwise be split, expanded, or globbed.
ZshAlwaysStatement(ShellStatementSyntax, SyntaxToken, ShellStatementSyntax)Builds a ZshAlwaysStatementSyntax from its parts.
ZshForeachStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a ZshForeachStatementSyntax from its parts.
ZshRepeatStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)Builds a ZshRepeatStatementSyntax from its parts.

Assignment(string, ShellWordSyntax?)

SyntaxFactory.cs
public static ShellAssignmentSyntax Assignment(string name, ShellWordSyntax? value)

Parameters

name string
value ShellWordSyntax?

Returns

ShellAssignmentSyntax

Exceptions

ArgumentNullException
name is null.

CmdCallStatement(SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a CmdCallStatementSyntax from its parts.

public static CmdCallStatementSyntax CmdCallStatement(SyntaxToken callKeyword, ShellStatementSyntax target)

Parameters

callKeyword SyntaxToken
target ShellStatementSyntax

Returns

CmdCallStatementSyntax

CmdElseClause(SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a CmdElseClauseSyntax from its parts.

public static CmdElseClauseSyntax CmdElseClause(SyntaxToken elseKeyword, ShellStatementSyntax body)

Parameters

elseKeyword SyntaxToken
body ShellStatementSyntax

Returns

CmdElseClauseSyntax

CmdForStatement(SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a CmdForStatementSyntax from its parts.

public static CmdForStatementSyntax CmdForStatement(SyntaxToken forKeyword, SyntaxToken switchToken, SyntaxList<ShellWordSyntax> switchArguments, SyntaxToken variableToken, SyntaxToken inKeyword, SyntaxToken openParenToken, SyntaxList<ShellWordSyntax> items, SyntaxToken closeParenToken, SyntaxToken doKeyword, ShellStatementSyntax body)

Parameters

forKeyword SyntaxToken
switchToken SyntaxToken
switchArguments SyntaxList<ShellWordSyntax>
variableToken SyntaxToken
inKeyword SyntaxToken
openParenToken SyntaxToken
items SyntaxList<ShellWordSyntax>
closeParenToken SyntaxToken
doKeyword SyntaxToken
body ShellStatementSyntax

Returns

CmdForStatementSyntax

CmdGotoStatement(SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a CmdGotoStatementSyntax from its parts.

public static CmdGotoStatementSyntax CmdGotoStatement(SyntaxToken gotoKeyword, SyntaxToken labelToken)

Parameters

gotoKeyword SyntaxToken
labelToken SyntaxToken

Returns

CmdGotoStatementSyntax

CmdIfStatement(SyntaxToken, SyntaxToken, SyntaxToken, ShellExpressionSyntax, ShellStatementSyntax, CmdElseClauseSyntax?)

Syntax.g.cs

Builds a CmdIfStatementSyntax from its parts.

public static CmdIfStatementSyntax CmdIfStatement(SyntaxToken ifKeyword, SyntaxToken caseInsensitiveToken, SyntaxToken notKeyword, ShellExpressionSyntax condition, ShellStatementSyntax body, CmdElseClauseSyntax? elseClause)

Parameters

ifKeyword SyntaxToken
caseInsensitiveToken SyntaxToken
notKeyword SyntaxToken
condition ShellExpressionSyntax
body ShellStatementSyntax
elseClause CmdElseClauseSyntax?

Returns

CmdIfStatementSyntax

CmdLabelStatement(SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a CmdLabelStatementSyntax from its parts.

public static CmdLabelStatementSyntax CmdLabelStatement(SyntaxToken colonToken, SyntaxToken nameToken)

Parameters

colonToken SyntaxToken
nameToken SyntaxToken

Returns

CmdLabelStatementSyntax

CmdParenthesizedBlock overloads

CmdParenthesizedBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken)

SyntaxFactory.cs

Builds a CmdParenthesizedBlockSyntax from its parts.

public static CmdParenthesizedBlockSyntax CmdParenthesizedBlock(SyntaxToken openParenToken, ShellStatementListSyntax statements, SyntaxToken closeParenToken)
Parameters
openParenToken SyntaxToken
statements ShellStatementListSyntax
closeParenToken SyntaxToken
Returns

CmdParenthesizedBlockSyntax

CmdParenthesizedBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken, SyntaxList<ShellRedirectionSyntax>)

Syntax.g.cs

Builds a CmdParenthesizedBlockSyntax from its parts.

public static CmdParenthesizedBlockSyntax CmdParenthesizedBlock(SyntaxToken openParenToken, ShellStatementListSyntax statements, SyntaxToken closeParenToken, SyntaxList<ShellRedirectionSyntax> redirections)
Parameters
openParenToken SyntaxToken
statements ShellStatementListSyntax
closeParenToken SyntaxToken
redirections SyntaxList<ShellRedirectionSyntax>
Returns

CmdParenthesizedBlockSyntax

CmdSetStatement overloads

CmdSetStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellWordSyntax?)

SyntaxFactory.cs

Builds a CmdSetStatementSyntax from its parts.

public static CmdSetStatementSyntax CmdSetStatement(SyntaxToken setKeyword, SyntaxToken switchToken, SyntaxToken nameToken, SyntaxToken equalsToken, ShellWordSyntax? value)
Parameters
setKeyword SyntaxToken
switchToken SyntaxToken
nameToken SyntaxToken
equalsToken SyntaxToken
value ShellWordSyntax?
Returns

CmdSetStatementSyntax

CmdSetStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellWordSyntax?, SyntaxList<ShellRedirectionSyntax>)

Syntax.g.cs

Builds a CmdSetStatementSyntax from its parts.

public static CmdSetStatementSyntax CmdSetStatement(SyntaxToken setKeyword, SyntaxToken switchToken, SyntaxToken nameToken, SyntaxToken equalsToken, ShellWordSyntax? value, SyntaxList<ShellRedirectionSyntax> redirections)
Parameters
setKeyword SyntaxToken
switchToken SyntaxToken
nameToken SyntaxToken
equalsToken SyntaxToken
value ShellWordSyntax?
redirections SyntaxList<ShellRedirectionSyntax>
Returns

CmdSetStatementSyntax

CmdVariableReference(SyntaxToken, SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a CmdVariableReferenceSyntax from its parts.

public static CmdVariableReferenceSyntax CmdVariableReference(SyntaxToken openToken, SyntaxToken nameToken, SyntaxToken closeToken)

Parameters

openToken SyntaxToken
nameToken SyntaxToken
closeToken SyntaxToken

Returns

CmdVariableReferenceSyntax

Command overloads

Command(ShellDialect, string, string[])

SyntaxFactory.cs

Creates a command whose name and arguments are quoted for dialect as needed.

public static ShellCommandSyntax Command(ShellDialect dialect, string name, params string[] arguments)
Parameters
dialect ShellDialect
name string
arguments string[]
Returns

ShellCommandSyntax

Exceptions
ArgumentNullException
Any argument is null.

Command(ShellWordSyntax, ShellWordSyntax[])

SyntaxFactory.cs

Creates a command from existing words, separated by single spaces.

public static ShellCommandSyntax Command(ShellWordSyntax name, params ShellWordSyntax[] arguments)
Parameters
name ShellWordSyntax
arguments ShellWordSyntax[]
Returns

ShellCommandSyntax

Exceptions
ArgumentNullException
name or arguments is null.

Comment(string, ShellDialect)

SyntaxFactory.cs

Creates comment trivia, adding the dialect's comment marker when text omits it.

public static SyntaxTrivia Comment(string text, ShellDialect dialect)

Parameters

text string
dialect ShellDialect

Returns

SyntaxTrivia

Exceptions

ArgumentNullException
text or dialect is null.

EndOfLine(string)

SyntaxFactory.cs
public static SyntaxTrivia EndOfLine(string text = "\n")

Parameters

text string

Returns

SyntaxTrivia

Exceptions

ArgumentNullException
text is null.

Literal(string)

SyntaxFactory.cs

Creates an unquoted literal word part. The text is used verbatim.

public static ShellLiteralWordPartSyntax Literal(string text)

Parameters

text string

Returns

ShellLiteralWordPartSyntax

Exceptions

ArgumentNullException
text is null.

MissingToken(SyntaxKind)

SyntaxFactory.cs

Creates a zero-width token standing in for one the source does not have.

public static SyntaxToken MissingToken(SyntaxKind kind)

Parameters

kind SyntaxKind

Returns

SyntaxToken

Pipeline(ShellStatementSyntax[])

SyntaxFactory.cs

Creates a pipeline joining commands with |.

public static ShellPipelineSyntax Pipeline(params ShellStatementSyntax[] commands)

Parameters

commands ShellStatementSyntax[]

Returns

ShellPipelineSyntax

Exceptions

ArgumentNullException
commands is null.

PosixArithmeticExpansion(SyntaxToken, ShellExpressionSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixArithmeticExpansionSyntax from its parts.

public static PosixArithmeticExpansionSyntax PosixArithmeticExpansion(SyntaxToken openToken, ShellExpressionSyntax expression, SyntaxToken closeToken)

Parameters

openToken SyntaxToken
expression ShellExpressionSyntax
closeToken SyntaxToken

Returns

PosixArithmeticExpansionSyntax

PosixArrayAssignment(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken)

Syntax.g.cs

Builds a PosixArrayAssignmentSyntax from its parts.

public static PosixArrayAssignmentSyntax PosixArrayAssignment(SyntaxToken nameToken, SyntaxToken equalsToken, SyntaxToken openParenToken, SyntaxList<ShellWordSyntax> elements, SyntaxToken closeParenToken)

Parameters

nameToken SyntaxToken
equalsToken SyntaxToken
openParenToken SyntaxToken
elements SyntaxList<ShellWordSyntax>
closeParenToken SyntaxToken

Returns

PosixArrayAssignmentSyntax

PosixCaseClause(SyntaxToken, SeparatedSyntaxList<ShellWordSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixCaseClauseSyntax from its parts.

public static PosixCaseClauseSyntax PosixCaseClause(SyntaxToken openParenToken, SeparatedSyntaxList<ShellWordSyntax> patterns, SyntaxToken closeParenToken, ShellStatementListSyntax body, SyntaxToken terminatorToken)

Parameters

openParenToken SyntaxToken
patterns SeparatedSyntaxList<ShellWordSyntax>
closeParenToken SyntaxToken
body ShellStatementListSyntax
terminatorToken SyntaxToken

Returns

PosixCaseClauseSyntax

PosixCaseStatement overloads

PosixCaseStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxList<PosixCaseClauseSyntax>, SyntaxToken)

SyntaxFactory.cs

Builds a PosixCaseStatementSyntax from its parts.

public static PosixCaseStatementSyntax PosixCaseStatement(SyntaxToken caseKeyword, ShellWordSyntax subject, SyntaxToken inKeyword, SyntaxList<PosixCaseClauseSyntax> clauses, SyntaxToken esacKeyword)
Parameters
caseKeyword SyntaxToken
subject ShellWordSyntax
inKeyword SyntaxToken
clauses SyntaxList<PosixCaseClauseSyntax>
esacKeyword SyntaxToken
Returns

PosixCaseStatementSyntax

PosixCaseStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxToken, SyntaxList<PosixCaseClauseSyntax>, SyntaxToken)

Syntax.g.cs

Builds a PosixCaseStatementSyntax from its parts.

public static PosixCaseStatementSyntax PosixCaseStatement(SyntaxToken caseKeyword, ShellWordSyntax subject, SyntaxToken subjectTerminatorToken, SyntaxToken inKeyword, SyntaxList<PosixCaseClauseSyntax> clauses, SyntaxToken esacKeyword)
Parameters
caseKeyword SyntaxToken
subject ShellWordSyntax
subjectTerminatorToken SyntaxToken
inKeyword SyntaxToken
clauses SyntaxList<PosixCaseClauseSyntax>
esacKeyword SyntaxToken
Returns

PosixCaseStatementSyntax

PosixCompoundStatement(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixCompoundStatementSyntax from its parts.

public static PosixCompoundStatementSyntax PosixCompoundStatement(SyntaxKind kind, SyntaxToken openToken, ShellStatementListSyntax statements, SyntaxToken closeToken)

Parameters

kind SyntaxKind
openToken SyntaxToken
statements ShellStatementListSyntax
closeToken SyntaxToken

Returns

PosixCompoundStatementSyntax

PosixDelimitedExpressionStatement(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixDelimitedExpressionStatementSyntax from its parts.

public static PosixDelimitedExpressionStatementSyntax PosixDelimitedExpressionStatement(SyntaxKind kind, SyntaxToken openToken, ShellExpressionSyntax expression, SyntaxToken closeToken)

Parameters

kind SyntaxKind
openToken SyntaxToken
expression ShellExpressionSyntax
closeToken SyntaxToken

Returns

PosixDelimitedExpressionStatementSyntax

PosixElifClause(SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax)

Syntax.g.cs

Builds a PosixElifClauseSyntax from its parts.

public static PosixElifClauseSyntax PosixElifClause(SyntaxToken elifKeyword, ShellStatementListSyntax condition, SyntaxToken thenKeyword, ShellStatementListSyntax body)

Parameters

elifKeyword SyntaxToken
condition ShellStatementListSyntax
thenKeyword SyntaxToken
body ShellStatementListSyntax

Returns

PosixElifClauseSyntax

PosixElseClause(SyntaxToken, ShellStatementListSyntax)

Syntax.g.cs

Builds a PosixElseClauseSyntax from its parts.

public static PosixElseClauseSyntax PosixElseClause(SyntaxToken elseKeyword, ShellStatementListSyntax body)

Parameters

elseKeyword SyntaxToken
body ShellStatementListSyntax

Returns

PosixElseClauseSyntax

PosixForStatement overloads

PosixForStatement(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

SyntaxFactory.cs

Builds a PosixForStatementSyntax from its parts.

public static PosixForStatementSyntax PosixForStatement(SyntaxKind kind, SyntaxToken keyword, SyntaxToken variableToken, SyntaxToken inKeyword, SyntaxList<ShellWordSyntax> items, SyntaxToken listTerminatorToken, SyntaxToken doKeyword, ShellStatementListSyntax body, SyntaxToken doneKeyword)
Parameters
kind SyntaxKind
keyword SyntaxToken
variableToken SyntaxToken
inKeyword SyntaxToken
items SyntaxList<ShellWordSyntax>
listTerminatorToken SyntaxToken
doKeyword SyntaxToken
body ShellStatementListSyntax
doneKeyword SyntaxToken
Returns

PosixForStatementSyntax

PosixForStatement(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxTokenList, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixForStatementSyntax from its parts.

public static PosixForStatementSyntax PosixForStatement(SyntaxKind kind, SyntaxToken keyword, SyntaxToken variableToken, SyntaxTokenList additionalVariableTokens, SyntaxToken inKeyword, SyntaxList<ShellWordSyntax> items, SyntaxToken listTerminatorToken, SyntaxToken doKeyword, ShellStatementListSyntax body, SyntaxToken doneKeyword)
Parameters
kind SyntaxKind
keyword SyntaxToken
variableToken SyntaxToken
additionalVariableTokens SyntaxTokenList
inKeyword SyntaxToken
items SyntaxList<ShellWordSyntax>
listTerminatorToken SyntaxToken
doKeyword SyntaxToken
body ShellStatementListSyntax
doneKeyword SyntaxToken
Returns

PosixForStatementSyntax

PosixFunctionDefinition(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a PosixFunctionDefinitionSyntax from its parts.

public static PosixFunctionDefinitionSyntax PosixFunctionDefinition(SyntaxToken functionKeyword, SyntaxToken nameToken, SyntaxToken openParenToken, SyntaxToken closeParenToken, ShellStatementSyntax body)

Parameters

functionKeyword SyntaxToken
nameToken SyntaxToken
openParenToken SyntaxToken
closeParenToken SyntaxToken
body ShellStatementSyntax

Returns

PosixFunctionDefinitionSyntax

PosixHereDocument(SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a PosixHereDocumentSyntax from its parts.

public static PosixHereDocumentSyntax PosixHereDocument(SyntaxToken bodyToken, SyntaxToken delimiterToken)

Parameters

bodyToken SyntaxToken
delimiterToken SyntaxToken

Returns

PosixHereDocumentSyntax

PosixIfStatement(SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax, SyntaxList<PosixElifClauseSyntax>, PosixElseClauseSyntax?, SyntaxToken)

Syntax.g.cs

Builds a PosixIfStatementSyntax from its parts.

public static PosixIfStatementSyntax PosixIfStatement(SyntaxToken ifKeyword, ShellStatementListSyntax condition, SyntaxToken thenKeyword, ShellStatementListSyntax body, SyntaxList<PosixElifClauseSyntax> elifClauses, PosixElseClauseSyntax? elseClause, SyntaxToken fiKeyword)

Parameters

ifKeyword SyntaxToken
condition ShellStatementListSyntax
thenKeyword SyntaxToken
body ShellStatementListSyntax
elifClauses SyntaxList<PosixElifClauseSyntax>
elseClause PosixElseClauseSyntax?
fiKeyword SyntaxToken

Returns

PosixIfStatementSyntax

PosixPrefixedStatement(SyntaxKind, SyntaxToken, SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a PosixPrefixedStatementSyntax from its parts.

public static PosixPrefixedStatementSyntax PosixPrefixedStatement(SyntaxKind kind, SyntaxToken keyword, SyntaxToken nameToken, ShellStatementSyntax statement)

Parameters

kind SyntaxKind
keyword SyntaxToken
nameToken SyntaxToken
statement ShellStatementSyntax

Returns

PosixPrefixedStatementSyntax

PosixProcessSubstitution(SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixProcessSubstitutionSyntax from its parts.

public static PosixProcessSubstitutionSyntax PosixProcessSubstitution(SyntaxToken openToken, ShellStatementListSyntax statements, SyntaxToken closeToken)

Parameters

openToken SyntaxToken
statements ShellStatementListSyntax
closeToken SyntaxToken

Returns

PosixProcessSubstitutionSyntax

PosixRedirectedStatement(ShellStatementSyntax, SyntaxList<ShellRedirectionSyntax>)

Syntax.g.cs

Builds a PosixRedirectedStatementSyntax from its parts.

public static PosixRedirectedStatementSyntax PosixRedirectedStatement(ShellStatementSyntax statement, SyntaxList<ShellRedirectionSyntax> redirections)

Parameters

statement ShellStatementSyntax
redirections SyntaxList<ShellRedirectionSyntax>

Returns

PosixRedirectedStatementSyntax

PosixWhileStatement(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PosixWhileStatementSyntax from its parts.

public static PosixWhileStatementSyntax PosixWhileStatement(SyntaxKind kind, SyntaxToken keyword, ShellStatementListSyntax condition, SyntaxToken doKeyword, ShellStatementListSyntax body, SyntaxToken doneKeyword)

Parameters

kind SyntaxKind
keyword SyntaxToken
condition ShellStatementListSyntax
doKeyword SyntaxToken
body ShellStatementListSyntax
doneKeyword SyntaxToken

Returns

PosixWhileStatementSyntax

PowerShellArrayLiteral(SeparatedSyntaxList<ShellExpressionSyntax>)

Syntax.g.cs

Builds a PowerShellArrayLiteralSyntax from its parts.

public static PowerShellArrayLiteralSyntax PowerShellArrayLiteral(SeparatedSyntaxList<ShellExpressionSyntax> elements)

Parameters

elements SeparatedSyntaxList<ShellExpressionSyntax>

Returns

PowerShellArrayLiteralSyntax

PowerShellAssignmentExpression(ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode)

Syntax.g.cs

Builds a PowerShellAssignmentExpressionSyntax from its parts.

public static PowerShellAssignmentExpressionSyntax PowerShellAssignmentExpression(ShellExpressionSyntax target, SyntaxToken operatorToken, ShellSyntaxNode value)

Parameters

target ShellExpressionSyntax
operatorToken SyntaxToken
value ShellSyntaxNode

Returns

PowerShellAssignmentExpressionSyntax

PowerShellAttribute(SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<ShellExpressionSyntax>, SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a PowerShellAttributeSyntax from its parts.

public static PowerShellAttributeSyntax PowerShellAttribute(SyntaxToken openBracketToken, SyntaxToken nameToken, SyntaxToken openParenToken, SeparatedSyntaxList<ShellExpressionSyntax> arguments, SyntaxToken closeParenToken, SyntaxToken closeBracketToken)

Parameters

openBracketToken SyntaxToken
nameToken SyntaxToken
openParenToken SyntaxToken
arguments SeparatedSyntaxList<ShellExpressionSyntax>
closeParenToken SyntaxToken
closeBracketToken SyntaxToken

Returns

PowerShellAttributeSyntax

PowerShellBinaryExpression(SyntaxKind, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)

Syntax.g.cs

Builds a PowerShellBinaryExpressionSyntax from its parts.

public static PowerShellBinaryExpressionSyntax PowerShellBinaryExpression(SyntaxKind kind, ShellExpressionSyntax left, SyntaxToken operatorToken, ShellExpressionSyntax right)

Parameters

kind SyntaxKind
left ShellExpressionSyntax
operatorToken SyntaxToken
right ShellExpressionSyntax

Returns

PowerShellBinaryExpressionSyntax

PowerShellCastExpression(PowerShellTypeLiteralSyntax, ShellExpressionSyntax)

Syntax.g.cs

Builds a PowerShellCastExpressionSyntax from its parts.

public static PowerShellCastExpressionSyntax PowerShellCastExpression(PowerShellTypeLiteralSyntax type, ShellExpressionSyntax operand)

Parameters

type PowerShellTypeLiteralSyntax
operand ShellExpressionSyntax

Returns

PowerShellCastExpressionSyntax

PowerShellCatchClause(SyntaxToken, SeparatedSyntaxList<PowerShellTypeLiteralSyntax>, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellCatchClauseSyntax from its parts.

public static PowerShellCatchClauseSyntax PowerShellCatchClause(SyntaxToken catchKeyword, SeparatedSyntaxList<PowerShellTypeLiteralSyntax> typeFilters, PowerShellScriptBlockSyntax body)

Parameters

catchKeyword SyntaxToken
typeFilters SeparatedSyntaxList<PowerShellTypeLiteralSyntax>
body PowerShellScriptBlockSyntax

Returns

PowerShellCatchClauseSyntax

PowerShellDataStatement(SyntaxToken, SyntaxToken, SyntaxTokenList, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellDataStatementSyntax from its parts.

public static PowerShellDataStatementSyntax PowerShellDataStatement(SyntaxToken dataKeyword, SyntaxToken nameToken, SyntaxTokenList parameterTokens, PowerShellScriptBlockSyntax body)

Parameters

dataKeyword SyntaxToken
nameToken SyntaxToken
parameterTokens SyntaxTokenList
body PowerShellScriptBlockSyntax

Returns

PowerShellDataStatementSyntax

PowerShellDoStatement(SyntaxToken, PowerShellScriptBlockSyntax, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellDoStatementSyntax from its parts.

public static PowerShellDoStatementSyntax PowerShellDoStatement(SyntaxToken doKeyword, PowerShellScriptBlockSyntax body, SyntaxToken conditionKeyword, SyntaxToken openParenToken, ShellStatementListSyntax condition, SyntaxToken closeParenToken)

Parameters

doKeyword SyntaxToken
body PowerShellScriptBlockSyntax
conditionKeyword SyntaxToken
openParenToken SyntaxToken
condition ShellStatementListSyntax
closeParenToken SyntaxToken

Returns

PowerShellDoStatementSyntax

PowerShellElseClause(SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellElseClauseSyntax from its parts.

public static PowerShellElseClauseSyntax PowerShellElseClause(SyntaxToken elseKeyword, PowerShellScriptBlockSyntax body)

Parameters

elseKeyword SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellElseClauseSyntax

PowerShellElseIfClause(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellElseIfClauseSyntax from its parts.

public static PowerShellElseIfClauseSyntax PowerShellElseIfClause(SyntaxToken elseIfKeyword, SyntaxToken openParenToken, ShellStatementListSyntax condition, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body)

Parameters

elseIfKeyword SyntaxToken
openParenToken SyntaxToken
condition ShellStatementListSyntax
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellElseIfClauseSyntax

PowerShellExpandableString(SyntaxKind, SyntaxToken, SyntaxList<ShellSyntaxNode>, SyntaxToken)

Syntax.g.cs

Builds a PowerShellExpandableStringSyntax from its parts.

public static PowerShellExpandableStringSyntax PowerShellExpandableString(SyntaxKind kind, SyntaxToken openToken, SyntaxList<ShellSyntaxNode> parts, SyntaxToken closeToken)

Parameters

kind SyntaxKind
openToken SyntaxToken
parts SyntaxList<ShellSyntaxNode>
closeToken SyntaxToken

Returns

PowerShellExpandableStringSyntax

PowerShellExpressionStatement(ShellSyntaxNode, SyntaxList<ShellRedirectionSyntax>)

Syntax.g.cs

Builds a PowerShellExpressionStatementSyntax from its parts.

public static PowerShellExpressionStatementSyntax PowerShellExpressionStatement(ShellSyntaxNode expression, SyntaxList<ShellRedirectionSyntax> redirections)

Parameters

expression ShellSyntaxNode
redirections SyntaxList<ShellRedirectionSyntax>

Returns

PowerShellExpressionStatementSyntax

PowerShellFinallyClause(SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellFinallyClauseSyntax from its parts.

public static PowerShellFinallyClauseSyntax PowerShellFinallyClause(SyntaxToken finallyKeyword, PowerShellScriptBlockSyntax body)

Parameters

finallyKeyword SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellFinallyClauseSyntax

PowerShellFlowStatement(SyntaxKind, SyntaxToken, ShellSyntaxNode?)

Syntax.g.cs

Builds a PowerShellFlowStatementSyntax from its parts.

public static PowerShellFlowStatementSyntax PowerShellFlowStatement(SyntaxKind kind, SyntaxToken keyword, ShellSyntaxNode? value)

Parameters

kind SyntaxKind
keyword SyntaxToken
value ShellSyntaxNode?

Returns

PowerShellFlowStatementSyntax

PowerShellForEachStatement(SyntaxToken, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellForEachStatementSyntax from its parts.

public static PowerShellForEachStatementSyntax PowerShellForEachStatement(SyntaxToken forEachKeyword, SyntaxToken openParenToken, ShellExpressionSyntax variable, SyntaxToken inKeyword, ShellSyntaxNode collection, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body)

Parameters

forEachKeyword SyntaxToken
openParenToken SyntaxToken
variable ShellExpressionSyntax
inKeyword SyntaxToken
collection ShellSyntaxNode
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellForEachStatementSyntax

PowerShellForStatement(SyntaxToken, SyntaxToken, ShellSyntaxNode?, SyntaxToken, ShellSyntaxNode?, SyntaxToken, ShellSyntaxNode?, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellForStatementSyntax from its parts.

public static PowerShellForStatementSyntax PowerShellForStatement(SyntaxToken forKeyword, SyntaxToken openParenToken, ShellSyntaxNode? initializer, SyntaxToken firstSemicolonToken, ShellSyntaxNode? condition, SyntaxToken secondSemicolonToken, ShellSyntaxNode? iterator, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body)

Parameters

forKeyword SyntaxToken
openParenToken SyntaxToken
initializer ShellSyntaxNode?
firstSemicolonToken SyntaxToken
condition ShellSyntaxNode?
secondSemicolonToken SyntaxToken
iterator ShellSyntaxNode?
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellForStatementSyntax

PowerShellFunctionDefinition(SyntaxKind, SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellParameterSyntax>, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellFunctionDefinitionSyntax from its parts.

public static PowerShellFunctionDefinitionSyntax PowerShellFunctionDefinition(SyntaxKind kind, SyntaxToken keyword, SyntaxToken nameToken, SyntaxToken openParenToken, SeparatedSyntaxList<PowerShellParameterSyntax> parameters, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body)

Parameters

kind SyntaxKind
keyword SyntaxToken
nameToken SyntaxToken
openParenToken SyntaxToken
parameters SeparatedSyntaxList<PowerShellParameterSyntax>
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellFunctionDefinitionSyntax

PowerShellHashEntry(ShellSyntaxNode, SyntaxToken, ShellSyntaxNode, SyntaxToken)

Syntax.g.cs

Builds a PowerShellHashEntrySyntax from its parts.

public static PowerShellHashEntrySyntax PowerShellHashEntry(ShellSyntaxNode key, SyntaxToken equalsToken, ShellSyntaxNode value, SyntaxToken separatorToken)

Parameters

key ShellSyntaxNode
equalsToken SyntaxToken
value ShellSyntaxNode
separatorToken SyntaxToken

Returns

PowerShellHashEntrySyntax

PowerShellHashLiteral(SyntaxToken, SyntaxList<PowerShellHashEntrySyntax>, SyntaxToken)

Syntax.g.cs

Builds a PowerShellHashLiteralSyntax from its parts.

public static PowerShellHashLiteralSyntax PowerShellHashLiteral(SyntaxToken openToken, SyntaxList<PowerShellHashEntrySyntax> entries, SyntaxToken closeBraceToken)

Parameters

openToken SyntaxToken
entries SyntaxList<PowerShellHashEntrySyntax>
closeBraceToken SyntaxToken

Returns

PowerShellHashLiteralSyntax

PowerShellIfStatement(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax, SyntaxList<PowerShellElseIfClauseSyntax>, PowerShellElseClauseSyntax?)

Syntax.g.cs

Builds a PowerShellIfStatementSyntax from its parts.

public static PowerShellIfStatementSyntax PowerShellIfStatement(SyntaxToken ifKeyword, SyntaxToken openParenToken, ShellStatementListSyntax condition, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body, SyntaxList<PowerShellElseIfClauseSyntax> elseIfClauses, PowerShellElseClauseSyntax? elseClause)

Parameters

ifKeyword SyntaxToken
openParenToken SyntaxToken
condition ShellStatementListSyntax
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax
elseIfClauses SyntaxList<PowerShellElseIfClauseSyntax>
elseClause PowerShellElseClauseSyntax?

Returns

PowerShellIfStatementSyntax

PowerShellIndexExpression(ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode, SyntaxToken)

Syntax.g.cs

Builds a PowerShellIndexExpressionSyntax from its parts.

public static PowerShellIndexExpressionSyntax PowerShellIndexExpression(ShellExpressionSyntax target, SyntaxToken openBracketToken, ShellSyntaxNode index, SyntaxToken closeBracketToken)

Parameters

target ShellExpressionSyntax
openBracketToken SyntaxToken
index ShellSyntaxNode
closeBracketToken SyntaxToken

Returns

PowerShellIndexExpressionSyntax

PowerShellInvocationExpression(ShellExpressionSyntax, SyntaxToken, SeparatedSyntaxList<ShellExpressionSyntax>, SyntaxToken)

Syntax.g.cs

Builds a PowerShellInvocationExpressionSyntax from its parts.

public static PowerShellInvocationExpressionSyntax PowerShellInvocationExpression(ShellExpressionSyntax target, SyntaxToken openParenToken, SeparatedSyntaxList<ShellExpressionSyntax> arguments, SyntaxToken closeParenToken)

Parameters

target ShellExpressionSyntax
openParenToken SyntaxToken
arguments SeparatedSyntaxList<ShellExpressionSyntax>
closeParenToken SyntaxToken

Returns

PowerShellInvocationExpressionSyntax

PowerShellLabeledStatement(SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a PowerShellLabeledStatementSyntax from its parts.

public static PowerShellLabeledStatementSyntax PowerShellLabeledStatement(SyntaxToken labelToken, ShellStatementSyntax statement)

Parameters

labelToken SyntaxToken
statement ShellStatementSyntax

Returns

PowerShellLabeledStatementSyntax

PowerShellLiteralExpression(SyntaxKind, SyntaxToken)

Syntax.g.cs

Builds a PowerShellLiteralExpressionSyntax from its parts.

public static PowerShellLiteralExpressionSyntax PowerShellLiteralExpression(SyntaxKind kind, SyntaxToken token)

Parameters

kind SyntaxKind
token SyntaxToken

Returns

PowerShellLiteralExpressionSyntax

PowerShellMemberAccessExpression(ShellExpressionSyntax, SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a PowerShellMemberAccessExpressionSyntax from its parts.

public static PowerShellMemberAccessExpressionSyntax PowerShellMemberAccessExpression(ShellExpressionSyntax target, SyntaxToken operatorToken, SyntaxToken memberNameToken)

Parameters

target ShellExpressionSyntax
operatorToken SyntaxToken
memberNameToken SyntaxToken

Returns

PowerShellMemberAccessExpressionSyntax

PowerShellNamedBlock(SyntaxKind, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellNamedBlockSyntax from its parts.

public static PowerShellNamedBlockSyntax PowerShellNamedBlock(SyntaxKind kind, SyntaxToken keyword, PowerShellScriptBlockSyntax body)

Parameters

kind SyntaxKind
keyword SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellNamedBlockSyntax

PowerShellParamBlock(SyntaxList<PowerShellAttributeSyntax>, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellParameterSyntax>, SyntaxToken)

Syntax.g.cs

Builds a PowerShellParamBlockSyntax from its parts.

public static PowerShellParamBlockSyntax PowerShellParamBlock(SyntaxList<PowerShellAttributeSyntax> attributes, SyntaxToken paramKeyword, SyntaxToken openParenToken, SeparatedSyntaxList<PowerShellParameterSyntax> parameters, SyntaxToken closeParenToken)

Parameters

attributes SyntaxList<PowerShellAttributeSyntax>
paramKeyword SyntaxToken
openParenToken SyntaxToken
parameters SeparatedSyntaxList<PowerShellParameterSyntax>
closeParenToken SyntaxToken

Returns

PowerShellParamBlockSyntax

PowerShellParameter(SyntaxList<PowerShellAttributeSyntax>, ShellExpressionSyntax, SyntaxToken, ShellSyntaxNode?)

Syntax.g.cs

Builds a PowerShellParameterSyntax from its parts.

public static PowerShellParameterSyntax PowerShellParameter(SyntaxList<PowerShellAttributeSyntax> attributes, ShellExpressionSyntax variable, SyntaxToken equalsToken, ShellSyntaxNode? defaultValue)

Parameters

attributes SyntaxList<PowerShellAttributeSyntax>
variable ShellExpressionSyntax
equalsToken SyntaxToken
defaultValue ShellSyntaxNode?

Returns

PowerShellParameterSyntax

PowerShellParenthesizedExpression(SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellParenthesizedExpressionSyntax from its parts.

public static PowerShellParenthesizedExpressionSyntax PowerShellParenthesizedExpression(SyntaxToken openParenToken, ShellStatementListSyntax statements, SyntaxToken closeParenToken)

Parameters

openParenToken SyntaxToken
statements ShellStatementListSyntax
closeParenToken SyntaxToken

Returns

PowerShellParenthesizedExpressionSyntax

PowerShellScriptBlock(SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellScriptBlockSyntax from its parts.

public static PowerShellScriptBlockSyntax PowerShellScriptBlock(SyntaxToken openBraceToken, ShellStatementListSyntax statements, SyntaxToken closeBraceToken)

Parameters

openBraceToken SyntaxToken
statements ShellStatementListSyntax
closeBraceToken SyntaxToken

Returns

PowerShellScriptBlockSyntax

PowerShellSubExpression(SyntaxKind, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellSubExpressionSyntax from its parts.

public static PowerShellSubExpressionSyntax PowerShellSubExpression(SyntaxKind kind, SyntaxToken openToken, ShellStatementListSyntax statements, SyntaxToken closeParenToken)

Parameters

kind SyntaxKind
openToken SyntaxToken
statements ShellStatementListSyntax
closeParenToken SyntaxToken

Returns

PowerShellSubExpressionSyntax

PowerShellSwitchClause overloads

PowerShellSwitchClause(ShellSyntaxNode, PowerShellScriptBlockSyntax)

SyntaxFactory.cs

Builds a PowerShellSwitchClauseSyntax from its parts.

public static PowerShellSwitchClauseSyntax PowerShellSwitchClause(ShellSyntaxNode pattern, PowerShellScriptBlockSyntax body)
Parameters
pattern ShellSyntaxNode
body PowerShellScriptBlockSyntax
Returns

PowerShellSwitchClauseSyntax

PowerShellSwitchClause(ShellSyntaxNode, PowerShellScriptBlockSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellSwitchClauseSyntax from its parts.

public static PowerShellSwitchClauseSyntax PowerShellSwitchClause(ShellSyntaxNode pattern, PowerShellScriptBlockSyntax body, SyntaxToken separatorToken)
Parameters
pattern ShellSyntaxNode
body PowerShellScriptBlockSyntax
separatorToken SyntaxToken
Returns

PowerShellSwitchClauseSyntax

PowerShellSwitchStatement(SyntaxToken, SyntaxTokenList, SyntaxToken, ShellStatementListSyntax, SyntaxToken, SyntaxToken, SyntaxList<PowerShellSwitchClauseSyntax>, SyntaxToken)

Syntax.g.cs

Builds a PowerShellSwitchStatementSyntax from its parts.

public static PowerShellSwitchStatementSyntax PowerShellSwitchStatement(SyntaxToken switchKeyword, SyntaxTokenList parameterTokens, SyntaxToken openParenToken, ShellStatementListSyntax condition, SyntaxToken closeParenToken, SyntaxToken openBraceToken, SyntaxList<PowerShellSwitchClauseSyntax> clauses, SyntaxToken closeBraceToken)

Parameters

switchKeyword SyntaxToken
parameterTokens SyntaxTokenList
openParenToken SyntaxToken
condition ShellStatementListSyntax
closeParenToken SyntaxToken
openBraceToken SyntaxToken
clauses SyntaxList<PowerShellSwitchClauseSyntax>
closeBraceToken SyntaxToken

Returns

PowerShellSwitchStatementSyntax

PowerShellTernaryExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)

Syntax.g.cs

Builds a PowerShellTernaryExpressionSyntax from its parts.

public static PowerShellTernaryExpressionSyntax PowerShellTernaryExpression(ShellExpressionSyntax condition, SyntaxToken questionToken, ShellExpressionSyntax whenTrue, SyntaxToken colonToken, ShellExpressionSyntax whenFalse)

Parameters

condition ShellExpressionSyntax
questionToken SyntaxToken
whenTrue ShellExpressionSyntax
colonToken SyntaxToken
whenFalse ShellExpressionSyntax

Returns

PowerShellTernaryExpressionSyntax

PowerShellTrapStatement(SyntaxToken, PowerShellTypeLiteralSyntax?, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellTrapStatementSyntax from its parts.

public static PowerShellTrapStatementSyntax PowerShellTrapStatement(SyntaxToken trapKeyword, PowerShellTypeLiteralSyntax? typeFilter, PowerShellScriptBlockSyntax body)

Parameters

trapKeyword SyntaxToken
typeFilter PowerShellTypeLiteralSyntax?
body PowerShellScriptBlockSyntax

Returns

PowerShellTrapStatementSyntax

PowerShellTryStatement(SyntaxToken, PowerShellScriptBlockSyntax, SyntaxList<PowerShellCatchClauseSyntax>, PowerShellFinallyClauseSyntax?)

Syntax.g.cs

Builds a PowerShellTryStatementSyntax from its parts.

public static PowerShellTryStatementSyntax PowerShellTryStatement(SyntaxToken tryKeyword, PowerShellScriptBlockSyntax body, SyntaxList<PowerShellCatchClauseSyntax> catchClauses, PowerShellFinallyClauseSyntax? finallyClause)

Parameters

tryKeyword SyntaxToken
body PowerShellScriptBlockSyntax
catchClauses SyntaxList<PowerShellCatchClauseSyntax>
finallyClause PowerShellFinallyClauseSyntax?

Returns

PowerShellTryStatementSyntax

PowerShellTypeDefinition(SyntaxKind, SyntaxList<PowerShellAttributeSyntax>, SyntaxToken, SyntaxToken, SyntaxToken, SeparatedSyntaxList<PowerShellTypeLiteralSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellTypeDefinitionSyntax from its parts.

public static PowerShellTypeDefinitionSyntax PowerShellTypeDefinition(SyntaxKind kind, SyntaxList<PowerShellAttributeSyntax> attributes, SyntaxToken keyword, SyntaxToken nameToken, SyntaxToken colonToken, SeparatedSyntaxList<PowerShellTypeLiteralSyntax> baseTypes, SyntaxToken openBraceToken, ShellStatementListSyntax members, SyntaxToken closeBraceToken)

Parameters

kind SyntaxKind
attributes SyntaxList<PowerShellAttributeSyntax>
keyword SyntaxToken
nameToken SyntaxToken
colonToken SyntaxToken
baseTypes SeparatedSyntaxList<PowerShellTypeLiteralSyntax>
openBraceToken SyntaxToken
members ShellStatementListSyntax
closeBraceToken SyntaxToken

Returns

PowerShellTypeDefinitionSyntax

PowerShellTypeLiteral(SyntaxToken, SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a PowerShellTypeLiteralSyntax from its parts.

public static PowerShellTypeLiteralSyntax PowerShellTypeLiteral(SyntaxToken openBracketToken, SyntaxToken nameToken, SyntaxToken closeBracketToken)

Parameters

openBracketToken SyntaxToken
nameToken SyntaxToken
closeBracketToken SyntaxToken

Returns

PowerShellTypeLiteralSyntax

PowerShellUnaryExpression(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)

Syntax.g.cs

Builds a PowerShellUnaryExpressionSyntax from its parts.

public static PowerShellUnaryExpressionSyntax PowerShellUnaryExpression(SyntaxKind kind, SyntaxToken prefixOperatorToken, ShellExpressionSyntax operand, SyntaxToken postfixOperatorToken)

Parameters

kind SyntaxKind
prefixOperatorToken SyntaxToken
operand ShellExpressionSyntax
postfixOperatorToken SyntaxToken

Returns

PowerShellUnaryExpressionSyntax

PowerShellUsingStatement(SyntaxToken, SyntaxToken, ShellSyntaxNode)

Syntax.g.cs

Builds a PowerShellUsingStatementSyntax from its parts.

public static PowerShellUsingStatementSyntax PowerShellUsingStatement(SyntaxToken usingKeyword, SyntaxToken kindToken, ShellSyntaxNode target)

Parameters

usingKeyword SyntaxToken
kindToken SyntaxToken
target ShellSyntaxNode

Returns

PowerShellUsingStatementSyntax

PowerShellVariableExpression(SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a PowerShellVariableExpressionSyntax from its parts.

public static PowerShellVariableExpressionSyntax PowerShellVariableExpression(SyntaxToken sigilToken, SyntaxToken nameToken)

Parameters

sigilToken SyntaxToken
nameToken SyntaxToken

Returns

PowerShellVariableExpressionSyntax

PowerShellWhileStatement(SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken, PowerShellScriptBlockSyntax)

Syntax.g.cs

Builds a PowerShellWhileStatementSyntax from its parts.

public static PowerShellWhileStatementSyntax PowerShellWhileStatement(SyntaxToken whileKeyword, SyntaxToken openParenToken, ShellStatementListSyntax condition, SyntaxToken closeParenToken, PowerShellScriptBlockSyntax body)

Parameters

whileKeyword SyntaxToken
openParenToken SyntaxToken
condition ShellStatementListSyntax
closeParenToken SyntaxToken
body PowerShellScriptBlockSyntax

Returns

PowerShellWhileStatementSyntax

QuotedString(string, ShellDialect)

SyntaxFactory.cs

Creates a quoted string that reproduces value literally in dialect.

public static ShellQuotedStringSyntax QuotedString(string value, ShellDialect dialect)

Parameters

value string
dialect ShellDialect

Returns

ShellQuotedStringSyntax

Exceptions

ArgumentNullException
value or dialect is null.

Remarks

The returned node's Value is always value. For the POSIX and PowerShell families the text also reads back as value when parsed again. Cmd has no escape for a quote inside a quoted string and no way to carry a line break in a word, so a value holding either cannot be written as cmd text that parses back to it.

RawExpression(string)

SyntaxFactory.cs
public static ShellRawExpressionSyntax RawExpression(string text)

Parameters

text string

Returns

ShellRawExpressionSyntax

Exceptions

ArgumentNullException
text is null.

Redirection(SyntaxKind, string, ShellWordSyntax)

SyntaxFactory.cs
public static ShellRedirectionSyntax Redirection(SyntaxKind operatorKind, string operatorText, ShellWordSyntax target)

Parameters

operatorKind SyntaxKind
operatorText string
target ShellWordSyntax

Returns

ShellRedirectionSyntax

Exceptions

ArgumentNullException
operatorText or target is null.

RequiresQuoting(string, ShellDialect)

SyntaxFactory.cs

Returns whether text would change meaning if written unquoted.

public static bool RequiresQuoting(string text, ShellDialect dialect)

Parameters

text string
dialect ShellDialect

Returns

bool

Exceptions

ArgumentNullException
text or dialect is null.

Script(ShellStatementListSyntax)

SyntaxFactory.cs
public static ShellScriptSyntax Script(ShellStatementListSyntax statements)

Parameters

statements ShellStatementListSyntax

Returns

ShellScriptSyntax

Exceptions

ArgumentNullException
statements is null.

ShellAssignment(SyntaxToken, SyntaxToken, ShellWordSyntax?)

Syntax.g.cs

Builds a ShellAssignmentSyntax from its parts.

public static ShellAssignmentSyntax ShellAssignment(SyntaxToken nameToken, SyntaxToken equalsToken, ShellWordSyntax? value)

Parameters

nameToken SyntaxToken
equalsToken SyntaxToken
value ShellWordSyntax?

Returns

ShellAssignmentSyntax

ShellBinaryExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)

Syntax.g.cs

Builds a ShellBinaryExpressionSyntax from its parts.

public static ShellBinaryExpressionSyntax ShellBinaryExpression(ShellExpressionSyntax left, SyntaxToken operatorToken, ShellExpressionSyntax right)

Parameters

left ShellExpressionSyntax
operatorToken SyntaxToken
right ShellExpressionSyntax

Returns

ShellBinaryExpressionSyntax

ShellCommand(SyntaxList<ShellSyntaxNode>)

Syntax.g.cs

Builds a ShellCommandSyntax from its parts.

public static ShellCommandSyntax ShellCommand(SyntaxList<ShellSyntaxNode> elements)

Parameters

elements SyntaxList<ShellSyntaxNode>

Returns

ShellCommandSyntax

ShellCommandList(SeparatedSyntaxList<ShellStatementSyntax>)

Syntax.g.cs

Builds a ShellCommandListSyntax from its parts.

public static ShellCommandListSyntax ShellCommandList(SeparatedSyntaxList<ShellStatementSyntax> pipelines)

Parameters

pipelines SeparatedSyntaxList<ShellStatementSyntax>

Returns

ShellCommandListSyntax

ShellCommandSubstitution(SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a ShellCommandSubstitutionSyntax from its parts.

public static ShellCommandSubstitutionSyntax ShellCommandSubstitution(SyntaxToken openToken, ShellStatementListSyntax statements, SyntaxToken closeToken)

Parameters

openToken SyntaxToken
statements ShellStatementListSyntax
closeToken SyntaxToken

Returns

ShellCommandSubstitutionSyntax

ShellConditionalExpression(ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax, SyntaxToken, ShellExpressionSyntax)

Syntax.g.cs

Builds a ShellConditionalExpressionSyntax from its parts.

public static ShellConditionalExpressionSyntax ShellConditionalExpression(ShellExpressionSyntax condition, SyntaxToken questionToken, ShellExpressionSyntax whenTrue, SyntaxToken colonToken, ShellExpressionSyntax whenFalse)

Parameters

condition ShellExpressionSyntax
questionToken SyntaxToken
whenTrue ShellExpressionSyntax
colonToken SyntaxToken
whenFalse ShellExpressionSyntax

Returns

ShellConditionalExpressionSyntax

ShellEmbeddedExpression(ShellSyntaxNode)

Syntax.g.cs

Builds a ShellEmbeddedExpressionSyntax from its parts.

public static ShellEmbeddedExpressionSyntax ShellEmbeddedExpression(ShellSyntaxNode expression)

Parameters

expression ShellSyntaxNode

Returns

ShellEmbeddedExpressionSyntax

ShellEmptyStatement()

Syntax.g.cs

Builds a ShellEmptyStatementSyntax from its parts.

public static ShellEmptyStatementSyntax ShellEmptyStatement()

Returns

ShellEmptyStatementSyntax

ShellEscapeSequence(SyntaxToken)

Syntax.g.cs

Builds a ShellEscapeSequenceSyntax from its parts.

public static ShellEscapeSequenceSyntax ShellEscapeSequence(SyntaxToken escapeToken)

Parameters

escapeToken SyntaxToken

Returns

ShellEscapeSequenceSyntax

ShellGlob(SyntaxToken)

Syntax.g.cs

Builds a ShellGlobSyntax from its parts.

public static ShellGlobSyntax ShellGlob(SyntaxToken globToken)

Parameters

globToken SyntaxToken

Returns

ShellGlobSyntax

ShellGroupedExpression(SyntaxToken, ShellExpressionSyntax, SyntaxToken)

Syntax.g.cs

Builds a ShellGroupedExpressionSyntax from its parts.

public static ShellGroupedExpressionSyntax ShellGroupedExpression(SyntaxToken openParenToken, ShellExpressionSyntax expression, SyntaxToken closeParenToken)

Parameters

openParenToken SyntaxToken
expression ShellExpressionSyntax
closeParenToken SyntaxToken

Returns

ShellGroupedExpressionSyntax

ShellLiteralWordPart(SyntaxToken)

Syntax.g.cs

Builds a ShellLiteralWordPartSyntax from its parts.

public static ShellLiteralWordPartSyntax ShellLiteralWordPart(SyntaxToken textToken)

Parameters

textToken SyntaxToken

Returns

ShellLiteralWordPartSyntax

ShellOperandExpression(ShellWordSyntax)

Syntax.g.cs

Builds a ShellOperandExpressionSyntax from its parts.

public static ShellOperandExpressionSyntax ShellOperandExpression(ShellWordSyntax word)

Parameters

word ShellWordSyntax

Returns

ShellOperandExpressionSyntax

ShellPipeline(SyntaxToken, SeparatedSyntaxList<ShellStatementSyntax>)

Syntax.g.cs

Builds a ShellPipelineSyntax from its parts.

public static ShellPipelineSyntax ShellPipeline(SyntaxToken bangToken, SeparatedSyntaxList<ShellStatementSyntax> commands)

Parameters

bangToken SyntaxToken
commands SeparatedSyntaxList<ShellStatementSyntax>

Returns

ShellPipelineSyntax

ShellQuotedString(SyntaxToken, SyntaxList<ShellWordPartSyntax>, SyntaxToken)

Syntax.g.cs

Builds a ShellQuotedStringSyntax from its parts.

public static ShellQuotedStringSyntax ShellQuotedString(SyntaxToken openQuoteToken, SyntaxList<ShellWordPartSyntax> parts, SyntaxToken closeQuoteToken)

Parameters

openQuoteToken SyntaxToken
parts SyntaxList<ShellWordPartSyntax>
closeQuoteToken SyntaxToken

Returns

ShellQuotedStringSyntax

ShellRawExpression(SyntaxToken)

Syntax.g.cs

Builds a ShellRawExpressionSyntax from its parts.

public static ShellRawExpressionSyntax ShellRawExpression(SyntaxToken textToken)

Parameters

textToken SyntaxToken

Returns

ShellRawExpressionSyntax

ShellRedirection(SyntaxToken, SyntaxToken, ShellWordSyntax?)

Syntax.g.cs

Builds a ShellRedirectionSyntax from its parts.

public static ShellRedirectionSyntax ShellRedirection(SyntaxToken ioNumberToken, SyntaxToken operatorToken, ShellWordSyntax? target)

Parameters

ioNumberToken SyntaxToken
operatorToken SyntaxToken
target ShellWordSyntax?

Returns

ShellRedirectionSyntax

ShellScript(ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a ShellScriptSyntax from its parts.

public static ShellScriptSyntax ShellScript(ShellStatementListSyntax statements, SyntaxToken endOfFileToken)

Parameters

statements ShellStatementListSyntax
endOfFileToken SyntaxToken

Returns

ShellScriptSyntax

ShellSkippedText(SyntaxTokenList)

Syntax.g.cs

Builds a ShellSkippedTextSyntax from its parts.

public static ShellSkippedTextSyntax ShellSkippedText(SyntaxTokenList tokens)

Parameters

tokens SyntaxTokenList

Returns

ShellSkippedTextSyntax

ShellStatementList(SeparatedSyntaxList<ShellStatementSyntax>)

Syntax.g.cs

Builds a ShellStatementListSyntax from its parts.

public static ShellStatementListSyntax ShellStatementList(SeparatedSyntaxList<ShellStatementSyntax> statements)

Parameters

statements SeparatedSyntaxList<ShellStatementSyntax>

Returns

ShellStatementListSyntax

ShellUnaryExpression(SyntaxKind, SyntaxToken, ShellExpressionSyntax, SyntaxToken)

Syntax.g.cs

Builds a ShellUnaryExpressionSyntax from its parts.

public static ShellUnaryExpressionSyntax ShellUnaryExpression(SyntaxKind kind, SyntaxToken prefixOperatorToken, ShellExpressionSyntax operand, SyntaxToken postfixOperatorToken)

Parameters

kind SyntaxKind
prefixOperatorToken SyntaxToken
operand ShellExpressionSyntax
postfixOperatorToken SyntaxToken

Returns

ShellUnaryExpressionSyntax

ShellVariableReference(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxToken)

Syntax.g.cs

Builds a ShellVariableReferenceSyntax from its parts.

public static ShellVariableReferenceSyntax ShellVariableReference(SyntaxToken introducerToken, SyntaxToken openBraceToken, SyntaxToken nameToken, SyntaxToken closeBraceToken)

Parameters

introducerToken SyntaxToken
openBraceToken SyntaxToken
nameToken SyntaxToken
closeBraceToken SyntaxToken

Returns

ShellVariableReferenceSyntax

ShellWord(SyntaxList<ShellWordPartSyntax>)

Syntax.g.cs

Builds a ShellWordSyntax from its parts.

public static ShellWordSyntax ShellWord(SyntaxList<ShellWordPartSyntax> parts)

Parameters

parts SyntaxList<ShellWordPartSyntax>

Returns

ShellWordSyntax

SkippedText(string)

SyntaxFactory.cs
public static ShellSkippedTextSyntax SkippedText(string text)

Parameters

text string

Returns

ShellSkippedTextSyntax

Exceptions

ArgumentNullException
text is null.

StatementList(ShellStatementSyntax[])

SyntaxFactory.cs
public static ShellStatementListSyntax StatementList(params ShellStatementSyntax[] statements)

Parameters

statements ShellStatementSyntax[]

Returns

ShellStatementListSyntax

Exceptions

ArgumentNullException
statements is null.

Token overloads

Token(SyntaxKind)

SyntaxFactory.cs

Creates a token of kind, spelled the only way that kind can be.

public static SyntaxToken Token(SyntaxKind kind)
Parameters
kind SyntaxKind
Returns

SyntaxToken

Token(SyntaxKind, string, string?)

SyntaxFactory.cs

Creates a token of kind spelled text.

public static SyntaxToken Token(SyntaxKind kind, string text, string? valueText = null)
Parameters
kind SyntaxKind
text string
valueText string?
Returns

SyntaxToken

Exceptions
ArgumentNullException
text is null.

Trivia(SyntaxKind, string)

SyntaxFactory.cs
public static SyntaxTrivia Trivia(SyntaxKind kind, string text)

Parameters

kind SyntaxKind
text string

Returns

SyntaxTrivia

Exceptions

ArgumentNullException
text is null.

VariableReference(string, ShellDialect, bool)

SyntaxFactory.cs

Creates a reference to name using the syntax of dialect.

public static ShellVariableReferenceSyntax VariableReference(string name, ShellDialect dialect, bool braced = false)

Parameters

name string
dialect ShellDialect
braced bool

Returns

ShellVariableReferenceSyntax

Exceptions

ArgumentNullException
name or dialect is null.

Whitespace(string)

SyntaxFactory.cs
public static SyntaxTrivia Whitespace(string text = " ")

Parameters

text string

Returns

SyntaxTrivia

Exceptions

ArgumentNullException
text is null.

Word overloads

Word(ShellWordPartSyntax[])

SyntaxFactory.cs

Creates a word from parts.

public static ShellWordSyntax Word(params ShellWordPartSyntax[] parts)
Parameters
parts ShellWordPartSyntax[]
Returns

ShellWordSyntax

Exceptions
ArgumentNullException
parts is null.

Word(string, ShellDialect)

SyntaxFactory.cs

Creates a word holding text, quoting it for dialect only when the text would otherwise be split, expanded, or globbed.

public static ShellWordSyntax Word(string text, ShellDialect dialect)
Parameters
text string
dialect ShellDialect
Returns

ShellWordSyntax

Exceptions
ArgumentNullException
text or dialect is null.

ZshAlwaysStatement(ShellStatementSyntax, SyntaxToken, ShellStatementSyntax)

Syntax.g.cs

Builds a ZshAlwaysStatementSyntax from its parts.

public static ZshAlwaysStatementSyntax ZshAlwaysStatement(ShellStatementSyntax body, SyntaxToken alwaysKeyword, ShellStatementSyntax alwaysBody)

Parameters

body ShellStatementSyntax
alwaysKeyword SyntaxToken
alwaysBody ShellStatementSyntax

Returns

ZshAlwaysStatementSyntax

ZshForeachStatement(SyntaxToken, SyntaxToken, SyntaxToken, SyntaxList<ShellWordSyntax>, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a ZshForeachStatementSyntax from its parts.

public static ZshForeachStatementSyntax ZshForeachStatement(SyntaxToken keyword, SyntaxToken variableToken, SyntaxToken openParenToken, SyntaxList<ShellWordSyntax> items, SyntaxToken closeParenToken, ShellStatementListSyntax body, SyntaxToken endKeyword)

Parameters

keyword SyntaxToken
variableToken SyntaxToken
openParenToken SyntaxToken
items SyntaxList<ShellWordSyntax>
closeParenToken SyntaxToken
body ShellStatementListSyntax
endKeyword SyntaxToken

Returns

ZshForeachStatementSyntax

ZshRepeatStatement(SyntaxToken, ShellWordSyntax, SyntaxToken, SyntaxToken, ShellStatementListSyntax, SyntaxToken)

Syntax.g.cs

Builds a ZshRepeatStatementSyntax from its parts.

public static ZshRepeatStatementSyntax ZshRepeatStatement(SyntaxToken repeatKeyword, ShellWordSyntax count, SyntaxToken listTerminatorToken, SyntaxToken doKeyword, ShellStatementListSyntax body, SyntaxToken doneKeyword)

Parameters

repeatKeyword SyntaxToken
count ShellWordSyntax
listTerminatorToken SyntaxToken
doKeyword SyntaxToken
body ShellStatementListSyntax
doneKeyword SyntaxToken

Returns

ZshRepeatStatementSyntax