Class RHelp

src/helpViewer/index.ts:212–668

// The name api.HelpPanel is a bit misleading
// This class manages all R-help and R-packages related functions
export class RHelp implements api.HelpPanel, vscode.WebviewPanelSerializer<string>
{
    // Path of a vanilla R installation
    readonly rPath: string

    // If applicable, the currently opened wd.
    // Used to read the correct .Rprofile when launching R
    readonly cwd?: string

    // Provides the content of help pages:
    readonly helpProvider: HelpProvider

    // Provides a list of aliases:
    readonly aliasProvider: AliasProvider
    
    // Provides previews of local help pages:
    readonly previewProviders: RLocalHelpPreviewer[]

    // Show/Install/Remove packages:
    readonly packageManager: PackageManager

    // The tree view that shows available packages and help topics
    readonly treeViewWrapper: HelpTreeWrapper

    // the webview panel(s) where the help is shown
    public readonly helpPanels: HelpPanel[] = []

    // locations on disk, only changed on construction
    readonly webviewScriptFile: vscode.Uri // the javascript added to help pages
    readonly webviewStyleFile: vscode.Uri // the css file applied to help pages

    // cache for modified help files (syntax highlighting etc.)
    private cachedHelpFiles: Map<string, HelpFile | undefined> = new Map<
        string,
        HelpFile | undefined
    >()

    // The options used when creating this instance
    private helpPanelOptions: HelpOptions
    private helpPreviewerOptions: RHelpPreviewerOptions

    constructor(options: HelpOptions) {
        this.rPath = options.rPath;
        this.webviewScriptFile = vscode.Uri.file(options.webviewScriptPath);
        this.webviewStyleFile = vscode.Uri.file(options.webviewStylePath);
        const pkgListener = () => {
            console.log('Restarting Help Server...');
            void this.refresh(true);
        };
        this.helpProvider = new HelpProvider({
            ...options,
            pkgListener: pkgListener,
        });
        this.aliasProvider = new AliasProvider(options);
        const previewListener = (previewer: RLocalHelpPreviewer) => {
            console.log(`Refreshing R Help preview: ${previewer.packageDir}`);
            void this.refreshPreviewer(previewer);
        };