Add is_inner information to rustdoc-json-types

Author: GuillaumeGomez

src/librustdoc/clean/types.rs

@@ -5,6 +5,7 @@ use std::{fmt, iter};
 
 use arrayvec::ArrayVec;
 use rustc_abi::{ExternAbi, VariantIdx};
+use rustc_ast::AttrStyle;
 use rustc_attr_parsing::{AttributeKind, ConstStability, Deprecation, Stability, StableSince};
 use rustc_data_structures::fx::{FxHashSet, FxIndexMap, FxIndexSet};
 use rustc_hir::def::{CtorKind, DefKind, Res};
@@ -759,13 +760,20 @@ impl Item {
         Some(tcx.visibility(def_id))
     }
 
-    pub(crate) fn attributes(&self, tcx: TyCtxt<'_>, cache: &Cache, is_json: bool) -> Vec<String> {
+    /// Returns a Vec of stringified attributes with a boolean set to `true` if it's an inner
+    /// attribute.
+    pub(crate) fn attributes(
+        &self,
+        tcx: TyCtxt<'_>,
+        cache: &Cache,
+        is_json: bool,
+    ) -> Vec<(bool, String)> {
         const ALLOWED_ATTRIBUTES: &[Symbol] =
             &[sym::export_name, sym::link_section, sym::no_mangle, sym::non_exhaustive];
 
         use rustc_abi::IntegerType;
 
-        let mut attrs: Vec<String> = self
+        let mut attrs: Vec<(bool, String)> = self
             .attrs
             .other_attrs
             .iter()
@@ -786,15 +794,19 @@ impl Item {
                             // because it isn't public API.
                             None
                         }
-                        _ => Some(rustc_hir_pretty::attribute_to_string(&tcx, attr)),
+                        _ => Some((
+                            attr.opt_style() == Some(AttrStyle::Inner),
+                            rustc_hir_pretty::attribute_to_string(&tcx, attr),
+                        )),
                     }
                 } else if attr.has_any_name(ALLOWED_ATTRIBUTES) {
-                    Some(
+                    Some((
+                        attr.opt_style() == Some(AttrStyle::Inner),
                         rustc_hir_pretty::attribute_to_string(&tcx, attr)
                             .replace("\\\n", "")
                             .replace('\n', "")
                             .replace("  ", " "),
-                    )
+                    ))
                 } else {
                     None
                 }
@@ -860,7 +872,7 @@ impl Item {
                 out.push(&int_s);
             }
             if !out.is_empty() {
-                attrs.push(format!("#[repr({})]", out.join(", ")));
+                attrs.push((false, format!("#[repr({})]", out.join(", "))));
             }
         }
         attrs

src/librustdoc/html/render/mod.rs

