Fix string view index in UpdateFileContents() #2079
Merged
Conversation
This file contains 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
When updating the parse buffers, make sure the old ones don't disappear while we still call the callbacks for everyone interested in the changes. They might've hold on to some data and expect the old one to be still viable when they get the update call. Add a unit test. Issues: #2078 While at it: update and refine documentation.
... needed later in verilog_project to unregeister string-view ranges. Issues: #2078
hzeller
changed the title
Codecov ReportAttention:
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #2079 +/- ##
==========================================
+ Coverage 92.95% 92.99% +0.03%
==========================================
Files 358 358
Lines 26446 26465 +19
==========================================
+ Hits 24583 24611 +28
+ Misses 1863 1854 -9 ☔ View full report in Codecov by Sentry. |
ivan444
approved these changes
Jan 28, 2024
verilog/analysis/verilog_project.h
Outdated
| @@ -289,7 +291,7 @@ class VerilogProject { | |||
| absl::string_view referenced_filename); | |||
|
|
|||
| // Adds an already opened file by directly passing its content. | |||
| // TODO(refactor): is this needed ? | |||
| // TODO(refactor): is this needed ? (probaly yes in external kythe backends) | |||
There was a problem hiding this comment.
You can drop TODO & "probably". This is indeed needed for the external Kythe backends
verilog/analysis/verilog_project.h
Outdated
| // This can come from the .begin() of any entry in string_view_map_. | ||
| std::map<absl::string_view::const_iterator, file_set_type::const_iterator> | ||
| buffer_to_analyzer_map_; | ||
| std::unique_ptr<ContentToFileIndex> content_index_; |
There was a problem hiding this comment.
std::optional might be a better fit here.
When files are updated and old ones removed, make sure that the corresponding index for the substring ranges is also updated. Move the data and logic needed for the substring index into its own class ContentToFileIndex. Since we _can_ removed string ranges now, we don't really have to choose anymore if we want to populate string view maps; still providing this feature for now, but calling it provide_lookup_file_origin, as this is what it provides. Make ParsedVerilogSourceFile take an Analyzer instead of a TextStructureView to better emphasize that this is essentially the same as the other VerilogSourceFiles, just with a non-owned Analyzer. This also allows to return the parse absl::Status instead of a potentially non-truthful ok(). Updating plumbing needed for the passing-an-analyzer. Add test for updating the project and verify that no stale string view index is kept (the original issue in #2078). Fixes: #2078
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This fixes #2078.
Since some changes are somewhat independent, they are in three different commits.
This also fixes the misfeature that the string view index had to be disabled in cases the
VerilogProjectis used where it needs to remove files. So instead of a fractured class use, this is now merely a feature that can be enabled.