1 //! An "interner" is a data structure that associates values with usize tags and
2 //! allows bidirectional lookup; i.e., given a value, one can easily find the
3 //! type, and vice versa.
5 use arena::DroplessArena;
6 use rustc_data_structures::fx::FxHashMap;
7 use rustc_data_structures::stable_hasher::{HashStable, StableHasher, ToStableHashKey};
8 use rustc_macros::{symbols, HashStable_Generic};
9 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
10 use rustc_serialize::{UseSpecializedDecodable, UseSpecializedEncodable};
12 use std::cmp::{Ord, PartialEq, PartialOrd};
14 use std::hash::{Hash, Hasher};
17 use crate::{Span, DUMMY_SP, GLOBALS};
23 // After modifying this list adjust `is_special`, `is_used_keyword`/`is_unused_keyword`,
24 // this should be rarely necessary though if the keywords are kept in alphabetic order.
26 // Special reserved identifiers used internally for elided lifetimes,
27 // unnamed method parameters, crate root module, error recovery etc.
30 DollarCrate: "$crate",
33 // Keywords that are used in stable Rust.
70 // Keywords that are used in unstable Rust or reserved for future use.
84 // Edition-specific keywords that are used in stable Rust.
85 Async: "async", // >= 2018 Edition only
86 Await: "await", // >= 2018 Edition only
87 Dyn: "dyn", // >= 2018 Edition only
89 // Edition-specific keywords that are used in unstable Rust or reserved for future use.
90 Try: "try", // >= 2018 Edition only
92 // Special lifetime names
93 UnderscoreLifetime: "'_",
94 StaticLifetime: "'static",
96 // Weak keywords, have special meaning only in specific contexts.
104 // Symbols that can be referred to with rustc_span::sym::*. The symbol is
105 // the stringified identifier unless otherwise specified (e.g.
106 // `proc_dash_macro` represents "proc-macro").
108 // As well as the symbols listed, there are symbols for the the strings
109 // "0", "1", ..., "9", which are accessible via `sym::integer`.
111 aarch64_target_feature,
115 abi_msp430_interrupt,
124 advanced_slice_patterns,
136 allow_internal_unsafe,
137 allow_internal_unstable,
138 allow_internal_unstable_backcompat_hack,
142 arbitrary_enum_discriminant,
143 arbitrary_self_types,
150 associated_type_bounds,
151 associated_type_defaults,
159 augmented_assignments,
160 automatically_derived,
161 avx512_target_feature,
166 bind_by_move_pattern_guards,
170 borrowck_graphviz_postflow,
171 borrowck_graphviz_preflow,
174 braced_empty_structs,
186 cfg_target_has_atomic,
187 cfg_target_thread_local,
195 closure_to_fn_coercion,
197 cmpxchg16b_target_feature,
204 conservative_impl_trait,
206 const_compare_raw_pointers,
214 const_in_array_repeat_expressions,
220 const_raw_ptr_to_usize_cast,
222 const_trait_bound_opt_out,
236 crate_visibility_modifier,
244 custom_inner_attributes,
245 custom_test_frameworks,
253 default_lib_allocator,
254 default_type_parameter_fallback,
256 delay_span_bug_from_inside_query,
271 document_private_items,
272 dotdoteq_in_patterns,
273 dotdot_in_tuple_patterns,
274 double_braced_crate: "{{crate}}",
275 double_braced_impl: "{{impl}}",
276 double_braced_misc: "{{misc}}",
277 double_braced_closure: "{{closure}}",
278 double_braced_constructor: "{{constructor}}",
279 double_braced_constant: "{{constant}}",
280 double_braced_opaque: "{{opaque}}",
282 dropck_parametricity,
298 exclusive_range_pattern,
299 exhaustive_integer_patterns,
305 extern_absolute_paths,
307 extern_crate_item_prelude,
318 field_init_shorthand,
341 generic_associated_types,
346 half_open_range_patterns,
351 hexagon_target_feature,
353 homogeneous_aggregate,
367 if_while_or_patterns,
369 impl_header_lifetime_elision,
371 impl_trait_in_bindings,
379 inclusive_range_syntax,
380 infer_outlives_requirements,
381 infer_static_outlives_requirements,
388 irrefutable_let_patterns,
391 issue_5723_bootstrap,
392 issue_tracker_base_url,
394 item_context: "ItemContext",
413 link_llvm_intrinsics,
423 macro_at_most_once_rep,
426 macro_lifetime_matcher,
427 macro_literal_matcher,
438 match_beginning_vert,
439 match_default_bindings,
457 movbe_target_feature,
493 object_safe_for_dispatch,
495 omit_gdb_pretty_printer_section,
502 optin_builtin_traits,
512 overlapping_marker_traits,
517 panic_implementation,
537 poll_with_tls_context,
538 powerpc_target_feature,
539 precise_pointer_size_matching,
544 proc_dash_macro: "proc-macro",
546 proc_macro_attribute,
552 proc_macro_internals,
554 proc_macro_non_items,
555 proc_macro_path_invoc,
560 quad_precision_float,
575 reexport_test_harness_main,
587 re_rebalance_coherence,
605 rustc_allocator_nounwind,
606 rustc_allow_const_fn_ptr,
607 rustc_args_required_const,
611 rustc_const_unstable,
613 rustc_conversion_suggestion,
616 rustc_diagnostic_item,
617 rustc_diagnostic_macros,
620 rustc_dump_env_program_clauses,
621 rustc_dump_program_clauses,
622 rustc_dump_user_substs,
624 rustc_expected_cgu_reuse,
625 rustc_if_this_changed,
626 rustc_inherit_overflow_checks,
628 rustc_layout_scalar_valid_range_end,
629 rustc_layout_scalar_valid_range_start,
630 rustc_macro_transparency,
632 rustc_nonnull_optimization_guaranteed,
633 rustc_object_lifetime_default,
634 rustc_on_unimplemented,
637 rustc_partition_codegened,
638 rustc_partition_reused,
640 rustc_peek_definite_init,
641 rustc_peek_maybe_init,
642 rustc_peek_maybe_uninit,
643 rustc_peek_indirectly_mutable,
645 rustc_proc_macro_decls,
649 rustc_std_internal_symbol,
652 rustc_reservation_impl,
654 rustc_then_this_would_need,
658 rust_eh_unwind_resume,
660 rvalue_static_promotion,
684 sse4a_target_feature,
697 stmt_expr_attributes,
699 struct_field_attributes,
709 target_has_atomic_load_store,
714 termination_trait_test,
717 test_accepted_feature,
719 test_removed_feature,
740 type_alias_impl_trait,
745 type_alias_enum_variants,
757 underscore_const_names,
759 underscore_lifetimes,
761 universal_impl_trait,
764 unrestricted_attribute_tokens,
767 unsized_tuple_coercion,
783 visible_private_types,
798 #[derive(Copy, Clone, Eq, HashStable_Generic)]
806 /// Constructs a new identifier from a symbol and a span.
807 pub const fn new(name: Symbol, span: Span) -> Ident {
811 /// Constructs a new identifier with a dummy span.
813 pub const fn with_dummy_span(name: Symbol) -> Ident {
814 Ident::new(name, DUMMY_SP)
818 pub fn invalid() -> Ident {
819 Ident::with_dummy_span(kw::Invalid)
822 /// Maps a string to an identifier with a dummy span.
823 pub fn from_str(string: &str) -> Ident {
824 Ident::with_dummy_span(Symbol::intern(string))
827 /// Maps a string and a span to an identifier.
828 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
829 Ident::new(Symbol::intern(string), span)
832 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
833 pub fn with_span_pos(self, span: Span) -> Ident {
834 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
837 pub fn without_first_quote(self) -> Ident {
838 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
841 /// "Normalize" ident for use in comparisons using "item hygiene".
842 /// Identifiers with same string value become same if they came from the same "modern" macro
843 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
844 /// different "modern" macros.
845 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
846 pub fn modern(self) -> Ident {
847 Ident::new(self.name, self.span.modern())
850 /// "Normalize" ident for use in comparisons using "local variable hygiene".
851 /// Identifiers with same string value become same if they came from the same non-transparent
852 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
853 /// non-transparent macros.
854 /// Technically, this operation strips all transparent marks from ident's syntactic context.
855 pub fn modern_and_legacy(self) -> Ident {
856 Ident::new(self.name, self.span.modern_and_legacy())
859 /// Convert the name to a `SymbolStr`. This is a slowish operation because
860 /// it requires locking the symbol interner.
861 pub fn as_str(self) -> SymbolStr {
866 impl PartialEq for Ident {
867 fn eq(&self, rhs: &Self) -> bool {
868 self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
872 impl Hash for Ident {
873 fn hash<H: Hasher>(&self, state: &mut H) {
874 self.name.hash(state);
875 self.span.ctxt().hash(state);
879 impl fmt::Debug for Ident {
880 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
881 if self.is_raw_guess() {
884 write!(f, "{}{:?}", self.name, self.span.ctxt())
888 impl fmt::Display for Ident {
889 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
890 if self.is_raw_guess() {
893 fmt::Display::fmt(&self.name, f)
897 impl UseSpecializedEncodable for Ident {
898 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
899 s.emit_struct("Ident", 2, |s| {
900 s.emit_struct_field("name", 0, |s| self.name.encode(s))?;
901 s.emit_struct_field("span", 1, |s| self.span.encode(s))
906 impl UseSpecializedDecodable for Ident {
907 fn default_decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error> {
908 d.read_struct("Ident", 2, |d| {
910 name: d.read_struct_field("name", 0, Decodable::decode)?,
911 span: d.read_struct_field("span", 1, Decodable::decode)?,
917 /// An interned string.
919 /// Internally, a `Symbol` is implemented as an index, and all operations
920 /// (including hashing, equality, and ordering) operate on that index. The use
921 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
922 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
924 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
925 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
926 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
927 pub struct Symbol(SymbolIndex);
929 rustc_index::newtype_index! {
930 pub struct SymbolIndex { .. }
934 const fn new(n: u32) -> Self {
935 Symbol(SymbolIndex::from_u32_const(n))
938 /// Maps a string to its interned representation.
939 pub fn intern(string: &str) -> Self {
940 with_interner(|interner| interner.intern(string))
943 /// Access the symbol's chars. This is a slowish operation because it
944 /// requires locking the symbol interner.
945 pub fn with<F: FnOnce(&str) -> R, R>(self, f: F) -> R {
946 with_interner(|interner| f(interner.get(self)))
949 /// Convert to a `SymbolStr`. This is a slowish operation because it
950 /// requires locking the symbol interner.
951 pub fn as_str(self) -> SymbolStr {
952 with_interner(|interner| unsafe {
953 SymbolStr { string: std::mem::transmute::<&str, &str>(interner.get(self)) }
957 pub fn as_u32(self) -> u32 {
962 impl fmt::Debug for Symbol {
963 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
964 self.with(|str| fmt::Debug::fmt(&str, f))
968 impl fmt::Display for Symbol {
969 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
970 self.with(|str| fmt::Display::fmt(&str, f))
974 impl Encodable for Symbol {
975 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
976 self.with(|string| s.emit_str(string))
980 impl Decodable for Symbol {
981 fn decode<D: Decoder>(d: &mut D) -> Result<Symbol, D::Error> {
982 Ok(Symbol::intern(&d.read_str()?))
986 impl<CTX> HashStable<CTX> for Symbol {
988 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
989 self.as_str().hash_stable(hcx, hasher);
993 impl<CTX> ToStableHashKey<CTX> for Symbol {
994 type KeyType = SymbolStr;
997 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {
1002 // The `&'static str`s in this type actually point into the arena.
1004 pub struct Interner {
1005 arena: DroplessArena,
1006 names: FxHashMap<&'static str, Symbol>,
1007 strings: Vec<&'static str>,
1011 fn prefill(init: &[&'static str]) -> Self {
1013 strings: init.into(),
1014 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1015 ..Default::default()
1019 pub fn intern(&mut self, string: &str) -> Symbol {
1020 if let Some(&name) = self.names.get(string) {
1024 let name = Symbol::new(self.strings.len() as u32);
1026 // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
1029 unsafe { str::from_utf8_unchecked(self.arena.alloc_slice(string.as_bytes())) };
1030 // It is safe to extend the arena allocation to `'static` because we only access
1031 // these while the arena is still alive.
1032 let string: &'static str = unsafe { &*(string as *const str) };
1033 self.strings.push(string);
1034 self.names.insert(string, name);
1038 // Get the symbol as a string. `Symbol::as_str()` should be used in
1039 // preference to this function.
1040 pub fn get(&self, symbol: Symbol) -> &str {
1041 self.strings[symbol.0.as_usize()]
1045 // This module has a very short name because it's used a lot.
1051 // This module has a very short name because it's used a lot.
1054 use std::convert::TryInto;
1058 // Get the symbol for an integer. The first few non-negative integers each
1059 // have a static symbol and therefore are fast.
1060 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1061 if let Result::Ok(idx) = n.try_into() {
1062 if let Option::Some(&sym) = digits_array.get(idx) {
1066 Symbol::intern(&n.to_string())
1071 fn is_used_keyword_2018(self) -> bool {
1072 self >= kw::Async && self <= kw::Dyn
1075 fn is_unused_keyword_2018(self) -> bool {
1079 /// Used for sanity checking rustdoc keyword sections.
1080 pub fn is_doc_keyword(self) -> bool {
1084 /// A keyword or reserved identifier that can be used as a path segment.
1085 pub fn is_path_segment_keyword(self) -> bool {
1087 || self == kw::SelfLower
1088 || self == kw::SelfUpper
1089 || self == kw::Crate
1090 || self == kw::PathRoot
1091 || self == kw::DollarCrate
1094 /// Returns `true` if the symbol is `true` or `false`.
1095 pub fn is_bool_lit(self) -> bool {
1096 self == kw::True || self == kw::False
1099 /// This symbol can be a raw identifier.
1100 pub fn can_be_raw(self) -> bool {
1101 self != kw::Invalid && self != kw::Underscore && !self.is_path_segment_keyword()
1106 // Returns `true` for reserved identifiers used internally for elided lifetimes,
1107 // unnamed method parameters, crate root module, error recovery etc.
1108 pub fn is_special(self) -> bool {
1109 self.name <= kw::Underscore
1112 /// Returns `true` if the token is a keyword used in the language.
1113 pub fn is_used_keyword(self) -> bool {
1114 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1115 self.name >= kw::As && self.name <= kw::While
1116 || self.name.is_used_keyword_2018() && self.span.rust_2018()
1119 /// Returns `true` if the token is a keyword reserved for possible future use.
1120 pub fn is_unused_keyword(self) -> bool {
1121 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1122 self.name >= kw::Abstract && self.name <= kw::Yield
1123 || self.name.is_unused_keyword_2018() && self.span.rust_2018()
1126 /// Returns `true` if the token is either a special identifier or a keyword.
1127 pub fn is_reserved(self) -> bool {
1128 self.is_special() || self.is_used_keyword() || self.is_unused_keyword()
1131 /// A keyword or reserved identifier that can be used as a path segment.
1132 pub fn is_path_segment_keyword(self) -> bool {
1133 self.name.is_path_segment_keyword()
1136 /// We see this identifier in a normal identifier position, like variable name or a type.
1137 /// How was it written originally? Did it use the raw form? Let's try to guess.
1138 pub fn is_raw_guess(self) -> bool {
1139 self.name.can_be_raw() && self.is_reserved()
1144 fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
1145 GLOBALS.with(|globals| f(&mut *globals.symbol_interner.lock()))
1148 /// An alternative to `Symbol`, useful when the chars within the symbol need to
1149 /// be accessed. It deliberately has limited functionality and should only be
1150 /// used for temporary values.
1152 /// Because the interner outlives any thread which uses this type, we can
1153 /// safely treat `string` which points to interner data, as an immortal string,
1154 /// as long as this type never crosses between threads.
1156 // FIXME: ensure that the interner outlives any thread which uses `SymbolStr`,
1157 // by creating a new thread right after constructing the interner.
1158 #[derive(Clone, Eq, PartialOrd, Ord)]
1159 pub struct SymbolStr {
1160 string: &'static str,
1163 // This impl allows a `SymbolStr` to be directly equated with a `String` or
1165 impl<T: std::ops::Deref<Target = str>> std::cmp::PartialEq<T> for SymbolStr {
1166 fn eq(&self, other: &T) -> bool {
1167 self.string == other.deref()
1171 impl !Send for SymbolStr {}
1172 impl !Sync for SymbolStr {}
1174 /// This impl means that if `ss` is a `SymbolStr`:
1175 /// - `*ss` is a `str`;
1176 /// - `&*ss` is a `&str`;
1177 /// - `&ss as &str` is a `&str`, which means that `&ss` can be passed to a
1178 /// function expecting a `&str`.
1179 impl std::ops::Deref for SymbolStr {
1182 fn deref(&self) -> &str {
1187 impl fmt::Debug for SymbolStr {
1188 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1189 fmt::Debug::fmt(self.string, f)
1193 impl fmt::Display for SymbolStr {
1194 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1195 fmt::Display::fmt(self.string, f)
1199 impl<CTX> HashStable<CTX> for SymbolStr {
1201 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1202 self.string.hash_stable(hcx, hasher)
1206 impl<CTX> ToStableHashKey<CTX> for SymbolStr {
1207 type KeyType = SymbolStr;
1210 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {