//!
//! [RFC 1946]: https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md
-use rustc_ast as ast;
-use rustc_data_structures::stable_set::FxHashSet;
+use rustc_data_structures::{fx::FxHashMap, stable_set::FxHashSet};
use rustc_errors::{Applicability, DiagnosticBuilder};
-use rustc_expand::base::SyntaxExtensionKind;
-use rustc_hir as hir;
use rustc_hir::def::{
DefKind,
Namespace::{self, *},
- PerNS, Res,
-};
-use rustc_hir::def_id::{CrateNum, DefId};
-use rustc_middle::ty;
-use rustc_resolve::ParentScope;
-use rustc_session::lint::{
- builtin::{BROKEN_INTRA_DOC_LINKS, PRIVATE_INTRA_DOC_LINKS},
- Lint,
+ PerNS,
};
+use rustc_hir::def_id::{CrateNum, DefId, CRATE_DEF_ID};
+use rustc_middle::ty::{DefIdTree, Ty, TyCtxt};
+use rustc_middle::{bug, span_bug, ty};
+use rustc_session::lint::Lint;
use rustc_span::hygiene::MacroKind;
-use rustc_span::symbol::sym;
-use rustc_span::symbol::Ident;
-use rustc_span::symbol::Symbol;
-use rustc_span::DUMMY_SP;
+use rustc_span::symbol::{sym, Ident, Symbol};
+use rustc_span::{BytePos, DUMMY_SP};
use smallvec::{smallvec, SmallVec};
+use pulldown_cmark::LinkType;
+
use std::borrow::Cow;
-use std::cell::Cell;
+use std::convert::{TryFrom, TryInto};
+use std::fmt::Write;
use std::mem;
use std::ops::Range;
-use crate::clean::{self, Crate, GetDefId, Import, Item, ItemLink, PrimitiveType};
+use crate::clean::{self, utils::find_nearest_parent_module, Crate, Item, ItemLink, PrimitiveType};
use crate::core::DocContext;
-use crate::fold::DocFolder;
-use crate::html::markdown::markdown_links;
+use crate::html::markdown::{markdown_links, MarkdownLink};
+use crate::lint::{BROKEN_INTRA_DOC_LINKS, PRIVATE_INTRA_DOC_LINKS};
use crate::passes::Pass;
+use crate::visit::DocVisitor;
-use super::span_of_attrs;
+mod early;
+crate use early::early_resolve_intra_doc_links;
-pub const COLLECT_INTRA_DOC_LINKS: Pass = Pass {
+crate const COLLECT_INTRA_DOC_LINKS: Pass = Pass {
name: "collect-intra-doc-links",
run: collect_intra_doc_links,
- description: "reads a crate's documentation to resolve intra-doc-links",
+ description: "resolves intra-doc links",
};
-pub fn collect_intra_doc_links(krate: Crate, cx: &DocContext<'_>) -> Crate {
- LinkCollector::new(cx).fold_crate(krate)
+fn collect_intra_doc_links(krate: Crate, cx: &mut DocContext<'_>) -> Crate {
+ let mut collector =
+ LinkCollector { cx, mod_ids: Vec::new(), visited_links: FxHashMap::default() };
+ collector.visit_crate(&krate);
+ krate
}
/// Top-level errors emitted by this pass.
}
}
-#[derive(Debug)]
+#[derive(Copy, Clone, Debug, Hash)]
+enum Res {
+ Def(DefKind, DefId),
+ Primitive(PrimitiveType),
+}
+
+type ResolveRes = rustc_hir::def::Res<rustc_ast::NodeId>;
+
+impl Res {
+ fn descr(self) -> &'static str {
+ match self {
+ Res::Def(kind, id) => ResolveRes::Def(kind, id).descr(),
+ Res::Primitive(_) => "builtin type",
+ }
+ }
+
+ fn article(self) -> &'static str {
+ match self {
+ Res::Def(kind, id) => ResolveRes::Def(kind, id).article(),
+ Res::Primitive(_) => "a",
+ }
+ }
+
+ fn name(self, tcx: TyCtxt<'_>) -> Symbol {
+ match self {
+ Res::Def(_, id) => tcx.item_name(id),
+ Res::Primitive(prim) => prim.as_sym(),
+ }
+ }
+
+ fn def_id(self, tcx: TyCtxt<'_>) -> DefId {
+ match self {
+ Res::Def(_, id) => id,
+ Res::Primitive(prim) => *PrimitiveType::primitive_locations(tcx).get(&prim).unwrap(),
+ }
+ }
+
+ fn as_hir_res(self) -> Option<rustc_hir::def::Res> {
+ match self {
+ Res::Def(kind, id) => Some(rustc_hir::def::Res::Def(kind, id)),
+ // FIXME: maybe this should handle the subset of PrimitiveType that fits into hir::PrimTy?
+ Res::Primitive(_) => None,
+ }
+ }
+
+ /// Used for error reporting.
+ fn disambiguator_suggestion(self) -> Suggestion {
+ let kind = match self {
+ Res::Primitive(_) => return Suggestion::Prefix("prim"),
+ Res::Def(kind, _) => kind,
+ };
+ if kind == DefKind::Macro(MacroKind::Bang) {
+ return Suggestion::Macro;
+ } else if kind == DefKind::Fn || kind == DefKind::AssocFn {
+ return Suggestion::Function;
+ } else if kind == DefKind::Field {
+ return Suggestion::RemoveDisambiguator;
+ }
+
+ let prefix = match kind {
+ DefKind::Struct => "struct",
+ DefKind::Enum => "enum",
+ DefKind::Trait => "trait",
+ DefKind::Union => "union",
+ DefKind::Mod => "mod",
+ DefKind::Const | DefKind::ConstParam | DefKind::AssocConst | DefKind::AnonConst => {
+ "const"
+ }
+ DefKind::Static => "static",
+ DefKind::Macro(MacroKind::Derive) => "derive",
+ // Now handle things that don't have a specific disambiguator
+ _ => match kind
+ .ns()
+ .expect("tried to calculate a disambiguator for a def without a namespace?")
+ {
+ Namespace::TypeNS => "type",
+ Namespace::ValueNS => "value",
+ Namespace::MacroNS => "macro",
+ },
+ };
+
+ Suggestion::Prefix(prefix)
+ }
+}
+
+impl TryFrom<ResolveRes> for Res {
+ type Error = ();
+
+ fn try_from(res: ResolveRes) -> Result<Self, ()> {
+ use rustc_hir::def::Res::*;
+ match res {
+ Def(kind, id) => Ok(Res::Def(kind, id)),
+ PrimTy(prim) => Ok(Res::Primitive(PrimitiveType::from_hir(prim))),
+ // e.g. `#[derive]`
+ NonMacroAttr(..) | Err => Result::Err(()),
+ other => bug!("unrecognized res {:?}", other),
+ }
+ }
+}
+
/// A link failed to resolve.
+#[derive(Debug)]
enum ResolutionFailure<'a> {
/// This resolved, but with the wrong namespace.
- ///
- /// `Namespace` is the namespace specified with a disambiguator
- /// (as opposed to the actual namespace of the `Res`).
- WrongNamespace(Res, /* disambiguated */ Namespace),
- /// The link failed to resolve. `resolution_failure` should look to see if there's
+ WrongNamespace {
+ /// What the link resolved to.
+ res: Res,
+ /// The expected namespace for the resolution, determined from the link's disambiguator.
+ ///
+ /// E.g., for `[fn@Result]` this is [`Namespace::ValueNS`],
+ /// even though `Result`'s actual namespace is [`Namespace::TypeNS`].
+ expected_ns: Namespace,
+ },
+ /// The link failed to resolve. [`resolution_failure`] should look to see if there's
/// a more helpful error that can be given.
NotResolved {
/// The scope the link was resolved in.
unresolved: Cow<'a, str>,
},
/// This happens when rustdoc can't determine the parent scope for an item.
- ///
/// It is always a bug in rustdoc.
NoParentItem,
/// This link has malformed generic parameters; e.g., the angle brackets are unbalanced.
MalformedGenerics(MalformedGenerics),
- /// Used to communicate that this should be ignored, but shouldn't be reported to the user
+ /// Used to communicate that this should be ignored, but shouldn't be reported to the user.
///
/// This happens when there is no disambiguator and one of the namespaces
/// failed to resolve.
EmptyAngleBrackets,
}
-impl ResolutionFailure<'a> {
+impl ResolutionFailure<'_> {
/// This resolved fully (not just partially) but is erroneous for some other reason
///
/// Returns the full resolution of the link, if present.
fn full_res(&self) -> Option<Res> {
match self {
- Self::WrongNamespace(res, _) => Some(*res),
+ Self::WrongNamespace { res, expected_ns: _ } => Some(*res),
_ => None,
}
}
/// link, Rustdoc disallows having a user-specified anchor.
///
/// Most of the time this is fine, because you can just link to the page of
- /// the item if you want to provide your own anchor. For primitives, though,
- /// rustdoc uses the anchor as a side channel to know which page to link to;
- /// it doesn't show up in the generated link. Ideally, rustdoc would remove
- /// this limitation, allowing you to link to subheaders on primitives.
+ /// the item if you want to provide your own anchor.
RustdocAnchorConflict(Res),
}
+#[derive(Clone, Debug, Hash, PartialEq, Eq)]
+crate enum UrlFragment {
+ Item(ItemFragment),
+ UserWritten(String),
+}
+
+impl UrlFragment {
+ /// Render the fragment, including the leading `#`.
+ crate fn render(&self, s: &mut String, tcx: TyCtxt<'_>) -> std::fmt::Result {
+ match self {
+ UrlFragment::Item(frag) => frag.render(s, tcx),
+ UrlFragment::UserWritten(raw) => write!(s, "#{}", raw),
+ }
+ }
+}
+
+#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
+crate struct ItemFragment(FragmentKind, DefId);
+
+#[derive(Copy, Clone, Debug, Hash, PartialEq, Eq)]
+crate enum FragmentKind {
+ Method,
+ TyMethod,
+ AssociatedConstant,
+ AssociatedType,
+
+ StructField,
+ Variant,
+ VariantField,
+}
+
+impl ItemFragment {
+ /// Create a fragment for an associated item.
+ #[instrument(level = "debug")]
+ fn from_assoc_item(item: &ty::AssocItem) -> Self {
+ let def_id = item.def_id;
+ match item.kind {
+ ty::AssocKind::Fn => {
+ if item.defaultness.has_value() {
+ ItemFragment(FragmentKind::Method, def_id)
+ } else {
+ ItemFragment(FragmentKind::TyMethod, def_id)
+ }
+ }
+ ty::AssocKind::Const => ItemFragment(FragmentKind::AssociatedConstant, def_id),
+ ty::AssocKind::Type => ItemFragment(FragmentKind::AssociatedType, def_id),
+ }
+ }
+
+ /// Render the fragment, including the leading `#`.
+ crate fn render(&self, s: &mut String, tcx: TyCtxt<'_>) -> std::fmt::Result {
+ write!(s, "#")?;
+ match *self {
+ ItemFragment(kind, def_id) => {
+ let name = tcx.item_name(def_id);
+ match kind {
+ FragmentKind::Method => write!(s, "method.{}", name),
+ FragmentKind::TyMethod => write!(s, "tymethod.{}", name),
+ FragmentKind::AssociatedConstant => write!(s, "associatedconstant.{}", name),
+ FragmentKind::AssociatedType => write!(s, "associatedtype.{}", name),
+ FragmentKind::StructField => write!(s, "structfield.{}", name),
+ FragmentKind::Variant => write!(s, "variant.{}", name),
+ FragmentKind::VariantField => {
+ let variant = tcx.item_name(tcx.parent(def_id).unwrap());
+ write!(s, "variant.{}.field.{}", variant, name)
+ }
+ }
+ }
+ }
+ }
+}
+
+#[derive(Clone, Debug, Hash, PartialEq, Eq)]
+struct ResolutionInfo {
+ module_id: DefId,
+ dis: Option<Disambiguator>,
+ path_str: String,
+ extra_fragment: Option<String>,
+}
+
+#[derive(Clone)]
+struct DiagnosticInfo<'a> {
+ item: &'a Item,
+ dox: &'a str,
+ ori_link: &'a str,
+ link_range: Range<usize>,
+}
+
+#[derive(Clone, Debug, Hash)]
+struct CachedLink {
+ res: (Res, Option<UrlFragment>),
+}
+
struct LinkCollector<'a, 'tcx> {
- cx: &'a DocContext<'tcx>,
+ cx: &'a mut DocContext<'tcx>,
/// A stack of modules used to decide what scope to resolve in.
///
/// The last module will be used if the parent scope of the current item is
/// unknown.
mod_ids: Vec<DefId>,
- /// This is used to store the kind of associated items,
- /// because `clean` and the disambiguator code expect them to be different.
- /// See the code for associated items on inherent impls for details.
- kind_side_channel: Cell<Option<(DefKind, DefId)>>,
+ /// Cache the resolved links so we can avoid resolving (and emitting errors for) the same link.
+ /// The link will be `None` if it could not be resolved (i.e. the error was cached).
+ visited_links: FxHashMap<ResolutionInfo, Option<CachedLink>>,
}
impl<'a, 'tcx> LinkCollector<'a, 'tcx> {
- fn new(cx: &'a DocContext<'tcx>) -> Self {
- LinkCollector { cx, mod_ids: Vec::new(), kind_side_channel: Cell::new(None) }
- }
-
/// Given a full link, parse it as an [enum struct variant].
///
/// In particular, this will return an error whenever there aren't three
/// full path segments left in the link.
///
- /// [enum struct variant]: hir::VariantData::Struct
- fn variant_field(
+ /// [enum struct variant]: rustc_hir::VariantData::Struct
+ fn variant_field<'path>(
&self,
path_str: &'path str,
- current_item: &Option<String>,
module_id: DefId,
- ) -> Result<(Res, Option<String>), ErrorKind<'path>> {
- let cx = self.cx;
+ ) -> Result<(Res, Option<ItemFragment>), ErrorKind<'path>> {
+ let tcx = self.cx.tcx;
let no_res = || ResolutionFailure::NotResolved {
module_id,
partial_res: None,
debug!("looking for enum variant {}", path_str);
let mut split = path_str.rsplitn(3, "::");
- let (variant_field_str, variant_field_name) = split
+ let variant_field_name = split
.next()
- .map(|f| (f, Symbol::intern(f)))
+ .map(|f| Symbol::intern(f))
.expect("fold_item should ensure link is non-empty");
- let (variant_str, variant_name) =
+ let variant_name =
// we're not sure this is a variant at all, so use the full string
// If there's no second component, the link looks like `[path]`.
// So there's no partial res and we should say the whole link failed to resolve.
- split.next().map(|f| (f, Symbol::intern(f))).ok_or_else(no_res)?;
+ split.next().map(|f| Symbol::intern(f)).ok_or_else(no_res)?;
let path = split
.next()
- .map(|f| {
- if f == "self" || f == "Self" {
- if let Some(name) = current_item.as_ref() {
- return name.clone();
- }
- }
- f.to_owned()
- })
+ .map(|f| f.to_owned())
// If there's no third component, we saw `[a::b]` before and it failed to resolve.
// So there's no partial res.
.ok_or_else(no_res)?;
- let ty_res = cx
+ let ty_res = self
+ .cx
.enter_resolver(|resolver| {
resolver.resolve_str_path_error(DUMMY_SP, &path, TypeNS, module_id)
})
- .map(|(_, res)| res)
- .unwrap_or(Res::Err);
- if let Res::Err = ty_res {
- return Err(no_res().into());
- }
- let ty_res = ty_res.map_id(|_| panic!("unexpected node_id"));
+ .and_then(|(_, res)| res.try_into())
+ .map_err(|()| no_res())?;
+
match ty_res {
Res::Def(DefKind::Enum, did) => {
- if cx
- .tcx
+ if tcx
.inherent_impls(did)
.iter()
- .flat_map(|imp| cx.tcx.associated_items(*imp).in_definition_order())
- .any(|item| item.ident.name == variant_name)
+ .flat_map(|imp| tcx.associated_items(*imp).in_definition_order())
+ .any(|item| item.name == variant_name)
{
// This is just to let `fold_item` know that this shouldn't be considered;
// it's a bug for the error to make it to the user
return Err(ResolutionFailure::Dummy.into());
}
- match cx.tcx.type_of(did).kind() {
+ match tcx.type_of(did).kind() {
ty::Adt(def, _) if def.is_enum() => {
- if def.all_fields().any(|item| item.ident.name == variant_field_name) {
- Ok((
- ty_res,
- Some(format!(
- "variant.{}.field.{}",
- variant_str, variant_field_name
- )),
- ))
+ if let Some(field) = def.all_fields().find(|f| f.name == variant_field_name)
+ {
+ Ok((ty_res, Some(ItemFragment(FragmentKind::VariantField, field.did))))
} else {
Err(ResolutionFailure::NotResolved {
module_id,
partial_res: Some(Res::Def(DefKind::Enum, def.did)),
- unresolved: variant_field_str.into(),
+ unresolved: variant_field_name.to_string().into(),
}
.into())
}
_ => Err(ResolutionFailure::NotResolved {
module_id,
partial_res: Some(ty_res),
- unresolved: variant_str.into(),
+ unresolved: variant_name.to_string().into(),
}
.into()),
}
}
/// Given a primitive type, try to resolve an associated item.
- ///
- /// HACK(jynelson): `item_str` is passed in instead of derived from `item_name` so the
- /// lifetimes on `&'path` will work.
fn resolve_primitive_associated_item(
&self,
- prim_ty: hir::PrimTy,
+ prim_ty: PrimitiveType,
ns: Namespace,
- module_id: DefId,
item_name: Symbol,
- item_str: &'path str,
- ) -> Result<(Res, Option<String>), ErrorKind<'path>> {
- let cx = self.cx;
-
- PrimitiveType::from_hir(prim_ty)
- .impls(cx.tcx)
- .into_iter()
- .find_map(|&impl_| {
- cx.tcx
- .associated_items(impl_)
- .find_by_name_and_namespace(
- cx.tcx,
- Ident::with_dummy_span(item_name),
- ns,
- impl_,
- )
- .map(|item| match item.kind {
- ty::AssocKind::Fn => "method",
- ty::AssocKind::Const => "associatedconstant",
- ty::AssocKind::Type => "associatedtype",
- })
- .map(|out| {
- (
- Res::PrimTy(prim_ty),
- Some(format!("{}#{}.{}", prim_ty.name(), out, item_str)),
- )
- })
- })
- .ok_or_else(|| {
- debug!(
- "returning primitive error for {}::{} in {} namespace",
- prim_ty.name(),
- item_name,
- ns.descr()
- );
- ResolutionFailure::NotResolved {
- module_id,
- partial_res: Some(Res::PrimTy(prim_ty)),
- unresolved: item_str.into(),
- }
- .into()
- })
+ ) -> Option<(Res, ItemFragment)> {
+ let tcx = self.cx.tcx;
+
+ prim_ty.impls(tcx).into_iter().find_map(|&impl_| {
+ tcx.associated_items(impl_)
+ .find_by_name_and_namespace(tcx, Ident::with_dummy_span(item_name), ns, impl_)
+ .map(|item| {
+ let fragment = ItemFragment::from_assoc_item(item);
+ (Res::Primitive(prim_ty), fragment)
+ })
+ })
}
/// Resolves a string as a macro.
path_str: &'a str,
module_id: DefId,
) -> Result<Res, ResolutionFailure<'a>> {
- let cx = self.cx;
- let path = ast::Path::from_ident(Ident::from_str(path_str));
- cx.enter_resolver(|resolver| {
- // FIXME(jynelson): does this really need 3 separate lookups?
- if let Ok((Some(ext), res)) = resolver.resolve_macro_path(
- &path,
- None,
- &ParentScope::module(resolver.graph_root(), resolver),
- false,
- false,
- ) {
- if let SyntaxExtensionKind::LegacyBang { .. } = ext.kind {
- return Ok(res.map_id(|_| panic!("unexpected id")));
- }
- }
- if let Some(res) = resolver.all_macros().get(&Symbol::intern(path_str)) {
- return Ok(res.map_id(|_| panic!("unexpected id")));
- }
+ self.cx.enter_resolver(|resolver| {
+ // NOTE: this needs 2 separate lookups because `resolve_str_path_error` doesn't take
+ // lexical scope into account (it ignores all macros not defined at the mod-level)
debug!("resolving {} as a macro in the module {:?}", path_str, module_id);
if let Ok((_, res)) =
resolver.resolve_str_path_error(DUMMY_SP, path_str, MacroNS, module_id)
{
// don't resolve builtins like `#[derive]`
- if let Res::Def(..) = res {
- let res = res.map_id(|_| panic!("unexpected node_id"));
+ if let Ok(res) = res.try_into() {
return Ok(res);
}
}
+ if let Some(&res) = resolver.all_macros().get(&Symbol::intern(path_str)) {
+ return Ok(res.try_into().unwrap());
+ }
Err(ResolutionFailure::NotResolved {
module_id,
partial_res: None,
/// Associated items will never be resolved by this function.
fn resolve_path(&self, path_str: &str, ns: Namespace, module_id: DefId) -> Option<Res> {
let result = self.cx.enter_resolver(|resolver| {
- resolver.resolve_str_path_error(DUMMY_SP, &path_str, ns, module_id)
+ resolver
+ .resolve_str_path_error(DUMMY_SP, path_str, ns, module_id)
+ .and_then(|(_, res)| res.try_into())
});
debug!("{} resolved to {:?} in namespace {:?}", path_str, result, ns);
- match result.map(|(_, res)| res) {
- // resolver doesn't know about true and false so we'll have to resolve them
+ match result {
+ // resolver doesn't know about true, false, and types that aren't paths (e.g. `()`)
// manually as bool
- Ok(Res::Err) | Err(()) => is_bool_value(path_str, ns).map(|(_, res)| res),
- Ok(res) => Some(res.map_id(|_| panic!("unexpected node_id"))),
+ Err(()) => resolve_primitive(path_str, ns),
+ Ok(res) => Some(res),
}
}
/// Resolves a string as a path within a particular namespace. Returns an
/// optional URL fragment in the case of variants and methods.
fn resolve<'path>(
- &self,
+ &mut self,
path_str: &'path str,
ns: Namespace,
- // FIXME(#76467): This is for `Self`, and it's wrong.
- current_item: &Option<String>,
module_id: DefId,
- extra_fragment: &Option<String>,
- ) -> Result<(Res, Option<String>), ErrorKind<'path>> {
- let cx = self.cx;
+ user_fragment: &Option<String>,
+ ) -> Result<(Res, Option<UrlFragment>), ErrorKind<'path>> {
+ let (res, rustdoc_fragment) = self.resolve_inner(path_str, ns, module_id)?;
+ let chosen_fragment = match (user_fragment, rustdoc_fragment) {
+ (Some(_), Some(r_frag)) => {
+ let diag_res = match r_frag {
+ ItemFragment(_, did) => Res::Def(self.cx.tcx.def_kind(did), did),
+ };
+ let failure = AnchorFailure::RustdocAnchorConflict(diag_res);
+ return Err(ErrorKind::AnchorFailure(failure));
+ }
+ (Some(u_frag), None) => Some(UrlFragment::UserWritten(u_frag.clone())),
+ (None, Some(r_frag)) => Some(UrlFragment::Item(r_frag)),
+ (None, None) => None,
+ };
+ Ok((res, chosen_fragment))
+ }
+ fn resolve_inner<'path>(
+ &mut self,
+ path_str: &'path str,
+ ns: Namespace,
+ module_id: DefId,
+ ) -> Result<(Res, Option<ItemFragment>), ErrorKind<'path>> {
if let Some(res) = self.resolve_path(path_str, ns, module_id) {
match res {
// FIXME(#76467): make this fallthrough to lookup the associated
// item a separate function.
- Res::Def(DefKind::AssocFn | DefKind::AssocConst, _) => {
- assert_eq!(ns, ValueNS);
- }
- Res::Def(DefKind::AssocTy, _) => {
- assert_eq!(ns, TypeNS);
- }
+ Res::Def(DefKind::AssocFn | DefKind::AssocConst, _) => assert_eq!(ns, ValueNS),
+ Res::Def(DefKind::AssocTy, _) => assert_eq!(ns, TypeNS),
Res::Def(DefKind::Variant, _) => {
- return handle_variant(cx, res, extra_fragment);
+ return handle_variant(self.cx, res);
}
// Not a trait item; just return what we found.
- Res::PrimTy(ty) => {
- if extra_fragment.is_some() {
- return Err(ErrorKind::AnchorFailure(
- AnchorFailure::RustdocAnchorConflict(res),
- ));
- }
- return Ok((res, Some(ty.name_str().to_owned())));
- }
- Res::Def(DefKind::Mod, _) => {
- return Ok((res, extra_fragment.clone()));
- }
- _ => {
- return Ok((res, extra_fragment.clone()));
- }
+ _ => return Ok((res, None)),
}
}
// Try looking for methods and associated items.
let mut split = path_str.rsplitn(2, "::");
- // this can be an `unwrap()` because we ensure the link is never empty
- let (item_str, item_name) = split.next().map(|i| (i, Symbol::intern(i))).unwrap();
+ // NB: `split`'s first element is always defined, even if the delimiter was not present.
+ // NB: `item_str` could be empty when resolving in the root namespace (e.g. `::std`).
+ let item_str = split.next().unwrap();
+ let item_name = Symbol::intern(item_str);
let path_root = split
.next()
- .map(|f| {
- if f == "self" || f == "Self" {
- if let Some(name) = current_item.as_ref() {
- return name.clone();
- }
- }
- f.to_owned()
- })
+ .map(|f| f.to_owned())
// If there's no `::`, it's not an associated item.
// So we can be sure that `rustc_resolve` was accurate when it said it wasn't resolved.
.ok_or_else(|| {
}
})?;
- // FIXME: are these both necessary?
- let ty_res = if let Some(ty_res) = resolve_primitive(&path_root, TypeNS)
- .map(|(_, res)| res)
+ // FIXME(#83862): this arbitrarily gives precedence to primitives over modules to support
+ // links to primitives when `#[doc(primitive)]` is present. It should give an ambiguity
+ // error instead and special case *only* modules with `#[doc(primitive)]`, not all
+ // primitives.
+ resolve_primitive(&path_root, TypeNS)
.or_else(|| self.resolve_path(&path_root, TypeNS, module_id))
- {
- ty_res
- } else {
- // FIXME: this is duplicated on the end of this function.
- return if ns == Namespace::ValueNS {
- self.variant_field(path_str, current_item, module_id)
- } else {
- Err(ResolutionFailure::NotResolved {
- module_id,
- partial_res: None,
- unresolved: path_root.into(),
+ .and_then(|ty_res| {
+ let (res, fragment) =
+ self.resolve_associated_item(ty_res, item_name, ns, module_id)?;
+
+ Some(Ok((res, Some(fragment))))
+ })
+ .unwrap_or_else(|| {
+ if ns == Namespace::ValueNS {
+ self.variant_field(path_str, module_id)
+ } else {
+ Err(ResolutionFailure::NotResolved {
+ module_id,
+ partial_res: None,
+ unresolved: path_root.into(),
+ }
+ .into())
}
- .into())
- };
- };
+ })
+ }
- let res = match ty_res {
- Res::PrimTy(prim) => Some(
- self.resolve_primitive_associated_item(prim, ns, module_id, item_name, item_str),
- ),
- Res::Def(DefKind::Struct | DefKind::Union | DefKind::Enum | DefKind::TyAlias, did) => {
+ /// Convert a DefId to a Res, where possible.
+ ///
+ /// This is used for resolving type aliases.
+ fn def_id_to_res(&self, ty_id: DefId) -> Option<Res> {
+ use PrimitiveType::*;
+ Some(match *self.cx.tcx.type_of(ty_id).kind() {
+ ty::Bool => Res::Primitive(Bool),
+ ty::Char => Res::Primitive(Char),
+ ty::Int(ity) => Res::Primitive(ity.into()),
+ ty::Uint(uty) => Res::Primitive(uty.into()),
+ ty::Float(fty) => Res::Primitive(fty.into()),
+ ty::Str => Res::Primitive(Str),
+ ty::Tuple(tys) if tys.is_empty() => Res::Primitive(Unit),
+ ty::Tuple(_) => Res::Primitive(Tuple),
+ ty::Array(..) => Res::Primitive(Array),
+ ty::Slice(_) => Res::Primitive(Slice),
+ ty::RawPtr(_) => Res::Primitive(RawPointer),
+ ty::Ref(..) => Res::Primitive(Reference),
+ ty::FnDef(..) => panic!("type alias to a function definition"),
+ ty::FnPtr(_) => Res::Primitive(Fn),
+ ty::Never => Res::Primitive(Never),
+ ty::Adt(&ty::AdtDef { did, .. }, _) | ty::Foreign(did) => {
+ Res::Def(self.cx.tcx.def_kind(did), did)
+ }
+ ty::Projection(_)
+ | ty::Closure(..)
+ | ty::Generator(..)
+ | ty::GeneratorWitness(_)
+ | ty::Opaque(..)
+ | ty::Dynamic(..)
+ | ty::Param(_)
+ | ty::Bound(..)
+ | ty::Placeholder(_)
+ | ty::Infer(_)
+ | ty::Error(_) => return None,
+ })
+ }
+
+ /// Convert a PrimitiveType to a Ty, where possible.
+ ///
+ /// This is used for resolving trait impls for primitives
+ fn primitive_type_to_ty(&mut self, prim: PrimitiveType) -> Option<Ty<'tcx>> {
+ use PrimitiveType::*;
+ let tcx = self.cx.tcx;
+
+ // FIXME: Only simple types are supported here, see if we can support
+ // other types such as Tuple, Array, Slice, etc.
+ // See https://github.com/rust-lang/rust/issues/90703#issuecomment-1004263455
+ Some(tcx.mk_ty(match prim {
+ Bool => ty::Bool,
+ Str => ty::Str,
+ Char => ty::Char,
+ Never => ty::Never,
+ I8 => ty::Int(ty::IntTy::I8),
+ I16 => ty::Int(ty::IntTy::I16),
+ I32 => ty::Int(ty::IntTy::I32),
+ I64 => ty::Int(ty::IntTy::I64),
+ I128 => ty::Int(ty::IntTy::I128),
+ Isize => ty::Int(ty::IntTy::Isize),
+ F32 => ty::Float(ty::FloatTy::F32),
+ F64 => ty::Float(ty::FloatTy::F64),
+ U8 => ty::Uint(ty::UintTy::U8),
+ U16 => ty::Uint(ty::UintTy::U16),
+ U32 => ty::Uint(ty::UintTy::U32),
+ U64 => ty::Uint(ty::UintTy::U64),
+ U128 => ty::Uint(ty::UintTy::U128),
+ Usize => ty::Uint(ty::UintTy::Usize),
+ _ => return None,
+ }))
+ }
+
+ /// Resolve an associated item, returning its containing page's `Res`
+ /// and the fragment targeting the associated item on its page.
+ fn resolve_associated_item(
+ &mut self,
+ root_res: Res,
+ item_name: Symbol,
+ ns: Namespace,
+ module_id: DefId,
+ ) -> Option<(Res, ItemFragment)> {
+ let tcx = self.cx.tcx;
+
+ match root_res {
+ Res::Primitive(prim) => {
+ self.resolve_primitive_associated_item(prim, ns, item_name).or_else(|| {
+ let assoc_item = self
+ .primitive_type_to_ty(prim)
+ .map(|ty| {
+ resolve_associated_trait_item(ty, module_id, item_name, ns, self.cx)
+ })
+ .flatten();
+
+ assoc_item.map(|item| {
+ let fragment = ItemFragment::from_assoc_item(&item);
+ (root_res, fragment)
+ })
+ })
+ }
+ Res::Def(DefKind::TyAlias, did) => {
+ // Resolve the link on the type the alias points to.
+ // FIXME: if the associated item is defined directly on the type alias,
+ // it will show up on its documentation page, we should link there instead.
+ let res = self.def_id_to_res(did)?;
+ self.resolve_associated_item(res, item_name, ns, module_id)
+ }
+ Res::Def(
+ DefKind::Struct | DefKind::Union | DefKind::Enum | DefKind::ForeignTy,
+ did,
+ ) => {
debug!("looking for associated item named {} for item {:?}", item_name, did);
// Checks if item_name belongs to `impl SomeItem`
- let assoc_item = cx
- .tcx
+ let assoc_item = tcx
.inherent_impls(did)
.iter()
.flat_map(|&imp| {
- cx.tcx.associated_items(imp).find_by_name_and_namespace(
- cx.tcx,
+ tcx.associated_items(imp).find_by_name_and_namespace(
+ tcx,
Ident::with_dummy_span(item_name),
ns,
imp,
)
})
- .map(|item| (item.kind, item.def_id))
+ .copied()
// There should only ever be one associated item that matches from any inherent impl
.next()
// Check if item_name belongs to `impl SomeTrait for SomeItem`
// To handle that properly resolve() would have to support
// something like [`ambi_fn`](<SomeStruct as SomeTrait>::ambi_fn)
.or_else(|| {
- let kind =
- resolve_associated_trait_item(did, module_id, item_name, ns, &self.cx);
- debug!("got associated item kind {:?}", kind);
- kind
+ resolve_associated_trait_item(
+ tcx.type_of(did),
+ module_id,
+ item_name,
+ ns,
+ self.cx,
+ )
});
- if let Some((kind, id)) = assoc_item {
- let out = match kind {
- ty::AssocKind::Fn => "method",
- ty::AssocKind::Const => "associatedconstant",
- ty::AssocKind::Type => "associatedtype",
- };
- Some(if extra_fragment.is_some() {
- Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(ty_res)))
- } else {
- // HACK(jynelson): `clean` expects the type, not the associated item
- // but the disambiguator logic expects the associated item.
- // Store the kind in a side channel so that only the disambiguator logic looks at it.
- self.kind_side_channel.set(Some((kind.as_def_kind(), id)));
- Ok((ty_res, Some(format!("{}.{}", out, item_str))))
- })
- } else if ns == Namespace::ValueNS {
- debug!("looking for variants or fields named {} for {:?}", item_name, did);
- // FIXME(jynelson): why is this different from
- // `variant_field`?
- match cx.tcx.type_of(did).kind() {
- ty::Adt(def, _) => {
- let field = if def.is_enum() {
- def.all_fields().find(|item| item.ident.name == item_name)
- } else {
- def.non_enum_variant()
- .fields
- .iter()
- .find(|item| item.ident.name == item_name)
- };
- field.map(|item| {
- if extra_fragment.is_some() {
- let res = Res::Def(
- if def.is_enum() {
- DefKind::Variant
- } else {
- DefKind::Field
- },
- item.did,
- );
- Err(ErrorKind::AnchorFailure(
- AnchorFailure::RustdocAnchorConflict(res),
- ))
- } else {
- Ok((
- ty_res,
- Some(format!(
- "{}.{}",
- if def.is_enum() { "variant" } else { "structfield" },
- item.ident
- )),
- ))
- }
- })
- }
- _ => None,
- }
- } else {
- None
+ debug!("got associated item {:?}", assoc_item);
+
+ if let Some(item) = assoc_item {
+ let fragment = ItemFragment::from_assoc_item(&item);
+ return Some((root_res, fragment));
+ }
+
+ if ns != Namespace::ValueNS {
+ return None;
}
+ debug!("looking for fields named {} for {:?}", item_name, did);
+ // FIXME: this doesn't really belong in `associated_item` (maybe `variant_field` is better?)
+ // NOTE: it's different from variant_field because it only resolves struct fields,
+ // not variant fields (2 path segments, not 3).
+ //
+ // We need to handle struct (and union) fields in this code because
+ // syntactically their paths are identical to associated item paths:
+ // `module::Type::field` and `module::Type::Assoc`.
+ //
+ // On the other hand, variant fields can't be mistaken for associated
+ // items because they look like this: `module::Type::Variant::field`.
+ //
+ // Variants themselves don't need to be handled here, even though
+ // they also look like associated items (`module::Type::Variant`),
+ // because they are real Rust syntax (unlike the intra-doc links
+ // field syntax) and are handled by the compiler's resolver.
+ let def = match tcx.type_of(did).kind() {
+ ty::Adt(def, _) if !def.is_enum() => def,
+ _ => return None,
+ };
+ let field =
+ def.non_enum_variant().fields.iter().find(|item| item.name == item_name)?;
+ Some((root_res, ItemFragment(FragmentKind::StructField, field.did)))
}
- Res::Def(DefKind::Trait, did) => cx
- .tcx
+ Res::Def(DefKind::Trait, did) => tcx
.associated_items(did)
- .find_by_name_and_namespace(cx.tcx, Ident::with_dummy_span(item_name), ns, did)
+ .find_by_name_and_namespace(tcx, Ident::with_dummy_span(item_name), ns, did)
.map(|item| {
- let kind = match item.kind {
- ty::AssocKind::Const => "associatedconstant",
- ty::AssocKind::Type => "associatedtype",
- ty::AssocKind::Fn => {
- if item.defaultness.has_value() {
- "method"
- } else {
- "tymethod"
- }
- }
- };
-
- if extra_fragment.is_some() {
- Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(ty_res)))
- } else {
- let res = Res::Def(item.kind.as_def_kind(), item.def_id);
- Ok((res, Some(format!("{}.{}", kind, item_str))))
- }
+ let fragment = ItemFragment::from_assoc_item(item);
+ let res = Res::Def(item.kind.as_def_kind(), item.def_id);
+ (res, fragment)
}),
_ => None,
- };
- res.unwrap_or_else(|| {
- if ns == Namespace::ValueNS {
- self.variant_field(path_str, current_item, module_id)
- } else {
- Err(ResolutionFailure::NotResolved {
- module_id,
- partial_res: Some(ty_res),
- unresolved: item_str.into(),
- }
- .into())
- }
- })
+ }
}
/// Used for reporting better errors.
/// This returns the `Res` even if it was erroneous for some reason
/// (such as having invalid URL fragments or being in the wrong namespace).
fn check_full_res(
- &self,
+ &mut self,
ns: Namespace,
path_str: &str,
module_id: DefId,
- current_item: &Option<String>,
extra_fragment: &Option<String>,
) -> Option<Res> {
// resolve() can't be used for macro namespace
let result = match ns {
- Namespace::MacroNS => self.resolve_macro(path_str, module_id).map_err(ErrorKind::from),
- Namespace::TypeNS | Namespace::ValueNS => self
- .resolve(path_str, ns, current_item, module_id, extra_fragment)
- .map(|(res, _)| res),
+ Namespace::MacroNS => self
+ .resolve_macro(path_str, module_id)
+ .map(|res| (res, None))
+ .map_err(ErrorKind::from),
+ Namespace::TypeNS | Namespace::ValueNS => {
+ self.resolve(path_str, ns, module_id, extra_fragment)
+ }
};
let res = match result {
- Ok(res) => Some(res),
+ Ok((res, frag)) => {
+ if let Some(UrlFragment::Item(ItemFragment(_, id))) = frag {
+ Some(Res::Def(self.cx.tcx.def_kind(id), id))
+ } else {
+ Some(res)
+ }
+ }
Err(ErrorKind::Resolve(box kind)) => kind.full_res(),
Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(res))) => Some(res),
Err(ErrorKind::AnchorFailure(AnchorFailure::MultipleAnchors)) => None,
};
- self.kind_side_channel.take().map(|(kind, id)| Res::Def(kind, id)).or(res)
+ res
}
}
/// Given `[std::io::Error::source]`, where `source` is unresolved, this would
/// find `std::error::Error::source` and return
/// `<io::Error as error::Error>::source`.
-fn resolve_associated_trait_item(
- did: DefId,
+fn resolve_associated_trait_item<'a>(
+ ty: Ty<'a>,
module: DefId,
item_name: Symbol,
ns: Namespace,
- cx: &DocContext<'_>,
-) -> Option<(ty::AssocKind, DefId)> {
- let ty = cx.tcx.type_of(did);
- // First consider blanket impls: `impl From<T> for T`
- let implicit_impls = crate::clean::get_auto_trait_and_blanket_impls(cx, ty, did);
- let mut candidates: Vec<_> = implicit_impls
- .flat_map(|impl_outer| {
- match impl_outer.inner {
- clean::ImplItem(impl_) => {
- debug!("considering auto or blanket impl for trait {:?}", impl_.trait_);
- // Give precedence to methods that were overridden
- if !impl_.provided_trait_methods.contains(&*item_name.as_str()) {
- let mut items = impl_.items.into_iter().filter_map(|assoc| {
- if assoc.name.as_deref() != Some(&*item_name.as_str()) {
- return None;
- }
- let kind = assoc
- .inner
- .as_assoc_kind()
- .expect("inner items for a trait should be associated items");
- if kind.namespace() != ns {
- return None;
- }
-
- trace!("considering associated item {:?}", assoc.inner);
- // We have a slight issue: normal methods come from `clean` types,
- // but provided methods come directly from `tcx`.
- // Fortunately, we don't need the whole method, we just need to know
- // what kind of associated item it is.
- Some((kind, assoc.def_id))
- });
- let assoc = items.next();
- debug_assert_eq!(items.count(), 0);
- assoc
- } else {
- // These are provided methods or default types:
- // ```
- // trait T {
- // type A = usize;
- // fn has_default() -> A { 0 }
- // }
- // ```
- let trait_ = impl_.trait_.unwrap().def_id().unwrap();
- cx.tcx
- .associated_items(trait_)
- .find_by_name_and_namespace(
- cx.tcx,
- Ident::with_dummy_span(item_name),
- ns,
- trait_,
- )
- .map(|assoc| (assoc.kind, assoc.def_id))
- }
- }
- _ => panic!("get_impls returned something that wasn't an impl"),
- }
- })
- .collect();
+ cx: &mut DocContext<'a>,
+) -> Option<ty::AssocItem> {
+ // FIXME: this should also consider blanket impls (`impl<T> X for T`). Unfortunately
+ // `get_auto_trait_and_blanket_impls` is broken because the caching behavior is wrong. In the
+ // meantime, just don't look for these blanket impls.
// Next consider explicit impls: `impl MyTrait for MyType`
// Give precedence to inherent impls.
- if candidates.is_empty() {
- let traits = traits_implemented_by(cx, did, module);
- debug!("considering traits {:?}", traits);
- candidates.extend(traits.iter().filter_map(|&trait_| {
- cx.tcx
- .associated_items(trait_)
- .find_by_name_and_namespace(cx.tcx, Ident::with_dummy_span(item_name), ns, trait_)
- .map(|assoc| (assoc.kind, assoc.def_id))
- }));
- }
+ let traits = trait_impls_for(cx, ty, module);
+ debug!("considering traits {:?}", traits);
+ let mut candidates = traits.iter().filter_map(|&(impl_, trait_)| {
+ cx.tcx
+ .associated_items(trait_)
+ .find_by_name_and_namespace(cx.tcx, Ident::with_dummy_span(item_name), ns, trait_)
+ .map(|trait_assoc| {
+ trait_assoc_to_impl_assoc_item(cx.tcx, impl_, trait_assoc.def_id)
+ .unwrap_or(trait_assoc)
+ })
+ });
// FIXME(#74563): warn about ambiguity
- debug!("the candidates were {:?}", candidates);
- candidates.pop()
+ debug!("the candidates were {:?}", candidates.clone().collect::<Vec<_>>());
+ candidates.next().copied()
}
-/// Given a type, return all traits in scope in `module` implemented by that type.
+/// Find the associated item in the impl `impl_id` that corresponds to the
+/// trait associated item `trait_assoc_id`.
+///
+/// This function returns `None` if no associated item was found in the impl.
+/// This can occur when the trait associated item has a default value that is
+/// not overriden in the impl.
+///
+/// This is just a wrapper around [`TyCtxt::impl_item_implementor_ids()`] and
+/// [`TyCtxt::associated_item()`] (with some helpful logging added).
+#[instrument(level = "debug", skip(tcx))]
+fn trait_assoc_to_impl_assoc_item<'tcx>(
+ tcx: TyCtxt<'tcx>,
+ impl_id: DefId,
+ trait_assoc_id: DefId,
+) -> Option<&'tcx ty::AssocItem> {
+ let trait_to_impl_assoc_map = tcx.impl_item_implementor_ids(impl_id);
+ debug!(?trait_to_impl_assoc_map);
+ let impl_assoc_id = *trait_to_impl_assoc_map.get(&trait_assoc_id)?;
+ debug!(?impl_assoc_id);
+ let impl_assoc = tcx.associated_item(impl_assoc_id);
+ debug!(?impl_assoc);
+ Some(impl_assoc)
+}
+
+/// Given a type, return all trait impls in scope in `module` for that type.
+/// Returns a set of pairs of `(impl_id, trait_id)`.
///
/// NOTE: this cannot be a query because more traits could be available when more crates are compiled!
/// So it is not stable to serialize cross-crate.
-fn traits_implemented_by(cx: &DocContext<'_>, type_: DefId, module: DefId) -> FxHashSet<DefId> {
- let mut cache = cx.module_trait_cache.borrow_mut();
- let in_scope_traits = cache.entry(module).or_insert_with(|| {
- cx.enter_resolver(|resolver| {
- resolver.traits_in_scope(module).into_iter().map(|candidate| candidate.def_id).collect()
- })
- });
-
- let ty = cx.tcx.type_of(type_);
- let iter = in_scope_traits.iter().flat_map(|&trait_| {
+#[instrument(level = "debug", skip(cx))]
+fn trait_impls_for<'a>(
+ cx: &mut DocContext<'a>,
+ ty: Ty<'a>,
+ module: DefId,
+) -> FxHashSet<(DefId, DefId)> {
+ let tcx = cx.tcx;
+ let iter = cx.resolver_caches.traits_in_scope[&module].iter().flat_map(|trait_candidate| {
+ let trait_ = trait_candidate.def_id;
trace!("considering explicit impl for trait {:?}", trait_);
// Look at each trait implementation to see if it's an impl for `did`
- cx.tcx.find_map_relevant_impl(trait_, ty, |impl_| {
- let trait_ref = cx.tcx.impl_trait_ref(impl_).expect("this is not an inherent impl");
+ tcx.find_map_relevant_impl(trait_, ty, |impl_| {
+ let trait_ref = tcx.impl_trait_ref(impl_).expect("this is not an inherent impl");
// Check if these are the same type.
let impl_type = trait_ref.self_ty();
trace!(
"comparing type {} with kind {:?} against type {:?}",
impl_type,
impl_type.kind(),
- type_
+ ty
);
// Fast path: if this is a primitive simple `==` will work
+ // NOTE: the `match` is necessary; see #92662.
+ // this allows us to ignore generics because the user input
+ // may not include the generic placeholders
+ // e.g. this allows us to match Foo (user comment) with Foo<T> (actual type)
let saw_impl = impl_type == ty
- || match impl_type.kind() {
- // Check if these are the same def_id
- ty::Adt(def, _) => {
- debug!("adt def_id: {:?}", def.did);
- def.did == type_
+ || match (impl_type.kind(), ty.kind()) {
+ (ty::Adt(impl_def, _), ty::Adt(ty_def, _)) => {
+ debug!("impl def_id: {:?}, ty def_id: {:?}", impl_def.did, ty_def.did);
+ impl_def.did == ty_def.did
}
- ty::Foreign(def_id) => *def_id == type_,
_ => false,
};
- if saw_impl { Some(trait_) } else { None }
+ if saw_impl { Some((impl_, trait_)) } else { None }
})
});
iter.collect()
///
/// These are common and we should just resolve to the trait in that case.
fn is_derive_trait_collision<T>(ns: &PerNS<Result<(Res, T), ResolutionFailure<'_>>>) -> bool {
- matches!(*ns, PerNS {
- type_ns: Ok((Res::Def(DefKind::Trait, _), _)),
- macro_ns: Ok((Res::Def(DefKind::Macro(MacroKind::Derive), _), _)),
- ..
- })
+ matches!(
+ *ns,
+ PerNS {
+ type_ns: Ok((Res::Def(DefKind::Trait, _), _)),
+ macro_ns: Ok((Res::Def(DefKind::Macro(MacroKind::Derive), _), _)),
+ ..
+ }
+ )
}
-impl<'a, 'tcx> DocFolder for LinkCollector<'a, 'tcx> {
- fn fold_item(&mut self, mut item: Item) -> Option<Item> {
- use rustc_middle::ty::DefIdTree;
-
- let parent_node = if item.is_fake() {
- // FIXME: is this correct?
- None
- // If we're documenting the crate root itself, it has no parent. Use the root instead.
- } else if item.def_id.is_top_level_module() {
- Some(item.def_id)
- } else {
- let mut current = item.def_id;
- // The immediate parent might not always be a module.
- // Find the first parent which is.
- loop {
- if let Some(parent) = self.cx.tcx.parent(current) {
- if self.cx.tcx.def_kind(parent) == DefKind::Mod {
- break Some(parent);
- }
- current = parent;
- } else {
- debug!(
- "{:?} has no parent (kind={:?}, original was {:?})",
- current,
- self.cx.tcx.def_kind(current),
- item.def_id
- );
- break None;
- }
- }
- };
-
+impl<'a, 'tcx> DocVisitor for LinkCollector<'a, 'tcx> {
+ fn visit_item(&mut self, item: &Item) {
+ let parent_node =
+ item.def_id.as_def_id().and_then(|did| find_nearest_parent_module(self.cx.tcx, did));
if parent_node.is_some() {
trace!("got parent node for {:?} {:?}, id {:?}", item.type_(), item.name, item.def_id);
}
- let current_item = match item.inner {
- clean::ModuleItem(..) => {
- if item.attrs.inner_docs {
- if item.def_id.is_top_level_module() { item.name.clone() } else { None }
- } else {
- match parent_node.or(self.mod_ids.last().copied()) {
- Some(parent) if !parent.is_top_level_module() => {
- Some(self.cx.tcx.item_name(parent).to_string())
- }
- _ => None,
- }
- }
- }
- clean::ImplItem(clean::Impl { ref for_, .. }) => {
- for_.def_id().map(|did| self.cx.tcx.item_name(did).to_string())
- }
- // we don't display docs on `extern crate` items anyway, so don't process them.
- clean::ExternCrateItem(..) => {
- debug!("ignoring extern crate item {:?}", item.def_id);
- return self.fold_item_recur(item);
+ // find item's parent to resolve `Self` in item's docs below
+ debug!("looking for the `Self` type");
+ let self_id = match item.def_id.as_def_id() {
+ None => None,
+ Some(did)
+ if (matches!(self.cx.tcx.def_kind(did), DefKind::Field)
+ && matches!(
+ self.cx.tcx.def_kind(self.cx.tcx.parent(did).unwrap()),
+ DefKind::Variant
+ )) =>
+ {
+ self.cx.tcx.parent(did).and_then(|item_id| self.cx.tcx.parent(item_id))
}
- clean::ImportItem(Import { kind: clean::ImportKind::Simple(ref name, ..), .. }) => {
- Some(name.clone())
+ Some(did)
+ if matches!(
+ self.cx.tcx.def_kind(did),
+ DefKind::AssocConst
+ | DefKind::AssocFn
+ | DefKind::AssocTy
+ | DefKind::Variant
+ | DefKind::Field
+ ) =>
+ {
+ self.cx.tcx.parent(did)
}
- clean::MacroItem(..) => None,
- _ => item.name.clone(),
+ Some(did) => Some(did),
};
- if item.is_mod() && item.attrs.inner_docs {
- self.mod_ids.push(item.def_id);
- }
-
- // find item's parent to resolve `Self` in item's docs below
- // FIXME(#76467, #75809): this is a mess and doesn't handle cross-crate
- // re-exports
- let parent_name = self.cx.as_local_hir_id(item.def_id).and_then(|item_hir| {
- let parent_hir = self.cx.tcx.hir().get_parent_item(item_hir);
- let item_parent = self.cx.tcx.hir().find(parent_hir);
- match item_parent {
- Some(hir::Node::Item(hir::Item {
- kind:
- hir::ItemKind::Impl {
- self_ty:
- hir::Ty {
- kind:
- hir::TyKind::Path(hir::QPath::Resolved(
- _,
- hir::Path { segments, .. },
- )),
- ..
- },
- ..
- },
- ..
- })) => segments.first().map(|seg| seg.ident.to_string()),
- Some(hir::Node::Item(hir::Item {
- ident, kind: hir::ItemKind::Enum(..), ..
- }))
- | Some(hir::Node::Item(hir::Item {
- ident, kind: hir::ItemKind::Struct(..), ..
- }))
- | Some(hir::Node::Item(hir::Item {
- ident, kind: hir::ItemKind::Union(..), ..
- }))
- | Some(hir::Node::Item(hir::Item {
- ident, kind: hir::ItemKind::Trait(..), ..
- })) => Some(ident.to_string()),
- _ => None,
+ // FIXME(jynelson): this shouldn't go through stringification, rustdoc should just use the DefId directly
+ let self_name = self_id.and_then(|self_id| {
+ if matches!(self.cx.tcx.def_kind(self_id), DefKind::Impl) {
+ // using `ty.to_string()` (or any variant) has issues with raw idents
+ let ty = self.cx.tcx.type_of(self_id);
+ let name = match ty.kind() {
+ ty::Adt(def, _) => Some(self.cx.tcx.item_name(def.did).to_string()),
+ other if other.is_primitive() => Some(ty.to_string()),
+ _ => None,
+ };
+ debug!("using type_of(): {:?}", name);
+ name
+ } else {
+ let name = self.cx.tcx.opt_item_name(self_id).map(|sym| sym.to_string());
+ debug!("using item_name(): {:?}", name);
+ name
}
});
+ let inner_docs = item.inner_docs(self.cx.tcx);
+
+ if item.is_mod() && inner_docs {
+ self.mod_ids.push(item.def_id.expect_def_id());
+ }
+
// We want to resolve in the lexical scope of the documentation.
// In the presence of re-exports, this is not the same as the module of the item.
// Rather than merging all documentation into one, resolve it one attribute at a time
// so we know which module it came from.
- let mut attrs = item.attrs.doc_strings.iter().peekable();
- while let Some(attr) = attrs.next() {
- // `collapse_docs` does not have the behavior we want:
- // we want `///` and `#[doc]` to count as the same attribute,
- // but currently it will treat them as separate.
- // As a workaround, combine all attributes with the same parent module into the same attribute.
- let mut combined_docs = attr.doc.clone();
- loop {
- match attrs.peek() {
- Some(next) if next.parent_module == attr.parent_module => {
- combined_docs.push('\n');
- combined_docs.push_str(&attrs.next().unwrap().doc);
- }
- _ => break,
- }
- }
- debug!("combined_docs={}", combined_docs);
+ for (parent_module, doc) in item.attrs.collapsed_doc_value_by_module_level() {
+ debug!("combined_docs={}", doc);
- let (krate, parent_node) = if let Some(id) = attr.parent_module {
- trace!("docs {:?} came from {:?}", attr.doc, id);
+ let (krate, parent_node) = if let Some(id) = parent_module {
(id.krate, Some(id))
} else {
- trace!("no parent found for {:?}", attr.doc);
- (item.def_id.krate, parent_node)
+ (item.def_id.krate(), parent_node)
};
// NOTE: if there are links that start in one crate and end in another, this will not resolve them.
// This is a degenerate case and it's not supported by rustdoc.
- for (ori_link, link_range) in markdown_links(&combined_docs) {
- let link = self.resolve_link(
- &item,
- &combined_docs,
- ¤t_item,
- parent_node,
- &parent_name,
- krate,
- ori_link,
- link_range,
- );
+ for md_link in markdown_links(&doc) {
+ let link = self.resolve_link(&item, &doc, &self_name, parent_node, krate, md_link);
if let Some(link) = link {
- item.attrs.links.push(link);
+ self.cx.cache.intra_doc_links.entry(item.def_id).or_default().push(link);
}
}
}
if item.is_mod() {
- if !item.attrs.inner_docs {
- self.mod_ids.push(item.def_id);
+ if !inner_docs {
+ self.mod_ids.push(item.def_id.expect_def_id());
}
- let ret = self.fold_item_recur(item);
+ self.visit_item_recur(item);
self.mod_ids.pop();
- ret
} else {
- self.fold_item_recur(item)
+ self.visit_item_recur(item)
}
}
}
-impl LinkCollector<'_, '_> {
- /// This is the entry point for resolving an intra-doc link.
- ///
- /// FIXME(jynelson): this is way too many arguments
- fn resolve_link(
- &self,
- item: &Item,
- dox: &str,
- current_item: &Option<String>,
- parent_node: Option<DefId>,
- parent_name: &Option<String>,
- krate: CrateNum,
- ori_link: String,
- link_range: Option<Range<usize>>,
- ) -> Option<ItemLink> {
- trace!("considering link '{}'", ori_link);
+enum PreprocessingError<'a> {
+ Anchor(AnchorFailure),
+ Disambiguator(Range<usize>, String),
+ Resolution(ResolutionFailure<'a>, String, Option<Disambiguator>),
+}
- // Bail early for real links.
- if ori_link.contains('/') {
- return None;
- }
+impl From<AnchorFailure> for PreprocessingError<'_> {
+ fn from(err: AnchorFailure) -> Self {
+ Self::Anchor(err)
+ }
+}
- // [] is mostly likely not supposed to be a link
- if ori_link.is_empty() {
- return None;
- }
+struct PreprocessingInfo {
+ path_str: String,
+ disambiguator: Option<Disambiguator>,
+ extra_fragment: Option<String>,
+ link_text: String,
+}
- let cx = self.cx;
- let link = ori_link.replace("`", "");
- let parts = link.split('#').collect::<Vec<_>>();
- let (link, extra_fragment) = if parts.len() > 2 {
- anchor_failure(cx, &item, &link, dox, link_range, AnchorFailure::MultipleAnchors);
- return None;
- } else if parts.len() == 2 {
- if parts[0].trim().is_empty() {
- // This is an anchor to an element of the current page, nothing to do in here!
+/// Returns:
+/// - `None` if the link should be ignored.
+/// - `Some(Err)` if the link should emit an error
+/// - `Some(Ok)` if the link is valid
+///
+/// `link_buffer` is needed for lifetime reasons; it will always be overwritten and the contents ignored.
+fn preprocess_link<'a>(
+ ori_link: &'a MarkdownLink,
+) -> Option<Result<PreprocessingInfo, PreprocessingError<'a>>> {
+ // [] is mostly likely not supposed to be a link
+ if ori_link.link.is_empty() {
+ return None;
+ }
+
+ // Bail early for real links.
+ if ori_link.link.contains('/') {
+ return None;
+ }
+
+ let stripped = ori_link.link.replace('`', "");
+ let mut parts = stripped.split('#');
+
+ let link = parts.next().unwrap();
+ if link.trim().is_empty() {
+ // This is an anchor to an element of the current page, nothing to do in here!
+ return None;
+ }
+ let extra_fragment = parts.next();
+ if parts.next().is_some() {
+ // A valid link can't have multiple #'s
+ return Some(Err(AnchorFailure::MultipleAnchors.into()));
+ }
+
+ // Parse and strip the disambiguator from the link, if present.
+ let (disambiguator, path_str, link_text) = match Disambiguator::from_str(link) {
+ Ok(Some((d, path, link_text))) => (Some(d), path.trim(), link_text.trim()),
+ Ok(None) => (None, link.trim(), link.trim()),
+ Err((err_msg, relative_range)) => {
+ // Only report error if we would not have ignored this link. See issue #83859.
+ if !should_ignore_link_with_disambiguators(link) {
+ let no_backticks_range = range_between_backticks(ori_link);
+ let disambiguator_range = (no_backticks_range.start + relative_range.start)
+ ..(no_backticks_range.start + relative_range.end);
+ return Some(Err(PreprocessingError::Disambiguator(disambiguator_range, err_msg)));
+ } else {
return None;
}
- (parts[0], Some(parts[1].to_owned()))
- } else {
- (parts[0], None)
- };
+ }
+ };
+
+ if should_ignore_link(path_str) {
+ return None;
+ }
+
+ // Strip generics from the path.
+ let path_str = if path_str.contains(['<', '>'].as_slice()) {
+ match strip_generics_from_path(path_str) {
+ Ok(path) => path,
+ Err(err_kind) => {
+ debug!("link has malformed generics: {}", path_str);
+ return Some(Err(PreprocessingError::Resolution(
+ err_kind,
+ path_str.to_owned(),
+ disambiguator,
+ )));
+ }
+ }
+ } else {
+ path_str.to_owned()
+ };
+
+ // Sanity check to make sure we don't have any angle brackets after stripping generics.
+ assert!(!path_str.contains(['<', '>'].as_slice()));
+
+ // The link is not an intra-doc link if it still contains spaces after stripping generics.
+ if path_str.contains(' ') {
+ return None;
+ }
+
+ Some(Ok(PreprocessingInfo {
+ path_str,
+ disambiguator,
+ extra_fragment: extra_fragment.map(|frag| frag.to_owned()),
+ link_text: link_text.to_owned(),
+ }))
+}
+
+impl LinkCollector<'_, '_> {
+ /// This is the entry point for resolving an intra-doc link.
+ ///
+ /// FIXME(jynelson): this is way too many arguments
+ fn resolve_link(
+ &mut self,
+ item: &Item,
+ dox: &str,
+ self_name: &Option<String>,
+ parent_node: Option<DefId>,
+ krate: CrateNum,
+ ori_link: MarkdownLink,
+ ) -> Option<ItemLink> {
+ trace!("considering link '{}'", ori_link.link);
- // Parse and strip the disambiguator from the link, if present.
- let (mut path_str, disambiguator) = if let Ok((d, path)) = Disambiguator::from_str(&link) {
- (path.trim(), Some(d))
- } else {
- (link.trim(), None)
+ let diag_info = DiagnosticInfo {
+ item,
+ dox,
+ ori_link: &ori_link.link,
+ link_range: ori_link.range.clone(),
};
- if path_str.contains(|ch: char| !(ch.is_alphanumeric() || ":_<>, ".contains(ch))) {
- return None;
- }
+ let PreprocessingInfo { path_str, disambiguator, extra_fragment, link_text } =
+ match preprocess_link(&ori_link)? {
+ Ok(x) => x,
+ Err(err) => {
+ match err {
+ PreprocessingError::Anchor(err) => anchor_failure(self.cx, diag_info, err),
+ PreprocessingError::Disambiguator(range, msg) => {
+ disambiguator_error(self.cx, diag_info, range, &msg)
+ }
+ PreprocessingError::Resolution(err, path_str, disambiguator) => {
+ resolution_failure(
+ self,
+ diag_info,
+ &path_str,
+ disambiguator,
+ smallvec![err],
+ );
+ }
+ }
+ return None;
+ }
+ };
+ let mut path_str = &*path_str;
- // We stripped `()` and `!` when parsing the disambiguator.
- // Add them back to be displayed, but not prefix disambiguators.
- let link_text =
- disambiguator.map(|d| d.display_for(path_str)).unwrap_or_else(|| path_str.to_owned());
+ let inner_docs = item.inner_docs(self.cx.tcx);
- // In order to correctly resolve intra-doc-links we need to
+ // In order to correctly resolve intra-doc links we need to
// pick a base AST node to work from. If the documentation for
// this module came from an inner comment (//!) then we anchor
// our name resolution *inside* the module. If, on the other
// we've already pushed this node onto the resolution stack but
// for outer comments we explicitly try and resolve against the
// parent_node first.
- let base_node = if item.is_mod() && item.attrs.inner_docs {
- self.mod_ids.last().copied()
- } else {
- parent_node
- };
+ let base_node =
+ if item.is_mod() && inner_docs { self.mod_ids.last().copied() } else { parent_node };
- let mut module_id = if let Some(id) = base_node {
- id
- } else {
+ let Some(mut module_id) = base_node else {
// This is a bug.
debug!("attempting to resolve item without parent module: {}", path_str);
- let err_kind = ResolutionFailure::NoParentItem.into();
resolution_failure(
self,
- &item,
+ diag_info,
path_str,
disambiguator,
- dox,
- link_range,
- smallvec![err_kind],
+ smallvec![ResolutionFailure::NoParentItem],
);
return None;
};
let resolved_self;
// replace `Self` with suitable item's parent name
- if path_str.starts_with("Self::") {
- if let Some(ref name) = parent_name {
- resolved_self = format!("{}::{}", name, &path_str[6..]);
- path_str = &resolved_self;
+ let is_lone_self = path_str == "Self";
+ let is_lone_crate = path_str == "crate";
+ if path_str.starts_with("Self::") || is_lone_self {
+ if let Some(ref name) = self_name {
+ if is_lone_self {
+ path_str = name;
+ } else {
+ resolved_self = format!("{}::{}", name, &path_str[6..]);
+ path_str = &resolved_self;
+ }
}
- } else if path_str.starts_with("crate::") {
+ } else if path_str.starts_with("crate::") || is_lone_crate {
use rustc_span::def_id::CRATE_DEF_INDEX;
// HACK(jynelson): rustc_resolve thinks that `crate` is the crate currently being documented.
// HACK(jynelson)(2): If we just strip `crate::` then suddenly primitives become ambiguous
// (consider `crate::char`). Instead, change it to `self::`. This works because 'self' is now the crate root.
// FIXME(#78696): This doesn't always work.
- resolved_self = format!("self::{}", &path_str["crate::".len()..]);
- path_str = &resolved_self;
+ if is_lone_crate {
+ path_str = "self";
+ } else {
+ resolved_self = format!("self::{}", &path_str["crate::".len()..]);
+ path_str = &resolved_self;
+ }
module_id = DefId { krate, index: CRATE_DEF_INDEX };
}
- // Strip generics from the path.
- let stripped_path_string;
- if path_str.contains(['<', '>'].as_slice()) {
- stripped_path_string = match strip_generics_from_path(path_str) {
- Ok(path) => path,
- Err(err_kind) => {
- debug!("link has malformed generics: {}", path_str);
- resolution_failure(
- self,
- &item,
- path_str,
- disambiguator,
- dox,
- link_range,
- smallvec![err_kind],
- );
- return None;
- }
- };
- path_str = &stripped_path_string;
- }
- // Sanity check to make sure we don't have any angle brackets after stripping generics.
- assert!(!path_str.contains(['<', '>'].as_slice()));
-
- // The link is not an intra-doc link if it still contains commas or spaces after
- // stripping generics.
- if path_str.contains([',', ' '].as_slice()) {
- return None;
- }
-
- let (mut res, mut fragment) = self.resolve_with_disambiguator(
- disambiguator,
- item,
- dox,
- path_str,
- current_item,
- module_id,
- extra_fragment,
- &ori_link,
- link_range.clone(),
+ let (mut res, fragment) = self.resolve_with_disambiguator_cached(
+ ResolutionInfo {
+ module_id,
+ dis: disambiguator,
+ path_str: path_str.to_owned(),
+ extra_fragment,
+ },
+ diag_info.clone(), // this struct should really be Copy, but Range is not :(
+ matches!(ori_link.kind, LinkType::Reference | LinkType::Shortcut),
)?;
// Check for a primitive which might conflict with a module
if matches!(
disambiguator,
None | Some(Disambiguator::Namespace(Namespace::TypeNS) | Disambiguator::Primitive)
- ) && !matches!(res, Res::PrimTy(_))
+ ) && !matches!(res, Res::Primitive(_))
{
- if let Some((path, prim)) = resolve_primitive(path_str, TypeNS) {
+ if let Some(prim) = resolve_primitive(path_str, TypeNS) {
// `prim@char`
if matches!(disambiguator, Some(Disambiguator::Primitive)) {
- if fragment.is_some() {
- anchor_failure(
- cx,
- &item,
- path_str,
- dox,
- link_range,
- AnchorFailure::RustdocAnchorConflict(prim),
- );
- return None;
- }
res = prim;
- fragment = Some(path.as_str().to_string());
} else {
// `[char]` when a `char` module is in scope
let candidates = vec![res, prim];
- ambiguity_error(cx, &item, path_str, dox, link_range, candidates);
+ ambiguity_error(self.cx, diag_info, path_str, candidates);
return None;
}
}
}
- let report_mismatch = |specified: Disambiguator, resolved: Disambiguator| {
- // The resolved item did not match the disambiguator; give a better error than 'not found'
- let msg = format!("incompatible link kind for `{}`", path_str);
- let callback = |diag: &mut DiagnosticBuilder<'_>, sp| {
- let note = format!(
- "this link resolved to {} {}, which is not {} {}",
- resolved.article(),
- resolved.descr(),
- specified.article(),
- specified.descr()
- );
- diag.note(¬e);
- suggest_disambiguator(resolved, diag, path_str, dox, sp, &link_range);
- };
- report_diagnostic(cx, BROKEN_INTRA_DOC_LINKS, &msg, &item, dox, &link_range, callback);
- };
- if let Res::PrimTy(..) = res {
- match disambiguator {
- Some(Disambiguator::Primitive | Disambiguator::Namespace(_)) | None => {
- Some(ItemLink { link: ori_link, link_text, did: None, fragment })
- }
- Some(other) => {
- report_mismatch(other, Disambiguator::Primitive);
- None
+ match res {
+ Res::Primitive(prim) => {
+ if let Some(UrlFragment::Item(ItemFragment(_, id))) = fragment {
+ // We're actually resolving an associated item of a primitive, so we need to
+ // verify the disambiguator (if any) matches the type of the associated item.
+ // This case should really follow the same flow as the `Res::Def` branch below,
+ // but attempting to add a call to `clean::register_res` causes an ICE. @jyn514
+ // thinks `register_res` is only needed for cross-crate re-exports, but Rust
+ // doesn't allow statements like `use str::trim;`, making this a (hopefully)
+ // valid omission. See https://github.com/rust-lang/rust/pull/80660#discussion_r551585677
+ // for discussion on the matter.
+ let kind = self.cx.tcx.def_kind(id);
+ self.verify_disambiguator(
+ path_str,
+ &ori_link,
+ kind,
+ id,
+ disambiguator,
+ item,
+ &diag_info,
+ )?;
+
+ // FIXME: it would be nice to check that the feature gate was enabled in the original crate, not just ignore it altogether.
+ // However I'm not sure how to check that across crates.
+ if prim == PrimitiveType::RawPointer
+ && item.def_id.is_local()
+ && !self.cx.tcx.features().intra_doc_pointers
+ {
+ self.report_rawptr_assoc_feature_gate(dox, &ori_link, item);
+ }
+ } else {
+ match disambiguator {
+ Some(Disambiguator::Primitive | Disambiguator::Namespace(_)) | None => {}
+ Some(other) => {
+ self.report_disambiguator_mismatch(
+ path_str, &ori_link, other, res, &diag_info,
+ );
+ return None;
+ }
+ }
}
+
+ Some(ItemLink {
+ link: ori_link.link,
+ link_text,
+ did: res.def_id(self.cx.tcx),
+ fragment,
+ })
}
- } else {
- debug!("intra-doc link to {} resolved to {:?}", path_str, res);
-
- // Disallow e.g. linking to enums with `struct@`
- if let Res::Def(kind, _) = res {
- debug!("saw kind {:?} with disambiguator {:?}", kind, disambiguator);
- match (self.kind_side_channel.take().map(|(kind, _)| kind).unwrap_or(kind), disambiguator) {
- | (DefKind::Const | DefKind::ConstParam | DefKind::AssocConst | DefKind::AnonConst, Some(Disambiguator::Kind(DefKind::Const)))
- // NOTE: this allows 'method' to mean both normal functions and associated functions
- // This can't cause ambiguity because both are in the same namespace.
- | (DefKind::Fn | DefKind::AssocFn, Some(Disambiguator::Kind(DefKind::Fn)))
- // These are namespaces; allow anything in the namespace to match
- | (_, Some(Disambiguator::Namespace(_)))
- // If no disambiguator given, allow anything
- | (_, None)
- // All of these are valid, so do nothing
- => {}
- (actual, Some(Disambiguator::Kind(expected))) if actual == expected => {}
- (_, Some(specified @ Disambiguator::Kind(_) | specified @ Disambiguator::Primitive)) => {
- report_mismatch(specified, Disambiguator::Kind(kind));
- return None;
- }
+ Res::Def(kind, id) => {
+ let (kind_for_dis, id_for_dis) =
+ if let Some(UrlFragment::Item(ItemFragment(_, id))) = fragment {
+ (self.cx.tcx.def_kind(id), id)
+ } else {
+ (kind, id)
+ };
+ self.verify_disambiguator(
+ path_str,
+ &ori_link,
+ kind_for_dis,
+ id_for_dis,
+ disambiguator,
+ item,
+ &diag_info,
+ )?;
+ let id = clean::register_res(self.cx, rustc_hir::def::Res::Def(kind, id));
+ Some(ItemLink { link: ori_link.link, link_text, did: id, fragment })
+ }
+ }
+ }
+
+ fn verify_disambiguator(
+ &self,
+ path_str: &str,
+ ori_link: &MarkdownLink,
+ kind: DefKind,
+ id: DefId,
+ disambiguator: Option<Disambiguator>,
+ item: &Item,
+ diag_info: &DiagnosticInfo<'_>,
+ ) -> Option<()> {
+ debug!("intra-doc link to {} resolved to {:?}", path_str, (kind, id));
+
+ // Disallow e.g. linking to enums with `struct@`
+ debug!("saw kind {:?} with disambiguator {:?}", kind, disambiguator);
+ match (kind, disambiguator) {
+ | (DefKind::Const | DefKind::ConstParam | DefKind::AssocConst | DefKind::AnonConst, Some(Disambiguator::Kind(DefKind::Const)))
+ // NOTE: this allows 'method' to mean both normal functions and associated functions
+ // This can't cause ambiguity because both are in the same namespace.
+ | (DefKind::Fn | DefKind::AssocFn, Some(Disambiguator::Kind(DefKind::Fn)))
+ // These are namespaces; allow anything in the namespace to match
+ | (_, Some(Disambiguator::Namespace(_)))
+ // If no disambiguator given, allow anything
+ | (_, None)
+ // All of these are valid, so do nothing
+ => {}
+ (actual, Some(Disambiguator::Kind(expected))) if actual == expected => {}
+ (_, Some(specified @ Disambiguator::Kind(_) | specified @ Disambiguator::Primitive)) => {
+ self.report_disambiguator_mismatch(path_str,ori_link,specified, Res::Def(kind, id),diag_info);
+ return None;
}
}
- // item can be non-local e.g. when using #[doc(primitive = "pointer")]
- if let Some((src_id, dst_id)) = res
- .opt_def_id()
- .and_then(|def_id| def_id.as_local())
- .and_then(|dst_id| item.def_id.as_local().map(|src_id| (src_id, dst_id)))
+ // item can be non-local e.g. when using #[doc(primitive = "pointer")]
+ if let Some((src_id, dst_id)) = id
+ .as_local()
+ // The `expect_def_id()` should be okay because `local_def_id_to_hir_id`
+ // would presumably panic if a fake `DefIndex` were passed.
+ .and_then(|dst_id| {
+ item.def_id.expect_def_id().as_local().map(|src_id| (src_id, dst_id))
+ })
+ {
+ if self.cx.tcx.privacy_access_levels(()).is_exported(src_id)
+ && !self.cx.tcx.privacy_access_levels(()).is_exported(dst_id)
{
- use rustc_hir::def_id::LOCAL_CRATE;
+ privacy_error(self.cx, diag_info, path_str);
+ }
+ }
- let hir_src = self.cx.tcx.hir().local_def_id_to_hir_id(src_id);
- let hir_dst = self.cx.tcx.hir().local_def_id_to_hir_id(dst_id);
+ Some(())
+ }
- if self.cx.tcx.privacy_access_levels(LOCAL_CRATE).is_exported(hir_src)
- && !self.cx.tcx.privacy_access_levels(LOCAL_CRATE).is_exported(hir_dst)
- {
- privacy_error(cx, &item, &path_str, dox, link_range);
+ fn report_disambiguator_mismatch(
+ &self,
+ path_str: &str,
+ ori_link: &MarkdownLink,
+ specified: Disambiguator,
+ resolved: Res,
+ diag_info: &DiagnosticInfo<'_>,
+ ) {
+ // The resolved item did not match the disambiguator; give a better error than 'not found'
+ let msg = format!("incompatible link kind for `{}`", path_str);
+ let callback = |diag: &mut DiagnosticBuilder<'_>, sp: Option<rustc_span::Span>| {
+ let note = format!(
+ "this link resolved to {} {}, which is not {} {}",
+ resolved.article(),
+ resolved.descr(),
+ specified.article(),
+ specified.descr(),
+ );
+ if let Some(sp) = sp {
+ diag.span_label(sp, ¬e);
+ } else {
+ diag.note(¬e);
+ }
+ suggest_disambiguator(resolved, diag, path_str, &ori_link.link, sp);
+ };
+ report_diagnostic(self.cx.tcx, BROKEN_INTRA_DOC_LINKS, &msg, &diag_info, callback);
+ }
+
+ fn report_rawptr_assoc_feature_gate(&self, dox: &str, ori_link: &MarkdownLink, item: &Item) {
+ let span =
+ super::source_span_for_markdown_range(self.cx.tcx, dox, &ori_link.range, &item.attrs)
+ .unwrap_or_else(|| item.attr_span(self.cx.tcx));
+ rustc_session::parse::feature_err(
+ &self.cx.tcx.sess.parse_sess,
+ sym::intra_doc_pointers,
+ span,
+ "linking to associated items of raw pointers is experimental",
+ )
+ .note("rustdoc does not allow disambiguating between `*const` and `*mut`, and pointers are unstable until it does")
+ .emit();
+ }
+
+ fn resolve_with_disambiguator_cached(
+ &mut self,
+ key: ResolutionInfo,
+ diag: DiagnosticInfo<'_>,
+ cache_resolution_failure: bool,
+ ) -> Option<(Res, Option<UrlFragment>)> {
+ if let Some(ref cached) = self.visited_links.get(&key) {
+ match cached {
+ Some(cached) => {
+ return Some(cached.res.clone());
+ }
+ None if cache_resolution_failure => return None,
+ None => {
+ // Although we hit the cache and found a resolution error, this link isn't
+ // supposed to cache those. Run link resolution again to emit the expected
+ // resolution error.
}
}
- let id = clean::register_res(cx, res);
- Some(ItemLink { link: ori_link, link_text, did: Some(id), fragment })
+ }
+
+ let res = self.resolve_with_disambiguator(&key, diag);
+
+ // Cache only if resolved successfully - don't silence duplicate errors
+ if let Some(res) = res {
+ // Store result for the actual namespace
+ self.visited_links.insert(key, Some(CachedLink { res: res.clone() }));
+
+ Some(res)
+ } else {
+ if cache_resolution_failure {
+ // For reference-style links we only want to report one resolution error
+ // so let's cache them as well.
+ self.visited_links.insert(key, None);
+ }
+
+ None
}
}
/// After parsing the disambiguator, resolve the main part of the link.
// FIXME(jynelson): wow this is just so much
fn resolve_with_disambiguator(
- &self,
- disambiguator: Option<Disambiguator>,
- item: &Item,
- dox: &str,
- path_str: &str,
- current_item: &Option<String>,
- base_node: DefId,
- extra_fragment: Option<String>,
- ori_link: &str,
- link_range: Option<Range<usize>>,
- ) -> Option<(Res, Option<String>)> {
+ &mut self,
+ key: &ResolutionInfo,
+ diag: DiagnosticInfo<'_>,
+ ) -> Option<(Res, Option<UrlFragment>)> {
+ let disambiguator = key.dis;
+ let path_str = &key.path_str;
+ let base_node = key.module_id;
+ let extra_fragment = &key.extra_fragment;
+
match disambiguator.map(Disambiguator::ns) {
- Some(ns @ (ValueNS | TypeNS)) => {
- match self.resolve(path_str, ns, ¤t_item, base_node, &extra_fragment) {
+ Some(expected_ns @ (ValueNS | TypeNS)) => {
+ match self.resolve(path_str, expected_ns, base_node, extra_fragment) {
Ok(res) => Some(res),
Err(ErrorKind::Resolve(box mut kind)) => {
// We only looked in one namespace. Try to give a better error if possible.
if kind.full_res().is_none() {
- let other_ns = if ns == ValueNS { TypeNS } else { ValueNS };
+ let other_ns = if expected_ns == ValueNS { TypeNS } else { ValueNS };
// FIXME: really it should be `resolution_failure` that does this, not `resolve_with_disambiguator`
// See https://github.com/rust-lang/rust/pull/76955#discussion_r493953382 for a good approach
- for &new_ns in &[other_ns, MacroNS] {
- if let Some(res) = self.check_full_res(
- new_ns,
- path_str,
- base_node,
- ¤t_item,
- &extra_fragment,
- ) {
- kind = ResolutionFailure::WrongNamespace(res, ns);
+ for new_ns in [other_ns, MacroNS] {
+ if let Some(res) =
+ self.check_full_res(new_ns, path_str, base_node, extra_fragment)
+ {
+ kind = ResolutionFailure::WrongNamespace { res, expected_ns };
break;
}
}
}
- resolution_failure(
- self,
- &item,
- path_str,
- disambiguator,
- dox,
- link_range,
- smallvec![kind],
- );
+ resolution_failure(self, diag, path_str, disambiguator, smallvec![kind]);
// This could just be a normal link or a broken link
// we could potentially check if something is
// "intra-doc-link-like" and warn in that case.
- return None;
+ None
}
Err(ErrorKind::AnchorFailure(msg)) => {
- anchor_failure(self.cx, &item, &ori_link, dox, link_range, msg);
- return None;
+ anchor_failure(self.cx, diag, msg);
+ None
}
}
}
let mut candidates = PerNS {
macro_ns: self
.resolve_macro(path_str, base_node)
- .map(|res| (res, extra_fragment.clone())),
- type_ns: match self.resolve(
- path_str,
- TypeNS,
- ¤t_item,
- base_node,
- &extra_fragment,
- ) {
+ .map(|res| (res, extra_fragment.clone().map(UrlFragment::UserWritten))),
+ type_ns: match self.resolve(path_str, TypeNS, base_node, extra_fragment) {
Ok(res) => {
debug!("got res in TypeNS: {:?}", res);
Ok(res)
}
Err(ErrorKind::AnchorFailure(msg)) => {
- anchor_failure(self.cx, &item, ori_link, dox, link_range, msg);
+ anchor_failure(self.cx, diag, msg);
return None;
}
Err(ErrorKind::Resolve(box kind)) => Err(kind),
},
- value_ns: match self.resolve(
- path_str,
- ValueNS,
- ¤t_item,
- base_node,
- &extra_fragment,
- ) {
+ value_ns: match self.resolve(path_str, ValueNS, base_node, extra_fragment) {
Ok(res) => Ok(res),
Err(ErrorKind::AnchorFailure(msg)) => {
- anchor_failure(self.cx, &item, ori_link, dox, link_range, msg);
+ anchor_failure(self.cx, diag, msg);
return None;
}
Err(ErrorKind::Resolve(box kind)) => Err(kind),
.and_then(|(res, fragment)| {
// Constructors are picked up in the type namespace.
match res {
- Res::Def(DefKind::Ctor(..), _) | Res::SelfCtor(..) => {
- Err(ResolutionFailure::WrongNamespace(res, TypeNS))
+ Res::Def(DefKind::Ctor(..), _) => {
+ Err(ResolutionFailure::WrongNamespace { res, expected_ns: TypeNS })
}
- _ => match (fragment, extra_fragment) {
- (Some(fragment), Some(_)) => {
- // Shouldn't happen but who knows?
- Ok((res, Some(fragment)))
+ _ => {
+ match (fragment, extra_fragment.clone()) {
+ (Some(fragment), Some(_)) => {
+ // Shouldn't happen but who knows?
+ Ok((res, Some(fragment)))
+ }
+ (fragment, None) => Ok((res, fragment)),
+ (None, fragment) => {
+ Ok((res, fragment.map(UrlFragment::UserWritten)))
+ }
}
- (fragment, None) | (None, fragment) => Ok((res, fragment)),
- },
+ }
}
}),
};
if len == 0 {
resolution_failure(
self,
- &item,
+ diag,
path_str,
disambiguator,
- dox,
- link_range,
candidates.into_iter().filter_map(|res| res.err()).collect(),
);
// this could just be a normal link
}
if len == 1 {
- Some(candidates.into_iter().filter_map(|res| res.ok()).next().unwrap())
+ Some(candidates.into_iter().find_map(|res| res.ok()).unwrap())
} else if len == 2 && is_derive_trait_collision(&candidates) {
Some(candidates.type_ns.unwrap())
} else {
}
// If we're reporting an ambiguity, don't mention the namespaces that failed
let candidates = candidates.map(|candidate| candidate.ok().map(|(res, _)| res));
- ambiguity_error(
- self.cx,
- &item,
- path_str,
- dox,
- link_range,
- candidates.present_items().collect(),
- );
- return None;
+ ambiguity_error(self.cx, diag, path_str, candidates.present_items().collect());
+ None
}
}
Some(MacroNS) => {
match self.resolve_macro(path_str, base_node) {
- Ok(res) => Some((res, extra_fragment)),
+ Ok(res) => Some((res, extra_fragment.clone().map(UrlFragment::UserWritten))),
Err(mut kind) => {
// `resolve_macro` only looks in the macro namespace. Try to give a better error if possible.
- for &ns in &[TypeNS, ValueNS] {
- if let Some(res) = self.check_full_res(
- ns,
- path_str,
- base_node,
- ¤t_item,
- &extra_fragment,
- ) {
- kind = ResolutionFailure::WrongNamespace(res, MacroNS);
+ for ns in [TypeNS, ValueNS] {
+ if let Some(res) =
+ self.check_full_res(ns, path_str, base_node, extra_fragment)
+ {
+ kind =
+ ResolutionFailure::WrongNamespace { res, expected_ns: MacroNS };
break;
}
}
- resolution_failure(
- self,
- &item,
- path_str,
- disambiguator,
- dox,
- link_range,
- smallvec![kind],
- );
- return None;
+ resolution_failure(self, diag, path_str, disambiguator, smallvec![kind]);
+ None
}
}
}
}
}
-#[derive(Copy, Clone, Debug, PartialEq, Eq)]
+/// Get the section of a link between the backticks,
+/// or the whole link if there aren't any backticks.
+///
+/// For example:
+///
+/// ```text
+/// [`Foo`]
+/// ^^^
+/// ```
+fn range_between_backticks(ori_link: &MarkdownLink) -> Range<usize> {
+ let after_first_backtick_group = ori_link.link.bytes().position(|b| b != b'`').unwrap_or(0);
+ let before_second_backtick_group = ori_link
+ .link
+ .bytes()
+ .skip(after_first_backtick_group)
+ .position(|b| b == b'`')
+ .unwrap_or(ori_link.link.len());
+ (ori_link.range.start + after_first_backtick_group)
+ ..(ori_link.range.start + before_second_backtick_group)
+}
+
+/// Returns true if we should ignore `link` due to it being unlikely
+/// that it is an intra-doc link. `link` should still have disambiguators
+/// if there were any.
+///
+/// The difference between this and [`should_ignore_link()`] is that this
+/// check should only be used on links that still have disambiguators.
+fn should_ignore_link_with_disambiguators(link: &str) -> bool {
+ link.contains(|ch: char| !(ch.is_alphanumeric() || ":_<>, !*&;@()".contains(ch)))
+}
+
+/// Returns true if we should ignore `path_str` due to it being unlikely
+/// that it is an intra-doc link.
+fn should_ignore_link(path_str: &str) -> bool {
+ path_str.contains(|ch: char| !(ch.is_alphanumeric() || ":_<>, !*&;".contains(ch)))
+}
+
+#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
/// Disambiguators for a link.
enum Disambiguator {
/// `prim@`
}
impl Disambiguator {
- /// The text that should be displayed when the path is rendered as HTML.
+ /// Given a link, parse and return `(disambiguator, path_str, link_text)`.
///
- /// NOTE: `path` is not the original link given by the user, but a name suitable for passing to `resolve`.
- fn display_for(&self, path: &str) -> String {
- match self {
- // FIXME: this will have different output if the user had `m!()` originally.
- Self::Kind(DefKind::Macro(MacroKind::Bang)) => format!("{}!", path),
- Self::Kind(DefKind::Fn) => format!("{}()", path),
- _ => path.to_owned(),
- }
- }
-
- /// Given a link, parse and return `(disambiguator, path_str)`
- fn from_str(link: &str) -> Result<(Self, &str), ()> {
+ /// This returns `Ok(Some(...))` if a disambiguator was found,
+ /// `Ok(None)` if no disambiguator was found, or `Err(...)`
+ /// if there was a problem with the disambiguator.
+ fn from_str(link: &str) -> Result<Option<(Self, &str, &str)>, (String, Range<usize>)> {
use Disambiguator::{Kind, Namespace as NS, Primitive};
- let find_suffix = || {
- let suffixes = [
- ("!()", DefKind::Macro(MacroKind::Bang)),
- ("()", DefKind::Fn),
- ("!", DefKind::Macro(MacroKind::Bang)),
- ];
- for &(suffix, kind) in &suffixes {
- if link.ends_with(suffix) {
- return Ok((Kind(kind), link.trim_end_matches(suffix)));
- }
- }
- Err(())
- };
-
if let Some(idx) = link.find('@') {
let (prefix, rest) = link.split_at(idx);
let d = match prefix {
"value" => NS(Namespace::ValueNS),
"macro" => NS(Namespace::MacroNS),
"prim" | "primitive" => Primitive,
- _ => return find_suffix(),
+ _ => return Err((format!("unknown disambiguator `{}`", prefix), 0..idx)),
};
- Ok((d, &rest[1..]))
+ Ok(Some((d, &rest[1..], &rest[1..])))
} else {
- find_suffix()
- }
- }
-
- /// WARNING: panics on `Res::Err`
- fn from_res(res: Res) -> Self {
- match res {
- Res::Def(kind, _) => Disambiguator::Kind(kind),
- Res::PrimTy(_) => Disambiguator::Primitive,
- _ => Disambiguator::Namespace(res.ns().expect("can't call `from_res` on Res::err")),
- }
- }
-
- /// Used for error reporting.
- fn suggestion(self) -> Suggestion {
- let kind = match self {
- Disambiguator::Primitive => return Suggestion::Prefix("prim"),
- Disambiguator::Kind(kind) => kind,
- Disambiguator::Namespace(_) => panic!("display_for cannot be used on namespaces"),
- };
- if kind == DefKind::Macro(MacroKind::Bang) {
- return Suggestion::Macro;
- } else if kind == DefKind::Fn || kind == DefKind::AssocFn {
- return Suggestion::Function;
- }
-
- let prefix = match kind {
- DefKind::Struct => "struct",
- DefKind::Enum => "enum",
- DefKind::Trait => "trait",
- DefKind::Union => "union",
- DefKind::Mod => "mod",
- DefKind::Const | DefKind::ConstParam | DefKind::AssocConst | DefKind::AnonConst => {
- "const"
+ let suffixes = [
+ ("!()", DefKind::Macro(MacroKind::Bang)),
+ ("!{}", DefKind::Macro(MacroKind::Bang)),
+ ("![]", DefKind::Macro(MacroKind::Bang)),
+ ("()", DefKind::Fn),
+ ("!", DefKind::Macro(MacroKind::Bang)),
+ ];
+ for (suffix, kind) in suffixes {
+ if let Some(path_str) = link.strip_suffix(suffix) {
+ // Avoid turning `!` or `()` into an empty string
+ if !path_str.is_empty() {
+ return Ok(Some((Kind(kind), path_str, link)));
+ }
+ }
}
- DefKind::Static => "static",
- DefKind::Macro(MacroKind::Derive) => "derive",
- // Now handle things that don't have a specific disambiguator
- _ => match kind
- .ns()
- .expect("tried to calculate a disambiguator for a def without a namespace?")
- {
- Namespace::TypeNS => "type",
- Namespace::ValueNS => "value",
- Namespace::MacroNS => "macro",
- },
- };
-
- Suggestion::Prefix(prefix)
+ Ok(None)
+ }
}
fn ns(self) -> Namespace {
fn descr(self) -> &'static str {
match self {
Self::Namespace(n) => n.descr(),
- // HACK(jynelson): by looking at the source I saw the DefId we pass
- // for `expected.descr()` doesn't matter, since it's not a crate
- Self::Kind(k) => k.descr(DefId::local(hir::def_id::DefIndex::from_usize(0))),
+ // HACK(jynelson): the source of `DefKind::descr` only uses the DefId for
+ // printing "module" vs "crate" so using the wrong ID is not a huge problem
+ Self::Kind(k) => k.descr(CRATE_DEF_ID.to_def_id()),
Self::Primitive => "builtin type",
}
}
Function,
/// `m!`
Macro,
+ /// `foo` without any disambiguator
+ RemoveDisambiguator,
}
impl Suggestion {
Self::Prefix(x) => format!("prefix with `{}@`", x).into(),
Self::Function => "add parentheses".into(),
Self::Macro => "add an exclamation mark".into(),
+ Self::RemoveDisambiguator => "remove the disambiguator".into(),
}
}
Self::Prefix(prefix) => format!("{}@{}", prefix, path_str),
Self::Function => format!("{}()", path_str),
Self::Macro => format!("{}!", path_str),
+ Self::RemoveDisambiguator => path_str.into(),
+ }
+ }
+
+ fn as_help_span(
+ &self,
+ path_str: &str,
+ ori_link: &str,
+ sp: rustc_span::Span,
+ ) -> Vec<(rustc_span::Span, String)> {
+ let inner_sp = match ori_link.find('(') {
+ Some(index) => sp.with_hi(sp.lo() + BytePos(index as _)),
+ None => sp,
+ };
+ let inner_sp = match ori_link.find('!') {
+ Some(index) => inner_sp.with_hi(inner_sp.lo() + BytePos(index as _)),
+ None => inner_sp,
+ };
+ let inner_sp = match ori_link.find('@') {
+ Some(index) => inner_sp.with_lo(inner_sp.lo() + BytePos(index as u32 + 1)),
+ None => inner_sp,
+ };
+ match self {
+ Self::Prefix(prefix) => {
+ // FIXME: if this is an implied shortcut link, it's bad style to suggest `@`
+ let mut sugg = vec![(sp.with_hi(inner_sp.lo()), format!("{}@", prefix))];
+ if sp.hi() != inner_sp.hi() {
+ sugg.push((inner_sp.shrink_to_hi().with_hi(sp.hi()), String::new()));
+ }
+ sugg
+ }
+ Self::Function => {
+ let mut sugg = vec![(inner_sp.shrink_to_hi().with_hi(sp.hi()), "()".to_string())];
+ if sp.lo() != inner_sp.lo() {
+ sugg.push((inner_sp.shrink_to_lo().with_lo(sp.lo()), String::new()));
+ }
+ sugg
+ }
+ Self::Macro => {
+ let mut sugg = vec![(inner_sp.shrink_to_hi(), "!".to_string())];
+ if sp.lo() != inner_sp.lo() {
+ sugg.push((inner_sp.shrink_to_lo().with_lo(sp.lo()), String::new()));
+ }
+ sugg
+ }
+ Self::RemoveDisambiguator => vec![(sp, path_str.into())],
}
}
}
/// parameter of the callback will contain it, and the primary span of the diagnostic will be set
/// to it.
fn report_diagnostic(
- cx: &DocContext<'_>,
+ tcx: TyCtxt<'_>,
lint: &'static Lint,
msg: &str,
- item: &Item,
- dox: &str,
- link_range: &Option<Range<usize>>,
+ DiagnosticInfo { item, ori_link: _, dox, link_range }: &DiagnosticInfo<'_>,
decorate: impl FnOnce(&mut DiagnosticBuilder<'_>, Option<rustc_span::Span>),
) {
- let hir_id = match cx.as_local_hir_id(item.def_id) {
+ let hir_id = match DocContext::as_local_hir_id(tcx, item.def_id) {
Some(hir_id) => hir_id,
None => {
// If non-local, no need to check anything.
}
};
- let attrs = &item.attrs;
- let sp = span_of_attrs(attrs).unwrap_or(item.source.span());
+ let sp = item.attr_span(tcx);
- cx.tcx.struct_span_lint_hir(lint, hir_id, sp, |lint| {
+ tcx.struct_span_lint_hir(lint, hir_id, sp, |lint| {
let mut diag = lint.build(msg);
- let span = link_range
- .as_ref()
- .and_then(|range| super::source_span_for_markdown_range(cx, dox, range, attrs));
+ let span =
+ super::source_span_for_markdown_range(tcx, dox, link_range, &item.attrs).map(|sp| {
+ if dox.as_bytes().get(link_range.start) == Some(&b'`')
+ && dox.as_bytes().get(link_range.end - 1) == Some(&b'`')
+ {
+ sp.with_lo(sp.lo() + BytePos(1)).with_hi(sp.hi() - BytePos(1))
+ } else {
+ sp
+ }
+ });
- if let Some(link_range) = link_range {
- if let Some(sp) = span {
- diag.set_span(sp);
- } else {
- // blah blah blah\nblah\nblah [blah] blah blah\nblah blah
- // ^ ~~~~
- // | link_range
- // last_new_line_offset
- let last_new_line_offset = dox[..link_range.start].rfind('\n').map_or(0, |n| n + 1);
- let line = dox[last_new_line_offset..].lines().next().unwrap_or("");
-
- // Print the line containing the `link_range` and manually mark it with '^'s.
- diag.note(&format!(
- "the link appears in this line:\n\n{line}\n\
+ if let Some(sp) = span {
+ diag.set_span(sp);
+ } else {
+ // blah blah blah\nblah\nblah [blah] blah blah\nblah blah
+ // ^ ~~~~
+ // | link_range
+ // last_new_line_offset
+ let last_new_line_offset = dox[..link_range.start].rfind('\n').map_or(0, |n| n + 1);
+ let line = dox[last_new_line_offset..].lines().next().unwrap_or("");
+
+ // Print the line containing the `link_range` and manually mark it with '^'s.
+ diag.note(&format!(
+ "the link appears in this line:\n\n{line}\n\
{indicator: <before$}{indicator:^<found$}",
- line = line,
- indicator = "",
- before = link_range.start - last_new_line_offset,
- found = link_range.len(),
- ));
- }
+ line = line,
+ indicator = "",
+ before = link_range.start - last_new_line_offset,
+ found = link_range.len(),
+ ));
}
decorate(&mut diag, span);
/// handled earlier. For example, if passed `Item::Crate(std)` and `path_str`
/// `std::io::Error::x`, this will resolve `std::io::Error`.
fn resolution_failure(
- collector: &LinkCollector<'_, '_>,
- item: &Item,
+ collector: &mut LinkCollector<'_, '_>,
+ diag_info: DiagnosticInfo<'_>,
path_str: &str,
disambiguator: Option<Disambiguator>,
- dox: &str,
- link_range: Option<Range<usize>>,
kinds: SmallVec<[ResolutionFailure<'_>; 3]>,
) {
+ let tcx = collector.cx.tcx;
report_diagnostic(
- collector.cx,
+ tcx,
BROKEN_INTRA_DOC_LINKS,
&format!("unresolved link to `{}`", path_str),
- item,
- dox,
- &link_range,
+ &diag_info,
|diag, sp| {
- let item = |res: Res| {
- format!(
- "the {} `{}`",
- res.descr(),
- collector.cx.tcx.item_name(res.def_id()).to_string()
- )
- };
+ let item = |res: Res| format!("the {} `{}`", res.descr(), res.name(tcx),);
let assoc_item_not_allowed = |res: Res| {
- let def_id = res.def_id();
- let name = collector.cx.tcx.item_name(def_id);
+ let name = res.name(tcx);
format!(
"`{}` is {} {}, not a module or type, and cannot have associated items",
name,
// If so, report it and say the first which failed; if not, say the first path segment didn't resolve.
let mut name = path_str;
'outer: loop {
- let (start, end) = if let Some(x) = split(name) {
- x
- } else {
+ let Some((start, end)) = split(name) else {
// avoid bug that marked [Quux::Z] as missing Z, not Quux
if partial_res.is_none() {
*unresolved = name.into();
break;
};
name = start;
- for &ns in &[TypeNS, ValueNS, MacroNS] {
- if let Some(res) =
- collector.check_full_res(ns, &start, module_id, &None, &None)
+ for ns in [TypeNS, ValueNS, MacroNS] {
+ if let Some(res) = collector.check_full_res(ns, start, module_id, &None)
{
debug!("found partial_res={:?}", res);
*partial_res = Some(res);
if let Some(module) = last_found_module {
let note = if partial_res.is_some() {
// Part of the link resolved; e.g. `std::io::nonexistent`
- let module_name = collector.cx.tcx.item_name(module);
+ let module_name = tcx.item_name(module);
format!("no item named `{}` in module `{}`", unresolved, module_name)
} else {
// None of the link resolved; e.g. `Notimported`
// Otherwise, it must be an associated item or variant
let res = partial_res.expect("None case was handled by `last_found_module`");
- let diagnostic_name;
- let (kind, name) = match res {
- Res::Def(kind, def_id) => {
- diagnostic_name = collector.cx.tcx.item_name(def_id).as_str();
- (Some(kind), &*diagnostic_name)
- }
- Res::PrimTy(ty) => (None, ty.name_str()),
- _ => unreachable!("only ADTs and primitives are in scope at module level"),
+ let name = res.name(tcx);
+ let kind = match res {
+ Res::Def(kind, _) => Some(kind),
+ Res::Primitive(_) => None,
};
let path_description = if let Some(kind) = kind {
match kind {
| Use
| LifetimeParam
| Ctor(_, _)
- | AnonConst => {
+ | AnonConst
+ | InlineConst => {
let note = assoc_item_not_allowed(res);
if let Some(span) = sp {
diag.span_label(span, ¬e);
let note = match failure {
ResolutionFailure::NotResolved { .. } => unreachable!("handled above"),
ResolutionFailure::Dummy => continue,
- ResolutionFailure::WrongNamespace(res, expected_ns) => {
- if let Res::Def(kind, _) = res {
- let disambiguator = Disambiguator::Kind(kind);
- suggest_disambiguator(
- disambiguator,
- diag,
- path_str,
- dox,
- sp,
- &link_range,
- )
- }
+ ResolutionFailure::WrongNamespace { res, expected_ns } => {
+ suggest_disambiguator(res, diag, path_str, diag_info.ori_link, sp);
format!(
"this link resolves to {}, which is not in the {} namespace",
}
ResolutionFailure::NoParentItem => {
diag.level = rustc_errors::Level::Bug;
- "all intra doc links should have a parent item".to_owned()
+ "all intra-doc links should have a parent item".to_owned()
}
ResolutionFailure::MalformedGenerics(variant) => match variant {
MalformedGenerics::UnbalancedAngleBrackets => {
}
/// Report an anchor failure.
-fn anchor_failure(
- cx: &DocContext<'_>,
- item: &Item,
- path_str: &str,
- dox: &str,
- link_range: Option<Range<usize>>,
- failure: AnchorFailure,
-) {
- let msg = match failure {
- AnchorFailure::MultipleAnchors => format!("`{}` contains multiple anchors", path_str),
- AnchorFailure::RustdocAnchorConflict(res) => format!(
- "`{}` contains an anchor, but links to {kind}s are already anchored",
- path_str,
- kind = res.descr(),
+fn anchor_failure(cx: &DocContext<'_>, diag_info: DiagnosticInfo<'_>, failure: AnchorFailure) {
+ let (msg, anchor_idx) = match failure {
+ AnchorFailure::MultipleAnchors => {
+ (format!("`{}` contains multiple anchors", diag_info.ori_link), 1)
+ }
+ AnchorFailure::RustdocAnchorConflict(res) => (
+ format!(
+ "`{}` contains an anchor, but links to {kind}s are already anchored",
+ diag_info.ori_link,
+ kind = res.descr(),
+ ),
+ 0,
),
};
- report_diagnostic(cx, BROKEN_INTRA_DOC_LINKS, &msg, item, dox, &link_range, |diag, sp| {
- if let Some(sp) = sp {
- diag.span_label(sp, "contains invalid anchor");
+ report_diagnostic(cx.tcx, BROKEN_INTRA_DOC_LINKS, &msg, &diag_info, |diag, sp| {
+ if let Some(mut sp) = sp {
+ if let Some((fragment_offset, _)) =
+ diag_info.ori_link.char_indices().filter(|(_, x)| *x == '#').nth(anchor_idx)
+ {
+ sp = sp.with_lo(sp.lo() + BytePos(fragment_offset as _));
+ }
+ diag.span_label(sp, "invalid anchor");
}
+ if let AnchorFailure::RustdocAnchorConflict(Res::Primitive(_)) = failure {
+ if let Some(sp) = sp {
+ span_bug!(sp, "anchors should be allowed now");
+ } else {
+ bug!("anchors should be allowed now");
+ }
+ }
+ });
+}
+
+/// Report an error in the link disambiguator.
+fn disambiguator_error(
+ cx: &DocContext<'_>,
+ mut diag_info: DiagnosticInfo<'_>,
+ disambiguator_range: Range<usize>,
+ msg: &str,
+) {
+ diag_info.link_range = disambiguator_range;
+ report_diagnostic(cx.tcx, BROKEN_INTRA_DOC_LINKS, msg, &diag_info, |diag, _sp| {
+ let msg = format!(
+ "see {}/rustdoc/linking-to-items-by-name.html#namespaces-and-disambiguators for more info about disambiguators",
+ crate::DOC_RUST_LANG_ORG_CHANNEL
+ );
+ diag.note(&msg);
});
}
/// Report an ambiguity error, where there were multiple possible resolutions.
fn ambiguity_error(
cx: &DocContext<'_>,
- item: &Item,
+ diag_info: DiagnosticInfo<'_>,
path_str: &str,
- dox: &str,
- link_range: Option<Range<usize>>,
candidates: Vec<Res>,
) {
let mut msg = format!("`{}` is ", path_str);
}
}
- report_diagnostic(cx, BROKEN_INTRA_DOC_LINKS, &msg, item, dox, &link_range, |diag, sp| {
+ report_diagnostic(cx.tcx, BROKEN_INTRA_DOC_LINKS, &msg, &diag_info, |diag, sp| {
if let Some(sp) = sp {
diag.span_label(sp, "ambiguous link");
} else {
}
for res in candidates {
- let disambiguator = Disambiguator::from_res(res);
- suggest_disambiguator(disambiguator, diag, path_str, dox, sp, &link_range);
+ suggest_disambiguator(res, diag, path_str, diag_info.ori_link, sp);
}
});
}
/// In case of an ambiguity or mismatched disambiguator, suggest the correct
/// disambiguator.
fn suggest_disambiguator(
- disambiguator: Disambiguator,
+ res: Res,
diag: &mut DiagnosticBuilder<'_>,
path_str: &str,
- dox: &str,
+ ori_link: &str,
sp: Option<rustc_span::Span>,
- link_range: &Option<Range<usize>>,
) {
- let suggestion = disambiguator.suggestion();
- let help = format!("to link to the {}, {}", disambiguator.descr(), suggestion.descr());
+ let suggestion = res.disambiguator_suggestion();
+ let help = format!("to link to the {}, {}", res.descr(), suggestion.descr());
if let Some(sp) = sp {
- let link_range = link_range.as_ref().expect("must have a link range if we have a span");
- let msg = if dox.bytes().nth(link_range.start) == Some(b'`') {
- format!("`{}`", suggestion.as_help(path_str))
+ let mut spans = suggestion.as_help_span(path_str, ori_link, sp);
+ if spans.len() > 1 {
+ diag.multipart_suggestion(&help, spans, Applicability::MaybeIncorrect);
} else {
- suggestion.as_help(path_str)
- };
-
- diag.span_suggestion(sp, &help, msg, Applicability::MaybeIncorrect);
+ let (sp, suggestion_text) = spans.pop().unwrap();
+ diag.span_suggestion_verbose(sp, &help, suggestion_text, Applicability::MaybeIncorrect);
+ }
} else {
diag.help(&format!("{}: {}", help, suggestion.as_help(path_str)));
}
}
/// Report a link from a public item to a private one.
-fn privacy_error(
- cx: &DocContext<'_>,
- item: &Item,
- path_str: &str,
- dox: &str,
- link_range: Option<Range<usize>>,
-) {
- let item_name = item.name.as_deref().unwrap_or("<unknown>");
+fn privacy_error(cx: &DocContext<'_>, diag_info: &DiagnosticInfo<'_>, path_str: &str) {
+ let sym;
+ let item_name = match diag_info.item.name {
+ Some(name) => {
+ sym = name;
+ sym.as_str()
+ }
+ None => "<unknown>",
+ };
let msg =
format!("public documentation for `{}` links to private item `{}`", item_name, path_str);
- report_diagnostic(cx, PRIVATE_INTRA_DOC_LINKS, &msg, item, dox, &link_range, |diag, sp| {
+ report_diagnostic(cx.tcx, PRIVATE_INTRA_DOC_LINKS, &msg, diag_info, |diag, sp| {
if let Some(sp) = sp {
diag.span_label(sp, "this item is private");
}
fn handle_variant(
cx: &DocContext<'_>,
res: Res,
- extra_fragment: &Option<String>,
-) -> Result<(Res, Option<String>), ErrorKind<'static>> {
- use rustc_middle::ty::DefIdTree;
-
- if extra_fragment.is_some() {
- return Err(ErrorKind::AnchorFailure(AnchorFailure::RustdocAnchorConflict(res)));
- }
+) -> Result<(Res, Option<ItemFragment>), ErrorKind<'static>> {
cx.tcx
- .parent(res.def_id())
+ .parent(res.def_id(cx.tcx))
.map(|parent| {
let parent_def = Res::Def(DefKind::Enum, parent);
- let variant = cx.tcx.expect_variant_res(res);
- (parent_def, Some(format!("variant.{}", variant.ident.name)))
+ let variant = cx.tcx.expect_variant_res(res.as_hir_res().unwrap());
+ (parent_def, Some(ItemFragment(FragmentKind::Variant, variant.def_id)))
})
.ok_or_else(|| ResolutionFailure::NoParentItem.into())
}
-// FIXME: At this point, this is basically a copy of the PrimitiveTypeTable
-const PRIMITIVES: &[(Symbol, Res)] = &[
- (sym::u8, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::U8))),
- (sym::u16, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::U16))),
- (sym::u32, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::U32))),
- (sym::u64, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::U64))),
- (sym::u128, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::U128))),
- (sym::usize, Res::PrimTy(hir::PrimTy::Uint(rustc_ast::UintTy::Usize))),
- (sym::i8, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::I8))),
- (sym::i16, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::I16))),
- (sym::i32, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::I32))),
- (sym::i64, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::I64))),
- (sym::i128, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::I128))),
- (sym::isize, Res::PrimTy(hir::PrimTy::Int(rustc_ast::IntTy::Isize))),
- (sym::f32, Res::PrimTy(hir::PrimTy::Float(rustc_ast::FloatTy::F32))),
- (sym::f64, Res::PrimTy(hir::PrimTy::Float(rustc_ast::FloatTy::F64))),
- (sym::str, Res::PrimTy(hir::PrimTy::Str)),
- (sym::bool, Res::PrimTy(hir::PrimTy::Bool)),
- (sym::char, Res::PrimTy(hir::PrimTy::Char)),
-];
-
/// Resolve a primitive type or value.
-fn resolve_primitive(path_str: &str, ns: Namespace) -> Option<(Symbol, Res)> {
- is_bool_value(path_str, ns).or_else(|| {
- if ns == TypeNS {
- // FIXME: this should be replaced by a lookup in PrimitiveTypeTable
- let maybe_primitive = Symbol::intern(path_str);
- PRIMITIVES.iter().find(|x| x.0 == maybe_primitive).copied()
- } else {
- None
- }
- })
-}
-
-/// Resolve a primitive value.
-fn is_bool_value(path_str: &str, ns: Namespace) -> Option<(Symbol, Res)> {
- if ns == TypeNS && (path_str == "true" || path_str == "false") {
- Some((sym::bool, Res::PrimTy(hir::PrimTy::Bool)))
- } else {
- None
+fn resolve_primitive(path_str: &str, ns: Namespace) -> Option<Res> {
+ if ns != TypeNS {
+ return None;
}
+ use PrimitiveType::*;
+ let prim = match path_str {
+ "isize" => Isize,
+ "i8" => I8,
+ "i16" => I16,
+ "i32" => I32,
+ "i64" => I64,
+ "i128" => I128,
+ "usize" => Usize,
+ "u8" => U8,
+ "u16" => U16,
+ "u32" => U32,
+ "u64" => U64,
+ "u128" => U128,
+ "f32" => F32,
+ "f64" => F64,
+ "char" => Char,
+ "bool" | "true" | "false" => Bool,
+ "str" | "&str" => Str,
+ // See #80181 for why these don't have symbols associated.
+ "slice" => Slice,
+ "array" => Array,
+ "tuple" => Tuple,
+ "unit" => Unit,
+ "pointer" | "*const" | "*mut" => RawPointer,
+ "reference" | "&" | "&mut" => Reference,
+ "fn" => Fn,
+ "never" | "!" => Never,
+ _ => return None,
+ };
+ debug!("resolved primitives {:?}", prim);
+ Some(Res::Primitive(prim))
}
fn strip_generics_from_path(path_str: &str) -> Result<String, ResolutionFailure<'static>> {
}
_ => segment.push(chr),
}
- debug!("raw segment: {:?}", segment);
+ trace!("raw segment: {:?}", segment);
}
if !segment.is_empty() {
projects / rustc.git / blobdiff