src/librustc/ty/item_path.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use hir::map::DefPathData;
  12 use hir::def_id::{CrateNum, DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
  13 use ty::{self, Ty, TyCtxt};
  14 use middle::cstore::{ExternCrate, ExternCrateSource};
  15 use syntax::ast;
  16 use syntax::symbol::Symbol;
  17 use syntax::symbol::LocalInternedString;
  18
  19 use std::cell::Cell;
  20
  21 thread_local! {
  22     static FORCE_ABSOLUTE: Cell<bool> = Cell::new(false);
  23     static FORCE_IMPL_FILENAME_LINE: Cell<bool> = Cell::new(false);
  24 }
  25
  26 /// Enforces that item_path_str always returns an absolute path and
  27 /// also enables "type-based" impl paths. This is used when building
  28 /// symbols that contain types, where we want the crate name to be
  29 /// part of the symbol.
  30 pub fn with_forced_absolute_paths<F: FnOnce() -> R, R>(f: F) -> R {
  31     FORCE_ABSOLUTE.with(|force| {
  32         let old = force.get();
  33         force.set(true);
  34         let result = f();
  35         force.set(old);
  36         result
  37     })
  38 }
  39
  40 /// Force us to name impls with just the filename/line number. We
  41 /// normally try to use types. But at some points, notably while printing
  42 /// cycle errors, this can result in extra or suboptimal error output,
  43 /// so this variable disables that check.
  44 pub fn with_forced_impl_filename_line<F: FnOnce() -> R, R>(f: F) -> R {
  45     FORCE_IMPL_FILENAME_LINE.with(|force| {
  46         let old = force.get();
  47         force.set(true);
  48         let result = f();
  49         force.set(old);
  50         result
  51     })
  52 }
  53
  54 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
  55     /// Returns a string identifying this def-id. This string is
  56     /// suitable for user output. It is relative to the current crate
  57     /// root, unless with_forced_absolute_paths was used.
  58     pub fn item_path_str(self, def_id: DefId) -> String {
  59         let mode = FORCE_ABSOLUTE.with(|force| {
  60             if force.get() {
  61                 RootMode::Absolute
  62             } else {
  63                 RootMode::Local
  64             }
  65         });
  66         let mut buffer = LocalPathBuffer::new(mode);
  67         self.push_item_path(&mut buffer, def_id);
  68         buffer.into_string()
  69     }
  70
  71     /// Returns a string identifying this local node-id.
  72     pub fn node_path_str(self, id: ast::NodeId) -> String {
  73         self.item_path_str(self.hir.local_def_id(id))
  74     }
  75
  76     /// Returns a string identifying this def-id. This string is
  77     /// suitable for user output. It always begins with a crate identifier.
  78     pub fn absolute_item_path_str(self, def_id: DefId) -> String {
  79         let mut buffer = LocalPathBuffer::new(RootMode::Absolute);
  80         self.push_item_path(&mut buffer, def_id);
  81         buffer.into_string()
  82     }
  83
  84     /// Returns the "path" to a particular crate. This can proceed in
  85     /// various ways, depending on the `root_mode` of the `buffer`.
  86     /// (See `RootMode` enum for more details.)
  87     pub fn push_krate_path<T>(self, buffer: &mut T, cnum: CrateNum)
  88         where T: ItemPathBuffer
  89     {
  90         match *buffer.root_mode() {
  91             RootMode::Local => {
  92                 // In local mode, when we encounter a crate other than
  93                 // LOCAL_CRATE, execution proceeds in one of two ways:
  94                 //
  95                 // 1. for a direct dependency, where user added an
  96                 //    `extern crate` manually, we put the `extern
  97                 //    crate` as the parent. So you wind up with
  98                 //    something relative to the current crate.
  99                 // 2. for an extern inferred from a path or an indirect crate,
 100                 //    where there is no explicit `extern crate`, we just prepend
 101                 //    the crate name.
 102                 //
 103                 // Returns `None` for the local crate.
 104                 if cnum != LOCAL_CRATE {
 105                     let opt_extern_crate = self.extern_crate(cnum.as_def_id());
 106                     if let Some(ExternCrate {
 107                         src: ExternCrateSource::Extern(def_id),
 108                         direct: true,
 109                         ..
 110                     }) = *opt_extern_crate
 111                     {
 112                         self.push_item_path(buffer, def_id);
 113                     } else {
 114                         buffer.push(&self.crate_name(cnum).as_str());
 115                     }
 116                 }
 117             }
 118             RootMode::Absolute => {
 119                 // In absolute mode, just write the crate name
 120                 // unconditionally.
 121                 buffer.push(&self.original_crate_name(cnum).as_str());
 122             }
 123         }
 124     }
 125
 126     /// If possible, this pushes a global path resolving to `external_def_id` that is visible
 127     /// from at least one local module and returns true. If the crate defining `external_def_id` is
 128     /// declared with an `extern crate`, the path is guaranteed to use the `extern crate`.
 129     pub fn try_push_visible_item_path<T>(self, buffer: &mut T, external_def_id: DefId) -> bool
 130         where T: ItemPathBuffer
 131     {
 132         let visible_parent_map = self.visible_parent_map(LOCAL_CRATE);
 133
 134         let (mut cur_def, mut cur_path) = (external_def_id, Vec::<LocalInternedString>::new());
 135         loop {
 136             // If `cur_def` is a direct or injected extern crate, push the path to the crate
 137             // followed by the path to the item within the crate and return.
 138             if cur_def.index == CRATE_DEF_INDEX {
 139                 match *self.extern_crate(cur_def) {
 140                     Some(ExternCrate {
 141                         src: ExternCrateSource::Extern(def_id),
 142                         direct: true,
 143                         ..
 144                     }) => {
 145                         self.push_item_path(buffer, def_id);
 146                         cur_path.iter().rev().for_each(|segment| buffer.push(&segment));
 147                         return true;
 148                     }
 149                     None => {
 150                         buffer.push(&self.crate_name(cur_def.krate).as_str());
 151                         cur_path.iter().rev().for_each(|segment| buffer.push(&segment));
 152                         return true;
 153                     }
 154                     _ => {},
 155                 }
 156             }
 157
 158             let mut cur_def_key = self.def_key(cur_def);
 159
 160             // For a UnitStruct or TupleStruct we want the name of its parent rather than <unnamed>.
 161             if let DefPathData::StructCtor = cur_def_key.disambiguated_data.data {
 162                 let parent = DefId {
 163                     krate: cur_def.krate,
 164                     index: cur_def_key.parent.expect("DefPathData::StructCtor missing a parent"),
 165                 };
 166
 167                 cur_def_key = self.def_key(parent);
 168             }
 169
 170             let data = cur_def_key.disambiguated_data.data;
 171             let symbol = data.get_opt_name().map(|n| n.as_str()).unwrap_or_else(|| {
 172                 Symbol::intern("<unnamed>").as_str()
 173             });
 174             cur_path.push(symbol);
 175
 176             match visible_parent_map.get(&cur_def) {
 177                 Some(&def) => cur_def = def,
 178                 None => return false,
 179             };
 180         }
 181     }
 182
 183     pub fn push_item_path<T>(self, buffer: &mut T, def_id: DefId)
 184         where T: ItemPathBuffer
 185     {
 186         match *buffer.root_mode() {
 187             RootMode::Local if !def_id.is_local() =>
 188                 if self.try_push_visible_item_path(buffer, def_id) { return },
 189             _ => {}
 190         }
 191
 192         let key = self.def_key(def_id);
 193         match key.disambiguated_data.data {
 194             DefPathData::CrateRoot => {
 195                 assert!(key.parent.is_none());
 196                 self.push_krate_path(buffer, def_id.krate);
 197             }
 198
 199             DefPathData::Impl => {
 200                 self.push_impl_path(buffer, def_id);
 201             }
 202
 203             // Unclear if there is any value in distinguishing these.
 204             // Probably eventually (and maybe we would even want
 205             // finer-grained distinctions, e.g. between enum/struct).
 206             data @ DefPathData::Misc |
 207             data @ DefPathData::TypeNs(..) |
 208             data @ DefPathData::Trait(..) |
 209             data @ DefPathData::AssocTypeInTrait(..) |
 210             data @ DefPathData::AssocTypeInImpl(..) |
 211             data @ DefPathData::ValueNs(..) |
 212             data @ DefPathData::Module(..) |
 213             data @ DefPathData::TypeParam(..) |
 214             data @ DefPathData::LifetimeDef(..) |
 215             data @ DefPathData::EnumVariant(..) |
 216             data @ DefPathData::Field(..) |
 217             data @ DefPathData::Initializer |
 218             data @ DefPathData::MacroDef(..) |
 219             data @ DefPathData::ClosureExpr |
 220             data @ DefPathData::ImplTrait |
 221             data @ DefPathData::Typeof |
 222             data @ DefPathData::GlobalMetaData(..) => {
 223                 let parent_def_id = self.parent_def_id(def_id).unwrap();
 224                 self.push_item_path(buffer, parent_def_id);
 225                 buffer.push(&data.as_interned_str().as_symbol().as_str());
 226             }
 227             DefPathData::StructCtor => { // present `X` instead of `X::{{constructor}}`
 228                 let parent_def_id = self.parent_def_id(def_id).unwrap();
 229                 self.push_item_path(buffer, parent_def_id);
 230             }
 231         }
 232     }
 233
 234     fn push_impl_path<T>(self,
 235                          buffer: &mut T,
 236                          impl_def_id: DefId)
 237         where T: ItemPathBuffer
 238     {
 239         let parent_def_id = self.parent_def_id(impl_def_id).unwrap();
 240
 241         // Always use types for non-local impls, where types are always
 242         // available, and filename/line-number is mostly uninteresting.
 243         let use_types = !impl_def_id.is_local() || {
 244             // Otherwise, use filename/line-number if forced.
 245             let force_no_types = FORCE_IMPL_FILENAME_LINE.with(|f| f.get());
 246             !force_no_types
 247         };
 248
 249         if !use_types {
 250             return self.push_impl_path_fallback(buffer, impl_def_id);
 251         }
 252
 253         // Decide whether to print the parent path for the impl.
 254         // Logically, since impls are global, it's never needed, but
 255         // users may find it useful. Currently, we omit the parent if
 256         // the impl is either in the same module as the self-type or
 257         // as the trait.
 258         let self_ty = self.type_of(impl_def_id);
 259         let in_self_mod = match characteristic_def_id_of_type(self_ty) {
 260             None => false,
 261             Some(ty_def_id) => self.parent_def_id(ty_def_id) == Some(parent_def_id),
 262         };
 263
 264         let impl_trait_ref = self.impl_trait_ref(impl_def_id);
 265         let in_trait_mod = match impl_trait_ref {
 266             None => false,
 267             Some(trait_ref) => self.parent_def_id(trait_ref.def_id) == Some(parent_def_id),
 268         };
 269
 270         if !in_self_mod && !in_trait_mod {
 271             // If the impl is not co-located with either self-type or
 272             // trait-type, then fallback to a format that identifies
 273             // the module more clearly.
 274             self.push_item_path(buffer, parent_def_id);
 275             if let Some(trait_ref) = impl_trait_ref {
 276                 buffer.push(&format!("<impl {} for {}>", trait_ref, self_ty));
 277             } else {
 278                 buffer.push(&format!("<impl {}>", self_ty));
 279             }
 280             return;
 281         }
 282
 283         // Otherwise, try to give a good form that would be valid language
 284         // syntax. Preferably using associated item notation.
 285
 286         if let Some(trait_ref) = impl_trait_ref {
 287             // Trait impls.
 288             buffer.push(&format!("<{} as {}>",
 289                                  self_ty,
 290                                  trait_ref));
 291             return;
 292         }
 293
 294         // Inherent impls. Try to print `Foo::bar` for an inherent
 295         // impl on `Foo`, but fallback to `<Foo>::bar` if self-type is
 296         // anything other than a simple path.
 297         match self_ty.sty {
 298             ty::TyAdt(adt_def, substs) => {
 299                 if substs.types().next().is_none() { // ignore regions
 300                     self.push_item_path(buffer, adt_def.did);
 301                 } else {
 302                     buffer.push(&format!("<{}>", self_ty));
 303                 }
 304             }
 305
 306             ty::TyForeign(did) => self.push_item_path(buffer, did),
 307
 308             ty::TyBool |
 309             ty::TyChar |
 310             ty::TyInt(_) |
 311             ty::TyUint(_) |
 312             ty::TyFloat(_) |
 313             ty::TyStr => {
 314                 buffer.push(&format!("{}", self_ty));
 315             }
 316
 317             _ => {
 318                 buffer.push(&format!("<{}>", self_ty));
 319             }
 320         }
 321     }
 322
 323     fn push_impl_path_fallback<T>(self,
 324                                   buffer: &mut T,
 325                                   impl_def_id: DefId)
 326         where T: ItemPathBuffer
 327     {
 328         // If no type info is available, fall back to
 329         // pretty printing some span information. This should
 330         // only occur very early in the compiler pipeline.
 331         let parent_def_id = self.parent_def_id(impl_def_id).unwrap();
 332         self.push_item_path(buffer, parent_def_id);
 333         let node_id = self.hir.as_local_node_id(impl_def_id).unwrap();
 334         let item = self.hir.expect_item(node_id);
 335         let span_str = self.sess.codemap().span_to_string(item.span);
 336         buffer.push(&format!("<impl at {}>", span_str));
 337     }
 338
 339     /// Returns the def-id of `def_id`'s parent in the def tree. If
 340     /// this returns `None`, then `def_id` represents a crate root or
 341     /// inlined root.
 342     pub fn parent_def_id(self, def_id: DefId) -> Option<DefId> {
 343         let key = self.def_key(def_id);
 344         key.parent.map(|index| DefId { krate: def_id.krate, index: index })
 345     }
 346 }
 347
 348 /// As a heuristic, when we see an impl, if we see that the
 349 /// 'self-type' is a type defined in the same module as the impl,
 350 /// we can omit including the path to the impl itself. This
 351 /// function tries to find a "characteristic def-id" for a
 352 /// type. It's just a heuristic so it makes some questionable
 353 /// decisions and we may want to adjust it later.
 354 pub fn characteristic_def_id_of_type(ty: Ty) -> Option<DefId> {
 355     match ty.sty {
 356         ty::TyAdt(adt_def, _) => Some(adt_def.did),
 357
 358         ty::TyDynamic(data, ..) => data.principal().map(|p| p.def_id()),
 359
 360         ty::TyArray(subty, _) |
 361         ty::TySlice(subty) => characteristic_def_id_of_type(subty),
 362
 363         ty::TyRawPtr(mt) |
 364         ty::TyRef(_, mt) => characteristic_def_id_of_type(mt.ty),
 365
 366         ty::TyTuple(ref tys) => tys.iter()
 367                                    .filter_map(|ty| characteristic_def_id_of_type(ty))
 368                                    .next(),
 369
 370         ty::TyFnDef(def_id, _) |
 371         ty::TyClosure(def_id, _) |
 372         ty::TyGenerator(def_id, _, _) |
 373         ty::TyForeign(def_id) => Some(def_id),
 374
 375         ty::TyBool |
 376         ty::TyChar |
 377         ty::TyInt(_) |
 378         ty::TyUint(_) |
 379         ty::TyStr |
 380         ty::TyFnPtr(_) |
 381         ty::TyProjection(_) |
 382         ty::TyParam(_) |
 383         ty::TyAnon(..) |
 384         ty::TyInfer(_) |
 385         ty::TyError |
 386         ty::TyGeneratorWitness(..) |
 387         ty::TyNever |
 388         ty::TyFloat(_) => None,
 389     }
 390 }
 391
 392 /// Unifying Trait for different kinds of item paths we might
 393 /// construct. The basic interface is that components get pushed: the
 394 /// instance can also customize how we handle the root of a crate.
 395 pub trait ItemPathBuffer {
 396     fn root_mode(&self) -> &RootMode;
 397     fn push(&mut self, text: &str);
 398 }
 399
 400 #[derive(Debug)]
 401 pub enum RootMode {
 402     /// Try to make a path relative to the local crate.  In
 403     /// particular, local paths have no prefix, and if the path comes
 404     /// from an extern crate, start with the path to the `extern
 405     /// crate` declaration.
 406     Local,
 407
 408     /// Always prepend the crate name to the path, forming an absolute
 409     /// path from within a given set of crates.
 410     Absolute,
 411 }
 412
 413 #[derive(Debug)]
 414 struct LocalPathBuffer {
 415     root_mode: RootMode,
 416     str: String,
 417 }
 418
 419 impl LocalPathBuffer {
 420     fn new(root_mode: RootMode) -> LocalPathBuffer {
 421         LocalPathBuffer {
 422             root_mode,
 423             str: String::new(),
 424         }
 425     }
 426
 427     fn into_string(self) -> String {
 428         self.str
 429     }
 430 }
 431
 432 impl ItemPathBuffer for LocalPathBuffer {
 433     fn root_mode(&self) -> &RootMode {
 434         &self.root_mode
 435     }
 436
 437     fn push(&mut self, text: &str) {
 438         if !self.str.is_empty() {
 439             self.str.push_str("::");
 440         }
 441         self.str.push_str(text);
 442     }
 443 }