Skip to content
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.

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

Added Handler for Semantic Tokenization #1328

Merged
merged 64 commits into from
Jul 30, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
64 commits
Select commit Hold shift + click to select a range
2790655
added basic semantic token support
Jul 16, 2020
04458e4
removed unnecessary imports
Jul 16, 2020
2e46016
removed unnecessary field
Jul 16, 2020
b3077cc
minor refactoring changes
Jul 17, 2020
f68e4e3
minor refactoring changes
Jul 17, 2020
6f28dc5
change tokenize to non async
Jul 17, 2020
d960ac7
rename handler
Jul 17, 2020
2853580
refactoring + copyright
Jul 17, 2020
a55108c
renamed handler file
Jul 17, 2020
75b6386
Delete log20200713.txt
justinytchen Jul 17, 2020
01bde39
moved/refactored handler
Jul 17, 2020
ea0fab2
added e2e tets
Jul 17, 2020
ccf1028
Merge branch 'semantic-token' of https://github.com/justinytchen/Powe…
Jul 17, 2020
170fb6b
updated test
Jul 20, 2020
4764d2e
remove pragma
Jul 20, 2020
5572a16
removed extra spacing
Jul 21, 2020
f8411cc
added testing for converting from PS token to semantic tokens
Jul 21, 2020
4b7db57
refactored the functions related to converting between tokens
Jul 21, 2020
a20241b
refactored ConvertSemanticToken
Jul 21, 2020
bebc507
fixed tests
Jul 22, 2020
5550780
added more test cases
Jul 22, 2020
3fb9abe
fixed spacing
Jul 23, 2020
73bda8d
added enum test
Jul 23, 2020
4703804
fixed spacing issues
Jul 23, 2020
c013b1d
fixed spacing, added note about token array representation
Jul 23, 2020
5ab13c4
changed name to PsesSemanticTokensHandler
Jul 23, 2020
62566a8
reformatted fields
Jul 24, 2020
bafff92
renamed file
Jul 24, 2020
5a631dd
used Assert.Collection instead of Assert.Single
Jul 24, 2020
7df4e67
modified yml file to fix build
Jul 27, 2020
b2e43b1
undo changes in yml file
Jul 28, 2020
4a6955f
addressed issues in PR
Jul 30, 2020
f4562c0
added basic semantic token support
Jul 16, 2020
6264c0b
removed unnecessary imports
Jul 16, 2020
ae5a498
removed unnecessary field
Jul 16, 2020
9ae83aa
minor refactoring changes
Jul 17, 2020
b4d558c
minor refactoring changes
Jul 17, 2020
874db6e
change tokenize to non async
Jul 17, 2020
bec8bd6
rename handler
Jul 17, 2020
9848c71
refactoring + copyright
Jul 17, 2020
855790c
renamed handler file
Jul 17, 2020
514012c
moved/refactored handler
Jul 17, 2020
5294cf4
added e2e tets
Jul 17, 2020
9aed66b
Delete log20200713.txt
justinytchen Jul 17, 2020
b4024e7
updated test
Jul 20, 2020
4908752
remove pragma
Jul 20, 2020
2e4f098
removed extra spacing
Jul 21, 2020
8f5db93
added testing for converting from PS token to semantic tokens
Jul 21, 2020
42714b5
refactored the functions related to converting between tokens
Jul 21, 2020
1657fdf
refactored ConvertSemanticToken
Jul 21, 2020
ebae357
fixed tests
Jul 22, 2020
f109d71
added more test cases
Jul 22, 2020
c9b858d
fixed spacing
Jul 23, 2020
d8f0a36
added enum test
Jul 23, 2020
3fba85f
fixed spacing issues
Jul 23, 2020
8592540
fixed spacing, added note about token array representation
Jul 23, 2020
d4a86ac
changed name to PsesSemanticTokensHandler
Jul 23, 2020
e86c5b8
reformatted fields
Jul 24, 2020
6c21195
renamed file
Jul 24, 2020
09d632c
used Assert.Collection instead of Assert.Single
Jul 24, 2020
7c4b3b7
addressed issues in PR
Jul 30, 2020
99c1c0b
Merge branch 'semantic-token' of https://github.com/justinytchen/Powe…
Jul 30, 2020
725e8eb
remove unused using
Jul 30, 2020
1aedd88
Delete Untitled-1.json
justinytchen Jul 30, 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
1 change: 1 addition & 0 deletions src/PowerShellEditorServices/Server/PsesLanguageServer.cs
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public async Task StartAsync()
.WithHandler<GetCommandHandler>()
.WithHandler<ShowHelpHandler>()
.WithHandler<ExpandAliasHandler>()
.WithHandler<SemanticTokens>()
.OnInitialize(
async (languageServer, request, cancellationToken) =>
{
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
using System.Text;
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.Logging;
using Microsoft.PowerShell.EditorServices.Services;
using Microsoft.PowerShell.EditorServices.Services.TextDocument;
using System.Management.Automation.Language;
using OmniSharp.Extensions.LanguageServer.Protocol;
using OmniSharp.Extensions.LanguageServer.Protocol.Document.Proposals;
using OmniSharp.Extensions.LanguageServer.Protocol.Models;
using OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals;

namespace Microsoft.PowerShell.EditorServices.Handlers
{
#pragma warning disable 618
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
internal class SemanticTokens : SemanticTokensHandler
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
{
private readonly ILogger _logger;
public WorkspaceService _workspaceService;
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
public SemanticTokens(ILogger<SemanticTokens> logger, WorkspaceService workspaceService) : base(new SemanticTokensRegistrationOptions() {
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
DocumentSelector = DocumentSelector.ForLanguage("powershell"),
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
Legend = new SemanticTokensLegend(),
DocumentProvider = new Supports<SemanticTokensDocumentProviderOptions>(true,
new SemanticTokensDocumentProviderOptions() {
Edits = true
}),
RangeProvider = true
})
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
{
_logger = logger;
_workspaceService = workspaceService;
}

public override async Task<OmniSharp.Extensions.LanguageServer.Protocol.Models.Proposals.SemanticTokens> Handle(
SemanticTokensParams request, CancellationToken cancellationToken)
{
var result = await base.Handle(request, cancellationToken);
return result;
}
rjmholt marked this conversation as resolved.
Show resolved Hide resolved

public override async Task<SemanticTokensOrSemanticTokensEdits> Handle(SemanticTokensEditsParams request,
CancellationToken cancellationToken)
{
var result = await base.Handle(request, cancellationToken);
return result;
}
rjmholt marked this conversation as resolved.
Show resolved Hide resolved

protected override async Task Tokenize(SemanticTokensBuilder builder, ITextDocumentIdentifierParams identifier,
CancellationToken cancellationToken)
{
ScriptFile file = _workspaceService.GetFile(DocumentUri.GetFileSystemPath(identifier));
await Task.Yield();
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
Token[] tokens = file.ScriptTokens;
foreach (var token in tokens){
pushToken(token, builder);
}
}
rjmholt marked this conversation as resolved.
Show resolved Hide resolved

private static void pushToken(Token token, SemanticTokensBuilder builder){
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
if(token is StringExpandableToken stringExpandableToken){
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
//try parsing tokens within the string
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
if(stringExpandableToken.NestedTokens != null)
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
{
foreach(Token t in stringExpandableToken.NestedTokens){
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
pushToken(t, builder);
}
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
return;
}
}

//Tokens line and col numbers indexed starting from 1, expecting indexing from 0
var line = token.Extent.StartLineNumber - 1;
var index = token.Extent.StartColumnNumber - 1;
rjmholt marked this conversation as resolved.
Show resolved Hide resolved

builder.Push(line, index, token.Text.Length, MapSemanticToken(token), new string[]{});
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
}

private static SemanticTokenType MapSemanticToken(Token token)
{
//first check token flags
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
if ((token.TokenFlags & TokenFlags.Keyword) != 0)
{
return SemanticTokenType.Keyword;
}

if ((token.TokenFlags & TokenFlags.CommandName) != 0)
{
return SemanticTokenType.Function;
}

if (token.Kind != TokenKind.Generic && (token.TokenFlags &
(TokenFlags.BinaryOperator | TokenFlags.UnaryOperator | TokenFlags.AssignmentOperator )) != 0)
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
{
return SemanticTokenType.Operator;
}

if ((token.TokenFlags & TokenFlags.TypeName) != 0)
{
return SemanticTokenType.Type;
}

if ((token.TokenFlags & TokenFlags.MemberName) != 0)
{
return SemanticTokenType.Member;
}

// Only check token kind after checking flags
switch (token.Kind)
{
case TokenKind.Comment:
return SemanticTokenType.Comment;

case TokenKind.Parameter:
case TokenKind.Generic when token is StringLiteralToken slt && slt.Text.StartsWith("--"):
return SemanticTokenType.Parameter;

case TokenKind.Variable:
case TokenKind.SplattedVariable:
return SemanticTokenType.Variable;

case TokenKind.StringExpandable:
case TokenKind.StringLiteral:
case TokenKind.HereStringExpandable:
case TokenKind.HereStringLiteral:
return SemanticTokenType.String;

case TokenKind.Number:
return SemanticTokenType.Number;

case TokenKind.Generic:
return SemanticTokenType.Function;
}

// Default semantic token
return SemanticTokenType.Documentation;
}

protected override Task<SemanticTokensDocument>
GetSemanticTokensDocument(ITextDocumentIdentifierParams @params, CancellationToken cancellationToken)
rjmholt marked this conversation as resolved.
Show resolved Hide resolved
{
return Task.FromResult(new SemanticTokensDocument(GetRegistrationOptions().Legend));
}
}
#pragma warning restore 618
}