Skip to main content

module IDEServices

rascal-0.28.2

Usage

import util::IDEServices;

Dependencies

extend analysis::diff::edits::TextEdits;
extend Content;
extend Message;

function browse

Synopsis

Open a browser for a given location.

void browse(loc uri)

function edit

Synopsis

Open an editor for file at a given location.

void edit(loc uri)

function applyDocumentsEdits

Synopsis

Let the IDE apply a list of document edits.

Description

Asks the IDE to apply document edits as defined in the standard library module analysis::diff::edits::TextEdits, according to the semantics defined in analysis::diff::edits::ExecuteTextEdits. However, the IDE can take care of these changes in order to provide important UI experience features such as "preview" and "undo".

Typically a call to this IDE service method is included in the implementation of refactoring and quick-fix features of the language service protocol.

void applyDocumentsEdits(list[DocumentEdit] edits)

function showInteractiveContent

Synopsis

Asks the IDE to show a "browser window" with the given interactive Content.

void showInteractiveContent(Content content)

function showMessage

void showMessage(Message message)

function logMessage

void logMessage(Message message)

function registerDiagnostics

void registerDiagnostics(list[Message] messages)

function unregisterDiagnostics

void unregisterDiagnostics(list[loc] resources)