Table of Contents

Namespace RDCore.SDK.Formatting

Classes

CodeFormattingOptions

What a formatting engine is told to do (SdkFormattingOptions is where a user says it): how deep to indent, what to align, and what the editing assists do.

FormattingTabSize

Takes the tab size of the client's editor as Formatting.IndentSpaces when the user never set one, through the configuration the client owns.

IndenterSettingsApplied

What setting an import's settings for a user made of them: how many were set, and the keys of the ones that were not.

IndenterSettingsImport

The indenter settings Rubberduck has, as Formatting settings of the platform: the mapping of what a client read of them (RubberduckIndenterSettingsResult) to the settings of SdkFormattingOptions.

IndenterSettingsImportFlow

Imports the indenter settings of Rubberduck from a client that reads them: asks it what it found, maps that to Formatting settings (IndenterSettingsImport), and asks it to take them as its own.

IndenterSettingsImportOutcome

What an import of Rubberduck's indenter settings did.

IndenterSettingsImportResult

The result of setting imported settings.

IndenterSettingsImportText

What the import of Rubberduck's indenter settings says to the user, in the language of the user interface.

IndenterSettingsOffer

Offers, once, to import the indenter settings of Rubberduck: when the client has them, the user never set a Formatting setting, and the user was not offered already.

ModuleBlocks

The blocks of a module that a line is in and that the module does not close, and what an editor does with them when a line break is typed: it indents the new line, and closes the block the line before it opens.

ModuleIndenter

Indents the lines of a module by what encloses them in its syntax tree (CodeFormattingOptions): a line is indented one level for each body it is in - of a procedure, an Enum or a Type, a branch of an If block, a Case, a loop, a With block, a branch of an #If directive.

ProgramBlocks

The blocks of a program of the platform's BASIC (BasicProgramText) that a line is in and that the program does not close, as a shell offers to close them while the program is typed one numbered line at a time.

ProgramIndenter

Indents the lines of a program of the platform's BASIC (BasicProgramText) as ModuleIndenter indents a module: a statement is indented one level for each block it is in - an If, a Select Case, a loop, a With.

RubberduckIndenterSettingsReader

Reads the indenter settings of Rubberduck where they are, as they are: what a client answers rdcore/formatting/indenterSettings with (RubberduckIndenterSettingsParams).

Snippet

The text a snippet is inserted as, and the places in it an editor's cursor stops at (LSP 3.17 §Snippet Syntax): what a completion item whose insertTextFormat is Snippet inserts.

WindowsLegacyIndenterRegistry

Where the legacy Smart Indenter kept its settings: the Windows Registry, which only Windows has.

Structs

IndentationEdit

An edit of the whitespace of a module: what is from Character of line Line to EndCharacter of line EndLine is replaced by NewText. What is replaced is whitespace, or nothing, and so is what replaces it: a run of it within a line, or the empty lines between two procedures, from the end of the line before them.

ModuleBlock

A block of a module that is open at one of its lines: its opener is at or before the line, and the module has no closer for it.

ProgramBlock

A block of a program of the platform's BASIC (BasicProgramText) that is open at one of its lines: its opener is at or before the line, and the program has no closer for it.

SnippetTabStop

A place of a snippet the cursor stops at (LSP 3.17 §Snippet Syntax, Tabstops and Placeholders): a tab stop, and the text of the snippet it is, which is its placeholder's - empty for a tab stop that has none.

Interfaces

ILegacyIndenterRegistry

Where the legacy Smart Indenter kept its settings: the Windows Registry, which only Windows has.

Enums

EmptyLineHandlingMethod

What is done with the lines that have nothing on them.

EndOfLineCommentStyle

Where the comment at the end of a line that has code goes.

SnippetDimPlacement

Where the Dim a snippet declares goes.