2 use rustc_errors::{Applicability, DiagnosticBuilder};
3 use rustc_expand::base::SyntaxExtensionKind;
4 use rustc_feature::UnstableFeatures;
11 use rustc_hir::def_id::DefId;
13 use rustc_resolve::ParentScope;
14 use rustc_session::lint;
15 use rustc_span::hygiene::MacroKind;
16 use rustc_span::symbol::Ident;
17 use rustc_span::symbol::Symbol;
18 use rustc_span::DUMMY_SP;
23 use crate::core::DocContext;
24 use crate::fold::DocFolder;
25 use crate::html::markdown::markdown_links;
26 use crate::passes::{look_for_tests, Pass};
28 use super::span_of_attrs;
30 pub const COLLECT_INTRA_DOC_LINKS: Pass = Pass {
31 name: "collect-intra-doc-links",
32 run: collect_intra_doc_links,
33 description: "reads a crate's documentation to resolve intra-doc-links",
36 pub fn collect_intra_doc_links(krate: Crate, cx: &DocContext<'_>) -> Crate {
37 if !UnstableFeatures::from_environment().is_nightly_build() {
40 let mut coll = LinkCollector::new(cx);
42 coll.fold_crate(krate)
48 AnchorFailure(AnchorFailure),
61 struct LinkCollector<'a, 'tcx> {
62 cx: &'a DocContext<'tcx>,
63 // NOTE: this may not necessarily be a module in the current crate
67 impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
68 fn new(cx: &'a DocContext<'tcx>) -> Self {
69 LinkCollector { cx, mod_ids: Vec::new() }
75 current_item: &Option<String>,
77 ) -> Result<(Res, Option<String>), ErrorKind> {
80 let mut split = path_str.rsplitn(3, "::");
81 let variant_field_name =
82 split.next().map(|f| Symbol::intern(f)).ok_or(ErrorKind::ResolutionFailure)?;
84 split.next().map(|f| Symbol::intern(f)).ok_or(ErrorKind::ResolutionFailure)?;
88 if f == "self" || f == "Self" {
89 if let Some(name) = current_item.as_ref() {
95 .ok_or(ErrorKind::ResolutionFailure)?;
97 .enter_resolver(|resolver| {
98 resolver.resolve_str_path_error(DUMMY_SP, &path, TypeNS, module_id)
100 .map_err(|_| ErrorKind::ResolutionFailure)?;
101 if let Res::Err = ty_res {
102 return Err(ErrorKind::ResolutionFailure);
104 let ty_res = ty_res.map_id(|_| panic!("unexpected node_id"));
106 Res::Def(DefKind::Enum, did) => {
111 .flat_map(|imp| cx.tcx.associated_items(*imp).in_definition_order())
112 .any(|item| item.ident.name == variant_name)
114 return Err(ErrorKind::ResolutionFailure);
116 match cx.tcx.type_of(did).kind {
117 ty::Adt(def, _) if def.is_enum() => {
118 if def.all_fields().any(|item| item.ident.name == variant_field_name) {
122 "variant.{}.field.{}",
123 variant_name, variant_field_name
127 Err(ErrorKind::ResolutionFailure)
130 _ => Err(ErrorKind::ResolutionFailure),
133 _ => Err(ErrorKind::ResolutionFailure),
137 /// Resolves a string as a macro.
138 fn macro_resolve(&self, path_str: &str, parent_id: Option<DefId>) -> Option<Res> {
140 let path = ast::Path::from_ident(Ident::from_str(path_str));
141 cx.enter_resolver(|resolver| {
142 if let Ok((Some(ext), res)) = resolver.resolve_macro_path(
145 &ParentScope::module(resolver.graph_root()),
149 if let SyntaxExtensionKind::LegacyBang { .. } = ext.kind {
150 return Some(res.map_id(|_| panic!("unexpected id")));
153 if let Some(res) = resolver.all_macros().get(&Symbol::intern(path_str)) {
154 return Some(res.map_id(|_| panic!("unexpected id")));
156 if let Some(module_id) = parent_id {
157 if let Ok((_, res)) =
158 resolver.resolve_str_path_error(DUMMY_SP, path_str, MacroNS, module_id)
160 // don't resolve builtins like `#[derive]`
161 if let Res::Def(..) = res {
162 let res = res.map_id(|_| panic!("unexpected node_id"));
167 debug!("attempting to resolve item without parent module: {}", path_str);
172 /// Resolves a string as a path within a particular namespace. Also returns an optional
173 /// URL fragment in the case of variants and methods.
177 disambiguator: Option<&str>,
179 current_item: &Option<String>,
180 parent_id: Option<DefId>,
181 extra_fragment: &Option<String>,
182 item_opt: Option<&Item>,
183 ) -> Result<(Res, Option<String>), ErrorKind> {
186 // In case we're in a module, try to resolve the relative path.
187 if let Some(module_id) = parent_id {
188 let result = cx.enter_resolver(|resolver| {
189 resolver.resolve_str_path_error(DUMMY_SP, &path_str, ns, module_id)
191 debug!("{} resolved to {:?} in namespace {:?}", path_str, result, ns);
192 let result = match result {
193 Ok((_, Res::Err)) => Err(ErrorKind::ResolutionFailure),
194 _ => result.map_err(|_| ErrorKind::ResolutionFailure),
197 if let Ok((_, res)) = result {
198 let res = res.map_id(|_| panic!("unexpected node_id"));
199 // In case this is a trait item, skip the
200 // early return and try looking for the trait.
201 let value = match res {
202 Res::Def(DefKind::AssocFn | DefKind::AssocConst, _) => true,
203 Res::Def(DefKind::AssocTy, _) => false,
204 Res::Def(DefKind::Variant, _) => {
205 return handle_variant(cx, res, extra_fragment);
207 // Not a trait item; just return what we found.
209 if extra_fragment.is_some() {
210 return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive));
212 return Ok((res, Some(path_str.to_owned())));
214 Res::Def(DefKind::Mod, _) => {
215 // This resolved to a module, but if we were passed `type@`,
216 // we want primitive types to take precedence instead.
217 if disambiguator == Some("type") {
218 if let Some(prim) = is_primitive(path_str, ns) {
219 if extra_fragment.is_some() {
220 return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive));
222 return Ok((prim, Some(path_str.to_owned())));
225 return Ok((res, extra_fragment.clone()));
228 return Ok((res, extra_fragment.clone()));
232 if value != (ns == ValueNS) {
233 return Err(ErrorKind::ResolutionFailure);
235 } else if let Some(prim) = is_primitive(path_str, ns) {
236 if extra_fragment.is_some() {
237 return Err(ErrorKind::AnchorFailure(AnchorFailure::Primitive));
239 return Ok((prim, Some(path_str.to_owned())));
241 // If resolution failed, it may still be a method
242 // because methods are not handled by the resolver
243 // If so, bail when we're not looking for a value.
245 return Err(ErrorKind::ResolutionFailure);
249 // Try looking for methods and associated items.
250 let mut split = path_str.rsplitn(2, "::");
252 split.next().map(|f| Symbol::intern(f)).ok_or(ErrorKind::ResolutionFailure)?;
256 if f == "self" || f == "Self" {
257 if let Some(name) = current_item.as_ref() {
263 .ok_or(ErrorKind::ResolutionFailure)?;
265 if let Some(prim) = is_primitive(&path, TypeNS) {
266 let did = primitive_impl(cx, &path).ok_or(ErrorKind::ResolutionFailure)?;
269 .associated_items(did)
270 .filter_by_name_unhygienic(item_name)
272 .and_then(|item| match item.kind {
273 ty::AssocKind::Fn => Some("method"),
276 .map(|out| (prim, Some(format!("{}#{}.{}", path, out, item_name))))
277 .ok_or(ErrorKind::ResolutionFailure);
281 .enter_resolver(|resolver| {
282 resolver.resolve_str_path_error(DUMMY_SP, &path, TypeNS, module_id)
284 .map_err(|_| ErrorKind::ResolutionFailure)?;
285 if let Res::Err = ty_res {
286 return self.variant_field(path_str, current_item, module_id);
288 let ty_res = ty_res.map_id(|_| panic!("unexpected node_id"));
291 DefKind::Struct | DefKind::Union | DefKind::Enum | DefKind::TyAlias,
294 // Checks if item_name belongs to `impl SomeItem`
299 .flat_map(|imp| cx.tcx.associated_items(*imp).in_definition_order())
300 .find(|item| item.ident.name == item_name);
301 let trait_item = item_opt
302 .and_then(|item| self.cx.as_local_hir_id(item.def_id))
303 .and_then(|item_hir| {
304 // Checks if item_name belongs to `impl SomeTrait for SomeItem`
305 let parent_hir = self.cx.tcx.hir().get_parent_item(item_hir);
306 let item_parent = self.cx.tcx.hir().find(parent_hir);
308 Some(hir::Node::Item(hir::Item {
309 kind: hir::ItemKind::Impl { of_trait: Some(_), self_ty, .. },
313 .associated_item_def_ids(self_ty.hir_id.owner)
316 let associated_item = cx.tcx.associated_item(*child);
319 .find(|child| child.ident.name == item_name),
323 let item = match (impl_item, trait_item) {
324 (Some(from_impl), Some(_)) => {
325 // Although it's ambiguous, return impl version for compat. sake.
326 // To handle that properly resolve() would have to support
328 // [`ambi_fn`](<SomeStruct as SomeTrait>::ambi_fn)
331 (None, Some(from_trait)) => Some(from_trait),
332 (Some(from_impl), None) => Some(from_impl),
336 if let Some(item) = item {
337 let out = match item.kind {
338 ty::AssocKind::Fn if ns == ValueNS => "method",
339 ty::AssocKind::Const if ns == ValueNS => "associatedconstant",
340 ty::AssocKind::Type if ns == ValueNS => "associatedtype",
341 _ => return self.variant_field(path_str, current_item, module_id),
343 if extra_fragment.is_some() {
344 Err(ErrorKind::AnchorFailure(if item.kind == ty::AssocKind::Fn {
345 AnchorFailure::Method
347 AnchorFailure::AssocConstant
350 Ok((ty_res, Some(format!("{}.{}", out, item_name))))
353 match cx.tcx.type_of(did).kind {
355 if let Some(item) = if def.is_enum() {
356 def.all_fields().find(|item| item.ident.name == item_name)
358 def.non_enum_variant()
361 .find(|item| item.ident.name == item_name)
363 if extra_fragment.is_some() {
364 Err(ErrorKind::AnchorFailure(if def.is_enum() {
365 AnchorFailure::Variant
384 self.variant_field(path_str, current_item, module_id)
387 _ => self.variant_field(path_str, current_item, module_id),
391 Res::Def(DefKind::Trait, did) => {
394 .associated_item_def_ids(did)
396 .map(|item| cx.tcx.associated_item(*item))
397 .find(|item| item.ident.name == item_name);
398 if let Some(item) = item {
401 ty::AssocKind::Const if ns == ValueNS => "associatedconstant",
402 ty::AssocKind::Type if ns == TypeNS => "associatedtype",
403 ty::AssocKind::Fn if ns == ValueNS => {
404 if item.defaultness.has_value() { "method" } else { "tymethod" }
406 _ => return self.variant_field(path_str, current_item, module_id),
409 if extra_fragment.is_some() {
410 Err(ErrorKind::AnchorFailure(if item.kind == ty::AssocKind::Const {
411 AnchorFailure::AssocConstant
412 } else if item.kind == ty::AssocKind::Type {
413 AnchorFailure::AssocType
415 AnchorFailure::Method
418 Ok((ty_res, Some(format!("{}.{}", kind, item_name))))
421 self.variant_field(path_str, current_item, module_id)
424 _ => self.variant_field(path_str, current_item, module_id),
427 debug!("attempting to resolve item without parent module: {}", path_str);
428 Err(ErrorKind::ResolutionFailure)
433 /// Check for resolve collisions between a trait and its derive
435 /// These are common and we should just resolve to the trait in that case
436 fn is_derive_trait_collision<T>(ns: &PerNS<Option<(Res, T)>>) -> bool {
438 type_ns: Some((Res::Def(DefKind::Trait, _), _)),
439 macro_ns: Some((Res::Def(DefKind::Macro(MacroKind::Derive), _), _)),
449 impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
450 fn fold_item(&mut self, mut item: Item) -> Option<Item> {
451 use rustc_middle::ty::DefIdTree;
453 let parent_node = if item.is_fake() {
454 // FIXME: is this correct?
457 let mut current = item.def_id;
458 // The immediate parent might not always be a module.
459 // Find the first parent which is.
461 if let Some(parent) = self.cx.tcx.parent(current) {
462 if self.cx.tcx.def_kind(parent) == DefKind::Mod {
472 if parent_node.is_some() {
473 trace!("got parent node for {:?} {:?}, id {:?}", item.type_(), item.name, item.def_id);
476 let current_item = match item.inner {
478 if item.attrs.inner_docs {
479 if item.def_id.is_top_level_module() { item.name.clone() } else { None }
481 match parent_node.or(self.mod_ids.last().copied()) {
482 Some(parent) if !parent.is_top_level_module() => {
483 // FIXME: can we pull the parent module's name from elsewhere?
484 Some(self.cx.tcx.item_name(parent).to_string())
490 ImplItem(Impl { ref for_, .. }) => {
491 for_.def_id().map(|did| self.cx.tcx.item_name(did).to_string())
493 // we don't display docs on `extern crate` items anyway, so don't process them.
494 ExternCrateItem(..) => {
495 debug!("ignoring extern crate item {:?}", item.def_id);
496 return self.fold_item_recur(item);
498 ImportItem(Import::Simple(ref name, ..)) => Some(name.clone()),
499 MacroItem(..) => None,
500 _ => item.name.clone(),
503 if item.is_mod() && item.attrs.inner_docs {
504 self.mod_ids.push(item.def_id);
508 let dox = item.attrs.collapsed_doc_value().unwrap_or_else(String::new);
509 trace!("got documentation '{}'", dox);
511 look_for_tests(&cx, &dox, &item, true);
513 // find item's parent to resolve `Self` in item's docs below
514 let parent_name = self.cx.as_local_hir_id(item.def_id).and_then(|item_hir| {
515 let parent_hir = self.cx.tcx.hir().get_parent_item(item_hir);
516 let item_parent = self.cx.tcx.hir().find(parent_hir);
518 Some(hir::Node::Item(hir::Item {
520 hir::ItemKind::Impl {
524 hir::TyKind::Path(hir::QPath::Resolved(
526 hir::Path { segments, .. },
533 })) => segments.first().map(|seg| seg.ident.to_string()),
534 Some(hir::Node::Item(hir::Item {
535 ident, kind: hir::ItemKind::Enum(..), ..
537 | Some(hir::Node::Item(hir::Item {
538 ident, kind: hir::ItemKind::Struct(..), ..
540 | Some(hir::Node::Item(hir::Item {
541 ident, kind: hir::ItemKind::Union(..), ..
543 | Some(hir::Node::Item(hir::Item {
544 ident, kind: hir::ItemKind::Trait(..), ..
545 })) => Some(ident.to_string()),
550 for (ori_link, link_range) in markdown_links(&dox) {
551 trace!("considering link '{}'", ori_link);
553 // Bail early for real links.
554 if ori_link.contains('/') {
558 // [] is mostly likely not supposed to be a link
559 if ori_link.is_empty() {
563 let link = ori_link.replace("`", "");
564 let parts = link.split('#').collect::<Vec<_>>();
565 let (link, extra_fragment) = if parts.len() > 2 {
566 anchor_failure(cx, &item, &link, &dox, link_range, AnchorFailure::MultipleAnchors);
568 } else if parts.len() == 2 {
569 if parts[0].trim().is_empty() {
570 // This is an anchor to an element of the current page, nothing to do in here!
573 (parts[0].to_owned(), Some(parts[1].to_owned()))
575 (parts[0].to_owned(), None)
579 let (res, fragment) = {
581 let mut disambiguator = None;
582 path_str = if let Some(prefix) =
583 ["struct@", "enum@", "type@", "trait@", "union@", "module@", "mod@"]
585 .find(|p| link.starts_with(**p))
588 disambiguator = Some(&prefix[..prefix.len() - 1]);
589 link.trim_start_matches(prefix)
590 } else if let Some(prefix) =
591 ["const@", "static@", "value@", "function@", "fn@", "method@"]
593 .find(|p| link.starts_with(**p))
595 kind = Some(ValueNS);
596 disambiguator = Some(&prefix[..prefix.len() - 1]);
597 link.trim_start_matches(prefix)
598 } else if link.ends_with("!()") {
599 kind = Some(MacroNS);
600 link.trim_end_matches("!()")
601 } else if link.ends_with("()") {
602 kind = Some(ValueNS);
603 disambiguator = Some("fn");
604 link.trim_end_matches("()")
605 } else if link.starts_with("macro@") {
606 kind = Some(MacroNS);
607 disambiguator = Some("macro");
608 link.trim_start_matches("macro@")
609 } else if link.starts_with("derive@") {
610 kind = Some(MacroNS);
611 disambiguator = Some("derive");
612 link.trim_start_matches("derive@")
613 } else if link.ends_with('!') {
614 kind = Some(MacroNS);
615 disambiguator = Some("macro");
616 link.trim_end_matches('!')
622 if path_str.contains(|ch: char| !(ch.is_alphanumeric() || ch == ':' || ch == '_')) {
626 // In order to correctly resolve intra-doc-links we need to
627 // pick a base AST node to work from. If the documentation for
628 // this module came from an inner comment (//!) then we anchor
629 // our name resolution *inside* the module. If, on the other
630 // hand it was an outer comment (///) then we anchor the name
631 // resolution in the parent module on the basis that the names
632 // used are more likely to be intended to be parent names. For
633 // this, we set base_node to None for inner comments since
634 // we've already pushed this node onto the resolution stack but
635 // for outer comments we explicitly try and resolve against the
636 // parent_node first.
637 let base_node = if item.is_mod() && item.attrs.inner_docs {
638 self.mod_ids.last().copied()
643 // replace `Self` with suitable item's parent name
644 if path_str.starts_with("Self::") {
645 if let Some(ref name) = parent_name {
646 resolved_self = format!("{}::{}", name, &path_str[6..]);
647 path_str = &resolved_self;
652 Some(ns @ ValueNS) => {
663 Err(ErrorKind::ResolutionFailure) => {
664 resolution_failure(cx, &item, path_str, &dox, link_range);
665 // This could just be a normal link or a broken link
666 // we could potentially check if something is
667 // "intra-doc-link-like" and warn in that case.
670 Err(ErrorKind::AnchorFailure(msg)) => {
671 anchor_failure(cx, &item, &ori_link, &dox, link_range, msg);
676 Some(ns @ TypeNS) => {
687 Err(ErrorKind::ResolutionFailure) => {
688 resolution_failure(cx, &item, path_str, &dox, link_range);
689 // This could just be a normal link.
692 Err(ErrorKind::AnchorFailure(msg)) => {
693 anchor_failure(cx, &item, &ori_link, &dox, link_range, msg);
700 let mut candidates = PerNS {
702 .macro_resolve(path_str, base_node)
703 .map(|res| (res, extra_fragment.clone())),
704 type_ns: match self.resolve(
713 Err(ErrorKind::AnchorFailure(msg)) => {
714 anchor_failure(cx, &item, &ori_link, &dox, link_range, msg);
719 value_ns: match self.resolve(
728 Err(ErrorKind::AnchorFailure(msg)) => {
729 anchor_failure(cx, &item, &ori_link, &dox, link_range, msg);
734 .and_then(|(res, fragment)| {
735 // Constructors are picked up in the type namespace.
737 Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => None,
738 _ => match (fragment, extra_fragment) {
739 (Some(fragment), Some(_)) => {
740 // Shouldn't happen but who knows?
741 Some((res, Some(fragment)))
743 (fragment, None) | (None, fragment) => {
744 Some((res, fragment))
751 if candidates.is_empty() {
752 resolution_failure(cx, &item, path_str, &dox, link_range);
753 // this could just be a normal link
757 let len = candidates.clone().present_items().count();
760 candidates.present_items().next().unwrap()
761 } else if len == 2 && is_derive_trait_collision(&candidates) {
762 candidates.type_ns.unwrap()
764 if is_derive_trait_collision(&candidates) {
765 candidates.macro_ns = None;
773 candidates.map(|candidate| candidate.map(|(res, _)| res)),
779 if let Some(res) = self.macro_resolve(path_str, base_node) {
780 (res, extra_fragment)
782 resolution_failure(cx, &item, path_str, &dox, link_range);
789 if let Res::PrimTy(_) = res {
790 item.attrs.links.push((ori_link, None, fragment));
792 debug!("intra-doc link to {} resolved to {:?}", path_str, res);
794 // item can be non-local e.g. when using #[doc(primitive = "pointer")]
795 if let Some((src_id, dst_id)) = res
797 .and_then(|def_id| def_id.as_local())
798 .and_then(|dst_id| item.def_id.as_local().map(|src_id| (src_id, dst_id)))
800 use rustc_hir::def_id::LOCAL_CRATE;
802 let hir_src = self.cx.tcx.hir().as_local_hir_id(src_id);
803 let hir_dst = self.cx.tcx.hir().as_local_hir_id(dst_id);
805 if self.cx.tcx.privacy_access_levels(LOCAL_CRATE).is_exported(hir_src)
806 && !self.cx.tcx.privacy_access_levels(LOCAL_CRATE).is_exported(hir_dst)
808 privacy_error(cx, &item, &path_str, &dox, link_range);
812 let id = register_res(cx, res);
813 item.attrs.links.push((ori_link, Some(id), fragment));
817 if item.is_mod() && !item.attrs.inner_docs {
818 self.mod_ids.push(item.def_id);
822 let ret = self.fold_item_recur(item);
828 self.fold_item_recur(item)
832 // FIXME: if we can resolve intra-doc links from other crates, we can use the stock
833 // `fold_crate`, but until then we should avoid scanning `krate.external_traits` since those
834 // will never resolve properly
835 fn fold_crate(&mut self, mut c: Crate) -> Crate {
836 c.module = c.module.take().and_then(|module| self.fold_item(module));
842 /// Reports a diagnostic for an intra-doc link.
844 /// If no link range is provided, or the source span of the link cannot be determined, the span of
845 /// the entire documentation block is used for the lint. If a range is provided but the span
846 /// calculation fails, a note is added to the diagnostic pointing to the link in the markdown.
848 /// The `decorate` callback is invoked in all cases to allow further customization of the
849 /// diagnostic before emission. If the span of the link was able to be determined, the second
850 /// parameter of the callback will contain it, and the primary span of the diagnostic will be set
852 fn report_diagnostic(
857 link_range: Option<Range<usize>>,
858 decorate: impl FnOnce(&mut DiagnosticBuilder<'_>, Option<rustc_span::Span>),
860 let hir_id = match cx.as_local_hir_id(item.def_id) {
861 Some(hir_id) => hir_id,
863 // If non-local, no need to check anything.
864 info!("ignoring warning from parent crate: {}", msg);
869 let attrs = &item.attrs;
870 let sp = span_of_attrs(attrs).unwrap_or(item.source.span());
872 cx.tcx.struct_span_lint_hir(
873 lint::builtin::INTRA_DOC_LINK_RESOLUTION_FAILURE,
877 let mut diag = lint.build(msg);
879 let span = link_range
881 .and_then(|range| super::source_span_for_markdown_range(cx, dox, range, attrs));
883 if let Some(link_range) = link_range {
884 if let Some(sp) = span {
887 // blah blah blah\nblah\nblah [blah] blah blah\nblah blah
890 // last_new_line_offset
891 let last_new_line_offset =
892 dox[..link_range.start].rfind('\n').map_or(0, |n| n + 1);
893 let line = dox[last_new_line_offset..].lines().next().unwrap_or("");
895 // Print the line containing the `link_range` and manually mark it with '^'s.
897 "the link appears in this line:\n\n{line}\n\
898 {indicator: <before$}{indicator:^<found$}",
901 before = link_range.start - last_new_line_offset,
902 found = link_range.len(),
907 decorate(&mut diag, span);
914 fn resolution_failure(
919 link_range: Option<Range<usize>>,
923 &format!("unresolved link to `{}`", path_str),
928 if let Some(sp) = sp {
929 diag.span_label(sp, "unresolved link");
932 diag.help(r#"to escape `[` and `]` characters, add '\' before them like `\[` or `\]`"#);
942 link_range: Option<Range<usize>>,
943 failure: AnchorFailure,
945 let msg = match failure {
946 AnchorFailure::MultipleAnchors => format!("`{}` contains multiple anchors", path_str),
947 AnchorFailure::Primitive
948 | AnchorFailure::Variant
949 | AnchorFailure::AssocConstant
950 | AnchorFailure::AssocType
951 | AnchorFailure::Field
952 | AnchorFailure::Method => {
953 let kind = match failure {
954 AnchorFailure::Primitive => "primitive type",
955 AnchorFailure::Variant => "enum variant",
956 AnchorFailure::AssocConstant => "associated constant",
957 AnchorFailure::AssocType => "associated type",
958 AnchorFailure::Field => "struct field",
959 AnchorFailure::Method => "method",
960 AnchorFailure::MultipleAnchors => unreachable!("should be handled already"),
964 "`{}` contains an anchor, but links to {kind}s are already anchored",
971 report_diagnostic(cx, &msg, item, dox, link_range, |diag, sp| {
972 if let Some(sp) = sp {
973 diag.span_label(sp, "contains invalid anchor");
983 link_range: Option<Range<usize>>,
984 candidates: PerNS<Option<Res>>,
986 let mut msg = format!("`{}` is ", path_str);
988 let candidates = [TypeNS, ValueNS, MacroNS]
990 .filter_map(|&ns| candidates[ns].map(|res| (res, ns)))
991 .collect::<Vec<_>>();
992 match candidates.as_slice() {
993 [(first_def, _), (second_def, _)] => {
995 "both {} {} and {} {}",
998 second_def.article(),
1003 let mut candidates = candidates.iter().peekable();
1004 while let Some((res, _)) = candidates.next() {
1005 if candidates.peek().is_some() {
1006 msg += &format!("{} {}, ", res.article(), res.descr());
1008 msg += &format!("and {} {}", res.article(), res.descr());
1014 report_diagnostic(cx, &msg, item, dox, link_range.clone(), |diag, sp| {
1015 if let Some(sp) = sp {
1016 diag.span_label(sp, "ambiguous link");
1018 let link_range = link_range.expect("must have a link range if we have a span");
1020 for (res, ns) in candidates {
1021 let (action, mut suggestion) = match res {
1022 Res::Def(DefKind::AssocFn | DefKind::Fn, _) => {
1023 ("add parentheses", format!("{}()", path_str))
1025 Res::Def(DefKind::Macro(MacroKind::Bang), _) => {
1026 ("add an exclamation mark", format!("{}!", path_str))
1029 let type_ = match (res, ns) {
1030 (Res::Def(DefKind::Const, _), _) => "const",
1031 (Res::Def(DefKind::Static, _), _) => "static",
1032 (Res::Def(DefKind::Struct, _), _) => "struct",
1033 (Res::Def(DefKind::Enum, _), _) => "enum",
1034 (Res::Def(DefKind::Union, _), _) => "union",
1035 (Res::Def(DefKind::Trait, _), _) => "trait",
1036 (Res::Def(DefKind::Mod, _), _) => "module",
1037 (_, TypeNS) => "type",
1038 (_, ValueNS) => "value",
1039 (Res::Def(DefKind::Macro(MacroKind::Derive), _), MacroNS) => "derive",
1040 (_, MacroNS) => "macro",
1043 // FIXME: if this is an implied shortcut link, it's bad style to suggest `@`
1044 ("prefix with the item type", format!("{}@{}", type_, path_str))
1048 if dox.bytes().nth(link_range.start) == Some(b'`') {
1049 suggestion = format!("`{}`", suggestion);
1052 // FIXME: Create a version of this suggestion for when we don't have the span.
1053 diag.span_suggestion(
1055 &format!("to link to the {}, {}", res.descr(), action),
1057 Applicability::MaybeIncorrect,
1065 cx: &DocContext<'_>,
1069 link_range: Option<Range<usize>>,
1071 let item_name = item.name.as_deref().unwrap_or("<unknown>");
1073 format!("public documentation for `{}` links to private item `{}`", item_name, path_str);
1075 report_diagnostic(cx, &msg, item, dox, link_range, |diag, sp| {
1076 if let Some(sp) = sp {
1077 diag.span_label(sp, "this item is private");
1082 /// Given an enum variant's res, return the res of its enum and the associated fragment.
1084 cx: &DocContext<'_>,
1086 extra_fragment: &Option<String>,
1087 ) -> Result<(Res, Option<String>), ErrorKind> {
1088 use rustc_middle::ty::DefIdTree;
1090 if extra_fragment.is_some() {
1091 return Err(ErrorKind::AnchorFailure(AnchorFailure::Variant));
1093 let parent = if let Some(parent) = cx.tcx.parent(res.def_id()) {
1096 return Err(ErrorKind::ResolutionFailure);
1098 let parent_def = Res::Def(DefKind::Enum, parent);
1099 let variant = cx.tcx.expect_variant_res(res);
1100 Ok((parent_def, Some(format!("variant.{}", variant.ident.name))))
1103 const PRIMITIVES: &[(&str, Res)] = &[
1104 ("u8", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::U8))),
1105 ("u16", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::U16))),
1106 ("u32", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::U32))),
1107 ("u64", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::U64))),
1108 ("u128", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::U128))),
1109 ("usize", Res::PrimTy(hir::PrimTy::Uint(rustc_ast::ast::UintTy::Usize))),
1110 ("i8", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::I8))),
1111 ("i16", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::I16))),
1112 ("i32", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::I32))),
1113 ("i64", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::I64))),
1114 ("i128", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::I128))),
1115 ("isize", Res::PrimTy(hir::PrimTy::Int(rustc_ast::ast::IntTy::Isize))),
1116 ("f32", Res::PrimTy(hir::PrimTy::Float(rustc_ast::ast::FloatTy::F32))),
1117 ("f64", Res::PrimTy(hir::PrimTy::Float(rustc_ast::ast::FloatTy::F64))),
1118 ("str", Res::PrimTy(hir::PrimTy::Str)),
1119 ("bool", Res::PrimTy(hir::PrimTy::Bool)),
1120 ("char", Res::PrimTy(hir::PrimTy::Char)),
1123 fn is_primitive(path_str: &str, ns: Namespace) -> Option<Res> {
1124 if ns == TypeNS { PRIMITIVES.iter().find(|x| x.0 == path_str).map(|x| x.1) } else { None }
1127 fn primitive_impl(cx: &DocContext<'_>, path_str: &str) -> Option<DefId> {
1130 "u8" => tcx.lang_items().u8_impl(),
1131 "u16" => tcx.lang_items().u16_impl(),
1132 "u32" => tcx.lang_items().u32_impl(),
1133 "u64" => tcx.lang_items().u64_impl(),
1134 "u128" => tcx.lang_items().u128_impl(),
1135 "usize" => tcx.lang_items().usize_impl(),
1136 "i8" => tcx.lang_items().i8_impl(),
1137 "i16" => tcx.lang_items().i16_impl(),
1138 "i32" => tcx.lang_items().i32_impl(),
1139 "i64" => tcx.lang_items().i64_impl(),
1140 "i128" => tcx.lang_items().i128_impl(),
1141 "isize" => tcx.lang_items().isize_impl(),
1142 "f32" => tcx.lang_items().f32_impl(),
1143 "f64" => tcx.lang_items().f64_impl(),
1144 "str" => tcx.lang_items().str_impl(),
1145 "bool" => tcx.lang_items().bool_impl(),
1146 "char" => tcx.lang_items().char_impl(),