1 // Copyright 2018 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
13 use rustc::lint as lint;
15 use rustc::hir::def::Def;
18 use syntax::ast::{self, Ident, NodeId};
19 use syntax::feature_gate::UnstableFeatures;
20 use syntax::symbol::Symbol;
21 use syntax_pos::{self, DUMMY_SP};
27 use html::markdown::markdown_links;
30 pub const COLLECT_INTRA_DOC_LINKS: Pass =
31 Pass::early("collect-intra-doc-links", collect_intra_doc_links,
32 "reads a crate's documentation to resolve intra-doc-links");
34 pub fn collect_intra_doc_links(krate: Crate, cx: &DocContext) -> Crate {
35 if !UnstableFeatures::from_environment().is_nightly_build() {
38 let mut coll = LinkCollector::new(cx);
40 coll.fold_crate(krate)
46 /// can be either value or type, not a macro
50 /// values, functions, consts, statics, everything in the value namespace
52 /// types, traits, everything in the type namespace
56 struct LinkCollector<'a, 'tcx: 'a, 'rcx: 'a, 'cstore: 'rcx> {
57 cx: &'a DocContext<'a, 'tcx, 'rcx, 'cstore>,
61 impl<'a, 'tcx, 'rcx, 'cstore> LinkCollector<'a, 'tcx, 'rcx, 'cstore> {
62 fn new(cx: &'a DocContext<'a, 'tcx, 'rcx, 'cstore>) -> Self {
69 /// Resolve a given string as a path, along with whether or not it is
70 /// in the value namespace. Also returns an optional URL fragment in the case
71 /// of variants and methods
75 current_item: &Option<String>,
76 parent_id: Option<NodeId>)
77 -> Result<(Def, Option<String>), ()>
81 // In case we're in a module, try to resolve the relative
83 if let Some(id) = parent_id.or(self.mod_ids.last().cloned()) {
84 // FIXME: `with_scope` requires the NodeId of a module
85 let result = cx.resolver.borrow_mut()
88 resolver.resolve_str_path_error(DUMMY_SP,
92 if let Ok(result) = result {
93 // In case this is a trait item, skip the
94 // early return and try looking for the trait
95 let value = match result.def {
96 Def::Method(_) | Def::AssociatedConst(_) => true,
97 Def::AssociatedTy(_) => false,
98 Def::Variant(_) => return handle_variant(cx, result.def),
99 // not a trait item, just return what we found
100 _ => return Ok((result.def, None))
106 } else if let Some(prim) = is_primitive(path_str, is_val) {
107 return Ok((prim, Some(path_str.to_owned())))
109 // If resolution failed, it may still be a method
110 // because methods are not handled by the resolver
111 // If so, bail when we're not looking for a value
117 // Try looking for methods and associated items
118 let mut split = path_str.rsplitn(2, "::");
119 let item_name = if let Some(first) = split.next() {
125 let mut path = if let Some(second) = split.next() {
131 if path == "self" || path == "Self" {
132 if let Some(name) = current_item.as_ref() {
137 // FIXME: `with_scope` requires the NodeId of a module
138 let ty = cx.resolver.borrow_mut()
141 resolver.resolve_str_path_error(DUMMY_SP, &path, false)
144 Def::Struct(did) | Def::Union(did) | Def::Enum(did) | Def::TyAlias(did) => {
145 let item = cx.tcx.inherent_impls(did)
147 .flat_map(|imp| cx.tcx.associated_items(*imp))
148 .find(|item| item.ident.name == item_name);
149 if let Some(item) = item {
150 let out = match item.kind {
151 ty::AssociatedKind::Method if is_val => "method",
152 ty::AssociatedKind::Const if is_val => "associatedconstant",
155 Ok((ty.def, Some(format!("{}.{}", out, item_name))))
157 match cx.tcx.type_of(did).sty {
159 if let Some(item) = if def.is_enum() {
160 def.all_fields().find(|item| item.ident.name == item_name)
162 def.non_enum_variant()
165 .find(|item| item.ident.name == item_name)
168 Some(format!("{}.{}",
184 let item = cx.tcx.associated_item_def_ids(did).iter()
185 .map(|item| cx.tcx.associated_item(*item))
186 .find(|item| item.ident.name == item_name);
187 if let Some(item) = item {
188 let kind = match item.kind {
189 ty::AssociatedKind::Const if is_val => "associatedconstant",
190 ty::AssociatedKind::Type if !is_val => "associatedtype",
191 ty::AssociatedKind::Method if is_val => {
192 if item.defaultness.has_value() {
201 Ok((ty.def, Some(format!("{}.{}", kind, item_name))))
214 impl<'a, 'tcx, 'rcx, 'cstore> DocFolder for LinkCollector<'a, 'tcx, 'rcx, 'cstore> {
215 fn fold_item(&mut self, mut item: Item) -> Option<Item> {
216 let item_node_id = if item.is_mod() {
217 if let Some(id) = self.cx.tcx.hir.as_local_node_id(item.def_id) {
220 debug!("attempting to fold on a non-local item: {:?}", item);
221 return self.fold_item_recur(item);
227 // FIXME: get the resolver to work with non-local resolve scopes
228 let parent_node = self.cx.as_local_node_id(item.def_id).and_then(|node_id| {
229 // FIXME: this fails hard for impls in non-module scope, but is necessary for the
230 // current resolve() implementation
231 match self.cx.tcx.hir.get_module_parent_node(node_id) {
232 id if id != node_id => Some(id),
237 if parent_node.is_some() {
238 debug!("got parent node for {} {:?}, id {:?}", item.type_(), item.name, item.def_id);
241 let current_item = match item.inner {
243 if item.attrs.inner_docs {
244 if item_node_id.unwrap() != NodeId::new(0) {
250 match parent_node.or(self.mod_ids.last().cloned()) {
251 Some(parent) if parent != NodeId::new(0) => {
252 //FIXME: can we pull the parent module's name from elsewhere?
253 Some(self.cx.tcx.hir.name(parent).to_string())
259 ImplItem(Impl { ref for_, .. }) => {
260 for_.def_id().map(|did| self.cx.tcx.item_name(did).to_string())
262 // we don't display docs on `extern crate` items anyway, so don't process them
263 ExternCrateItem(..) => return self.fold_item_recur(item),
264 ImportItem(Import::Simple(ref name, ..)) => Some(name.clone()),
265 MacroItem(..) => None,
266 _ => item.name.clone(),
269 if item.is_mod() && item.attrs.inner_docs {
270 self.mod_ids.push(item_node_id.unwrap());
274 let dox = item.attrs.collapsed_doc_value().unwrap_or_else(String::new);
276 for (ori_link, link_range) in markdown_links(&dox) {
277 // bail early for real links
278 if ori_link.contains('/') {
281 let link = ori_link.replace("`", "");
282 let (def, fragment) = {
283 let mut kind = PathKind::Unknown;
284 let path_str = if let Some(prefix) =
285 ["struct@", "enum@", "type@",
286 "trait@", "union@"].iter()
287 .find(|p| link.starts_with(**p)) {
288 kind = PathKind::Type;
289 link.trim_left_matches(prefix)
290 } else if let Some(prefix) =
291 ["const@", "static@",
292 "value@", "function@", "mod@",
293 "fn@", "module@", "method@"]
294 .iter().find(|p| link.starts_with(**p)) {
295 kind = PathKind::Value;
296 link.trim_left_matches(prefix)
297 } else if link.ends_with("()") {
298 kind = PathKind::Value;
299 link.trim_right_matches("()")
300 } else if link.starts_with("macro@") {
301 kind = PathKind::Macro;
302 link.trim_left_matches("macro@")
303 } else if link.ends_with('!') {
304 kind = PathKind::Macro;
305 link.trim_right_matches('!')
310 if path_str.contains(|ch: char| !(ch.is_alphanumeric() ||
311 ch == ':' || ch == '_')) {
317 if let Ok(def) = self.resolve(path_str, true, ¤t_item, parent_node) {
320 resolution_failure(cx, &item.attrs, path_str, &dox, link_range);
321 // this could just be a normal link or a broken link
322 // we could potentially check if something is
323 // "intra-doc-link-like" and warn in that case
328 if let Ok(def) = self.resolve(path_str, false, ¤t_item, parent_node) {
331 resolution_failure(cx, &item.attrs, path_str, &dox, link_range);
332 // this could just be a normal link
336 PathKind::Unknown => {
338 if let Some(macro_def) = macro_resolve(cx, path_str) {
339 if let Ok(type_def) =
340 self.resolve(path_str, false, ¤t_item, parent_node)
342 let (type_kind, article, type_disambig)
343 = type_ns_kind(type_def.0, path_str);
344 ambiguity_error(cx, &item.attrs, path_str,
345 article, type_kind, &type_disambig,
346 "a", "macro", &format!("macro@{}", path_str));
348 } else if let Ok(value_def) =
349 self.resolve(path_str, true, ¤t_item, parent_node)
351 let (value_kind, value_disambig)
352 = value_ns_kind(value_def.0, path_str)
353 .expect("struct and mod cases should have been \
354 caught in previous branch");
355 ambiguity_error(cx, &item.attrs, path_str,
356 "a", value_kind, &value_disambig,
357 "a", "macro", &format!("macro@{}", path_str));
360 } else if let Ok(type_def) =
361 self.resolve(path_str, false, ¤t_item, parent_node)
363 // It is imperative we search for not-a-value first
364 // Otherwise we will find struct ctors for when we are looking
365 // for structs, and the link won't work.
366 // if there is something in both namespaces
367 if let Ok(value_def) =
368 self.resolve(path_str, true, ¤t_item, parent_node)
370 let kind = value_ns_kind(value_def.0, path_str);
371 if let Some((value_kind, value_disambig)) = kind {
372 let (type_kind, article, type_disambig)
373 = type_ns_kind(type_def.0, path_str);
374 ambiguity_error(cx, &item.attrs, path_str,
375 article, type_kind, &type_disambig,
376 "a", value_kind, &value_disambig);
381 } else if let Ok(value_def) =
382 self.resolve(path_str, true, ¤t_item, parent_node)
386 resolution_failure(cx, &item.attrs, path_str, &dox, link_range);
387 // this could just be a normal link
392 if let Some(def) = macro_resolve(cx, path_str) {
395 resolution_failure(cx, &item.attrs, path_str, &dox, link_range);
402 if let Def::PrimTy(_) = def {
403 item.attrs.links.push((ori_link, None, fragment));
405 let id = register_def(cx, def);
406 item.attrs.links.push((ori_link, Some(id), fragment));
410 if item.is_mod() && !item.attrs.inner_docs {
411 self.mod_ids.push(item_node_id.unwrap());
415 let ret = self.fold_item_recur(item);
421 self.fold_item_recur(item)
426 /// Resolve a string as a macro
427 fn macro_resolve(cx: &DocContext, path_str: &str) -> Option<Def> {
428 use syntax::ext::base::{MacroKind, SyntaxExtension};
429 let segment = ast::PathSegment::from_ident(Ident::from_str(path_str));
430 let path = ast::Path { segments: vec![segment], span: DUMMY_SP };
431 let mut resolver = cx.resolver.borrow_mut();
432 let parent_scope = resolver.dummy_parent_scope();
433 if let Ok(def) = resolver.resolve_macro_to_def_inner(&path, MacroKind::Bang,
434 &parent_scope, false) {
435 if let SyntaxExtension::DeclMacro { .. } = *resolver.get_macro(def) {
439 if let Some(def) = resolver.all_macros.get(&Symbol::intern(path_str)) {
445 fn span_of_attrs(attrs: &Attributes) -> syntax_pos::Span {
446 if attrs.doc_strings.is_empty() {
449 let start = attrs.doc_strings[0].span();
450 let end = attrs.doc_strings.last().expect("No doc strings provided").span();
454 fn resolution_failure(
459 link_range: Option<Range<usize>>,
461 let sp = span_of_attrs(attrs);
462 let msg = format!("`[{}]` cannot be resolved, ignoring it...", path_str);
464 let code_dox = sp.to_src(cx);
466 let doc_comment_padding = 3;
467 let mut diag = if let Some(link_range) = link_range {
468 // blah blah blah\nblah\nblah [blah] blah blah\nblah blah
471 // last_new_line_offset
474 if dox.lines().count() == code_dox.lines().count() {
475 let line_offset = dox[..link_range.start].lines().count();
476 // The span starts in the `///`, so we don't have to account for the leading whitespace
477 let code_dox_len = if line_offset <= 1 {
481 doc_comment_padding +
482 // Each subsequent leading whitespace and `///`
483 code_dox.lines().skip(1).take(line_offset - 1).fold(0, |sum, line| {
484 sum + doc_comment_padding + line.len() - line.trim().len()
488 // Extract the specific span
489 let sp = sp.from_inner_byte_pos(
490 link_range.start + code_dox_len,
491 link_range.end + code_dox_len,
494 diag = cx.tcx.struct_span_lint_node(lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE,
498 diag.span_label(sp, "cannot be resolved, ignoring");
500 diag = cx.tcx.struct_span_lint_node(lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE,
505 let last_new_line_offset = dox[..link_range.start].rfind('\n').map_or(0, |n| n + 1);
506 let line = dox[last_new_line_offset..].lines().next().unwrap_or("");
508 // Print the line containing the `link_range` and manually mark it with '^'s
510 "the link appears in this line:\n\n{line}\n\
511 {indicator: <before$}{indicator:^<found$}",
514 before=link_range.start - last_new_line_offset,
515 found=link_range.len(),
520 cx.tcx.struct_span_lint_node(lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE,
525 diag.help("to escape `[` and `]` characters, just add '\\' before them like \
530 fn ambiguity_error(cx: &DocContext, attrs: &Attributes,
532 article1: &str, kind1: &str, disambig1: &str,
533 article2: &str, kind2: &str, disambig2: &str) {
534 let sp = span_of_attrs(attrs);
536 .struct_span_warn(sp,
537 &format!("`{}` is both {} {} and {} {}",
538 path_str, article1, kind1,
540 .help(&format!("try `{}` if you want to select the {}, \
541 or `{}` if you want to \
543 disambig1, kind1, disambig2,
548 /// Given a def, returns its name and disambiguator
549 /// for a value namespace
551 /// Returns None for things which cannot be ambiguous since
552 /// they exist in both namespaces (structs and modules)
553 fn value_ns_kind(def: Def, path_str: &str) -> Option<(&'static str, String)> {
555 // structs, variants, and mods exist in both namespaces. skip them
556 Def::StructCtor(..) | Def::Mod(..) | Def::Variant(..) |
557 Def::VariantCtor(..) | Def::SelfCtor(..)
560 => Some(("function", format!("{}()", path_str))),
562 => Some(("method", format!("{}()", path_str))),
564 => Some(("const", format!("const@{}", path_str))),
566 => Some(("static", format!("static@{}", path_str))),
567 _ => Some(("value", format!("value@{}", path_str))),
571 /// Given a def, returns its name, the article to be used, and a disambiguator
572 /// for the type namespace
573 fn type_ns_kind(def: Def, path_str: &str) -> (&'static str, &'static str, String) {
574 let (kind, article) = match def {
575 // we can still have non-tuple structs
576 Def::Struct(..) => ("struct", "a"),
577 Def::Enum(..) => ("enum", "an"),
578 Def::Trait(..) => ("trait", "a"),
579 Def::Union(..) => ("union", "a"),
582 (kind, article, format!("{}@{}", kind, path_str))
585 /// Given an enum variant's def, return the def of its enum and the associated fragment
586 fn handle_variant(cx: &DocContext, def: Def) -> Result<(Def, Option<String>), ()> {
587 use rustc::ty::DefIdTree;
589 let parent = if let Some(parent) = cx.tcx.parent(def.def_id()) {
594 let parent_def = Def::Enum(parent);
595 let variant = cx.tcx.expect_variant_def(def);
596 Ok((parent_def, Some(format!("{}.v", variant.name))))
599 const PRIMITIVES: &[(&str, Def)] = &[
600 ("u8", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::U8))),
601 ("u16", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::U16))),
602 ("u32", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::U32))),
603 ("u64", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::U64))),
604 ("u128", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::U128))),
605 ("usize", Def::PrimTy(hir::PrimTy::Uint(syntax::ast::UintTy::Usize))),
606 ("i8", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::I8))),
607 ("i16", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::I16))),
608 ("i32", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::I32))),
609 ("i64", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::I64))),
610 ("i128", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::I128))),
611 ("isize", Def::PrimTy(hir::PrimTy::Int(syntax::ast::IntTy::Isize))),
612 ("f32", Def::PrimTy(hir::PrimTy::Float(syntax::ast::FloatTy::F32))),
613 ("f64", Def::PrimTy(hir::PrimTy::Float(syntax::ast::FloatTy::F64))),
614 ("str", Def::PrimTy(hir::PrimTy::Str)),
615 ("bool", Def::PrimTy(hir::PrimTy::Bool)),
616 ("char", Def::PrimTy(hir::PrimTy::Char)),
619 fn is_primitive(path_str: &str, is_val: bool) -> Option<Def> {
623 PRIMITIVES.iter().find(|x| x.0 == path_str).map(|x| x.1)