|
| 1 | +import { DisposableCollection } from '@theia/core/lib/common/disposable'; |
| 2 | +import { isObject } from '@theia/core/lib/common/types'; |
| 3 | +import URI from '@theia/core/lib/common/uri'; |
| 4 | +import { inject, injectable } from '@theia/core/shared/inversify'; |
| 5 | +import { HostedPluginSupport } from '@theia/plugin-ext/lib/hosted/browser/hosted-plugin'; |
| 6 | +import type { ArduinoState } from 'vscode-arduino-api'; |
| 7 | +import { URI as CodeUri } from 'vscode-uri'; |
| 8 | +import type { Port, Sketch } from '../../common/protocol'; |
| 9 | +import { BoardsService } from '../../common/protocol'; |
| 10 | +import type { BoardsConfig } from '../boards/boards-config'; |
| 11 | +import { BoardsDataStore } from '../boards/boards-data-store'; |
| 12 | +import { BoardsServiceProvider } from '../boards/boards-service-provider'; |
| 13 | +import { CurrentSketch } from '../sketches-service-client-impl'; |
| 14 | +import { SketchContribution } from './contribution'; |
| 15 | + |
| 16 | +interface UpdateWorkspaceStateParams { |
| 17 | + readonly key: keyof ArduinoState; |
| 18 | + readonly value: ArduinoState[keyof ArduinoState]; |
| 19 | +} |
| 20 | + |
| 21 | +/** |
| 22 | + * Contribution for setting the VS Code [`workspaceState`](https://code.visualstudio.com/api/references/vscode-api#workspace) on Arduino IDE context changes, such as FQBN, selected port, and sketch path changes via commands. |
| 23 | + * See [`vscode-arduino-api`](https://www.npmjs.com/package/vscode-arduino-api) for more details. |
| 24 | + */ |
| 25 | +@injectable() |
| 26 | +export class UpdateArduinoContext extends SketchContribution { |
| 27 | + @inject(BoardsService) |
| 28 | + private readonly boardsService: BoardsService; |
| 29 | + @inject(BoardsServiceProvider) |
| 30 | + private readonly boardsServiceProvider: BoardsServiceProvider; |
| 31 | + @inject(BoardsDataStore) |
| 32 | + private readonly boardsDataStore: BoardsDataStore; |
| 33 | + @inject(HostedPluginSupport) |
| 34 | + private readonly hostedPluginSupport: HostedPluginSupport; |
| 35 | + |
| 36 | + private readonly toDispose = new DisposableCollection(); |
| 37 | + |
| 38 | + override onStart(): void { |
| 39 | + this.toDispose.pushAll([ |
| 40 | + this.boardsServiceProvider.onBoardsConfigChanged((config) => |
| 41 | + this.updateBoardsConfig(config) |
| 42 | + ), |
| 43 | + this.sketchServiceClient.onCurrentSketchDidChange((sketch) => |
| 44 | + this.updateSketchPath(sketch) |
| 45 | + ), |
| 46 | + this.configService.onDidChangeDataDirUri((dataDirUri) => |
| 47 | + this.updateDataDirPath(dataDirUri) |
| 48 | + ), |
| 49 | + this.configService.onDidChangeSketchDirUri((userDirUri) => |
| 50 | + this.updateUserDirPath(userDirUri) |
| 51 | + ), |
| 52 | + this.commandService.onDidExecuteCommand(({ commandId, args }) => { |
| 53 | + if ( |
| 54 | + commandId === 'arduino.languageserver.notifyBuildDidComplete' && |
| 55 | + isObject<Partial<{ buildOutputUri: string }>>(args) |
| 56 | + ) { |
| 57 | + const buildOutputUri = args.buildOutputUri; |
| 58 | + if (typeof buildOutputUri === 'string') { |
| 59 | + this.updateBuildPath(new URI(buildOutputUri).path.fsPath()); |
| 60 | + } |
| 61 | + } |
| 62 | + }), |
| 63 | + this.boardsDataStore.onChanged((fqbn) => { |
| 64 | + const selectedFqbn = |
| 65 | + this.boardsServiceProvider.boardsConfig.selectedBoard?.fqbn; |
| 66 | + if (selectedFqbn && fqbn.includes(selectedFqbn)) { |
| 67 | + this.updateBoardDetails(selectedFqbn); |
| 68 | + } |
| 69 | + }), |
| 70 | + ]); |
| 71 | + } |
| 72 | + |
| 73 | + override onReady(): void { |
| 74 | + this.boardsServiceProvider.reconciled.then(() => { |
| 75 | + this.updateBoardsConfig(this.boardsServiceProvider.boardsConfig); |
| 76 | + }); |
| 77 | + const sketch = this.sketchServiceClient.tryGetCurrentSketch(); |
| 78 | + this.updateSketchPath(sketch); |
| 79 | + if (CurrentSketch.isValid(sketch)) { |
| 80 | + this.tryFindBuildPath(sketch).then((buildPath) => { |
| 81 | + if (buildPath) { |
| 82 | + this.updateBuildPath(buildPath); |
| 83 | + } |
| 84 | + }); |
| 85 | + } |
| 86 | + this.updateUserDirPath(this.configService.tryGetSketchDirUri()); |
| 87 | + this.updateDataDirPath(this.configService.tryGetDataDirUri()); |
| 88 | + } |
| 89 | + |
| 90 | + onStop(): void { |
| 91 | + this.toDispose.dispose(); |
| 92 | + } |
| 93 | + |
| 94 | + private async tryFindBuildPath(sketch: Sketch): Promise<string | undefined> { |
| 95 | + const buildPaths = await this.sketchesService.tempBuildPath(sketch); |
| 96 | + for (const buildPath of buildPaths) { |
| 97 | + try { |
| 98 | + const uri = new URI(CodeUri.file(buildPath)); |
| 99 | + await this.fileService.access(uri); |
| 100 | + return buildPath; |
| 101 | + } catch {} |
| 102 | + } |
| 103 | + return undefined; |
| 104 | + } |
| 105 | + |
| 106 | + private async updateSketchPath( |
| 107 | + sketch: CurrentSketch | undefined |
| 108 | + ): Promise<void> { |
| 109 | + const sketchPath = CurrentSketch.isValid(sketch) |
| 110 | + ? new URI(sketch.uri).path.fsPath() |
| 111 | + : undefined; |
| 112 | + return this.updateWorkspaceState({ key: 'sketchPath', value: sketchPath }); |
| 113 | + } |
| 114 | + |
| 115 | + private async updateBuildPath(buildPath: string | undefined): Promise<void> { |
| 116 | + return this.updateWorkspaceState({ key: 'buildPath', value: buildPath }); |
| 117 | + } |
| 118 | + |
| 119 | + private async updateBoardsConfig( |
| 120 | + boardsConfig: BoardsConfig.Config |
| 121 | + ): Promise<void> { |
| 122 | + const fqbn = boardsConfig.selectedBoard?.fqbn; |
| 123 | + const port = boardsConfig.selectedPort; |
| 124 | + await this.updateFqbn(fqbn); |
| 125 | + await this.updateBoardDetails(fqbn); |
| 126 | + await this.updatePort(port); |
| 127 | + } |
| 128 | + |
| 129 | + private async updateFqbn(fqbn: string | undefined): Promise<void> { |
| 130 | + await this.updateWorkspaceState({ key: 'fqbn', value: fqbn }); |
| 131 | + } |
| 132 | + |
| 133 | + private async updateBoardDetails(fqbn: string | undefined): Promise<void> { |
| 134 | + const unset = () => |
| 135 | + this.updateWorkspaceState({ key: 'boardDetails', value: undefined }); |
| 136 | + if (!fqbn) { |
| 137 | + return unset(); |
| 138 | + } |
| 139 | + const [details, persistedData] = await Promise.all([ |
| 140 | + this.boardsService.getBoardDetails({ fqbn }), |
| 141 | + this.boardsDataStore.getData(fqbn), |
| 142 | + ]); |
| 143 | + if (!details) { |
| 144 | + return unset(); |
| 145 | + } |
| 146 | + return this.updateWorkspaceState({ |
| 147 | + key: 'boardDetails', |
| 148 | + value: { |
| 149 | + ...details, |
| 150 | + configOptions: |
| 151 | + BoardsDataStore.Data.EMPTY === persistedData |
| 152 | + ? details.configOptions |
| 153 | + : persistedData.configOptions.slice(), |
| 154 | + }, |
| 155 | + }); |
| 156 | + } |
| 157 | + |
| 158 | + private async updatePort(port: Port | undefined): Promise<void> { |
| 159 | + return this.updateWorkspaceState({ key: 'port', value: port }); |
| 160 | + } |
| 161 | + |
| 162 | + private async updateUserDirPath(userDirUri: URI | undefined): Promise<void> { |
| 163 | + const userDirPath = userDirUri?.path.fsPath(); |
| 164 | + return this.updateWorkspaceState({ |
| 165 | + key: 'userDirPath', |
| 166 | + value: userDirPath, |
| 167 | + }); |
| 168 | + } |
| 169 | + |
| 170 | + private async updateDataDirPath(dataDirUri: URI | undefined): Promise<void> { |
| 171 | + const dataDirPath = dataDirUri?.path.fsPath(); |
| 172 | + return this.updateWorkspaceState({ |
| 173 | + key: 'dataDirPath', |
| 174 | + value: dataDirPath, |
| 175 | + }); |
| 176 | + } |
| 177 | + |
| 178 | + private async updateWorkspaceState( |
| 179 | + params: UpdateWorkspaceStateParams |
| 180 | + ): Promise<void> { |
| 181 | + await this.hostedPluginSupport.didStart; |
| 182 | + return this.commandService.executeCommand( |
| 183 | + 'vscodeArduinoAPI.updateState', |
| 184 | + params |
| 185 | + ); |
| 186 | + } |
| 187 | +} |
0 commit comments