Skip to content

Commit

Permalink
Auto merge of #50305 - GuillaumeGomez:fix-mod-stackoverflow, r=QuietM…
Browse files Browse the repository at this point in the history
…isdreavus

Prevent infinite recursion of modules

Fixes #50196.

r? @QuietMisdreavus
  • Loading branch information
bors committed May 7, 2018
2 parents 565235e + 3ba7c00 commit 715d6a9
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 9 deletions.
16 changes: 8 additions & 8 deletions src/librustdoc/clean/inline.rs
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ use super::Clean;
///
/// The returned value is `None` if the definition could not be inlined,
/// and `Some` of a vector of items if it was successfully expanded.
pub fn try_inline(cx: &DocContext, def: Def, name: ast::Name)
pub fn try_inline(cx: &DocContext, def: Def, name: ast::Name, visited: &mut FxHashSet<DefId>)
-> Option<Vec<clean::Item>> {
if def == Def::Err { return None }
let did = def.def_id();
Expand Down Expand Up @@ -87,7 +87,7 @@ pub fn try_inline(cx: &DocContext, def: Def, name: ast::Name)
Def::StructCtor(..) => return Some(Vec::new()),
Def::Mod(did) => {
record_extern_fqn(cx, did, clean::TypeKind::Module);
clean::ModuleItem(build_module(cx, did))
clean::ModuleItem(build_module(cx, did, visited))
}
Def::Static(did, mtbl) => {
record_extern_fqn(cx, did, clean::TypeKind::Static);
Expand Down Expand Up @@ -385,24 +385,24 @@ pub fn build_impl(cx: &DocContext, did: DefId, ret: &mut Vec<clean::Item>) {
});
}

fn build_module(cx: &DocContext, did: DefId) -> clean::Module {
fn build_module(cx: &DocContext, did: DefId, visited: &mut FxHashSet<DefId>) -> clean::Module {
let mut items = Vec::new();
fill_in(cx, did, &mut items);
fill_in(cx, did, &mut items, visited);
return clean::Module {
items,
is_crate: false,
};

fn fill_in(cx: &DocContext, did: DefId, items: &mut Vec<clean::Item>) {
fn fill_in(cx: &DocContext, did: DefId, items: &mut Vec<clean::Item>,
visited: &mut FxHashSet<DefId>) {
// If we're re-exporting a re-export it may actually re-export something in
// two namespaces, so the target may be listed twice. Make sure we only
// visit each node at most once.
let mut visited = FxHashSet();
for &item in cx.tcx.item_children(did).iter() {
let def_id = item.def.def_id();
if item.vis == ty::Visibility::Public {
if !visited.insert(def_id) { continue }
if let Some(i) = try_inline(cx, item.def, item.ident.name) {
if did == def_id || !visited.insert(def_id) { continue }
if let Some(i) = try_inline(cx, item.def, item.ident.name, visited) {
items.extend(i)
}
}
Expand Down
3 changes: 2 additions & 1 deletion src/librustdoc/clean/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3686,7 +3686,8 @@ impl Clean<Vec<Item>> for doctree::Import {
} else {
let name = self.name;
if !denied {
if let Some(items) = inline::try_inline(cx, path.def, name) {
let mut visited = FxHashSet();
if let Some(items) = inline::try_inline(cx, path.def, name, &mut visited) {
return items;
}
}
Expand Down
21 changes: 21 additions & 0 deletions src/test/rustdoc/auxiliary/mod-stackoverflow.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// compile-flags: -Cmetadata=aux

pub mod tree {
pub use tree;
}

pub mod tree2 {
pub mod prelude {
pub use tree2;
}
}
16 changes: 16 additions & 0 deletions src/test/rustdoc/mod-stackoverflow.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

// aux-build:mod-stackoverflow.rs
// ignore-cross-compile

extern crate mod_stackoverflow;
pub use mod_stackoverflow::tree;
pub use mod_stackoverflow::tree2;

0 comments on commit 715d6a9

Please sign in to comment.