crates/ra_hir_expand/src/name.rs

   1 //! FIXME: write short doc here
   2
   3 use std::fmt;
   4
   5 use ra_syntax::{ast, SmolStr};
   6
   7 /// `Name` is a wrapper around string, which is used in hir for both references
   8 /// and declarations. In theory, names should also carry hygiene info, but we are
   9 /// not there yet!
  10 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
  11 pub struct Name(Repr);
  12
  13 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
  14 enum Repr {
  15     Text(SmolStr),
  16     TupleField(usize),
  17 }
  18
  19 impl fmt::Display for Name {
  20     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
  21         match &self.0 {
  22             Repr::Text(text) => fmt::Display::fmt(&text, f),
  23             Repr::TupleField(idx) => fmt::Display::fmt(&idx, f),
  24         }
  25     }
  26 }
  27
  28 impl Name {
  29     /// Note: this is private to make creating name from random string hard.
  30     /// Hopefully, this should allow us to integrate hygiene cleaner in the
  31     /// future, and to switch to interned representation of names.
  32     const fn new_text(text: SmolStr) -> Name {
  33         Name(Repr::Text(text))
  34     }
  35
  36     pub fn new_tuple_field(idx: usize) -> Name {
  37         Name(Repr::TupleField(idx))
  38     }
  39
  40     /// Shortcut to create inline plain text name
  41     const fn new_inline_ascii(len: usize, text: &[u8]) -> Name {
  42         Name::new_text(SmolStr::new_inline_from_ascii(len, text))
  43     }
  44
  45     /// Resolve a name from the text of token.
  46     fn resolve(raw_text: &SmolStr) -> Name {
  47         let raw_start = "r#";
  48         if raw_text.as_str().starts_with(raw_start) {
  49             Name::new_text(SmolStr::new(&raw_text[raw_start.len()..]))
  50         } else {
  51             Name::new_text(raw_text.clone())
  52         }
  53     }
  54
  55     pub fn missing() -> Name {
  56         Name::new_text("[missing name]".into())
  57     }
  58
  59     pub fn as_tuple_index(&self) -> Option<usize> {
  60         match self.0 {
  61             Repr::TupleField(idx) => Some(idx),
  62             _ => None,
  63         }
  64     }
  65 }
  66
  67 pub trait AsName {
  68     fn as_name(&self) -> Name;
  69 }
  70
  71 impl AsName for ast::NameRef {
  72     fn as_name(&self) -> Name {
  73         match self.as_tuple_field() {
  74             Some(idx) => Name::new_tuple_field(idx),
  75             None => Name::resolve(self.text()),
  76         }
  77     }
  78 }
  79
  80 impl AsName for ast::Name {
  81     fn as_name(&self) -> Name {
  82         Name::resolve(self.text())
  83     }
  84 }
  85
  86 impl AsName for ast::FieldKind {
  87     fn as_name(&self) -> Name {
  88         match self {
  89             ast::FieldKind::Name(nr) => nr.as_name(),
  90             ast::FieldKind::Index(idx) => Name::new_tuple_field(idx.text().parse().unwrap()),
  91         }
  92     }
  93 }
  94
  95 impl AsName for ra_db::Dependency {
  96     fn as_name(&self) -> Name {
  97         Name::new_text(self.name.clone())
  98     }
  99 }
 100
 101 // Primitives
 102 pub const ISIZE: Name = Name::new_inline_ascii(5, b"isize");
 103 pub const I8: Name = Name::new_inline_ascii(2, b"i8");
 104 pub const I16: Name = Name::new_inline_ascii(3, b"i16");
 105 pub const I32: Name = Name::new_inline_ascii(3, b"i32");
 106 pub const I64: Name = Name::new_inline_ascii(3, b"i64");
 107 pub const I128: Name = Name::new_inline_ascii(4, b"i128");
 108 pub const USIZE: Name = Name::new_inline_ascii(5, b"usize");
 109 pub const U8: Name = Name::new_inline_ascii(2, b"u8");
 110 pub const U16: Name = Name::new_inline_ascii(3, b"u16");
 111 pub const U32: Name = Name::new_inline_ascii(3, b"u32");
 112 pub const U64: Name = Name::new_inline_ascii(3, b"u64");
 113 pub const U128: Name = Name::new_inline_ascii(4, b"u128");
 114 pub const F32: Name = Name::new_inline_ascii(3, b"f32");
 115 pub const F64: Name = Name::new_inline_ascii(3, b"f64");
 116 pub const BOOL: Name = Name::new_inline_ascii(4, b"bool");
 117 pub const CHAR: Name = Name::new_inline_ascii(4, b"char");
 118 pub const STR: Name = Name::new_inline_ascii(3, b"str");
 119
 120 // Special names
 121 pub const SELF_PARAM: Name = Name::new_inline_ascii(4, b"self");
 122 pub const SELF_TYPE: Name = Name::new_inline_ascii(4, b"Self");
 123 pub const MACRO_RULES: Name = Name::new_inline_ascii(11, b"macro_rules");
 124
 125 // Components of known path (value or mod name)
 126 pub const STD: Name = Name::new_inline_ascii(3, b"std");
 127 pub const ITER: Name = Name::new_inline_ascii(4, b"iter");
 128 pub const OPS: Name = Name::new_inline_ascii(3, b"ops");
 129 pub const FUTURE: Name = Name::new_inline_ascii(6, b"future");
 130 pub const RESULT: Name = Name::new_inline_ascii(6, b"result");
 131 pub const BOXED: Name = Name::new_inline_ascii(5, b"boxed");
 132
 133 // Components of known path (type name)
 134 pub const INTO_ITERATOR_TYPE: Name = Name::new_inline_ascii(12, b"IntoIterator");
 135 pub const ITEM_TYPE: Name = Name::new_inline_ascii(4, b"Item");
 136 pub const TRY_TYPE: Name = Name::new_inline_ascii(3, b"Try");
 137 pub const OK_TYPE: Name = Name::new_inline_ascii(2, b"Ok");
 138 pub const FUTURE_TYPE: Name = Name::new_inline_ascii(6, b"Future");
 139 pub const RESULT_TYPE: Name = Name::new_inline_ascii(6, b"Result");
 140 pub const OUTPUT_TYPE: Name = Name::new_inline_ascii(6, b"Output");
 141 pub const TARGET_TYPE: Name = Name::new_inline_ascii(6, b"Target");
 142 pub const BOX_TYPE: Name = Name::new_inline_ascii(3, b"Box");
 143
 144 // Builtin Macros
 145 pub const FILE_MACRO: Name = Name::new_inline_ascii(4, b"file");
 146 pub const COLUMN_MACRO: Name = Name::new_inline_ascii(6, b"column");
 147 pub const COMPILE_ERROR_MACRO: Name = Name::new_inline_ascii(13, b"compile_error");
 148 pub const LINE_MACRO: Name = Name::new_inline_ascii(4, b"line");
 149 pub const STRINGIFY_MACRO: Name = Name::new_inline_ascii(9, b"stringify");