Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} #139671

m-ou-se · 2025-04-11T12:39:01Z

Simplification/redesign of the unstable proc macro span API, tracked in #54725:

Before:

impl Span {
    pub fn line(&self) -> usize;
    pub fn column(&self) -> usize;
    pub fn source_file(&self) -> SourceFile;
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct SourceFile { .. }

impl !Send for SourceFile {}
impl !Sync for SourceFile {}

impl SourceFile {
    pub fn path(&self) -> PathBuf;
    pub fn is_real(&self) -> bool;
}

After:

impl Span {
    pub fn line(&self) -> usize;
    pub fn column(&self) -> usize;
    pub fn file(&self) -> String; // Mapped file name, for display purposes.
    pub fn local_file(&self) -> Option<PathBuf>; // Real file name as it exists on disk.
}

This resolves the last blocker for stabilizing these methods. (Stabilizing will be a separate PR with FCP.)

m-ou-se · 2025-04-11T12:39:46Z

r? @dtolnay

Veykril · 2025-04-11T13:28:25Z

For rust-analyzer's proc-macro server those two functions can be just stubbed out with None / String::new(), they aren't implementable right now

dtolnay

Thank you! This is great.

dtolnay · 2025-04-13T17:43:19Z

@bors r+

bors · 2025-04-13T17:43:22Z

📌 Commit 5113f5e has been approved by dtolnay

It is now in the queue for this repository.

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} Simplification/redesign of the unstable proc macro span API, tracked in rust-lang#54725: Before: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn source_file(&self) -> SourceFile; } #[derive(Clone, Debug, PartialEq, Eq)] pub struct SourceFile { .. } impl !Send for SourceFile {} impl !Sync for SourceFile {} impl SourceFile { pub fn path(&self) -> PathBuf; pub fn is_real(&self) -> bool; } ``` After: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn file(&self) -> String; // Mapped file name, for display purposes. pub fn local_file(&self) -> Option<PathBuf>; // Real file name as it exists on disk. } ``` This resolves the last blocker for stabilizing these methods. (Stabilizing will be a separate PR with FCP.)

m-ou-se · 2025-04-14T14:48:28Z

@rust-lang/rust-analyzer One of the rust-analyzer tests is panicking. See logs. Please advise.

m-ou-se · 2025-04-14T14:50:23Z

Looks like

./x.py test src/tools/rust-analyzer --stage=2

works fine, but

./x.py test src/tools/rust-analyzer --stage=1

fails, resulting in those panics.

It looks like --stage=1 rust-analyzer uses the proc_macro client from the checkout, but the proc_macro server from beta (stage 0). 😬

I don't think we can properly support stage 1 r-a, unless we assume that proc_macro never changes its unstable private interface..

m-ou-se · 2025-04-14T14:54:08Z

I've disabled two r-a tests in stage 1 with #[cfg(not(bootstrap))]. This needs a proper fix though. Perhaps we should not support --stage=1 r-a at all.

m-ou-se · 2025-04-14T15:05:28Z

@bors r=dtolnay

bors · 2025-04-14T15:05:31Z

📌 Commit 1f3199c has been approved by dtolnay

It is now in the queue for this repository.

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} Simplification/redesign of the unstable proc macro span API, tracked in rust-lang#54725: Before: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn source_file(&self) -> SourceFile; } #[derive(Clone, Debug, PartialEq, Eq)] pub struct SourceFile { .. } impl !Send for SourceFile {} impl !Sync for SourceFile {} impl SourceFile { pub fn path(&self) -> PathBuf; pub fn is_real(&self) -> bool; } ``` After: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn file(&self) -> String; // Mapped file name, for display purposes. pub fn local_file(&self) -> Option<PathBuf>; // Real file name as it exists on disk. } ``` This resolves the last blocker for stabilizing these methods. (Stabilizing will be a separate PR with FCP.)