@@ -1194,7 +1194,7 @@ fn render_assoc_item(
 // a whitespace prefix and newline.
 fn render_attributes_in_pre(it: &clean::Item, prefix: &str, cx: &Context<'_>) -> impl fmt::Display {
     fmt::from_fn(move |f| {
-        for a in it.attributes(cx.tcx(), cx.cache(), false) {
+        for (_, a) in it.attributes(cx.tcx(), cx.cache(), false) {
             writeln!(f, "{prefix}{a}")?;
         }
         Ok(())
@@ -1204,7 +1204,7 @@ fn render_attributes_in_pre(it: &clean::Item, prefix: &str, cx: &Context<'_>) ->
 // When an attribute is rendered inside a <code> tag, it is formatted using
 // a div to produce a newline after it.
 fn render_attributes_in_code(w: &mut impl fmt::Write, it: &clean::Item, cx: &Context<'_>) {
-    for attr in it.attributes(cx.tcx(), cx.cache(), false) {
+    for (_, attr) in it.attributes(cx.tcx(), cx.cache(), false) {
         write!(w, "<div class=\"code-attribute\">{attr}</div>").unwrap();
     }
 }

src/librustdoc/json/conversions.rs

@@ -40,7 +40,11 @@ impl JsonRenderer<'_> {
             })
             .collect();
         let docs = item.opt_doc_value();
-        let attrs = item.attributes(self.tcx, self.cache(), true);
+        let attrs = item
+            .attributes(self.tcx, self.cache(), true)
+            .into_iter()
+            .map(|(is_inner, content)| Attribute { is_inner, content })
+            .collect::<Vec<_>>();
         let span = item.span(self.tcx);
         let visibility = item.visibility(self.tcx);
         let clean::ItemInner { name, item_id, .. } = *item.inner;
@@ -767,7 +771,11 @@ impl FromClean<clean::ProcMacro> for ProcMacro {
     fn from_clean(mac: clean::ProcMacro, _renderer: &JsonRenderer<'_>) -> Self {
         ProcMacro {
             kind: from_macro_kind(mac.kind),
-            helpers: mac.helpers.iter().map(|x| x.to_string()).collect(),
+            helpers: mac
+                .helpers
+                .iter()
+                .map(|x| Attribute { is_inner: false, content: x.to_string() })
+                .collect(),
         }
     }
 }

src/rustdoc-json-types/lib.rs

@@ -152,6 +152,15 @@ pub struct ItemSummary {
     pub kind: ItemKind,
 }
 
+/// An attribute (like `#[inline]`).
+#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Hash)]
+pub struct Attribute {
+    /// Whether it is an inner (`#![]`) or an outer attribute (`#[]`).
+    pub is_inner: bool,
+    /// The content of the attribute.
+    pub content: String,
+}
+
 /// Anything that can hold documentation - modules, structs, enums, functions, traits, etc.
 ///
 /// The `Item` data type holds fields that can apply to any of these,
@@ -193,7 +202,7 @@ pub struct Item {
     ///
     /// As an internal implementation detail subject to change, this debug-printing format
     /// is currently equivalent to the HIR pretty-printing of parsed attributes.
-    pub attrs: Vec<String>,
+    pub attrs: Vec<Attribute>,
     /// Information about the item’s deprecation, if present.
     pub deprecation: Option<Deprecation>,
     /// The type-specific fields describing this item.
@@ -1301,7 +1310,7 @@ pub struct ProcMacro {
     ///     Some(T),
     /// }
     /// ```
-    pub helpers: Vec<String>,
+    pub helpers: Vec<Attribute>,
 }
 
 /// The way a [`ProcMacro`] is declared to be used.

tests/rustdoc-json/attrs/automatically_derived.rs

@@ -9,5 +9,5 @@ impl Default for Manual {
     }
 }
 
-//@ is '$.index[?(@.inner.impl.for.resolved_path.path == "Derive" && @.inner.impl.trait.path == "Default")].attrs' '["#[automatically_derived]"]'
+//@ is '$.index[?(@.inner.impl.for.resolved_path.path == "Derive" && @.inner.impl.trait.path == "Default")].attrs' '[{"content": "#[automatically_derived]", "is_inner": false}]'
 //@ is '$.index[?(@.inner.impl.for.resolved_path.path == "Manual" && @.inner.impl.trait.path == "Default")].attrs' '[]'

tests/rustdoc-json/attrs/export_name_2021.rs

@@ -1,6 +1,6 @@
 //@ edition: 2021
 #![no_std]
 
-//@ is "$.index[?(@.name=='example')].attrs" '["#[export_name = \"altered\"]"]'
+//@ is "$.index[?(@.name=='example')].attrs" '[{"content": "#[export_name = \"altered\"]", "is_inner": false}]'
 #[export_name = "altered"]
 pub extern "C" fn example() {}

tests/rustdoc-json/attrs/export_name_2024.rs

@@ -4,6 +4,6 @@
 // The representation of `#[unsafe(export_name = ..)]` in rustdoc in edition 2024
 // is still `#[export_name = ..]` without the `unsafe` attribute wrapper.
 
-//@ is "$.index[?(@.name=='example')].attrs" '["#[export_name = \"altered\"]"]'
+//@ is "$.index[?(@.name=='example')].attrs" '[{"content": "#[export_name = \"altered\"]", "is_inner": false}]'
 #[unsafe(export_name = "altered")]
 pub extern "C" fn example() {}

tests/rustdoc-json/attrs/must_use.rs

@@ -1,9 +1,9 @@
 #![no_std]
 
-//@ is "$.index[?(@.name=='example')].attrs" '["#[must_use]"]'
+//@ is "$.index[?(@.name=='example')].attrs" '[{"content": "#[must_use]", "is_inner": false}]'
 #[must_use]
 pub fn example() -> impl Iterator<Item = i64> {}
 
-//@ is "$.index[?(@.name=='explicit_message')].attrs" '["#[must_use = \"does nothing if you do not use it\"]"]'
+//@ is "$.index[?(@.name=='explicit_message')].attrs" '[{"content": "#[must_use = \"does nothing if you do not use it\"]", "is_inner": false}]'
 #[must_use = "does nothing if you do not use it"]
 pub fn explicit_message() -> impl Iterator<Item = i64> {}

tests/rustdoc-json/attrs/no_mangle_2021.rs

@@ -1,6 +1,6 @@
 //@ edition: 2021
 #![no_std]
 
-//@ is "$.index[?(@.name=='example')].attrs" '["#[no_mangle]"]'
+//@ is "$.index[?(@.name=='example')].attrs" '[{"content": "#[no_mangle]", "is_inner": false}]'
 #[no_mangle]
 pub extern "C" fn example() {}

tests/rustdoc-json/attrs/no_mangle_2024.rs

@@ -4,6 +4,6 @@
 // The representation of `#[unsafe(no_mangle)]` in rustdoc in edition 2024
 // is still `#[no_mangle]` without the `unsafe` attribute wrapper.
 
-//@ is "$.index[?(@.name=='example')].attrs" '["#[no_mangle]"]'
+//@ is "$.index[?(@.name=='example')].attrs" '[{"content": "#[no_mangle]", "is_inner": false}]'
 #[unsafe(no_mangle)]
 pub extern "C" fn example() {}