Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DO NOT MERGE] Document non-exported macros with --document-private-items #79396

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions compiler/rustc_ast_lowering/src/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -216,9 +216,9 @@ impl<'hir> LoweringContext<'_, 'hir> {
let attrs = self.lower_attrs(&i.attrs);

if let ItemKind::MacroDef(MacroDef { ref body, macro_rules }) = i.kind {
let hir_id = self.lower_node_id(i.id);
let body = P(self.lower_mac_args(body));
if !macro_rules || self.sess.contains_name(&i.attrs, sym::macro_export) {
let hir_id = self.lower_node_id(i.id);
let body = P(self.lower_mac_args(body));
self.exported_macros.push(hir::MacroDef {
ident,
vis,
Expand All @@ -228,6 +228,14 @@ impl<'hir> LoweringContext<'_, 'hir> {
ast: MacroDef { body, macro_rules },
});
} else {
self.non_exported_macros.push(hir::MacroDef {
ident,
vis,
attrs,
hir_id,
span: i.span,
ast: MacroDef { body, macro_rules },
});
self.non_exported_macro_attrs.extend(attrs.iter().cloned());
}
return None;
Expand Down
3 changes: 3 additions & 0 deletions compiler/rustc_ast_lowering/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ struct LoweringContext<'a, 'hir: 'a> {
impl_items: BTreeMap<hir::ImplItemId, hir::ImplItem<'hir>>,
bodies: BTreeMap<hir::BodyId, hir::Body<'hir>>,
exported_macros: Vec<hir::MacroDef<'hir>>,
non_exported_macros: Vec<hir::MacroDef<'hir>>,
non_exported_macro_attrs: Vec<ast::Attribute>,

trait_impls: BTreeMap<DefId, Vec<hir::HirId>>,
Expand Down Expand Up @@ -302,6 +303,7 @@ pub fn lower_crate<'a, 'hir>(
trait_impls: BTreeMap::new(),
modules: BTreeMap::new(),
exported_macros: Vec::new(),
non_exported_macros: Vec::new(),
non_exported_macro_attrs: Vec::new(),
catch_scopes: Vec::new(),
loop_scopes: Vec::new(),
Expand Down Expand Up @@ -582,6 +584,7 @@ impl<'a, 'hir> LoweringContext<'a, 'hir> {
hir::Crate {
item: hir::CrateItem { module, attrs, span: c.span },
exported_macros: self.arena.alloc_from_iter(self.exported_macros),
non_exported_macros: self.arena.alloc_from_iter(self.non_exported_macros),
non_exported_macro_attrs: self.arena.alloc_from_iter(self.non_exported_macro_attrs),
items: self.items,
trait_items: self.trait_items,
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_hir/src/hir.rs
Original file line number Diff line number Diff line change
Expand Up @@ -599,6 +599,7 @@ pub struct CrateItem<'hir> {
pub struct Crate<'hir> {
pub item: CrateItem<'hir>,
pub exported_macros: &'hir [MacroDef<'hir>],
pub non_exported_macros: &'hir [MacroDef<'hir>],
// Attributes from non-exported macros, kept only for collecting the library feature list.
pub non_exported_macro_attrs: &'hir [Attribute],

Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_hir/src/intravisit.rs
Original file line number Diff line number Diff line change
Expand Up @@ -463,6 +463,7 @@ pub fn walk_crate<'v, V: Visitor<'v>>(visitor: &mut V, krate: &'v Crate<'v>) {
visitor.visit_mod(&krate.item.module, krate.item.span, CRATE_HIR_ID);
walk_list!(visitor, visit_attribute, krate.item.attrs);
walk_list!(visitor, visit_macro_def, krate.exported_macros);
walk_list!(visitor, visit_macro_def, krate.non_exported_macros);
}

pub fn walk_macro_def<'v, V: Visitor<'v>>(visitor: &mut V, macro_def: &'v MacroDef<'v>) {
Expand Down
1 change: 1 addition & 0 deletions compiler/rustc_middle/src/hir/map/collector.rs
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ impl<'a, 'hir> NodeCollector<'a, 'hir> {
ref item,
// These fields are handled separately:
exported_macros: _,
non_exported_macros: _,
non_exported_macro_attrs: _,
items: _,
trait_items: _,
Expand Down
7 changes: 7 additions & 0 deletions src/librustdoc/visit_ast.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,13 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
module
.macros
.extend(krate.exported_macros.iter().map(|def| self.visit_local_macro(def, None)));
if self.cx.render_options.document_private {
// If `--document-private-items` is passed, also attach the crate's
// *non*-exported macros to the top-level module.
module
.macros
.extend(krate.non_exported_macros.iter().map(|def| self.visit_local_macro(def, None)));
}
module.is_crate = true;

self.cx.renderinfo.get_mut().exact_paths = self.exact_paths;
Expand Down
16 changes: 16 additions & 0 deletions src/test/rustdoc/non-exported-macros.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// compile-flags: --document-private-items

fn foo_fn() {}

pub fn pub_foo_fn() {}

macro_rules! foo_macro {
() => { };
}

#[macro_export]
macro_rules! exported_foo_macro {
() => { };
}

// TODO: add `@has` checks