Rollup of 11 pull requests Successful merges: - rust-lang#139669 (Overhaul `AssocItem`) - rust-lang#139671 (Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file}) - rust-lang#139750 (std/thread: Use default stack size from menuconfig for NuttX) - rust-lang#139785 (Let CStrings be either 1 or 2 byte aligned.) - rust-lang#139797 (Allow (but don't require) `#[unsafe(naked)]` so that `compiler-builtins` can upgrade to it) - rust-lang#139798 (normalize: prefer `ParamEnv` over `AliasBound` candidates) - rust-lang#139799 (Specify `--print info=file` syntax in `--help`) - rust-lang#139811 (Use `newtype_index!`-generated types more idiomatically) - rust-lang#139813 (Miri subtree update) - rust-lang#139822 (Fix: Map EOPNOTSUPP to ErrorKind::Unsupported on Unix) - rust-lang#139836 (Basic tests of MPMC receiver cloning) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 17 pull requests Successful merges: - rust-lang#138374 (Enable contracts for const functions) - rust-lang#138380 (ci: add runners for vanilla LLVM 20) - rust-lang#138393 (Allow const patterns of matches to contain pattern types) - rust-lang#139517 (std: sys: process: uefi: Use NULL stdin by default) - rust-lang#139554 (std: add Output::exit_ok) - rust-lang#139660 (compiletest: Add an experimental new executor to replace libtest) - rust-lang#139669 (Overhaul `AssocItem`) - rust-lang#139671 (Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file}) - rust-lang#139750 (std/thread: Use default stack size from menuconfig for NuttX) - rust-lang#139772 (Remove `hir::Map`) - rust-lang#139785 (Let CStrings be either 1 or 2 byte aligned.) - rust-lang#139789 (do not unnecessarily leak auto traits in item bounds) - rust-lang#139791 (drop global where-bounds before merging candidates) - rust-lang#139798 (normalize: prefer `ParamEnv` over `AliasBound` candidates) - rust-lang#139822 (Fix: Map EOPNOTSUPP to ErrorKind::Unsupported on Unix) - rust-lang#139833 (Fix some HIR pretty-printing problems) - rust-lang#139836 (Basic tests of MPMC receiver cloning) r? `@ghost` `@rustbot` modify labels: rollup

Rollup merge of rust-lang#139671 - m-ou-se:proc-macro-span, r=dtolnay Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} Simplification/redesign of the unstable proc macro span API, tracked in rust-lang#54725: Before: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn source_file(&self) -> SourceFile; } #[derive(Clone, Debug, PartialEq, Eq)] pub struct SourceFile { .. } impl !Send for SourceFile {} impl !Sync for SourceFile {} impl SourceFile { pub fn path(&self) -> PathBuf; pub fn is_real(&self) -> bool; } ``` After: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn file(&self) -> String; // Mapped file name, for display purposes. pub fn local_file(&self) -> Option<PathBuf>; // Real file name as it exists on disk. } ``` This resolves the last blocker for stabilizing these methods. (Stabilizing will be a separate PR with FCP.)

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} Simplification/redesign of the unstable proc macro span API, tracked in rust-lang#54725: Before: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn source_file(&self) -> SourceFile; } #[derive(Clone, Debug, PartialEq, Eq)] pub struct SourceFile { .. } impl !Send for SourceFile {} impl !Sync for SourceFile {} impl SourceFile { pub fn path(&self) -> PathBuf; pub fn is_real(&self) -> bool; } ``` After: ```rust impl Span { pub fn line(&self) -> usize; pub fn column(&self) -> usize; pub fn file(&self) -> String; // Mapped file name, for display purposes. pub fn local_file(&self) -> Option<PathBuf>; // Real file name as it exists on disk. } ``` This resolves the last blocker for stabilizing these methods. (Stabilizing will be a separate PR with FCP.)

Rollup of 17 pull requests Successful merges: - rust-lang#138374 (Enable contracts for const functions) - rust-lang#138380 (ci: add runners for vanilla LLVM 20) - rust-lang#138393 (Allow const patterns of matches to contain pattern types) - rust-lang#139517 (std: sys: process: uefi: Use NULL stdin by default) - rust-lang#139554 (std: add Output::exit_ok) - rust-lang#139660 (compiletest: Add an experimental new executor to replace libtest) - rust-lang#139669 (Overhaul `AssocItem`) - rust-lang#139671 (Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file}) - rust-lang#139750 (std/thread: Use default stack size from menuconfig for NuttX) - rust-lang#139772 (Remove `hir::Map`) - rust-lang#139785 (Let CStrings be either 1 or 2 byte aligned.) - rust-lang#139789 (do not unnecessarily leak auto traits in item bounds) - rust-lang#139791 (drop global where-bounds before merging candidates) - rust-lang#139798 (normalize: prefer `ParamEnv` over `AliasBound` candidates) - rust-lang#139822 (Fix: Map EOPNOTSUPP to ErrorKind::Unsupported on Unix) - rust-lang#139833 (Fix some HIR pretty-printing problems) - rust-lang#139836 (Basic tests of MPMC receiver cloning) r? `@ghost` `@rustbot` modify labels: rollup

Remove proc_macro::SourceFile::is_real().

6788ce7

rustbot assigned petrochenkov Apr 11, 2025

This comment was marked as outdated.

Sign in to view

rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Apr 11, 2025

rustbot assigned dtolnay and unassigned petrochenkov Apr 11, 2025

m-ou-se added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. and removed T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Apr 11, 2025

m-ou-se mentioned this pull request Apr 11, 2025

Tracking issue for proc_macro::Span inspection APIs #54725

Open

5 tasks

