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 rustc_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.
100 MacroRules: "macro_rules",
105 // Symbols that can be referred to with rustc_span::sym::*. The symbol is
106 // the stringified identifier unless otherwise specified (e.g.
107 // `proc_dash_macro` represents "proc-macro").
109 // As well as the symbols listed, there are symbols for the the strings
110 // "0", "1", ..., "9", which are accessible via `sym::integer`.
112 aarch64_target_feature,
116 abi_msp430_interrupt,
128 advanced_slice_patterns,
140 allow_internal_unsafe,
141 allow_internal_unstable,
142 allow_internal_unstable_backcompat_hack,
146 arbitrary_enum_discriminant,
147 arbitrary_self_types,
156 associated_type_bounds,
157 associated_type_defaults,
166 augmented_assignments,
167 automatically_derived,
168 avx512_target_feature,
173 bind_by_move_pattern_guards,
177 borrowck_graphviz_format,
178 borrowck_graphviz_postflow,
179 borrowck_graphviz_preflow,
182 braced_empty_structs,
195 cfg_target_has_atomic,
196 cfg_target_thread_local,
205 closure_to_fn_coercion,
207 cmpxchg16b_target_feature,
214 conservative_impl_trait,
216 const_compare_raw_pointers,
225 const_in_array_repeat_expressions,
230 const_precise_live_drops,
232 const_raw_ptr_to_usize_cast,
234 const_trait_bound_opt_out,
249 crate_visibility_modifier,
257 custom_inner_attributes,
258 custom_test_frameworks,
267 default_lib_allocator,
268 default_type_parameter_fallback,
270 delay_span_bug_from_inside_query,
285 document_private_items,
286 dotdoteq_in_patterns,
287 dotdot_in_tuple_patterns,
288 double_braced_crate: "{{crate}}",
289 double_braced_impl: "{{impl}}",
290 double_braced_misc: "{{misc}}",
291 double_braced_closure: "{{closure}}",
292 double_braced_constructor: "{{constructor}}",
293 double_braced_constant: "{{constant}}",
294 double_braced_opaque: "{{opaque}}",
296 dropck_parametricity,
311 exclusive_range_pattern,
312 exhaustive_integer_patterns,
318 extern_absolute_paths,
320 extern_crate_item_prelude,
333 field_init_shorthand,
358 generic_associated_types,
364 half_open_range_patterns,
369 hexagon_target_feature,
371 homogeneous_aggregate,
385 if_while_or_patterns,
389 impl_header_lifetime_elision,
391 impl_trait_in_bindings,
399 inclusive_range_syntax,
400 infer_outlives_requirements,
401 infer_static_outlives_requirements,
408 irrefutable_let_patterns,
411 issue_5723_bootstrap,
412 issue_tracker_base_url,
414 item_context: "ItemContext",
434 link_llvm_intrinsics,
445 macro_at_most_once_rep,
448 macro_lifetime_matcher,
449 macro_literal_matcher,
459 match_beginning_vert,
460 match_default_bindings,
481 movbe_target_feature,
523 object_safe_for_dispatch,
526 omit_gdb_pretty_printer_section,
533 optin_builtin_traits,
545 overlapping_marker_traits,
550 panic_implementation,
571 powerpc_target_feature,
572 precise_pointer_size_matching,
578 proc_dash_macro: "proc-macro",
580 proc_macro_attribute,
586 proc_macro_internals,
588 proc_macro_non_items,
589 proc_macro_path_invoc,
597 quad_precision_float,
614 reexport_test_harness_main,
627 re_rebalance_coherence,
632 riscv_target_feature,
646 rustc_allocator_nounwind,
647 rustc_allow_const_fn_ptr,
648 rustc_args_required_const,
652 rustc_const_unstable,
654 rustc_conversion_suggestion,
657 rustc_diagnostic_item,
658 rustc_diagnostic_macros,
661 rustc_dump_env_program_clauses,
662 rustc_dump_program_clauses,
663 rustc_dump_user_substs,
665 rustc_expected_cgu_reuse,
666 rustc_if_this_changed,
667 rustc_inherit_overflow_checks,
669 rustc_layout_scalar_valid_range_end,
670 rustc_layout_scalar_valid_range_start,
671 rustc_macro_transparency,
673 rustc_nonnull_optimization_guaranteed,
674 rustc_object_lifetime_default,
675 rustc_on_unimplemented,
678 rustc_partition_codegened,
679 rustc_partition_reused,
681 rustc_peek_definite_init,
683 rustc_peek_maybe_init,
684 rustc_peek_maybe_uninit,
685 rustc_peek_indirectly_mutable,
687 rustc_proc_macro_decls,
690 rustc_unsafe_specialization_marker,
691 rustc_specialization_trait,
693 rustc_std_internal_symbol,
696 rustc_reservation_impl,
698 rustc_then_this_would_need,
703 rvalue_static_promotion,
726 sse4a_target_feature,
739 stmt_expr_attributes,
741 struct_field_attributes,
753 target_has_atomic_load_store,
759 termination_trait_test,
762 test_accepted_feature,
764 test_removed_feature,
787 type_alias_impl_trait,
792 type_alias_enum_variants,
809 underscore_const_names,
811 underscore_lifetimes,
813 universal_impl_trait,
816 unrestricted_attribute_tokens,
817 unsafe_block_in_unsafe_fn,
820 unsized_tuple_coercion,
838 visible_private_types,
853 #[derive(Copy, Clone, Eq, HashStable_Generic)]
861 /// Constructs a new identifier from a symbol and a span.
862 pub const fn new(name: Symbol, span: Span) -> Ident {
866 /// Constructs a new identifier with a dummy span.
868 pub const fn with_dummy_span(name: Symbol) -> Ident {
869 Ident::new(name, DUMMY_SP)
873 pub fn invalid() -> Ident {
874 Ident::with_dummy_span(kw::Invalid)
877 /// Maps a string to an identifier with a dummy span.
878 pub fn from_str(string: &str) -> Ident {
879 Ident::with_dummy_span(Symbol::intern(string))
882 /// Maps a string and a span to an identifier.
883 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
884 Ident::new(Symbol::intern(string), span)
887 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
888 pub fn with_span_pos(self, span: Span) -> Ident {
889 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
892 pub fn without_first_quote(self) -> Ident {
893 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
896 /// "Normalize" ident for use in comparisons using "item hygiene".
897 /// Identifiers with same string value become same if they came from the same macro 2.0 macro
898 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
899 /// different macro 2.0 macros.
900 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
901 pub fn normalize_to_macros_2_0(self) -> Ident {
902 Ident::new(self.name, self.span.normalize_to_macros_2_0())
905 /// "Normalize" ident for use in comparisons using "local variable hygiene".
906 /// Identifiers with same string value become same if they came from the same non-transparent
907 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
908 /// non-transparent macros.
909 /// Technically, this operation strips all transparent marks from ident's syntactic context.
910 pub fn normalize_to_macro_rules(self) -> Ident {
911 Ident::new(self.name, self.span.normalize_to_macro_rules())
914 /// Convert the name to a `SymbolStr`. This is a slowish operation because
915 /// it requires locking the symbol interner.
916 pub fn as_str(self) -> SymbolStr {
921 impl PartialEq for Ident {
922 fn eq(&self, rhs: &Self) -> bool {
923 self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
927 impl Hash for Ident {
928 fn hash<H: Hasher>(&self, state: &mut H) {
929 self.name.hash(state);
930 self.span.ctxt().hash(state);
934 impl fmt::Debug for Ident {
935 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
936 fmt::Display::fmt(self, f)?;
937 fmt::Debug::fmt(&self.span.ctxt(), f)
941 /// This implementation is supposed to be used in error messages, so it's expected to be identical
942 /// to printing the original identifier token written in source code (`token_to_string`),
943 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
944 impl fmt::Display for Ident {
945 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
946 fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
950 impl UseSpecializedEncodable for Ident {
951 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
952 s.emit_struct("Ident", 2, |s| {
953 s.emit_struct_field("name", 0, |s| self.name.encode(s))?;
954 s.emit_struct_field("span", 1, |s| self.span.encode(s))
959 impl UseSpecializedDecodable for Ident {
960 fn default_decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error> {
961 d.read_struct("Ident", 2, |d| {
963 name: d.read_struct_field("name", 0, Decodable::decode)?,
964 span: d.read_struct_field("span", 1, Decodable::decode)?,
970 /// This is the most general way to print identifiers.
971 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
972 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
973 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
974 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
975 /// hygiene data, most importantly name of the crate it refers to.
976 /// As a result we print `$crate` as `crate` if it refers to the local crate
977 /// and as `::other_crate_name` if it refers to some other crate.
978 /// Note, that this is only done if the ident token is printed from inside of AST pretty-pringing,
979 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
980 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
981 /// done for a token stream or a single token.
982 pub struct IdentPrinter {
985 /// Span used for retrieving the crate name to which `$crate` refers to,
986 /// if this field is `None` then the `$crate` conversion doesn't happen.
987 convert_dollar_crate: Option<Span>,
991 /// The most general `IdentPrinter` constructor. Do not use this.
992 pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
993 IdentPrinter { symbol, is_raw, convert_dollar_crate }
996 /// This implementation is supposed to be used when printing identifiers
997 /// as a part of pretty-printing for larger AST pieces.
998 /// Do not use this either.
999 pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1000 IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1004 impl fmt::Display for IdentPrinter {
1005 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1009 if self.symbol == kw::DollarCrate {
1010 if let Some(span) = self.convert_dollar_crate {
1011 let converted = span.ctxt().dollar_crate_name();
1012 if !converted.is_path_segment_keyword() {
1015 return fmt::Display::fmt(&converted, f);
1019 fmt::Display::fmt(&self.symbol, f)
1023 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1025 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1026 // `ModernIdent` struct and use that as well.
1027 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1028 pub struct MacroRulesNormalizedIdent(Ident);
1030 impl MacroRulesNormalizedIdent {
1031 pub fn new(ident: Ident) -> Self {
1032 Self(ident.normalize_to_macro_rules())
1036 impl fmt::Debug for MacroRulesNormalizedIdent {
1037 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1038 fmt::Debug::fmt(&self.0, f)
1042 impl fmt::Display for MacroRulesNormalizedIdent {
1043 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1044 fmt::Display::fmt(&self.0, f)
1048 /// An interned string.
1050 /// Internally, a `Symbol` is implemented as an index, and all operations
1051 /// (including hashing, equality, and ordering) operate on that index. The use
1052 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1053 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1055 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1056 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1057 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1058 pub struct Symbol(SymbolIndex);
1060 rustc_index::newtype_index! {
1061 pub struct SymbolIndex { .. }
1065 const fn new(n: u32) -> Self {
1066 Symbol(SymbolIndex::from_u32(n))
1069 /// Maps a string to its interned representation.
1070 pub fn intern(string: &str) -> Self {
1071 with_interner(|interner| interner.intern(string))
1074 /// Access the symbol's chars. This is a slowish operation because it
1075 /// requires locking the symbol interner.
1076 pub fn with<F: FnOnce(&str) -> R, R>(self, f: F) -> R {
1077 with_interner(|interner| f(interner.get(self)))
1080 /// Convert to a `SymbolStr`. This is a slowish operation because it
1081 /// requires locking the symbol interner.
1082 pub fn as_str(self) -> SymbolStr {
1083 with_interner(|interner| unsafe {
1084 SymbolStr { string: std::mem::transmute::<&str, &str>(interner.get(self)) }
1088 pub fn as_u32(self) -> u32 {
1092 /// This method is supposed to be used in error messages, so it's expected to be
1093 /// identical to printing the original identifier token written in source code
1094 /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1095 /// or edition, so we have to guess the rawness using the global edition.
1096 pub fn to_ident_string(self) -> String {
1097 Ident::with_dummy_span(self).to_string()
1101 impl fmt::Debug for Symbol {
1102 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1103 self.with(|str| fmt::Debug::fmt(&str, f))
1107 impl fmt::Display for Symbol {
1108 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1109 self.with(|str| fmt::Display::fmt(&str, f))
1113 impl Encodable for Symbol {
1114 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1115 self.with(|string| s.emit_str(string))
1119 impl Decodable for Symbol {
1121 fn decode<D: Decoder>(d: &mut D) -> Result<Symbol, D::Error> {
1122 Ok(Symbol::intern(&d.read_str()?))
1126 impl<CTX> HashStable<CTX> for Symbol {
1128 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1129 self.as_str().hash_stable(hcx, hasher);
1133 impl<CTX> ToStableHashKey<CTX> for Symbol {
1134 type KeyType = SymbolStr;
1137 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {
1142 // The `&'static str`s in this type actually point into the arena.
1144 pub struct Interner {
1145 arena: DroplessArena,
1146 names: FxHashMap<&'static str, Symbol>,
1147 strings: Vec<&'static str>,
1151 fn prefill(init: &[&'static str]) -> Self {
1153 strings: init.into(),
1154 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1155 ..Default::default()
1160 pub fn intern(&mut self, string: &str) -> Symbol {
1161 if let Some(&name) = self.names.get(string) {
1165 let name = Symbol::new(self.strings.len() as u32);
1167 // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
1170 unsafe { str::from_utf8_unchecked(self.arena.alloc_slice(string.as_bytes())) };
1171 // It is safe to extend the arena allocation to `'static` because we only access
1172 // these while the arena is still alive.
1173 let string: &'static str = unsafe { &*(string as *const str) };
1174 self.strings.push(string);
1175 self.names.insert(string, name);
1179 // Get the symbol as a string. `Symbol::as_str()` should be used in
1180 // preference to this function.
1181 pub fn get(&self, symbol: Symbol) -> &str {
1182 self.strings[symbol.0.as_usize()]
1186 // This module has a very short name because it's used a lot.
1187 /// This module contains all the defined keyword `Symbol`s.
1189 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1190 /// For example `kw::Loop` or `kw::Break`.
1196 // This module has a very short name because it's used a lot.
1197 /// This module contains all the defined non-keyword `Symbol`s.
1199 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1200 /// For example `sym::rustfmt` or `sym::u8`.
1201 #[allow(rustc::default_hash_types)]
1204 use std::convert::TryInto;
1208 // Used from a macro in `librustc_feature/accepted.rs`
1209 pub use super::kw::MacroRules as macro_rules;
1211 // Get the symbol for an integer. The first few non-negative integers each
1212 // have a static symbol and therefore are fast.
1213 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1214 if let Result::Ok(idx) = n.try_into() {
1215 if let Option::Some(&sym_) = digits_array.get(idx) {
1219 Symbol::intern(&n.to_string())
1224 fn is_used_keyword_2018(self) -> bool {
1225 self >= kw::Async && self <= kw::Dyn
1228 fn is_unused_keyword_2018(self) -> bool {
1232 /// Used for sanity checking rustdoc keyword sections.
1233 pub fn is_doc_keyword(self) -> bool {
1237 /// A keyword or reserved identifier that can be used as a path segment.
1238 pub fn is_path_segment_keyword(self) -> bool {
1240 || self == kw::SelfLower
1241 || self == kw::SelfUpper
1242 || self == kw::Crate
1243 || self == kw::PathRoot
1244 || self == kw::DollarCrate
1247 /// Returns `true` if the symbol is `true` or `false`.
1248 pub fn is_bool_lit(self) -> bool {
1249 self == kw::True || self == kw::False
1252 /// This symbol can be a raw identifier.
1253 pub fn can_be_raw(self) -> bool {
1254 self != kw::Invalid && self != kw::Underscore && !self.is_path_segment_keyword()
1259 // Returns `true` for reserved identifiers used internally for elided lifetimes,
1260 // unnamed method parameters, crate root module, error recovery etc.
1261 pub fn is_special(self) -> bool {
1262 self.name <= kw::Underscore
1265 /// Returns `true` if the token is a keyword used in the language.
1266 pub fn is_used_keyword(self) -> bool {
1267 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1268 self.name >= kw::As && self.name <= kw::While
1269 || self.name.is_used_keyword_2018() && self.span.rust_2018()
1272 /// Returns `true` if the token is a keyword reserved for possible future use.
1273 pub fn is_unused_keyword(self) -> bool {
1274 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1275 self.name >= kw::Abstract && self.name <= kw::Yield
1276 || self.name.is_unused_keyword_2018() && self.span.rust_2018()
1279 /// Returns `true` if the token is either a special identifier or a keyword.
1280 pub fn is_reserved(self) -> bool {
1281 self.is_special() || self.is_used_keyword() || self.is_unused_keyword()
1284 /// A keyword or reserved identifier that can be used as a path segment.
1285 pub fn is_path_segment_keyword(self) -> bool {
1286 self.name.is_path_segment_keyword()
1289 /// We see this identifier in a normal identifier position, like variable name or a type.
1290 /// How was it written originally? Did it use the raw form? Let's try to guess.
1291 pub fn is_raw_guess(self) -> bool {
1292 self.name.can_be_raw() && self.is_reserved()
1297 fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
1298 GLOBALS.with(|globals| f(&mut *globals.symbol_interner.lock()))
1301 /// An alternative to `Symbol`, useful when the chars within the symbol need to
1302 /// be accessed. It deliberately has limited functionality and should only be
1303 /// used for temporary values.
1305 /// Because the interner outlives any thread which uses this type, we can
1306 /// safely treat `string` which points to interner data, as an immortal string,
1307 /// as long as this type never crosses between threads.
1309 // FIXME: ensure that the interner outlives any thread which uses `SymbolStr`,
1310 // by creating a new thread right after constructing the interner.
1311 #[derive(Clone, Eq, PartialOrd, Ord)]
1312 pub struct SymbolStr {
1313 string: &'static str,
1316 // This impl allows a `SymbolStr` to be directly equated with a `String` or
1318 impl<T: std::ops::Deref<Target = str>> std::cmp::PartialEq<T> for SymbolStr {
1319 fn eq(&self, other: &T) -> bool {
1320 self.string == other.deref()
1324 impl !Send for SymbolStr {}
1325 impl !Sync for SymbolStr {}
1327 /// This impl means that if `ss` is a `SymbolStr`:
1328 /// - `*ss` is a `str`;
1329 /// - `&*ss` is a `&str`;
1330 /// - `&ss as &str` is a `&str`, which means that `&ss` can be passed to a
1331 /// function expecting a `&str`.
1332 impl std::ops::Deref for SymbolStr {
1335 fn deref(&self) -> &str {
1340 impl fmt::Debug for SymbolStr {
1341 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1342 fmt::Debug::fmt(self.string, f)
1346 impl fmt::Display for SymbolStr {
1347 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1348 fmt::Display::fmt(self.string, f)
1352 impl<CTX> HashStable<CTX> for SymbolStr {
1354 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1355 self.string.hash_stable(hcx, hasher)
1359 impl<CTX> ToStableHashKey<CTX> for SymbolStr {
1360 type KeyType = SymbolStr;
1363 fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {