feat: add getPreferredUILocation request for other tooling (#2075)

Author: connor4312

dprint.json

@@ -13,7 +13,8 @@
     "**/node_modules",
     "**/testWorkspace",
     "**/*-lock.json",
-    "**/*.d.ts"
+    "**/*.d.ts",
+    "!src/{dap,cdp}/*.d.ts"
   ],
   "plugins": [
     "https://plugins.dprint.dev/typescript-0.91.6.wasm",

src/adapter/debugAdapter.ts

@@ -126,6 +126,31 @@ export class DebugAdapter implements IDisposable {
     this.dap.on('setSymbolOptions', params => this._setSymbolOptions(params));
     this.dap.on('networkCall', params => this._doNetworkCall(params));
     this.dap.on('enableNetworking', params => this._withThread(t => t.enableNetworking(params)));
+    this.dap.on(
+      'getPreferredUILocation',
+      params => this._getPreferredUILocation(params),
+    );
+  }
+
+  private async _getPreferredUILocation(
+    params: Dap.GetPreferredUILocationParams,
+  ): Promise<Dap.GetPreferredUILocationResult> {
+    const source = this.sourceContainer.source(params.source);
+    if (!source) {
+      return params;
+    }
+
+    const location = await this.sourceContainer.preferredUiLocation({
+      columnNumber: params.column + 1,
+      lineNumber: params.line + 1,
+      source,
+    });
+
+    return {
+      column: location.columnNumber - 1,
+      line: location.lineNumber - 1,
+      source: await location.source.toDap(),
+    };
   }
 
   private async _doNetworkCall({ method, params }: Dap.NetworkCallParams) {

src/build/dapCustom.ts

@@ -786,6 +786,45 @@ const dapCustom: JSONSchema4 = {
         type: 'object',
       },
     ),
+
+    ...makeRequest(
+      'getPreferredUILocation',
+      'Resolves a compiled location into a preferred source location. May be used by other VS Code extensions.',
+      {
+        properties: {
+          source: {
+            $ref: '#/definitions/Source',
+            description: 'The source to look up.',
+          },
+          line: {
+            type: 'integer',
+            description: 'The base-0 line number to look up.',
+          },
+          column: {
+            type: 'integer',
+            description: 'The base-0 column number to look up.',
+          },
+        },
+        required: ['source', 'line', 'column'],
+      },
+      {
+        properties: {
+          source: {
+            $ref: '#/definitions/Source',
+            description: 'The resolved source.',
+          },
+          line: {
+            type: 'integer',
+            description: 'The base-0 line number in the source.',
+          },
+          column: {
+            type: 'integer',
+            description: 'The base-0 column number in the source.',
+          },
+        },
+        required: ['source', 'line', 'column'],
+      },
+    ),
   },
 };