m-ou-se added the A-proc-macros Area: Procedural macros label Apr 11, 2025

This comment has been minimized.

Sign in to view

Replace proc_macro::SourceFile by Span::{file, local_file}.

3962069

m-ou-se force-pushed the proc-macro-span branch from 869776d to 3962069 Compare April 11, 2025 13:07

This comment has been minimized.

Sign in to view

Update rust-analyzer for new proc_macro span api.

5113f5e

This comment was marked as resolved.

Sign in to view

This comment was marked as off-topic.

Sign in to view

m-ou-se added the I-libs-api-nominated Nominated for discussion during a libs-api team meeting. label Apr 12, 2025

dtolnay approved these changes Apr 13, 2025

View reviewed changes

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 13, 2025

m-ou-se removed the I-libs-api-nominated Nominated for discussion during a libs-api team meeting. label Apr 13, 2025

jhpratt mentioned this pull request Apr 13, 2025

Rollup of 11 pull requests #139761

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Apr 13, 2025

Disable some r-a tests in bootstrap.

1f3199c

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Apr 14, 2025

m-ou-se mentioned this pull request Apr 14, 2025

rust-analyzer --stage=1 mixes incompatible proc_macro server and client #139810

Open

Zalathar mentioned this pull request Apr 15, 2025

Rollup of 11 pull requests #139838

Closed

Zalathar mentioned this pull request Apr 15, 2025

Rollup of 17 pull requests #139845

Merged

bors merged commit bc4e7ad into rust-lang:master Apr 15, 2025
6 checks passed

rustbot added this to the 1.88.0 milestone Apr 15, 2025

m-ou-se deleted the proc-macro-span branch April 15, 2025 11:40

m-ou-se mentioned this pull request Apr 15, 2025

Stabilize proc_macro::Span::{start,end,line,column}. #139865

Merged

dtolnay mentioned this pull request Apr 16, 2025

Update semver-exempt API to nightly-2025-04-16 dtolnay/proc-macro2#497

Merged

dsgallups mentioned this pull request Apr 16, 2025

error[E0412]: cannot find type SourceFile in crate proc_macro rust-lang/docs.rs#2803

Closed

Kobzol mentioned this pull request Apr 16, 2025

Build aarch64 builds on CI with PGO rust-lang/rust-analyzer#19597

Merged

niooss-ledger mentioned this pull request Apr 16, 2025

anchor-syn 0.31.0 is incompatible with proc-macro2 >= 1.0.95 solana-foundation/anchor#3661

Closed

cryptopapi997 mentioned this pull request Apr 16, 2025

fix: Update proc-macro2 usage for latest nightly solana-foundation/anchor#3663

Merged

syphar mentioned this pull request Apr 19, 2025

fix build-test after breaking nightly proc-macro change rust-lang/docs.rs#2807

Merged

Huliiiiii mentioned this pull request May 1, 2025

Fix nightly api change wdanilo/crabtime#38

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} #139671

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} #139671

Uh oh!

m-ou-se commented Apr 11, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

m-ou-se commented Apr 11, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

Veykril commented Apr 11, 2025

Uh oh!

This comment was marked as resolved.

This comment was marked as off-topic.

This comment was marked as off-topic.

dtolnay left a comment

Uh oh!

dtolnay commented Apr 13, 2025

Uh oh!

bors commented Apr 13, 2025

Uh oh!

m-ou-se commented Apr 14, 2025

Uh oh!

m-ou-se commented Apr 14, 2025 •

edited

Loading

Uh oh!

m-ou-se commented Apr 14, 2025 •

edited

Loading

Uh oh!

m-ou-se commented Apr 14, 2025

Uh oh!

bors commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} #139671

Proc macro span API redesign: Replace proc_macro::SourceFile by Span::{file, local_file} #139671

Uh oh!

Conversation

m-ou-se commented Apr 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

m-ou-se commented Apr 11, 2025

Uh oh!

This comment has been minimized.

This comment has been minimized.

Veykril commented Apr 11, 2025

Uh oh!

This comment was marked as resolved.

This comment was marked as off-topic.

This comment was marked as off-topic.

dtolnay left a comment

Choose a reason for hiding this comment

Uh oh!

dtolnay commented Apr 13, 2025

Uh oh!

bors commented Apr 13, 2025

Uh oh!

m-ou-se commented Apr 14, 2025

Uh oh!

m-ou-se commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

m-ou-se commented Apr 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

m-ou-se commented Apr 14, 2025

Uh oh!

bors commented Apr 14, 2025

Uh oh!

Uh oh!

Uh oh!

m-ou-se commented Apr 11, 2025 •

edited

Loading

m-ou-se commented Apr 14, 2025 •

edited

Loading

m-ou-se commented Apr 14, 2025 •

edited

Loading