Add macro support in jump to definition feature #91264

GuillaumeGomez · 2021-11-26T20:24:49Z

To do so, I check if the span comes from an expansion, and if so, I infer the original macro DefId or Span depending if it's a defined in the current crate or not.

There is one limitation due to macro expansion though:

macro_rules! yolo { () => {}}

fn foo() {
    yolo!();
}

In foo, yolo! won't be linked because after expansion, it is replaced by nothing (which seems logical). So I can't get an item from the Visitor from which I could tell if its Span comes from an expansion.

I added a test for this specific limitation alongside others.

Demo: https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html

As for the empty macro issue that cannot create a jump to definition, you can see it here.

Part of #89095.

r? @jyn514

src/librustdoc/html/highlight.rs

src/librustdoc/html/render/span_map.rs

src/test/rustdoc/check-source-code-urls-to-def-std.rs

jyn514 · 2022-01-04T22:57:59Z

I won't have a chance to review this any time soon.

r? @camelid

camelid · 2022-01-08T02:18:41Z

I don't have knowledge of this code. r? rust-lang/rustdoc

Dylan-DPC · 2022-03-07T04:17:47Z

@jsha this is waiting for your review

bors · 2022-03-14T10:24:01Z

☔ The latest upstream changes (presumably #94139) made this pull request unmergeable. Please resolve the merge conflicts.

bors · 2022-04-30T16:42:29Z

☔ The latest upstream changes (presumably #93803) made this pull request unmergeable. Please resolve the merge conflicts.

GuillaumeGomez · 2022-05-02T13:15:30Z

I'll fix the conflict once #96636 is merged.

jsha · 2022-05-10T04:21:33Z

#96636 is now merged. Can you put up a demo, including a demo of the "expands to empty" behavior you mentioned?

GuillaumeGomez · 2022-05-10T12:30:30Z

Here you go: https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html

As for the empty macro issue that cannot create a jump to definition, you can see it here.

Kobzol · 2022-05-18T18:15:08Z

I wonder why eprintln! in the demo links to doc and not source?

GuillaumeGomez · 2022-05-18T18:58:33Z

It's because the code tried to find it location based on its Span and failed, using then the documentation page (which we can generate pretty easily).

rust-log-analyzer · 2022-06-22T00:37:18Z

A job failed! Check out the build log: (web) (plain)

Click to see the possible cause of the failure (guessed by this bot)

GuillaumeGomez · 2022-06-22T09:12:22Z

@bors retry

…=jsha Add macro support in jump to definition feature Fixes rust-lang#91174. To do so, I check if the span comes from an expansion, and if so, I infer the original macro `DefId` or `Span` depending if it's a defined in the current crate or not. There is one limitation due to macro expansion though: ```rust macro_rules! yolo { () => {}} fn foo() { yolo!(); } ``` In `foo`, `yolo!` won't be linked because after expansion, it is replaced by nothing (which seems logical). So I can't get an item from the `Visitor` from which I could tell if its `Span` comes from an expansion. I added a test for this specific limitation alongside others. Demo: https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html As for the empty macro issue that cannot create a jump to definition, you can see it [here](https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html#35). r? `@jyn514`

…=jsha Add macro support in jump to definition feature Fixes rust-lang#91174. To do so, I check if the span comes from an expansion, and if so, I infer the original macro `DefId` or `Span` depending if it's a defined in the current crate or not. There is one limitation due to macro expansion though: ```rust macro_rules! yolo { () => {}} fn foo() { yolo!(); } ``` In `foo`, `yolo!` won't be linked because after expansion, it is replaced by nothing (which seems logical). So I can't get an item from the `Visitor` from which I could tell if its `Span` comes from an expansion. I added a test for this specific limitation alongside others. Demo: https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html As for the empty macro issue that cannot create a jump to definition, you can see it [here](https://rustdoc.crud.net/imperio/macro-jump-to-def/src/foo/check-source-code-urls-to-def-std.rs.html#35). r? ``@jyn514``

Rollup of 9 pull requests Successful merges: - rust-lang#91264 (Add macro support in jump to definition feature) - rust-lang#96955 (Remove (transitive) reliance on sorting by DefId in pretty-printer) - rust-lang#97633 (Session object: Set OS/ABI) - rust-lang#98039 (Fix `panic` message for `BTreeSet`'s `range` API and document `panic` cases) - rust-lang#98214 (rustc_target: Remove some redundant target properties) - rust-lang#98280 (Improve suggestion for calling fn-like expr on type mismatch) - rust-lang#98394 (Fixup missing renames from `#[main]` to `#[rustc_main]`) - rust-lang#98411 (Update tendril) - rust-lang#98419 (Remove excess rib while resolving closures) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup

…eGomez rustdoc: simplify highlight.rs Split render_with_highlighting, which took many optional parameters, into three functions for specific purposes, which each take a smaller number of mostly required parameters. Remove some plumbing to pass through an "edition" parameter, which was used solely to avoid highlighting some 2021 Edition keywords in non-2021 code. I've tested a build of std docs before and after, and this does not change the generated HTML at all. Followup from rust-lang#91264 (comment) r? `@GuillaumeGomez`

…eGomez rustdoc: simplify highlight.rs Split render_with_highlighting, which took many optional parameters, into three functions for specific purposes, which each take a smaller number of mostly required parameters. Remove some plumbing to pass through an "edition" parameter, which was used solely to avoid highlighting some 2021 Edition keywords in non-2021 code. I've tested a build of std docs before and after, and this does not change the generated HTML at all. Followup from rust-lang#91264 (comment) r? ``@GuillaumeGomez``

…eGomez rustdoc: simplify highlight.rs Split render_with_highlighting, which took many optional parameters, into three functions for specific purposes, which each take a smaller number of mostly required parameters. Remove some plumbing to pass through an "edition" parameter, which was used solely to avoid highlighting some 2021 Edition keywords in non-2021 code. I've tested a build of std docs before and after, and this does not change the generated HTML at all. Followup from rust-lang#91264 (comment) r? ```@GuillaumeGomez```

rustdoc: simplify highlight.rs Split render_with_highlighting, which took many optional parameters, into three functions for specific purposes, which each take a smaller number of mostly required parameters. Remove some plumbing to pass through an "edition" parameter, which was used solely to avoid highlighting some 2021 Edition keywords in non-2021 code. I've tested a build of std docs before and after, and this does not change the generated HTML at all. Followup from rust-lang/rust#91264 (comment) r? ``@GuillaumeGomez``

GuillaumeGomez added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. A-rustdoc-ui Area: Rustdoc UI (generated HTML) labels Nov 26, 2021

rust-highfive assigned jyn514 Nov 26, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 26, 2021

GuillaumeGomez commented Nov 26, 2021

View reviewed changes

src/librustdoc/html/highlight.rs Show resolved Hide resolved

GuillaumeGomez commented Nov 26, 2021

View reviewed changes

src/librustdoc/html/highlight.rs Outdated Show resolved Hide resolved

GuillaumeGomez commented Nov 26, 2021

View reviewed changes

src/librustdoc/html/render/span_map.rs Show resolved Hide resolved

GuillaumeGomez commented Nov 26, 2021

View reviewed changes

src/test/rustdoc/check-source-code-urls-to-def-std.rs Show resolved Hide resolved

camelid reviewed Nov 26, 2021

View reviewed changes

src/test/rustdoc/check-source-code-urls-to-def-std.rs Outdated Show resolved Hide resolved

GuillaumeGomez force-pushed the macro-jump-to-def branch from 8d667cc to 616da70 Compare November 27, 2021 12:58

rust-highfive assigned camelid and unassigned jyn514 Jan 4, 2022

rust-highfive assigned jsha and unassigned camelid Jan 8, 2022

JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 30, 2022

JohnCSimon added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Mar 6, 2022

GuillaumeGomez force-pushed the macro-jump-to-def branch from 616da70 to 427b31b Compare April 20, 2022 08:58

GuillaumeGomez force-pushed the macro-jump-to-def branch from 427b31b to 5613627 Compare May 10, 2022 12:26

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 Jun 22, 2022

Dylan-DPC mentioned this pull request Jun 22, 2022

Rollup of 8 pull requests #98381

Closed

JohnTitor mentioned this pull request Jun 24, 2022

Rollup of 8 pull requests #98442

Closed

JohnTitor mentioned this pull request Jun 24, 2022

Rollup of 9 pull requests #98447

Merged

bors merged commit 97f4d7b into rust-lang:master Jun 24, 2022

rustbot added this to the 1.63.0 milestone Jun 24, 2022

GuillaumeGomez deleted the macro-jump-to-def branch June 24, 2022 13:03

jsha mentioned this pull request Jul 16, 2022

rustdoc: simplify highlight.rs #99337

Merged

GuillaumeGomez mentioned this pull request Aug 12, 2022

Tracking Issue for "jump to definition" #89095

Open

7 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add macro support in jump to definition feature #91264

Add macro support in jump to definition feature #91264

GuillaumeGomez commented Nov 26, 2021 •

edited

Loading

jyn514 commented Jan 4, 2022

camelid commented Jan 8, 2022

Dylan-DPC commented Mar 7, 2022

bors commented Mar 14, 2022

bors commented Apr 30, 2022

GuillaumeGomez commented May 2, 2022

jsha commented May 10, 2022 •

edited

Loading

GuillaumeGomez commented May 10, 2022

Kobzol commented May 18, 2022

GuillaumeGomez commented May 18, 2022

rust-log-analyzer commented Jun 22, 2022

GuillaumeGomez commented Jun 22, 2022

Add macro support in jump to definition feature #91264

Add macro support in jump to definition feature #91264

Conversation

GuillaumeGomez commented Nov 26, 2021 • edited Loading

jyn514 commented Jan 4, 2022

camelid commented Jan 8, 2022

Dylan-DPC commented Mar 7, 2022

bors commented Mar 14, 2022

bors commented Apr 30, 2022

GuillaumeGomez commented May 2, 2022

jsha commented May 10, 2022 • edited Loading

GuillaumeGomez commented May 10, 2022

Kobzol commented May 18, 2022

GuillaumeGomez commented May 18, 2022

rust-log-analyzer commented Jun 22, 2022

GuillaumeGomez commented Jun 22, 2022

GuillaumeGomez commented Nov 26, 2021 •

edited

Loading

jsha commented May 10, 2022 •

edited

Loading