Function setSelections

src/rstudioapi.ts:176–209

(ranges: number[][], id: string)

}

export async function setSelections(ranges: number[][], id: string): Promise<void> {
    // Setting selections can only be done on TextEditors not TextDocuments, but
    // it is the latter which are the things actually referred to by `id`. In
    // VSCode it's not possible to get a list of the open text editors. it is not
    // window.visibleTextEditors - this is only editors (tabs) with text showing.
    // The only editors we know about are those that are visible and the last
    // active (which may not be visible if it was overtaken by a WebViewPanel).
    // This function looks to see if a text editor for the document id is amongst
    // those known, and if not, it opens and shows that document, but in a
    // texteditor 'beside' the current one.
    // The rationale for this is:
    // If an addin is trying to set selections in an editor that is not the active
    // one it is most likely that it was active before the addin ran, but the addin
    // opened a something that overtook its' focus. The most likely culprit for
    // this is a shiny app. In the case that the target window is visible
    // alongside the shiny app, it will be found and used. If it is not visible,
    // there's a change it may be the last active, if the shiny app over took it.
    // If it is neither of these things a new one needs to be opened to set
    // selections and the question is whether open it in the same window as the
    // shiny app, or the one 'beside'. 'beside' is preferred since it allows shiny
    // apps that work interactively with an open document to behave more smoothly.
    // {prefixer} is an example of one of these.
    const target = findTargetUri(id);
    const targetDocument = await workspace.openTextDocument(target);
    const editor = await reuseOrCreateEditor(targetDocument);

    const selectionObjects = ranges.map(x => {
        const newRange = parseRange(x, targetDocument);
        const newSelection = new Selection(newRange.start, newRange.end);
        return (newSelection);
    });

    editor.selections = selectionObjects;
}

export async function documentSave(id: string): Promise<void> {
    const target = findTargetUri(id);