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