rustdoc: Treat decl macros like other items

Author: fmease

src/librustdoc/clean/inline.rs

@@ -134,11 +134,7 @@ pub(crate) fn try_inline(
 })
 }
 Res::Def(DefKind::Macro(kind), did) => {
-let is_doc_hidden = cx.tcx.is_doc_hidden(did)
- || attrs_without_docs
-.map(|(attrs, _)| attrs)
-.is_some_and(|attrs| utils::attrs_have_doc_flag(attrs.iter(), sym::hidden));
-let mac = build_macro(cx, did, name, import_def_id, kind, is_doc_hidden);
+let mac = build_macro(cx, did, name, kind);
 
 let type_kind = match kind {
 MacroKind::Bang => ItemType::Macro,
@@ -740,18 +736,14 @@ fn build_macro(
 cx:&mutDocContext<'_>,
 def_id:DefId,
 name:Symbol,
-import_def_id:Option<LocalDefId>,
 macro_kind:MacroKind,
-is_doc_hidden:bool,
 ) -> clean::ItemKind{
 matchCStore::from_tcx(cx.tcx).load_macro_untracked(def_id, cx.tcx){
 LoadedMacro::MacroDef{ def, .. } => match macro_kind {
-MacroKind::Bang => {
-let vis = cx.tcx.visibility(import_def_id.map(|d| d.to_def_id()).unwrap_or(def_id));
- clean::MacroItem(clean::Macro{
-source: utils::display_macro_source(cx, name,&def, def_id, vis, is_doc_hidden),
-})
-}
+MacroKind::Bang => clean::MacroItem(clean::Macro{
+source: utils::display_macro_source(cx, name,&def),
+macro_rules: def.macro_rules,
+}),
 MacroKind::Derive | MacroKind::Attr => {
  clean::ProcMacroItem(clean::ProcMacro{kind: macro_kind,helpers:Vec::new()})
 }

src/librustdoc/clean/mod.rs

@@ -2787,13 +2787,10 @@ fn clean_maybe_renamed_item<'tcx>(
 fields: variant_data.fields().iter().map(|x| clean_field(x, cx)).collect(),
 }),
 ItemKind::Impl(impl_) => returnclean_impl(impl_, item.owner_id.def_id, cx),
-ItemKind::Macro(macro_def,MacroKind::Bang) => {
-let ty_vis = cx.tcx.visibility(def_id);
-MacroItem(Macro{
-// FIXME this shouldn't be false
-source:display_macro_source(cx, name, macro_def, def_id, ty_vis,false),
-})
-}
+ItemKind::Macro(macro_def,MacroKind::Bang) => MacroItem(Macro{
+source:display_macro_source(cx, name, macro_def),
+macro_rules: macro_def.macro_rules,
+}),
 ItemKind::Macro(_, macro_kind) => clean_proc_macro(item,&mut name, macro_kind, cx),
 // proc macros can have a name set by attributes
 ItemKind::Fn(ref sig, generics, body_id) => {

src/librustdoc/clean/types.rs

@@ -2543,6 +2543,8 @@ pub(crate) struct ImportSource {
 #[derive(Clone,Debug)]
 pub(crate)structMacro{
 pub(crate)source:String,
+/// Whether the macro was defined via `macro_rules!` as opposed to `macro`.
+pub(crate)macro_rules:bool,
 }
 
 #[derive(Clone,Debug)]

src/librustdoc/clean/utils.rs

@@ -24,7 +24,6 @@ use crate::clean::{
  clean_middle_ty, inline,
 };
 usecrate::core::DocContext;
-usecrate::html::format::visibility_to_src_with_space;
 
 #[cfg(test)]
 mod tests;
@@ -599,7 +598,7 @@ pub(crate) static DOC_CHANNEL: Lazy<&'static str> =
 
 /// Render a sequence of macro arms in a format suitable for displaying to the user
 /// as part of an item declaration.
-pub(super)fnrender_macro_arms<'a>(
+fnrender_macro_arms<'a>(
 tcx:TyCtxt<'_>,
 matchers:implIterator<Item = &'aTokenTree>,
 arm_delim:&str,
@@ -620,9 +619,6 @@ pub(super) fn display_macro_source(
 cx:&mutDocContext<'_>,
 name:Symbol,
 def:&ast::MacroDef,
-def_id:DefId,
-vis: ty::Visibility<DefId>,
-is_doc_hidden:bool,
 ) -> String{
 // Extract the spans of all matchers. They represent the "interface" of the macro.
 let matchers = def.body.tokens.chunks(4).map(|arm| &arm[0]);
@@ -632,18 +628,13 @@ pub(super) fn display_macro_source(
 }else{
 if matchers.len() <= 1{
 format!(
-"{vis}macro {name}{matchers} {{\n ...\n}}",
- vis = visibility_to_src_with_space(Some(vis), cx.tcx, def_id, is_doc_hidden),
+"macro {name}{matchers} {{\n ...\n}}",
  matchers = matchers
 .map(|matcher| render_macro_matcher(cx.tcx, matcher))
 .collect::<String>(),
 )
 }else{
-format!(
-"{vis}macro {name} {{\n{arms}}}",
- vis = visibility_to_src_with_space(Some(vis), cx.tcx, def_id, is_doc_hidden),
- arms = render_macro_arms(cx.tcx, matchers,","),
-)
+format!("macro {name} {{\n{arms}}}", arms = render_macro_arms(cx.tcx, matchers,","))
 }
 }
 }

src/librustdoc/html/format.rs

@@ -1615,47 +1615,6 @@ pub(crate) fn visibility_print_with_space<'a, 'tcx: 'a>(
 })
 }
 
-/// This function is the same as print_with_space, except that it renders no links.
-/// It's used for macros' rendered source view, which is syntax highlighted and cannot have
-/// any HTML in it.
-pub(crate)fnvisibility_to_src_with_space<'a,'tcx:'a>(
-visibility:Option<ty::Visibility<DefId>>,
-tcx:TyCtxt<'tcx>,
-item_did:DefId,
-is_doc_hidden:bool,
-) -> implDisplay + 'a + Captures<'tcx>{
-let vis:Cow<'static,str> = match visibility {
-None => "".into(),
-Some(ty::Visibility::Public) => "pub ".into(),
-Some(ty::Visibility::Restricted(vis_did)) => {
-// FIXME(camelid): This may not work correctly if `item_did` is a module.
-// However, rustdoc currently never displays a module's
-// visibility, so it shouldn't matter.
-let parent_module = find_nearest_parent_module(tcx, item_did);
-
-if vis_did.is_crate_root(){
-"pub(crate) ".into()
-}elseif parent_module == Some(vis_did){
-// `pub(in foo)` where `foo` is the parent module
-// is the same as no visibility modifier
-"".into()
-}elseif parent_module.and_then(|parent| find_nearest_parent_module(tcx, parent))
- == Some(vis_did)
-{
-"pub(super) ".into()
-}else{
-format!("pub(in {}) ", tcx.def_path_str(vis_did)).into()
-}
-}
-};
-display_fn(move |f| {
-if is_doc_hidden {
- f.write_str("#[doc(hidden)] ")?;
-}
- f.write_str(&vis)
-})
-}
-
 pub(crate)traitPrintWithSpace{
 fnprint_with_space(&self) -> &str;
 }

