-
Notifications
You must be signed in to change notification settings - Fork 31
Add gotodefinition support for stdlib #492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright 2025 Valentin Erokhin | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import * as vscode from 'vscode' | ||
| import AdmZip from 'adm-zip' | ||
| import * as fs from 'fs' | ||
|
|
||
| /** | ||
| * The scheme used to distinguish stdlib documents from jar files. | ||
| */ | ||
| const scheme = 'flixstdlib' | ||
|
|
||
| /** | ||
| * Handle documents where the uri scheme is [[scheme]] (flixstdlib): | ||
| * - Extract the jar path and file path from the URI | ||
| * - Read the file content from inside the jar | ||
| * - Return the file content for display | ||
| */ | ||
| const flixStdlibDocumentProvider = new (class implements vscode.TextDocumentContentProvider { | ||
| provideTextDocumentContent(uri: vscode.Uri): string { | ||
| try { | ||
| const jarPath = decodeURIComponent(uri.authority) | ||
| const filePath = uri.path.startsWith('/') ? uri.path.substring(1) : uri.path | ||
|
|
||
| if (!fs.existsSync(jarPath)) { | ||
| return `// Error: Flix jar file not found at: ${jarPath}` | ||
| } | ||
|
|
||
| const zip = new AdmZip(jarPath) | ||
| let entry = zip.getEntry(filePath) | ||
| let searchedPaths = [filePath] | ||
|
|
||
| // If not found at root level, try common stdlib directories | ||
| if (!entry && !filePath.startsWith('src/')) { | ||
| const commonPaths = [ | ||
| `src/library/${filePath}`, | ||
| `src/resources/${filePath}`, | ||
| ] | ||
|
|
||
| for (const path of commonPaths) { | ||
| entry = zip.getEntry(path) | ||
| searchedPaths.push(path) | ||
| if (entry) break | ||
| } | ||
| } | ||
|
|
||
| if (!entry) { | ||
| return `// Error: File '${filePath}' not found in jar: ${jarPath}\n// Searched paths: ${searchedPaths.join(', ')}` | ||
| } | ||
|
|
||
| return entry.getData().toString('utf8') | ||
| } catch (error) { | ||
| return `// Error reading stdlib file: ${error.message}` | ||
| } | ||
| } | ||
| })() | ||
|
|
||
| /** | ||
| * Register the stdlib document provider. | ||
| */ | ||
| export function registerFlixStdlibDocumentProvider({ subscriptions }: vscode.ExtensionContext) { | ||
| subscriptions.push(vscode.workspace.registerTextDocumentContentProvider(scheme, flixStdlibDocumentProvider)) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here your strategy is to extract the source code from the jar.
But an alternative would be this:
We add a new command to VSCodeLspServer called "GetSource(name)".
VSCodeLspServer has access to TypedAst.Root which has a field sources: Map[Source, SourceLocation]
From this we can extract the source code of any file loaded into the compiler by other means than the IDE (e.g. from the std lib or from packages)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an alternative, if we cannot get VSCode to load a file from inside a zip (maybe thats not yet possible as the ticket seems to suggest??)