Make SourceMap available for early debug-printing of Spans
#72618
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
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
|
cc #72669 |
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
May 28, 2020
…crum rustc_session: Cleanup session creation Noticed while reviewing rust-lang#72618.
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
May 30, 2020
…crum rustc_session: Cleanup session creation Noticed while reviewing rust-lang#72618.
|
This is a bit hacky, but we don't have much choice here, I guess. |
petrochenkov
added
S-blocked
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
May 30, 2020
…crum rustc_session: Cleanup session creation Noticed while reviewing rust-lang#72618.
|
☔ The latest upstream changes (presumably #72794) made this pull request unmergeable. Please resolve the merge conflicts. |
Aaron1011
force-pushed
the
feature/early-sourcemap
branch
from
a1149ff to
d13b3f0
Compare
|
@petrochenkov: Rebased |
Aaron1011
added
S-waiting-on-review
|
r=me after the cleanup (#72618 (comment)) and squashing commits. |
petrochenkov
added
S-waiting-on-author
|
Actually I need to look at #72799 first. |
Aaron1011
force-pushed
the
feature/early-sourcemap
branch
2 times, most recently
from
f836cf2 to
5909611
Compare
|
@bors r=petrochenkov |
|
📌 Commit 5909611eb1e9c1ac0207ec631dee8f51217fe1d8 has been approved by |
bors
removed
the
S-waiting-on-author
bors
added
the
S-waiting-on-bors
Normally, we debug-print `Spans` using the `SourceMap` retrieved from the global `TyCtxt`. However, we fall back to printing out the `Span`'s raw fields (instead of a file and line number) when we try to print a `Span` before a `TyCtxt` is available. This makes debugging early phases of the compile, such as parsing, much more difficult. This commit stores a `SourceMap` in `rustc_span::GlOBALS` as a fallback. When a `TyCtxt` is not available, we try to retrieve one from `GLOBALS` - only if this is not available do we fall back to the raw field output. I'm not sure how to write a test for this - however, this can be verified locally by setting `RUSTC_LOG="rustc_parse=debug"`, and verifying that the output contains filenames and line numbers.
Aaron1011
force-pushed
the
feature/early-sourcemap
branch
from
5909611 to
717fd66
Compare
|
Forgot to run tidy @bors r- r=petrochenkov |
bors
added
S-waiting-on-author
|
📌 Commit 717fd66 has been approved by |
bors
added
S-waiting-on-bors
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
Jun 1, 2020
…r=petrochenkov Make `SourceMap` available for early debug-printing of `Span`s Normally, we debug-print `Spans` using the `SourceMap` retrieved from the global `TyCtxt`. However, we fall back to printing out the `Span`'s raw fields (instead of a file and line number) when we try to print a `Span` before a `TyCtxt` is available. This makes debugging early phases of the compile, such as parsing, much more difficult. This commit stores a `SourceMap` in `rustc_span::GlOBALS` as a fallback. When a `TyCtxt` is not available, we try to retrieve one from `GLOBALS` - only if this is not available do we fall back to the raw field output. I'm not sure how to write a test for this - however, this can be verified locally by setting `RUSTC_LOG="rustc_parse=debug"`, and verifying that the output contains filenames and line numbers.
|
⌛ Testing commit 717fd66 with merge b6d3f6ea8c95f4d6d9d16f428c79df5e0342db1a... |
|
@bors retry yield |
|
⌛ Testing commit 717fd66 with merge c0c40d8ccada6a3ecbbbd09e4e88b7082588dbb8... |
|
@bors retry |
|
☀️ Test successful - checks-azure |
Aaron1011
added a commit
to Aaron1011/rust
that referenced
this pull request
Jun 4, 2020
Currently, the `Debug` impl for `proc_macro::Span` just prints out the byte range. This can make debugging proc macros (either as a crate author or as a compiler developer) very frustrating, since neither the actual filename nor the `SyntaxContext` is displayed. This commit adds a perma-unstable flag `-Z span-debug`. When enabled, the `Debug` impl for `proc_macro::Span` simply forwards directly to `rustc_span::Span`. Once rust-lang#72618 is merged, this will start displaying actual line numbers. While `Debug` impls are not subject to Rust's normal stability guarnatees, we probably shouldn't expose any additional information on stable until `#![feature(proc_macro_span)]` is stabilized. Otherwise, we would be providing a 'backdoor' way to access information that's supposed be behind unstable APIs.
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
Jun 6, 2020
…rochenkov Add `-Z span-debug` to allow for easier debugging of proc macros Currently, the `Debug` impl for `proc_macro::Span` just prints out the byte range. This can make debugging proc macros (either as a crate author or as a compiler developer) very frustrating, since neither the actual filename nor the `SyntaxContext` is displayed. This commit adds a perma-unstable flag `-Z span-debug`. When enabled, the `Debug` impl for `proc_macro::Span` simply forwards directly to `rustc_span::Span`. Once rust-lang#72618 is merged, this will start displaying actual line numbers. While `Debug` impls are not subject to Rust's normal stability guarnatees, we probably shouldn't expose any additional information on stable until `#![feature(proc_macro_span)]` is stabilized. Otherwise, we would be providing a 'backdoor' way to access information that's supposed be behind unstable APIs.
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
Jun 6, 2020
…rochenkov Add `-Z span-debug` to allow for easier debugging of proc macros Currently, the `Debug` impl for `proc_macro::Span` just prints out the byte range. This can make debugging proc macros (either as a crate author or as a compiler developer) very frustrating, since neither the actual filename nor the `SyntaxContext` is displayed. This commit adds a perma-unstable flag `-Z span-debug`. When enabled, the `Debug` impl for `proc_macro::Span` simply forwards directly to `rustc_span::Span`. Once rust-lang#72618 is merged, this will start displaying actual line numbers. While `Debug` impls are not subject to Rust's normal stability guarnatees, we probably shouldn't expose any additional information on stable until `#![feature(proc_macro_span)]` is stabilized. Otherwise, we would be providing a 'backdoor' way to access information that's supposed be behind unstable APIs.
RalfJung
added a commit
to RalfJung/rust
that referenced
this pull request
Jun 8, 2020
…rochenkov Add `-Z span-debug` to allow for easier debugging of proc macros Currently, the `Debug` impl for `proc_macro::Span` just prints out the byte range. This can make debugging proc macros (either as a crate author or as a compiler developer) very frustrating, since neither the actual filename nor the `SyntaxContext` is displayed. This commit adds a perma-unstable flag `-Z span-debug`. When enabled, the `Debug` impl for `proc_macro::Span` simply forwards directly to `rustc_span::Span`. Once rust-lang#72618 is merged, this will start displaying actual line numbers. While `Debug` impls are not subject to Rust's normal stability guarnatees, we probably shouldn't expose any additional information on stable until `#![feature(proc_macro_span)]` is stabilized. Otherwise, we would be providing a 'backdoor' way to access information that's supposed be behind unstable APIs.
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.
Normally, we debug-print
Spansusing theSourceMapretrieved fromthe global
TyCtxt. However, we fall back to printing out theSpan'sraw fields (instead of a file and line number) when we try to print a
Spanbefore aTyCtxtis available. This makes debugging early phasesof the compile, such as parsing, much more difficult.
This commit stores a
SourceMapinrustc_span::GlOBALSas a fallback.When a
TyCtxtis not available, we try to retrieve one fromGLOBALSI'm not sure how to write a test for this - however, this can be
verified locally by setting
RUSTC_LOG="rustc_parse=debug", andverifying that the output contains filenames and line numbers.