Table of Contents

Class SourceInlayHints

Namespace
RDCore.SDK.Semantics.Refactoring
Assembly
RDCore.SDK.dll

The inlay hints of a module: what its code means without saying it, each in square brackets, at the place it describes. A hint is never at the end of a line it does not describe, where it would read like code.

public static class SourceInlayHints
Inheritance
SourceInlayHints
Inherited Members

Methods

In(ModuleNode, SourceRange, SdkInlayHintOptions, Func<ExpressionNode, SignatureDescription?>)

The hints of the places of a range of a module that the settings show (SdkInlayHintOptions), in the order of their positions.

public static IReadOnlyList<SourceInlayHint> In(ModuleNode module, SourceRange range, SdkInlayHintOptions sites, Func<ExpressionNode, SignatureDescription?> signatureOf)

Parameters

module ModuleNode

The module.

range SourceRange

The range of the module's source the hints are asked of.

sites SdkInlayHintOptions

Which places are hinted.

signatureOf Func<ExpressionNode, SignatureDescription>

The signature of what a call calls, given the expression it calls (Wheel.MoveTo); null when it is not known, and the call's arguments are not hinted. What a name binds to is the platform's to say.

Returns

IReadOnlyList<SourceInlayHint>

Remarks

An argument's hint is the name of the parameter its position gives it to, before it, for each positional argument up to the first named one (MS-VBAL §5.6.13.1): none for an omitted argument, for an argument that is a name and the parameter's, nor for an argument there is no parameter for. A ParamArray takes the first of the arguments left over, which is shown its name, and the others are not. A call is hinted when it overlaps the range.

A procedure without an access modifier is [Public] (MS-VBAL §5.3.1.1), and the statement that closes it shows its name. A parameter written without ByVal or ByRef is [ByRef] (MS-VBAL §5.3.1.5), or [ByVal] for the value of a Property Let or Set, which is passed by value (ImplicitByVal); a ParamArray is neither. Each header of a procedure written once in each branch of a #If block has its own (HeaderAlternatives).

A variable or a parameter declared without a type is a Variant unless a Deftype statement covers its name (MS-VBAL §5.2.3.1.5): only a Variant that nothing says is hinted. An array parameter (Items()) is not: there is nowhere to show the type where it would be written.