src/librustdoc/html/highlight.rs

@@ -58,13 +58,6 @@ pub(crate) fn render_example_with_highlighting(
 write_footer(out, playground_button);
 }
 
-/// Highlights `src` as an item-decl, returning the HTML output.
-pub(crate)fnrender_item_decl_with_highlighting(src:&str,out:&mutBuffer){
-write!(out,"<pre class=\"rust item-decl\">");
-write_code(out, src,None,None);
-write!(out,"</pre>");
-}
-
 fnwrite_header(
 out:&mutBuffer,
 class:&str,

src/librustdoc/html/render/print_item.rs

@@ -35,7 +35,6 @@ use crate::html::format::{
 Buffer,Ending,PrintWithSpace, display_fn, join_with_double_colon, print_abi_with_space,
  print_constness_with_space, print_where_clause, visibility_print_with_space,
 };
-usecrate::html::highlight;
 usecrate::html::markdown::{HeadingOffset,MarkdownSummaryLine};
 usecrate::html::render::{document_full, document_item_info};
 usecrate::html::url_parts_builder::UrlPartsBuilder;
@@ -1745,7 +1744,13 @@ fn item_variants(
 }
 
 fnitem_macro(w:&mutBuffer,cx:&mutContext<'_>,it:&clean::Item,t:&clean::Macro){
- highlight::render_item_decl_with_highlighting(&t.source, w);
+wrap_item(w, |w| {
+// FIXME: Also print `#[doc(hidden)]` for `macro_rules!` if it `is_doc_hidden`.
+if !t.macro_rules{
+write!(w,"{}", visibility_print_with_space(it, cx));
+}
+write!(w,"{}",Escape(&t.source));
+});
 write!(w,"{}", document(cx, it,None,HeadingOffset::H2))
 }
 

tests/rustdoc/decl_macro.rs

@@ -48,6 +48,8 @@ mod a {
 }
 mod c {
 //@ has decl_macro/a/b/c/macro.by_example_vis_named.html //pre 'pub(in a) macro by_example_vis_named($foo:expr) {'
+// Regression test for <https://github.com/rust-lang/rust/issues/83000>:
+//@ has - '//pre[@class="rust item-decl"]//a[@class="mod"]/@href' '../../index.html'
 pub(in a) macro by_example_vis_named {
 ($foo:expr) => {}
 }

tests/rustdoc/macro_rules-matchers.rs

@@ -3,29 +3,17 @@
 
 #![crate_name = "foo"]
 
-//@ has 'foo/macro.todo.html'
-//@ has - '//span[@class="macro"]' 'macro_rules!'
-//@ hasraw - ' todo {'
-
-//@ hasraw - '{ () => { ... }; ($('
-//@ has - '//span[@class="macro-nonterminal"]' '$'
-//@ has - '//span[@class="macro-nonterminal"]' 'arg'
-//@ hasraw - ':tt)+'
-//@ hasraw - ') => { ... }; }'
+//@ has 'foo/macro.todo.html' '//pre' 'macro_rules! todo { \
+// () => { ... }; \
+// ($($arg:tt)+) => { ... }; \
+// }'
 pubuse std::todo;
 
 mod mod1 {
-//@ has 'foo/macro.macro1.html'
-//@ hasraw - 'macro_rules!'
-//@ hasraw - 'macro1'
-//@ hasraw - '{ () => { ... }; ($('
-//@ has - '//span[@class="macro-nonterminal"]' '$'
-//@ has - '//span[@class="macro-nonterminal"]' 'arg'
-//@ hasraw - ':'
-//@ hasraw - 'expr'
-//@ hasraw - '),'
-//@ hasraw - '+'
-//@ hasraw - ') => { ... }; }'
+//@ has 'foo/macro.macro1.html' '//pre' 'macro_rules! macro1 { \
+// () => { ... }; \
+// ($($arg:expr),+) => { ... }; \
+// }'
 #[macro_export]
 macro_rules! macro1 {
 () => {};