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.

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

Jump to bottom

feat: inlay hints for inferred types of lambda parameters #993

Merged
merged 1 commit into from
Apr 4, 2024
Merged

feat: inlay hints for inferred types of lambda parameters #993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
86 changes: 61 additions & 25 deletions packages/safe-ds-lang/src/language/lsp/safe-ds-inlay-hint-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { AstNode, AstUtils, DocumentationProvider, interruptAndCheck, LangiumDocument } from 'langium';
import { AstNode, AstUtils, CstNode, DocumentationProvider, interruptAndCheck, LangiumDocument } from 'langium';
import {
CancellationToken,
type InlayHint,
Expand All @@ -7,11 +7,22 @@ import {
MarkupContent,
} from 'vscode-languageserver';
import { createMarkupContent } from '../documentation/safe-ds-comment-provider.js';
import { isSdsArgument, isSdsBlockLambdaResult, isSdsPlaceholder, isSdsYield } from '../generated/ast.js';
import {
isSdsArgument,
isSdsBlockLambdaResult,
isSdsLambda,
isSdsParameter,
isSdsPlaceholder,
isSdsYield,
SdsArgument,
SdsBlockLambdaResult,
SdsPlaceholder,
SdsYield,
} from '../generated/ast.js';
import { Argument } from '../helpers/nodeProperties.js';
import { SafeDsNodeMapper } from '../helpers/safe-ds-node-mapper.js';
import { SafeDsServices } from '../safe-ds-module.js';
import { NamedType } from '../typing/model.js';
import { NamedType, UnknownType } from '../typing/model.js';
import { SafeDsTypeComputer } from '../typing/safe-ds-type-computer.js';
import { AbstractInlayHintProvider, InlayHintAcceptor } from 'langium/lsp';
import { SafeDsSettingsProvider } from '../workspace/safe-ds-settings-provider.js';
Expand Down Expand Up @@ -54,31 +65,37 @@ export class SafeDsInlayHintProvider extends AbstractInlayHintProvider {
return;
}

// Show inferred types for named assignees
if (
(await this.settingsProvider.shouldShowAssigneeTypeInlayHints()) &&
(isSdsBlockLambdaResult(node) || isSdsPlaceholder(node) || isSdsYield(node))
) {
const type = this.typeComputer.computeType(node);
let tooltip: MarkupContent | undefined = undefined;
if (type instanceof NamedType) {
tooltip = createMarkupContent(this.documentationProvider.getDocumentation(type.declaration));
}
if (await this.settingsProvider.shouldShowAssigneeTypeInlayHints()) {
this.computeAssigneeTypeInlayHint(node, cstNode, acceptor);
}

if (await this.settingsProvider.shouldShowLambdaParameterTypeInlayHints()) {
this.computeLambdaParameterTypeInlayHint(node, cstNode, acceptor);
}

acceptor({
position: cstNode.range.end,
label: `: ${type}`,
kind: InlayHintKind.Type,
tooltip,
});
if (await this.settingsProvider.shouldShowParameterNameInlayHints()) {
this.computeParameterNameInlayHint(node, cstNode, acceptor);
}
}

// Show parameter names for positional arguments
if (
(await this.settingsProvider.shouldShowParameterNameInlayHints()) &&
isSdsArgument(node) &&
Argument.isPositional(node)
) {
private computeAssigneeTypeInlayHint(
node: AstNode | SdsBlockLambdaResult | SdsPlaceholder | SdsYield,
cstNode: CstNode,
acceptor: InlayHintAcceptor,
) {
if (isSdsBlockLambdaResult(node) || isSdsPlaceholder(node) || isSdsYield(node)) {
this.computeTypeInlayHint(node, cstNode, acceptor);
}
}

private computeLambdaParameterTypeInlayHint(node: AstNode, cstNode: CstNode, acceptor: InlayHintAcceptor) {
if (isSdsParameter(node) && AstUtils.hasContainerOfType(node, isSdsLambda) && !node.type) {
this.computeTypeInlayHint(node, cstNode, acceptor);
}
}

private computeParameterNameInlayHint(node: AstNode | SdsArgument, cstNode: CstNode, acceptor: InlayHintAcceptor) {
if (isSdsArgument(node) && Argument.isPositional(node)) {
const parameter = this.nodeMapper.argumentToParameter(node);
if (parameter) {
acceptor({
Expand All @@ -90,4 +107,23 @@ export class SafeDsInlayHintProvider extends AbstractInlayHintProvider {
}
}
}

private computeTypeInlayHint(node: AstNode, cstNode: CstNode, acceptor: InlayHintAcceptor) {
const type = this.typeComputer.computeType(node);
if (type === UnknownType) {
return;
}

let tooltip: MarkupContent | undefined = undefined;
if (type instanceof NamedType) {
tooltip = createMarkupContent(this.documentationProvider.getDocumentation(type.declaration));
}

acceptor({
position: cstNode.range.end,
label: `: ${type}`,
kind: InlayHintKind.Type,
tooltip,
});
}
}
7 changes: 7 additions & 0 deletions packages/safe-ds-lang/src/language/workspace/safe-ds-settings-provider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ export class SafeDsSettingsProvider {
return (await this.getInlayHintsSettings()).assigneeTypes?.enabled ?? true;
}

async shouldShowLambdaParameterTypeInlayHints(): Promise<boolean> {
return (await this.getInlayHintsSettings()).lambdaParameterTypes?.enabled ?? true;
}

async shouldShowParameterNameInlayHints(): Promise<boolean> {
return (await this.getInlayHintsSettings()).parameterNames?.enabled ?? true;
}
Expand Down Expand Up @@ -50,6 +54,9 @@ interface InlayHintsSettings {
assigneeTypes: {
enabled: boolean;
};
lambdaParameterTypes: {
enabled: boolean;
};
parameterNames: {
enabled: boolean;
};
Expand Down
Loading