Skip to content

Flag default switch statement condition clause as keyword #10487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
daxian-dbw merged 4 commits into from
Jun 9, 2020
Merged

Flag default switch statement condition clause as keyword #10487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5d0cac4
Add `Default` TokenKind
msftrncs Oct 3, 2019
7a9aa2c
Correct test for change of Default keyword.
msftrncs Oct 1, 2019
e7f6c17
Add tests for parsing 'limited' keywords.
msftrncs Oct 3, 2019
8a46649
Keep backward compatibility
daxian-dbw Jun 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 31 additions & 21 deletions src/System.Management.Automation/engine/parser/Parser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2744,28 +2744,42 @@ private StatementAst SwitchStatementRule(LabelToken labelToken, Token switchToke

while (true)
{
ExpressionAst clauseCondition = GetSingleCommandArgument(CommandArgumentContext.SwitchCondition);
if (clauseCondition == null)
{
// ErrorRecovery: if we don't have anything that looks like a condition, we won't
// find a body (because a body is just a script block, which works as a condition.)
// So don't look for a body, hope we find the '}' next.
Token token = PeekToken();
bool isDefaultClause = token.Kind == TokenKind.Default;
ExpressionAst clauseCondition = null;

isError = true;
ReportIncompleteInput(After(endErrorStatement),
nameof(ParserStrings.MissingSwitchConditionExpression),
ParserStrings.MissingSwitchConditionExpression);
// Consume a closing curly, if there is one, to avoid an extra error
if (PeekToken().Kind == TokenKind.RCurly)
if (isDefaultClause)
{
// Consume the 'default' token.
SkipToken();
clauseCondition = new StringConstantExpressionAst(token.Extent, token.Text, StringConstantType.BareWord);
}
else
{
clauseCondition = GetSingleCommandArgument(CommandArgumentContext.SwitchCondition);
if (clauseCondition == null)
{
SkipToken();
}
// ErrorRecovery: if we don't have anything that looks like a condition, we won't
// find a body (because a body is just a script block, which works as a condition.)
// So don't look for a body, hope we find the '}' next.
isError = true;
ReportIncompleteInput(After(endErrorStatement),
nameof(ParserStrings.MissingSwitchConditionExpression),
ParserStrings.MissingSwitchConditionExpression);

break;
// Consume a closing curly, if there is one, to avoid an extra error
if (PeekToken().Kind == TokenKind.RCurly)
{
SkipToken();
}

break;
}
}

errorAsts.Add(clauseCondition);
endErrorStatement = clauseCondition.Extent;

StatementBlockAst clauseBody = StatementBlockRule();
if (clauseBody == null)
{
Expand All @@ -2781,11 +2795,7 @@ private StatementAst SwitchStatementRule(LabelToken labelToken, Token switchToke
errorAsts.Add(clauseBody);
endErrorStatement = clauseBody.Extent;

var clauseConditionString = clauseCondition as StringConstantExpressionAst;

if (clauseConditionString != null &&
clauseConditionString.StringConstantType == StringConstantType.BareWord &&
clauseConditionString.Value.Equals("default", StringComparison.OrdinalIgnoreCase))
if (isDefaultClause)
{
if (@default != null)
{
Expand All @@ -2807,7 +2817,7 @@ private StatementAst SwitchStatementRule(LabelToken labelToken, Token switchToke

SkipNewlinesAndSemicolons();

Token token = PeekToken();
token = PeekToken();
if (token.Kind == TokenKind.RCurly)
{
rCurly = token;
Expand Down
9 changes: 7 additions & 2 deletions src/System.Management.Automation/engine/parser/token.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,9 @@ public enum TokenKind
/// <summary>The 'base' keyword</summary>
Base = 168,

/// <summary>The 'default' keyword</summary>
Default = 169,

#endregion Keywords
}

Expand Down Expand Up @@ -927,6 +930,7 @@ public static class TokenTraits
/* Command */ TokenFlags.Keyword,
/* Hidden */ TokenFlags.Keyword,
/* Base */ TokenFlags.Keyword,
/* Default */ TokenFlags.Keyword,

#endregion Flags for keywords
};
Expand Down Expand Up @@ -1125,16 +1129,17 @@ public static class TokenTraits
/* Command */ "command",
/* Hidden */ "hidden",
/* Base */ "base",
/* Default */ "default",

#endregion Text for keywords
};

#if DEBUG
static TokenTraits()
{
Diagnostics.Assert(s_staticTokenFlags.Length == ((int)TokenKind.Base + 1),
Diagnostics.Assert(s_staticTokenFlags.Length == ((int)TokenKind.Default + 1),
"Table size out of sync with enum - _staticTokenFlags");
Diagnostics.Assert(s_tokenText.Length == ((int)TokenKind.Base + 1),
Diagnostics.Assert(s_tokenText.Length == ((int)TokenKind.Default + 1),
"Table size out of sync with enum - _tokenText");
// Some random assertions to make sure the enum and the traits are in sync
Diagnostics.Assert(GetTraits(TokenKind.Begin) == (TokenFlags.Keyword | TokenFlags.ScriptBlockBlockName),
Expand Down
4 changes: 2 additions & 2 deletions src/System.Management.Automation/engine/parser/tokenizer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,7 +628,7 @@ private static readonly Dictionary<string, TokenKind> s_operatorTable
/*A*/ "configuration", "public", "private", "static", /*A*/
/*B*/ "interface", "enum", "namespace", "module", /*B*/
/*C*/ "type", "assembly", "command", "hidden", /*C*/
/*D*/ "base", /*D*/
/*D*/ "base", "default", /*D*/
};

private static readonly TokenKind[] s_keywordTokenKind = new TokenKind[] {
Expand All @@ -644,7 +644,7 @@ private static readonly Dictionary<string, TokenKind> s_operatorTable
/*A*/ TokenKind.Configuration, TokenKind.Public, TokenKind.Private, TokenKind.Static, /*A*/
/*B*/ TokenKind.Interface, TokenKind.Enum, TokenKind.Namespace,TokenKind.Module, /*B*/
/*C*/ TokenKind.Type, TokenKind.Assembly, TokenKind.Command, TokenKind.Hidden, /*C*/
/*D*/ TokenKind.Base, /*D*/
/*D*/ TokenKind.Base, TokenKind.Default, /*D*/
};

internal static readonly string[] _operatorText = new string[] {
Expand Down
162 changes: 162 additions & 0 deletions test/powershell/Language/Parser/Parsing.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,3 +423,165 @@ Describe "Ternary Operator parsing" -Tags CI {
$expr.IfFalse | Should -BeOfType 'System.Management.Automation.Language.ConstantExpressionAst'
}
}

Describe "Keywords 'default', 'hidden', 'in', 'static' Token parsing" -Tags CI {
BeforeAll {
$testCases_basic = @(
@{
Script = 'switch (1) {default {0} 1 {1}}'
TokensToCheck = @{
5 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Default
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::Keyword
}
}
}
@{
Script = 'switch (1) {"default" {0} 1 {1}}'
TokensToCheck = @{
5 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::StringExpandable
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
}
}
@{
Script = 'switch (1) {adefault {0} 1 {1}}'
TokensToCheck = @{
5 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Identifier
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
}
}
@{
Script = 'foreach ($i in 1..2) {$i}'
TokensToCheck = @{
3 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::In
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::Keyword
}
}
}
@{
Script = 'class test {hidden $a; static aMethod () {return $this.a} }'
TokensToCheck = @{
3 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Hidden
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::Keyword
}
6 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Static
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::Keyword
}
}
}
@{
Script = 'echo default hidden in static'
TokensToCheck = @{
1 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Generic
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
2 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Generic
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
3 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Generic
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
4 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Generic
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::None
}
}
}
@{
Script = 'default'
TokensToCheck = @{
0 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Default
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword -bor [System.Management.Automation.Language.TokenFlags]::CommandName
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::CommandName
}
}
}
@{
Script = 'hidden'
TokensToCheck = @{
0 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Hidden
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword -bor [System.Management.Automation.Language.TokenFlags]::CommandName
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::CommandName
}
}
}
@{
Script = 'in'
TokensToCheck = @{
0 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::In
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword -bor [System.Management.Automation.Language.TokenFlags]::CommandName
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::CommandName
}
}
}
@{
Script = 'static'
TokensToCheck = @{
0 = @{
TokenKind = [System.Management.Automation.Language.TokenKind]::Static
TokenFlags_Mask = [System.Management.Automation.Language.TokenFlags]::Keyword -bor [System.Management.Automation.Language.TokenFlags]::CommandName
TokenFlags_Value = [System.Management.Automation.Language.TokenFlags]::CommandName
}
}
}
)
}

AfterAll {
}

It "Keywords 'default', 'hidden', 'in', 'static' in {<Script>} correctly tokenized." -TestCases $testCases_basic {
param($Script, $TokensToCheck)

$tks = $null
$ers = $null
$result = [System.Management.Automation.Language.Parser]::ParseInput($Script, [ref]$tks, [ref]$ers)

foreach ($token in $TokensToCheck.Keys ) {
if ($TokensToCheck[$Token].ContainsKey('TokenKind')) {
$tks[$token].Kind | Should -Be $TokensToCheck[$token].TokenKind -Because 'because TokenKind must be as expected'
}
if ($TokensToCheck[$Token].ContainsKey('TokenFlags_Value')) {
$tks[$token].TokenFlags -band $TokensToCheck[$token].TokenFlags_Mask | Should -Be $TokensToCheck[$token].TokenFlags_Value -Because 'because TokenFlags must be as expected after masking'
}
}
}

$testKeywordsAsCmds = @(
@{ Keyword = 'default' }
@{ Keyword = 'hidden' }
@{ Keyword = 'in' } # Note: this overwrites Pester's `In` function.
@{ Keyword = 'static' }
)

It "<Keyword> can be used as command name" -TestCases $testKeywordsAsCmds {
param($Keyword)

Invoke-Expression "function $Keyword { '$Keyword' }"

. $Keyword | Should -BeExactly $Keyword
}
}