Skip to content

Prevent infinite recursion in rustdoc #17492

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

Merged
merged 2 commits into from
Sep 25, 2014
Merged
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
14 changes: 12 additions & 2 deletions src/librustdoc/visit_ast.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@
//! Rust AST Visitor. Extracts useful information and massages it into a form
//! usable for clean

use std::collections::HashSet;

use syntax::abi;
use syntax::ast;
use syntax::ast_util;
Expand Down Expand Up @@ -38,16 +40,21 @@ pub struct RustdocVisitor<'a, 'tcx: 'a> {
pub attrs: Vec<ast::Attribute>,
pub cx: &'a core::DocContext<'tcx>,
pub analysis: Option<&'a core::CrateAnalysis>,
view_item_stack: HashSet<ast::NodeId>,
}

impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
pub fn new(cx: &'a core::DocContext<'tcx>,
analysis: Option<&'a core::CrateAnalysis>) -> RustdocVisitor<'a, 'tcx> {
// If the root is reexported, terminate all recursion.
let mut stack = HashSet::new();
stack.insert(ast::CRATE_NODE_ID);
RustdocVisitor {
module: Module::new(None),
attrs: Vec::new(),
cx: cx,
analysis: analysis,
view_item_stack: stack,
}
}

Expand Down Expand Up @@ -228,8 +235,9 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
if !please_inline && analysis.public_items.contains(&def.node) {
return false
}
if !self.view_item_stack.insert(def.node) { return false }

match tcx.map.get(def.node) {
let ret = match tcx.map.get(def.node) {
ast_map::NodeItem(it) => {
if glob {
match it.node {
Expand All @@ -249,7 +257,9 @@ impl<'a, 'tcx> RustdocVisitor<'a, 'tcx> {
true
}
_ => false,
}
};
self.view_item_stack.remove(&id);
return ret;
}

pub fn visit_item(&mut self, item: &ast::Item,
Expand Down
12 changes: 12 additions & 0 deletions src/test/run-make/rustdoc-recursion/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
-include ../tools.mk

# FIXME ignore windows
ifndef IS_WINDOWS
all:
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc foo.rs
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc foo2.rs
$(HOST_RPATH_ENV) $(RUSTDOC) -w html -o $(TMPDIR)/doc foo3.rs
else
all:
endif

25 changes: 25 additions & 0 deletions src/test/run-make/rustdoc-recursion/foo.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright 2014 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.

#![crate_type = "lib"]
#![feature(globs)]

mod m {
pub use self::a::Foo;

mod a {
pub struct Foo;
}

mod b {
pub use super::*;
}
}

24 changes: 24 additions & 0 deletions src/test/run-make/rustdoc-recursion/foo2.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// Copyright 2014 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.

#![crate_type = "lib"]
#![feature(globs)]

mod m {
pub use self::a::Foo;

mod a {
pub struct Foo;
}

mod b {
pub use super::*;
}
}
25 changes: 25 additions & 0 deletions src/test/run-make/rustdoc-recursion/foo3.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright 2014 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.

#![feature(globs)]

pub mod longhands {
pub use super::*;

pub use super::common_types::computed::compute_CSSColor as to_computed_value;

pub fn computed_as_specified() {}
}

pub mod common_types {
pub mod computed {
pub use super::super::longhands::computed_as_specified as compute_CSSColor;
}
}