1 //! A desugared representation of paths like `crate::foo` or `<Type as Trait>::bar`.
10 use crate::{body::LowerCtx, db::DefDatabase, intern::Interned, type_ref::LifetimeRef};
19 type_ref::{TypeBound, TypeRef},
23 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
29 #[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
32 /// `self::` is `Super(0)`
35 /// Absolute path (::foo)
37 /// `$crate` from macro expansion
41 #[derive(Debug, Clone, PartialEq, Eq)]
42 pub enum ImportAlias {
43 /// Unnamed alias, as in `use Foo as _;`
50 pub fn from_src(db: &dyn DefDatabase, path: ast::Path, hygiene: &Hygiene) -> Option<ModPath> {
51 let ctx = LowerCtx::with_hygiene(db, hygiene);
52 lower::lower_path(db, path, &ctx).map(|it| (*it.mod_path).clone())
55 pub fn from_segments(kind: PathKind, segments: impl IntoIterator<Item = Name>) -> ModPath {
56 let segments = segments.into_iter().collect::<Vec<_>>();
57 ModPath { kind, segments }
60 /// Creates a `ModPath` from a `PathKind`, with no extra path segments.
61 pub const fn from_kind(kind: PathKind) -> ModPath {
62 ModPath { kind, segments: Vec::new() }
65 /// Calls `cb` with all paths, represented by this use item.
66 pub(crate) fn expand_use_item(
68 item_src: InFile<ast::Use>,
70 mut cb: impl FnMut(ModPath, &ast::UseTree, /* is_glob */ bool, Option<ImportAlias>),
72 if let Some(tree) = item_src.value.use_tree() {
73 lower::lower_use_tree(db, None, tree, hygiene, &mut cb);
77 pub fn segments(&self) -> &[Name] {
81 pub fn push_segment(&mut self, segment: Name) {
82 self.segments.push(segment);
85 pub fn pop_segment(&mut self) -> Option<Name> {
89 /// Returns the number of segments in the path (counting special segments like `$crate` and
91 pub fn len(&self) -> usize {
95 PathKind::Super(i) => i as usize,
98 PathKind::DollarCrate(_) => 1,
102 pub fn is_ident(&self) -> bool {
103 self.as_ident().is_some()
106 pub fn is_self(&self) -> bool {
107 self.kind == PathKind::Super(0) && self.segments.is_empty()
110 /// If this path is a single identifier, like `foo`, return its name.
111 pub fn as_ident(&self) -> Option<&Name> {
112 if self.kind != PathKind::Plain {
116 match &*self.segments {
117 [name] => Some(name),
123 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
125 /// Type based path like `<T>::foo`.
126 /// Note that paths like `<Type as Trait>::foo` are desugard to `Trait::<Self=Type>::foo`.
127 type_anchor: Option<Interned<TypeRef>>,
128 mod_path: Interned<ModPath>,
129 /// Invariant: the same len as `self.mod_path.segments`
130 generic_args: Vec<Option<Arc<GenericArgs>>>,
133 /// Generic arguments to a path segment (e.g. the `i32` in `Option<i32>`). This
134 /// also includes bindings of associated types, like in `Iterator<Item = Foo>`.
135 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
136 pub struct GenericArgs {
137 pub args: Vec<GenericArg>,
138 /// This specifies whether the args contain a Self type as the first
139 /// element. This is the case for path segments like `<T as Trait>`, where
140 /// `T` is actually a type parameter for the path `Trait` specifying the
141 /// Self type. Otherwise, when we have a path `Trait<X, Y>`, the Self type
143 pub has_self_type: bool,
144 /// Associated type bindings like in `Iterator<Item = T>`.
145 pub bindings: Vec<AssociatedTypeBinding>,
148 /// An associated type binding like in `Iterator<Item = T>`.
149 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
150 pub struct AssociatedTypeBinding {
151 /// The name of the associated type.
153 /// The type bound to this associated type (in `Item = T`, this would be the
154 /// `T`). This can be `None` if there are bounds instead.
155 pub type_ref: Option<TypeRef>,
156 /// Bounds for the associated type, like in `Iterator<Item:
157 /// SomeOtherTrait>`. (This is the unstable `associated_type_bounds`
159 pub bounds: Vec<TypeBound>,
162 /// A single generic argument.
163 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
164 pub enum GenericArg {
166 Lifetime(LifetimeRef),
170 /// Converts an `ast::Path` to `Path`. Works with use trees.
171 /// It correctly handles `$crate` based path from macro call.
172 pub fn from_src(db: &dyn DefDatabase, path: ast::Path, ctx: &LowerCtx) -> Option<Path> {
173 lower::lower_path(db, path, ctx)
176 /// Converts a known mod path to `Path`.
177 pub(crate) fn from_known_path(
179 generic_args: Vec<Option<Arc<GenericArgs>>>,
181 Path { type_anchor: None, mod_path: Interned::new(path), generic_args }
184 pub fn kind(&self) -> &PathKind {
188 pub fn type_anchor(&self) -> Option<&TypeRef> {
189 self.type_anchor.as_deref()
192 pub fn segments(&self) -> PathSegments<'_> {
194 segments: self.mod_path.segments.as_slice(),
195 generic_args: self.generic_args.as_slice(),
199 pub fn mod_path(&self) -> &ModPath {
203 pub fn qualifier(&self) -> Option<Path> {
204 if self.mod_path.is_ident() {
208 type_anchor: self.type_anchor.clone(),
209 mod_path: Interned::new(ModPath::from_segments(
210 self.mod_path.kind.clone(),
211 self.mod_path.segments[..self.mod_path.segments.len() - 1].iter().cloned(),
213 generic_args: self.generic_args[..self.generic_args.len() - 1].to_vec(),
218 pub fn is_self_type(&self) -> bool {
219 self.type_anchor.is_none()
220 && self.generic_args == &[None]
221 && self.mod_path.as_ident() == Some(&name!(Self))
225 #[derive(Debug, Clone, PartialEq, Eq, Hash)]
226 pub struct PathSegment<'a> {
228 pub args_and_bindings: Option<&'a GenericArgs>,
231 pub struct PathSegments<'a> {
232 segments: &'a [Name],
233 generic_args: &'a [Option<Arc<GenericArgs>>],
236 impl<'a> PathSegments<'a> {
237 pub const EMPTY: PathSegments<'static> = PathSegments { segments: &[], generic_args: &[] };
238 pub fn is_empty(&self) -> bool {
241 pub fn len(&self) -> usize {
244 pub fn first(&self) -> Option<PathSegment<'a>> {
247 pub fn last(&self) -> Option<PathSegment<'a>> {
248 self.get(self.len().checked_sub(1)?)
250 pub fn get(&self, idx: usize) -> Option<PathSegment<'a>> {
251 assert_eq!(self.segments.len(), self.generic_args.len());
252 let res = PathSegment {
253 name: self.segments.get(idx)?,
254 args_and_bindings: self.generic_args.get(idx).unwrap().as_ref().map(|it| &**it),
258 pub fn skip(&self, len: usize) -> PathSegments<'a> {
259 assert_eq!(self.segments.len(), self.generic_args.len());
260 PathSegments { segments: &self.segments[len..], generic_args: &self.generic_args[len..] }
262 pub fn take(&self, len: usize) -> PathSegments<'a> {
263 assert_eq!(self.segments.len(), self.generic_args.len());
264 PathSegments { segments: &self.segments[..len], generic_args: &self.generic_args[..len] }
266 pub fn iter(&self) -> impl Iterator<Item = PathSegment<'a>> {
267 self.segments.iter().zip(self.generic_args.iter()).map(|(name, args)| PathSegment {
269 args_and_bindings: args.as_ref().map(|it| &**it),
275 pub(crate) fn from_ast(lower_ctx: &LowerCtx, node: ast::GenericArgList) -> Option<GenericArgs> {
276 lower::lower_generic_args(lower_ctx, node)
279 pub(crate) fn empty() -> GenericArgs {
280 GenericArgs { args: Vec::new(), has_self_type: false, bindings: Vec::new() }
284 impl From<Name> for Path {
285 fn from(name: Name) -> Path {
288 mod_path: Interned::new(ModPath::from_segments(PathKind::Plain, iter::once(name))),
289 generic_args: vec![None],
294 impl From<Name> for Box<Path> {
295 fn from(name: Name) -> Box<Path> {
296 Box::new(Path::from(name))
300 impl From<Name> for ModPath {
301 fn from(name: Name) -> ModPath {
302 ModPath::from_segments(PathKind::Plain, iter::once(name))
306 impl Display for ModPath {
307 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
308 let mut first_segment = true;
309 let mut add_segment = |s| -> fmt::Result {
313 first_segment = false;
318 PathKind::Plain => {}
319 PathKind::Super(0) => add_segment("self")?,
320 PathKind::Super(n) => {
322 add_segment("super")?;
325 PathKind::Crate => add_segment("crate")?,
326 PathKind::Abs => add_segment("")?,
327 PathKind::DollarCrate(_) => add_segment("$crate")?,
329 for segment in &self.segments {
333 first_segment = false;
334 write!(f, "{}", segment)?;
340 pub use hir_expand::name as __name;
343 macro_rules! __known_path {
344 (core::iter::IntoIterator) => {};
345 (core::iter::Iterator) => {};
346 (core::result::Result) => {};
347 (core::option::Option) => {};
348 (core::ops::Range) => {};
349 (core::ops::RangeFrom) => {};
350 (core::ops::RangeFull) => {};
351 (core::ops::RangeTo) => {};
352 (core::ops::RangeToInclusive) => {};
353 (core::ops::RangeInclusive) => {};
354 (core::future::Future) => {};
355 (core::ops::Try) => {};
357 compile_error!("Please register your known path in the path module")
362 macro_rules! __path {
363 ($start:ident $(:: $seg:ident)*) => ({
364 $crate::__known_path!($start $(:: $seg)*);
365 $crate::path::ModPath::from_segments($crate::path::PathKind::Abs, vec![
366 $crate::path::__name![$start], $($crate::path::__name![$seg],)*
371 pub use crate::__path as path;