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_data_structures::sync::Lock;
9 use rustc_macros::HashStable_Generic;
10 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
12 use std::cmp::{Ord, PartialEq, PartialOrd};
14 use std::hash::{Hash, Hasher};
17 use crate::{with_session_globals, Edition, Span, DUMMY_SP};
22 // The proc macro code for this is in `compiler/rustc_macros/src/symbols.rs`.
24 // After modifying this list adjust `is_special`, `is_used_keyword`/`is_unused_keyword`,
25 // this should be rarely necessary though if the keywords are kept in alphabetic order.
27 // Special reserved identifiers used internally for elided lifetimes,
28 // unnamed method parameters, crate root module, error recovery etc.
31 DollarCrate: "$crate",
34 // Keywords that are used in stable Rust.
71 // Keywords that are used in unstable Rust or reserved for future use.
85 // Edition-specific keywords that are used in stable Rust.
86 Async: "async", // >= 2018 Edition only
87 Await: "await", // >= 2018 Edition only
88 Dyn: "dyn", // >= 2018 Edition only
90 // Edition-specific keywords that are used in unstable Rust or reserved for future use.
91 Try: "try", // >= 2018 Edition only
93 // Special lifetime names
94 UnderscoreLifetime: "'_",
95 StaticLifetime: "'static",
97 // Weak keywords, have special meaning only in specific contexts.
101 MacroRules: "macro_rules",
107 // Pre-interned symbols that can be referred to with `rustc_span::sym::*`.
109 // The symbol is the stringified identifier unless otherwise specified, in
110 // which case the name should mention the non-identifier punctuation.
111 // E.g. `sym::proc_dash_macro` represents "proc-macro", and it shouldn't be
112 // called `sym::proc_macro` because then it's easy to mistakenly think it
113 // represents "proc_macro".
115 // As well as the symbols listed, there are symbols for the strings
116 // "0", "1", ..., "9", which are accessible via `sym::integer`.
118 // The proc macro will abort if symbols are not in alphabetical order (as
119 // defined by `impl Ord for str`) or if any symbols are duplicated. Vim
120 // users can sort the list by selecting it and executing the command
121 // `:'<,'>!LC_ALL=C sort`.
123 // There is currently no checking that all symbols are used; that would be
245 ProceduralMasqueradeDummyType,
270 SubdiagnosticMessage,
300 aarch64_target_feature,
301 aarch64_ver_target_feature,
305 abi_c_cmse_nonsecure_call,
307 abi_msp430_interrupt,
321 advanced_slice_patterns,
337 allow_internal_unsafe,
338 allow_internal_unstable,
344 anonymous_lifetime_in_impl_trait,
347 arbitrary_enum_discriminant,
348 arbitrary_self_types,
360 asm_experimental_arch,
368 assert_receiver_is_total_eq,
372 associated_const_equality,
374 associated_type_bounds,
375 associated_type_defaults,
388 augmented_assignments,
390 automatically_derived,
392 avx512_target_feature,
400 bind_by_move_pattern_guards,
412 borrowck_graphviz_format,
413 borrowck_graphviz_postflow,
414 borrowck_graphviz_preflow,
419 braced_empty_structs,
431 capture_disjoint_fields,
448 cfg_target_has_atomic,
449 cfg_target_has_atomic_equal_alignment,
450 cfg_target_has_atomic_load_store,
451 cfg_target_thread_local,
463 closure_lifetime_binder,
464 closure_to_fn_coercion,
465 closure_track_caller,
469 cmpxchg16b_target_feature,
470 cmse_nonsecure_entry,
477 compare_exchange_weak,
487 conservative_impl_trait,
491 const_compare_raw_pointers,
496 const_eval_select_ct,
497 const_evaluatable_checked,
500 const_fn_floating_point_arithmetic,
501 const_fn_fn_ptr_basics,
502 const_fn_trait_bound,
508 const_generic_defaults,
510 const_generics_defaults,
513 const_in_array_repeat_expressions,
520 const_precise_live_drops,
522 const_raw_ptr_to_usize_cast,
525 const_trait_bound_opt_out,
542 core_panic_2015_macro,
553 crate_visibility_modifier,
554 crt_dash_static: "crt-static",
563 custom_inner_attributes,
564 custom_test_frameworks,
571 debug_assert_eq_macro,
573 debug_assert_ne_macro,
576 debug_struct_fields_finish,
579 debug_tuple_fields_finish,
584 default_alloc_error_handler,
585 default_lib_allocator,
586 default_method_body_is_const,
587 default_type_parameter_fallback,
589 delay_span_bug_from_inside_query,
593 deprecated_suggestion,
601 destructuring_assignment,
622 document_private_items,
624 dotdot_in_tuple_patterns,
625 dotdoteq_in_patterns,
633 dropck_parametricity,
644 emit_enum_variant_arg,
656 ermsb_target_feature,
660 exclusive_range_pattern,
661 exhaustive_integer_patterns,
670 explicit_generic_args_with_impl_trait,
673 extended_key_value_attributes,
674 extern_absolute_paths,
675 extern_crate_item_prelude,
698 field_init_shorthand,
705 float_to_int_unchecked,
738 from_size_align_unchecked,
755 generic_associated_types,
756 generic_associated_types_extended,
764 half_open_range_patterns,
766 hexagon_target_feature,
768 homogeneous_aggregate,
785 if_while_or_patterns,
787 impl_header_lifetime_elision,
790 impl_trait_in_bindings,
801 inclusive_range_syntax,
804 infer_outlives_requirements,
805 infer_static_outlives_requirements,
806 inherent_associated_types,
820 irrefutable_let_patterns,
824 issue_5723_bootstrap,
825 issue_tracker_base_url,
840 lazy_normalization_consts,
855 link_llvm_intrinsics,
876 macro_at_most_once_rep,
877 macro_attributes_in_derive_output,
880 macro_lifetime_matcher,
881 macro_literal_matcher,
894 match_beginning_vert,
895 match_default_bindings,
925 min_type_alias_impl_trait,
936 more_qualified_paths,
938 movbe_target_feature,
950 native_link_modifiers,
951 native_link_modifiers_as_needed,
952 native_link_modifiers_bundle,
953 native_link_modifiers_verbatim,
954 native_link_modifiers_whole_archive,
992 non_exhaustive_omitted_patterns_lint,
1004 object_safe_for_dispatch,
1007 omit_gdb_pretty_printer_section,
1016 optin_builtin_traits,
1025 overlapping_marker_traits,
1037 panic_implementation,
1052 pattern_parentheses,
1055 platform_intrinsics,
1064 post_dash_lto: "post-lto",
1065 powerpc_target_feature,
1070 pre_dash_lto: "pre-lto",
1071 precise_pointer_size_matching,
1075 prefetch_read_instruction,
1076 prefetch_write_data,
1077 prefetch_write_instruction,
1085 proc_dash_macro: "proc-macro",
1087 proc_macro_attribute,
1088 proc_macro_def_site,
1093 proc_macro_internals,
1095 proc_macro_non_items,
1096 proc_macro_path_invoc,
1105 ptr_offset_from_unsigned,
1113 quad_precision_float,
1116 range_inclusive_new,
1121 re_rebalance_coherence,
1124 read_enum_variant_arg,
1132 reexport_test_harness_main,
1133 ref_unwind_safe_trait,
1150 relaxed_struct_unsize,
1165 riscv_target_feature,
1184 rust_eh_catch_typeinfo,
1185 rust_eh_personality,
1186 rust_eh_register_frames,
1187 rust_eh_unregister_frames,
1191 rustc_allocator_nounwind,
1192 rustc_allow_const_fn_unstable,
1193 rustc_allow_incoherent_impl,
1196 rustc_builtin_macro,
1197 rustc_capture_analysis,
1199 rustc_coherence_is_core,
1201 rustc_const_unstable,
1202 rustc_conversion_suggestion,
1204 rustc_diagnostic_item,
1205 rustc_diagnostic_macros,
1207 rustc_do_not_const_check,
1209 rustc_dump_env_program_clauses,
1210 rustc_dump_program_clauses,
1211 rustc_dump_user_substs,
1214 rustc_evaluate_where_clauses,
1215 rustc_expected_cgu_reuse,
1216 rustc_has_incoherent_inherent_impls,
1217 rustc_if_this_changed,
1218 rustc_inherit_overflow_checks,
1219 rustc_insignificant_dtor,
1221 rustc_layout_scalar_valid_range_end,
1222 rustc_layout_scalar_valid_range_start,
1223 rustc_legacy_const_generics,
1224 rustc_lint_diagnostics,
1225 rustc_lint_query_instability,
1226 rustc_macro_transparency,
1229 rustc_must_implement_one_of,
1230 rustc_nonnull_optimization_guaranteed,
1231 rustc_object_lifetime_default,
1232 rustc_on_unimplemented,
1235 rustc_partition_codegened,
1236 rustc_partition_reused,
1237 rustc_pass_by_value,
1239 rustc_peek_definite_init,
1240 rustc_peek_liveness,
1241 rustc_peek_maybe_init,
1242 rustc_peek_maybe_uninit,
1243 rustc_polymorphize_error,
1245 rustc_proc_macro_decls,
1248 rustc_reservation_impl,
1250 rustc_skip_array_during_method_dispatch,
1251 rustc_specialization_trait,
1253 rustc_std_internal_symbol,
1254 rustc_strict_coherence,
1257 rustc_then_this_would_need,
1258 rustc_trivial_field_reads,
1259 rustc_unsafe_specialization_marker,
1264 rvalue_static_promotion,
1315 simd_reduce_add_ordered,
1316 simd_reduce_add_unordered,
1321 simd_reduce_max_nanless,
1323 simd_reduce_min_nanless,
1324 simd_reduce_mul_ordered,
1325 simd_reduce_mul_unordered,
1330 simd_saturating_add,
1331 simd_saturating_sub,
1334 simd_select_bitmask,
1362 sse4a_target_feature,
1374 std_panic_2015_macro,
1377 stmt_expr_attributes,
1378 stop_after_dataflow,
1381 str_split_whitespace,
1388 struct_field_attributes,
1411 target_has_atomic_equal_alignment,
1412 target_has_atomic_load_store,
1414 target_pointer_width,
1415 target_target_vendor,
1416 target_thread_local,
1422 termination_trait_test,
1425 test_accepted_feature,
1427 test_removed_feature,
1435 thumb_mode: "thumb-mode",
1463 type_alias_enum_variants,
1464 type_alias_impl_trait,
1466 type_changing_struct_update,
1476 unaligned_volatile_load,
1477 unaligned_volatile_store,
1486 underscore_const_names,
1488 underscore_lifetimes,
1490 unimplemented_macro,
1492 universal_impl_trait,
1499 unreachable_2015_macro,
1501 unreachable_2021_macro,
1503 unreachable_display,
1505 unrestricted_attribute_tokens,
1506 unsafe_block_in_unsafe_fn,
1508 unsafe_no_drop_flag,
1509 unsafe_pin_internals,
1513 unsized_tuple_coercion,
1517 unused_qualifications,
1544 visible_private_types,
1546 volatile_copy_memory,
1547 volatile_copy_nonoverlapping_memory,
1549 volatile_set_memory,
1556 wasm_target_feature,
1561 with_negative_coherence,
1573 yeet_desugar_details,
1580 #[derive(Copy, Clone, Eq, HashStable_Generic, Encodable, Decodable)]
1588 /// Constructs a new identifier from a symbol and a span.
1589 pub const fn new(name: Symbol, span: Span) -> Ident {
1590 Ident { name, span }
1593 /// Constructs a new identifier with a dummy span.
1595 pub const fn with_dummy_span(name: Symbol) -> Ident {
1596 Ident::new(name, DUMMY_SP)
1600 pub fn empty() -> Ident {
1601 Ident::with_dummy_span(kw::Empty)
1604 /// Maps a string to an identifier with a dummy span.
1605 pub fn from_str(string: &str) -> Ident {
1606 Ident::with_dummy_span(Symbol::intern(string))
1609 /// Maps a string and a span to an identifier.
1610 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
1611 Ident::new(Symbol::intern(string), span)
1614 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
1615 pub fn with_span_pos(self, span: Span) -> Ident {
1616 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
1619 pub fn without_first_quote(self) -> Ident {
1620 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
1623 /// "Normalize" ident for use in comparisons using "item hygiene".
1624 /// Identifiers with same string value become same if they came from the same macro 2.0 macro
1625 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
1626 /// different macro 2.0 macros.
1627 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
1628 pub fn normalize_to_macros_2_0(self) -> Ident {
1629 Ident::new(self.name, self.span.normalize_to_macros_2_0())
1632 /// "Normalize" ident for use in comparisons using "local variable hygiene".
1633 /// Identifiers with same string value become same if they came from the same non-transparent
1634 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
1635 /// non-transparent macros.
1636 /// Technically, this operation strips all transparent marks from ident's syntactic context.
1637 pub fn normalize_to_macro_rules(self) -> Ident {
1638 Ident::new(self.name, self.span.normalize_to_macro_rules())
1641 /// Access the underlying string. This is a slowish operation because it
1642 /// requires locking the symbol interner.
1644 /// Note that the lifetime of the return value is a lie. See
1645 /// `Symbol::as_str()` for details.
1646 pub fn as_str(&self) -> &str {
1651 impl PartialEq for Ident {
1652 fn eq(&self, rhs: &Self) -> bool {
1653 self.name == rhs.name && self.span.eq_ctxt(rhs.span)
1657 impl Hash for Ident {
1658 fn hash<H: Hasher>(&self, state: &mut H) {
1659 self.name.hash(state);
1660 self.span.ctxt().hash(state);
1664 impl fmt::Debug for Ident {
1665 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1666 fmt::Display::fmt(self, f)?;
1667 fmt::Debug::fmt(&self.span.ctxt(), f)
1671 /// This implementation is supposed to be used in error messages, so it's expected to be identical
1672 /// to printing the original identifier token written in source code (`token_to_string`),
1673 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
1674 impl fmt::Display for Ident {
1675 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1676 fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
1680 /// This is the most general way to print identifiers.
1681 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
1682 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
1683 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
1684 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
1685 /// hygiene data, most importantly name of the crate it refers to.
1686 /// As a result we print `$crate` as `crate` if it refers to the local crate
1687 /// and as `::other_crate_name` if it refers to some other crate.
1688 /// Note, that this is only done if the ident token is printed from inside of AST pretty-printing,
1689 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
1690 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
1691 /// done for a token stream or a single token.
1692 pub struct IdentPrinter {
1695 /// Span used for retrieving the crate name to which `$crate` refers to,
1696 /// if this field is `None` then the `$crate` conversion doesn't happen.
1697 convert_dollar_crate: Option<Span>,
1701 /// The most general `IdentPrinter` constructor. Do not use this.
1702 pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
1703 IdentPrinter { symbol, is_raw, convert_dollar_crate }
1706 /// This implementation is supposed to be used when printing identifiers
1707 /// as a part of pretty-printing for larger AST pieces.
1708 /// Do not use this either.
1709 pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1710 IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1714 impl fmt::Display for IdentPrinter {
1715 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1718 } else if self.symbol == kw::DollarCrate {
1719 if let Some(span) = self.convert_dollar_crate {
1720 let converted = span.ctxt().dollar_crate_name();
1721 if !converted.is_path_segment_keyword() {
1724 return fmt::Display::fmt(&converted, f);
1727 fmt::Display::fmt(&self.symbol, f)
1731 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1733 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1734 // `ModernIdent` struct and use that as well.
1735 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1736 pub struct MacroRulesNormalizedIdent(Ident);
1738 impl MacroRulesNormalizedIdent {
1739 pub fn new(ident: Ident) -> Self {
1740 Self(ident.normalize_to_macro_rules())
1744 impl fmt::Debug for MacroRulesNormalizedIdent {
1745 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1746 fmt::Debug::fmt(&self.0, f)
1750 impl fmt::Display for MacroRulesNormalizedIdent {
1751 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1752 fmt::Display::fmt(&self.0, f)
1756 /// An interned string.
1758 /// Internally, a `Symbol` is implemented as an index, and all operations
1759 /// (including hashing, equality, and ordering) operate on that index. The use
1760 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1761 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1763 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1764 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1765 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1766 pub struct Symbol(SymbolIndex);
1768 rustc_index::newtype_index! {
1769 struct SymbolIndex { .. }
1773 const fn new(n: u32) -> Self {
1774 Symbol(SymbolIndex::from_u32(n))
1777 /// Maps a string to its interned representation.
1778 pub fn intern(string: &str) -> Self {
1779 with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
1782 /// Access the underlying string. This is a slowish operation because it
1783 /// requires locking the symbol interner.
1785 /// Note that the lifetime of the return value is a lie. It's not the same
1786 /// as `&self`, but actually tied to the lifetime of the underlying
1787 /// interner. Interners are long-lived, and there are very few of them, and
1788 /// this function is typically used for short-lived things, so in practice
1789 /// it works out ok.
1790 pub fn as_str(&self) -> &str {
1791 with_session_globals(|session_globals| unsafe {
1792 std::mem::transmute::<&str, &str>(session_globals.symbol_interner.get(*self))
1796 pub fn as_u32(self) -> u32 {
1800 pub fn is_empty(self) -> bool {
1804 /// This method is supposed to be used in error messages, so it's expected to be
1805 /// identical to printing the original identifier token written in source code
1806 /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1807 /// or edition, so we have to guess the rawness using the global edition.
1808 pub fn to_ident_string(self) -> String {
1809 Ident::with_dummy_span(self).to_string()
1813 impl fmt::Debug for Symbol {
1814 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1815 fmt::Debug::fmt(self.as_str(), f)
1819 impl fmt::Display for Symbol {
1820 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1821 fmt::Display::fmt(self.as_str(), f)
1825 impl<S: Encoder> Encodable<S> for Symbol {
1826 fn encode(&self, s: &mut S) {
1827 s.emit_str(self.as_str());
1831 impl<D: Decoder> Decodable<D> for Symbol {
1833 fn decode(d: &mut D) -> Symbol {
1834 Symbol::intern(&d.read_str())
1838 impl<CTX> HashStable<CTX> for Symbol {
1840 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1841 self.as_str().hash_stable(hcx, hasher);
1845 impl<CTX> ToStableHashKey<CTX> for Symbol {
1846 type KeyType = String;
1848 fn to_stable_hash_key(&self, _: &CTX) -> String {
1849 self.as_str().to_string()
1854 pub(crate) struct Interner(Lock<InternerInner>);
1856 // The `&'static str`s in this type actually point into the arena.
1858 // The `FxHashMap`+`Vec` pair could be replaced by `FxIndexSet`, but #75278
1859 // found that to regress performance up to 2% in some cases. This might be
1860 // revisited after further improvements to `indexmap`.
1862 // This type is private to prevent accidentally constructing more than one
1863 // `Interner` on the same thread, which makes it easy to mix up `Symbol`s
1864 // between `Interner`s.
1866 struct InternerInner {
1867 arena: DroplessArena,
1868 names: FxHashMap<&'static str, Symbol>,
1869 strings: Vec<&'static str>,
1873 fn prefill(init: &[&'static str]) -> Self {
1874 Interner(Lock::new(InternerInner {
1875 strings: init.into(),
1876 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1877 ..Default::default()
1882 fn intern(&self, string: &str) -> Symbol {
1883 let mut inner = self.0.lock();
1884 if let Some(&name) = inner.names.get(string) {
1888 let name = Symbol::new(inner.strings.len() as u32);
1890 // SAFETY: we convert from `&str` to `&[u8]`, clone it into the arena,
1891 // and immediately convert the clone back to `&[u8], all because there
1892 // is no `inner.arena.alloc_str()` method. This is clearly safe.
1894 unsafe { str::from_utf8_unchecked(inner.arena.alloc_slice(string.as_bytes())) };
1896 // SAFETY: we can extend the arena allocation to `'static` because we
1897 // only access these while the arena is still alive.
1898 let string: &'static str = unsafe { &*(string as *const str) };
1899 inner.strings.push(string);
1901 // This second hash table lookup can be avoided by using `RawEntryMut`,
1902 // but this code path isn't hot enough for it to be worth it. See
1903 // #91445 for details.
1904 inner.names.insert(string, name);
1908 // Get the symbol as a string. `Symbol::as_str()` should be used in
1909 // preference to this function.
1910 fn get(&self, symbol: Symbol) -> &str {
1911 self.0.lock().strings[symbol.0.as_usize()]
1915 // This module has a very short name because it's used a lot.
1916 /// This module contains all the defined keyword `Symbol`s.
1918 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1919 /// For example `kw::Loop` or `kw::Break`.
1921 pub use super::kw_generated::*;
1924 // This module has a very short name because it's used a lot.
1925 /// This module contains all the defined non-keyword `Symbol`s.
1927 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1928 /// For example `sym::rustfmt` or `sym::u8`.
1931 use std::convert::TryInto;
1934 pub use super::sym_generated::*;
1936 // Used from a macro in `librustc_feature/accepted.rs`
1937 pub use super::kw::MacroRules as macro_rules;
1939 /// Get the symbol for an integer.
1941 /// The first few non-negative integers each have a static symbol and therefore
1943 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1944 if let Result::Ok(idx) = n.try_into() {
1946 return Symbol::new(super::SYMBOL_DIGITS_BASE + idx as u32);
1949 Symbol::intern(&n.to_string())
1954 fn is_special(self) -> bool {
1955 self <= kw::Underscore
1958 fn is_used_keyword_always(self) -> bool {
1959 self >= kw::As && self <= kw::While
1962 fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1963 (self >= kw::Async && self <= kw::Dyn) && edition() >= Edition::Edition2018
1966 fn is_unused_keyword_always(self) -> bool {
1967 self >= kw::Abstract && self <= kw::Yield
1970 fn is_unused_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1971 self == kw::Try && edition() >= Edition::Edition2018
1974 pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool {
1976 || self.is_used_keyword_always()
1977 || self.is_unused_keyword_always()
1978 || self.is_used_keyword_conditional(edition)
1979 || self.is_unused_keyword_conditional(edition)
1982 /// A keyword or reserved identifier that can be used as a path segment.
1983 pub fn is_path_segment_keyword(self) -> bool {
1985 || self == kw::SelfLower
1986 || self == kw::SelfUpper
1987 || self == kw::Crate
1988 || self == kw::PathRoot
1989 || self == kw::DollarCrate
1992 /// Returns `true` if the symbol is `true` or `false`.
1993 pub fn is_bool_lit(self) -> bool {
1994 self == kw::True || self == kw::False
1997 /// Returns `true` if this symbol can be a raw identifier.
1998 pub fn can_be_raw(self) -> bool {
1999 self != kw::Empty && self != kw::Underscore && !self.is_path_segment_keyword()
2004 // Returns `true` for reserved identifiers used internally for elided lifetimes,
2005 // unnamed method parameters, crate root module, error recovery etc.
2006 pub fn is_special(self) -> bool {
2007 self.name.is_special()
2010 /// Returns `true` if the token is a keyword used in the language.
2011 pub fn is_used_keyword(self) -> bool {
2012 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2013 self.name.is_used_keyword_always()
2014 || self.name.is_used_keyword_conditional(|| self.span.edition())
2017 /// Returns `true` if the token is a keyword reserved for possible future use.
2018 pub fn is_unused_keyword(self) -> bool {
2019 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2020 self.name.is_unused_keyword_always()
2021 || self.name.is_unused_keyword_conditional(|| self.span.edition())
2024 /// Returns `true` if the token is either a special identifier or a keyword.
2025 pub fn is_reserved(self) -> bool {
2026 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2027 self.name.is_reserved(|| self.span.edition())
2030 /// A keyword or reserved identifier that can be used as a path segment.
2031 pub fn is_path_segment_keyword(self) -> bool {
2032 self.name.is_path_segment_keyword()
2035 /// We see this identifier in a normal identifier position, like variable name or a type.
2036 /// How was it written originally? Did it use the raw form? Let's try to guess.
2037 pub fn is_raw_guess(self) -> bool {
2038 self.name.can_be_raw() && self.is_reserved()