analyze: script for automatically fixing some compile errors #1174
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
ahomescu
approved these changes
Dec 3, 2024
kkysen
reviewed
Dec 3, 2024
Comment on lines
+16
to
+52
| Fix = namedtuple('Fix', ( | ||
| # Path to the file to modify. | ||
| 'file_path', | ||
| # Line number where the fix will be applied. This is used for debug output | ||
| # only. | ||
| 'line_number', | ||
| # Start of the byte range to replace. | ||
| 'start_byte', | ||
| # End (exclusive) of the byte range to replace. | ||
| 'end_byte', | ||
| # Replacement text (as a `str`, not `bytes`). | ||
| 'new_text', | ||
| # The original error message. This is used for debug output only. | ||
| 'message', | ||
| )) | ||
|
|
||
| LifetimeBound = namedtuple('LifetimeBound', ( | ||
| 'file_path', | ||
| 'line_number', | ||
| # Byte offset of the start of the lifetime parameter declaration. | ||
| 'start_byte', | ||
| # Byte offset of the end of the lifetime parameter declaration. | ||
| 'end_byte', | ||
| # The lifetime to use in the new bound. If `'a: 'b` is the suggested | ||
| # bound, then `start/end_byte` points to the declaration of `'a`, and | ||
| # `bound_lifetime` is the string `"'b"`. | ||
| 'bound_lifetime', | ||
| )) | ||
|
|
||
| RemoveDeriveCopy = namedtuple('RemoveDeriveCopy', ( | ||
| 'file_path', | ||
| 'line_number', | ||
| # Byte offset of the start of the token `Copy`. | ||
| 'start_byte', | ||
| # Byte offset of the end of the token `Copy`. | ||
| 'end_byte', | ||
| )) |
There was a problem hiding this comment.
nit: I think it's a lot more idiomatic to use @dataclasses instead of namedtuple.
There was a problem hiding this comment.
I originally used @dataclass here, but switched to namedtuple because CI was failing - the Ubuntu 18 runner has Python 3.6, but dataclasses were added in 3.7
There was a problem hiding this comment.
Oh that's really annoying. Python 3.6 was EOL 3 years ago.
spernsteiner
force-pushed
the
analyze-auto-fix-script-base
branch
from
7fdeddc to
ecd1cbc
Compare
spernsteiner
force-pushed
the
analyze-auto-fix-script
branch
from
60b828d to
ba9bad9
Compare
spernsteiner
changed the base branch from
analyze-auto-fix-script-base
to
master
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 branch adds a Python script that automatically fixes some kinds of compiler errors by processing the output of
rustc --error-format json. It applies allMachineApplicablesuggestions, plus two other kinds of fixes that don't come with aMachineApplicablesuggestion (in our current nightly) but are important for lighttpdbuffer:c2rust-analyzeadds a lifetime parameter for each reference in the arguments and return type, but doesn't add any outlives bounds (e.g.'a: 'b) to relate those lifetimes. On functions that return a borrowed reference into one of their arguments, this results in a borrow checker error. The error comes with a human-readable suggestion like "consider adding the following bound:'a: 'b", and also marks the declaration of the first lifetime ('a); the auto-fix script parses this output and inserts the suggested: 'bbound after the declaration.Copymay not be implemented for this type": Whenc2rust-analyzeconverts a field from raw pointer type to&mut TorBox<T>, it doesn't removederive(Copy)from the struct. This causes a compile error because&mut TandBox<T>don't implementCopy. The error marks the location of theCopytoken in#[derive(Copy)]; the auto-fix script removes that token (and the subsequent comma, if necessary). Note this can produce a trailing comma (#[derive(Clone, Copy)]->#[derive(Clone, )]) or an emptyderive()(#[derive(Copy)]->#[derive()]), both of which are legal but unidiomatic.