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
257 ProceduralMasqueradeDummyType,
285 SubdiagnosticMessage,
316 aarch64_target_feature,
317 aarch64_ver_target_feature,
321 abi_c_cmse_nonsecure_call,
323 abi_msp430_interrupt,
337 advanced_slice_patterns,
354 allow_internal_unsafe,
355 allow_internal_unstable,
361 anonymous_lifetime_in_impl_trait,
364 arbitrary_enum_discriminant,
365 arbitrary_self_types,
377 asm_experimental_arch,
385 assert_receiver_is_total_eq,
389 associated_const_equality,
391 associated_type_bounds,
392 associated_type_defaults,
405 augmented_assignments,
407 automatically_derived,
409 avx512_target_feature,
417 bind_by_move_pattern_guards,
429 borrowck_graphviz_format,
430 borrowck_graphviz_postflow,
431 borrowck_graphviz_preflow,
436 braced_empty_structs,
448 capture_disjoint_fields,
465 cfg_target_has_atomic,
466 cfg_target_has_atomic_equal_alignment,
467 cfg_target_has_atomic_load_store,
468 cfg_target_thread_local,
480 closure_lifetime_binder,
481 closure_to_fn_coercion,
482 closure_track_caller,
486 cmpxchg16b_target_feature,
487 cmse_nonsecure_entry,
494 compare_exchange_weak,
504 conservative_impl_trait,
508 const_compare_raw_pointers,
513 const_evaluatable_checked,
516 const_fn_floating_point_arithmetic,
517 const_fn_fn_ptr_basics,
518 const_fn_trait_bound,
524 const_generic_defaults,
526 const_generics_defaults,
529 const_in_array_repeat_expressions,
536 const_precise_live_drops,
538 const_raw_ptr_to_usize_cast,
541 const_trait_bound_opt_out,
558 core_panic_2015_macro,
569 crate_visibility_modifier,
570 crt_dash_static: "crt-static",
579 custom_inner_attributes,
580 custom_test_frameworks,
587 debug_assert_eq_macro,
589 debug_assert_ne_macro,
592 debug_struct_fields_finish,
595 debug_tuple_fields_finish,
600 default_alloc_error_handler,
601 default_lib_allocator,
602 default_method_body_is_const,
603 default_type_parameter_fallback,
605 delay_span_bug_from_inside_query,
609 deprecated_suggestion,
617 destructuring_assignment,
638 document_private_items,
640 dotdot_in_tuple_patterns,
641 dotdoteq_in_patterns,
649 dropck_parametricity,
660 emit_enum_variant_arg,
671 ermsb_target_feature,
675 exclusive_range_pattern,
676 exhaustive_integer_patterns,
685 explicit_generic_args_with_impl_trait,
688 extended_key_value_attributes,
689 extern_absolute_paths,
690 extern_crate_item_prelude,
714 field_init_shorthand,
721 float_to_int_unchecked,
754 from_size_align_unchecked,
770 generic_associated_types,
771 generic_associated_types_extended,
779 half_open_range_patterns,
781 hexagon_target_feature,
783 homogeneous_aggregate,
800 if_while_or_patterns,
802 impl_header_lifetime_elision,
805 impl_trait_in_bindings,
818 inclusive_range_syntax,
821 infer_outlives_requirements,
822 infer_static_outlives_requirements,
823 inherent_associated_types,
838 irrefutable_let_patterns,
842 issue_5723_bootstrap,
843 issue_tracker_base_url,
858 lazy_normalization_consts,
874 link_llvm_intrinsics,
895 macro_at_most_once_rep,
896 macro_attributes_in_derive_output,
899 macro_lifetime_matcher,
900 macro_literal_matcher,
913 match_beginning_vert,
914 match_default_bindings,
944 min_type_alias_impl_trait,
955 more_qualified_paths,
957 movbe_target_feature,
969 native_link_modifiers,
970 native_link_modifiers_as_needed,
971 native_link_modifiers_bundle,
972 native_link_modifiers_verbatim,
973 native_link_modifiers_whole_archive,
1011 non_exhaustive_omitted_patterns_lint,
1023 object_safe_for_dispatch,
1026 omit_gdb_pretty_printer_section,
1035 optin_builtin_traits,
1044 overlapping_marker_traits,
1056 panic_implementation,
1072 pattern_parentheses,
1075 platform_intrinsics,
1084 post_dash_lto: "post-lto",
1085 powerpc_target_feature,
1090 pre_dash_lto: "pre-lto",
1091 precise_pointer_size_matching,
1095 prefetch_read_instruction,
1096 prefetch_write_data,
1097 prefetch_write_instruction,
1105 proc_dash_macro: "proc-macro",
1107 proc_macro_attribute,
1108 proc_macro_def_site,
1113 proc_macro_internals,
1115 proc_macro_non_items,
1116 proc_macro_path_invoc,
1126 ptr_offset_from_unsigned,
1135 quad_precision_float,
1138 range_inclusive_new,
1143 re_rebalance_coherence,
1146 read_enum_variant_arg,
1154 reexport_test_harness_main,
1155 ref_unwind_safe_trait,
1172 relaxed_struct_unsize,
1185 return_position_impl_trait_in_trait,
1189 riscv_target_feature,
1208 rust_eh_catch_typeinfo,
1209 rust_eh_personality,
1210 rust_eh_register_frames,
1211 rust_eh_unregister_frames,
1216 rustc_allocator_nounwind,
1217 rustc_allocator_zeroed,
1218 rustc_allow_const_fn_unstable,
1219 rustc_allow_incoherent_impl,
1220 rustc_allowed_through_unstable_modules,
1223 rustc_builtin_macro,
1224 rustc_capture_analysis,
1226 rustc_coherence_is_core,
1228 rustc_const_unstable,
1229 rustc_conversion_suggestion,
1232 rustc_default_body_unstable,
1233 rustc_diagnostic_item,
1234 rustc_diagnostic_macros,
1236 rustc_do_not_const_check,
1238 rustc_dump_env_program_clauses,
1239 rustc_dump_program_clauses,
1240 rustc_dump_user_substs,
1243 rustc_evaluate_where_clauses,
1244 rustc_expected_cgu_reuse,
1245 rustc_has_incoherent_inherent_impls,
1246 rustc_if_this_changed,
1247 rustc_inherit_overflow_checks,
1248 rustc_insignificant_dtor,
1250 rustc_layout_scalar_valid_range_end,
1251 rustc_layout_scalar_valid_range_start,
1252 rustc_legacy_const_generics,
1253 rustc_lint_diagnostics,
1254 rustc_lint_opt_deny_field_access,
1256 rustc_lint_query_instability,
1257 rustc_macro_transparency,
1260 rustc_must_implement_one_of,
1261 rustc_nonnull_optimization_guaranteed,
1262 rustc_object_lifetime_default,
1263 rustc_on_unimplemented,
1266 rustc_partition_codegened,
1267 rustc_partition_reused,
1268 rustc_pass_by_value,
1270 rustc_peek_definite_init,
1271 rustc_peek_liveness,
1272 rustc_peek_maybe_init,
1273 rustc_peek_maybe_uninit,
1274 rustc_polymorphize_error,
1276 rustc_proc_macro_decls,
1280 rustc_reservation_impl,
1282 rustc_skip_array_during_method_dispatch,
1283 rustc_specialization_trait,
1285 rustc_std_internal_symbol,
1286 rustc_strict_coherence,
1289 rustc_then_this_would_need,
1290 rustc_trivial_field_reads,
1291 rustc_unsafe_specialization_marker,
1296 rvalue_static_promotion,
1351 simd_reduce_add_ordered,
1352 simd_reduce_add_unordered,
1357 simd_reduce_max_nanless,
1359 simd_reduce_min_nanless,
1360 simd_reduce_mul_ordered,
1361 simd_reduce_mul_unordered,
1366 simd_saturating_add,
1367 simd_saturating_sub,
1370 simd_select_bitmask,
1398 sse4a_target_feature,
1410 std_panic_2015_macro,
1413 stmt_expr_attributes,
1414 stop_after_dataflow,
1417 str_split_whitespace,
1424 struct_field_attributes,
1447 target_has_atomic_equal_alignment,
1448 target_has_atomic_load_store,
1450 target_pointer_width,
1451 target_target_vendor,
1452 target_thread_local,
1458 termination_trait_test,
1461 test_accepted_feature,
1463 test_removed_feature,
1471 thumb_mode: "thumb-mode",
1502 type_alias_enum_variants,
1503 type_alias_impl_trait,
1505 type_changing_struct_update,
1515 unaligned_volatile_load,
1516 unaligned_volatile_store,
1525 underscore_const_names,
1527 underscore_lifetimes,
1529 unimplemented_macro,
1531 universal_impl_trait,
1539 unreachable_2015_macro,
1541 unreachable_2021_macro,
1543 unreachable_display,
1545 unrestricted_attribute_tokens,
1546 unsafe_block_in_unsafe_fn,
1548 unsafe_no_drop_flag,
1549 unsafe_pin_internals,
1553 unsized_tuple_coercion,
1555 unstable_location_reason_default: "this crate is being loaded from the sysroot, an \
1556 unstable location; did you mean to load this crate \
1557 from crates.io via `Cargo.toml` instead?",
1560 unused_qualifications,
1588 visible_private_types,
1590 volatile_copy_memory,
1591 volatile_copy_nonoverlapping_memory,
1593 volatile_set_memory,
1602 wasm_target_feature,
1607 with_negative_coherence,
1619 yeet_desugar_details,
1626 #[derive(Copy, Clone, Eq, HashStable_Generic, Encodable, Decodable)]
1634 /// Constructs a new identifier from a symbol and a span.
1635 pub const fn new(name: Symbol, span: Span) -> Ident {
1636 Ident { name, span }
1639 /// Constructs a new identifier with a dummy span.
1641 pub const fn with_dummy_span(name: Symbol) -> Ident {
1642 Ident::new(name, DUMMY_SP)
1646 pub fn empty() -> Ident {
1647 Ident::with_dummy_span(kw::Empty)
1650 /// Maps a string to an identifier with a dummy span.
1651 pub fn from_str(string: &str) -> Ident {
1652 Ident::with_dummy_span(Symbol::intern(string))
1655 /// Maps a string and a span to an identifier.
1656 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
1657 Ident::new(Symbol::intern(string), span)
1660 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
1661 pub fn with_span_pos(self, span: Span) -> Ident {
1662 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
1665 pub fn without_first_quote(self) -> Ident {
1666 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
1669 /// "Normalize" ident for use in comparisons using "item hygiene".
1670 /// Identifiers with same string value become same if they came from the same macro 2.0 macro
1671 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
1672 /// different macro 2.0 macros.
1673 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
1674 pub fn normalize_to_macros_2_0(self) -> Ident {
1675 Ident::new(self.name, self.span.normalize_to_macros_2_0())
1678 /// "Normalize" ident for use in comparisons using "local variable hygiene".
1679 /// Identifiers with same string value become same if they came from the same non-transparent
1680 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
1681 /// non-transparent macros.
1682 /// Technically, this operation strips all transparent marks from ident's syntactic context.
1683 pub fn normalize_to_macro_rules(self) -> Ident {
1684 Ident::new(self.name, self.span.normalize_to_macro_rules())
1687 /// Access the underlying string. This is a slowish operation because it
1688 /// requires locking the symbol interner.
1690 /// Note that the lifetime of the return value is a lie. See
1691 /// `Symbol::as_str()` for details.
1692 pub fn as_str(&self) -> &str {
1697 impl PartialEq for Ident {
1698 fn eq(&self, rhs: &Self) -> bool {
1699 self.name == rhs.name && self.span.eq_ctxt(rhs.span)
1703 impl Hash for Ident {
1704 fn hash<H: Hasher>(&self, state: &mut H) {
1705 self.name.hash(state);
1706 self.span.ctxt().hash(state);
1710 impl fmt::Debug for Ident {
1711 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1712 fmt::Display::fmt(self, f)?;
1713 fmt::Debug::fmt(&self.span.ctxt(), f)
1717 /// This implementation is supposed to be used in error messages, so it's expected to be identical
1718 /// to printing the original identifier token written in source code (`token_to_string`),
1719 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
1720 impl fmt::Display for Ident {
1721 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1722 fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
1726 /// This is the most general way to print identifiers.
1727 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
1728 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
1729 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
1730 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
1731 /// hygiene data, most importantly name of the crate it refers to.
1732 /// As a result we print `$crate` as `crate` if it refers to the local crate
1733 /// and as `::other_crate_name` if it refers to some other crate.
1734 /// Note, that this is only done if the ident token is printed from inside of AST pretty-printing,
1735 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
1736 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
1737 /// done for a token stream or a single token.
1738 pub struct IdentPrinter {
1741 /// Span used for retrieving the crate name to which `$crate` refers to,
1742 /// if this field is `None` then the `$crate` conversion doesn't happen.
1743 convert_dollar_crate: Option<Span>,
1747 /// The most general `IdentPrinter` constructor. Do not use this.
1748 pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
1749 IdentPrinter { symbol, is_raw, convert_dollar_crate }
1752 /// This implementation is supposed to be used when printing identifiers
1753 /// as a part of pretty-printing for larger AST pieces.
1754 /// Do not use this either.
1755 pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1756 IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1760 impl fmt::Display for IdentPrinter {
1761 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1764 } else if self.symbol == kw::DollarCrate {
1765 if let Some(span) = self.convert_dollar_crate {
1766 let converted = span.ctxt().dollar_crate_name();
1767 if !converted.is_path_segment_keyword() {
1770 return fmt::Display::fmt(&converted, f);
1773 fmt::Display::fmt(&self.symbol, f)
1777 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1779 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1780 // `ModernIdent` struct and use that as well.
1781 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1782 pub struct MacroRulesNormalizedIdent(Ident);
1784 impl MacroRulesNormalizedIdent {
1785 pub fn new(ident: Ident) -> Self {
1786 Self(ident.normalize_to_macro_rules())
1790 impl fmt::Debug for MacroRulesNormalizedIdent {
1791 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1792 fmt::Debug::fmt(&self.0, f)
1796 impl fmt::Display for MacroRulesNormalizedIdent {
1797 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1798 fmt::Display::fmt(&self.0, f)
1802 /// An interned string.
1804 /// Internally, a `Symbol` is implemented as an index, and all operations
1805 /// (including hashing, equality, and ordering) operate on that index. The use
1806 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1807 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1809 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1810 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1811 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1812 pub struct Symbol(SymbolIndex);
1814 rustc_index::newtype_index! {
1815 struct SymbolIndex { .. }
1819 const fn new(n: u32) -> Self {
1820 Symbol(SymbolIndex::from_u32(n))
1823 /// for use in Decoder only
1824 pub fn new_from_decoded(n: u32) -> Self {
1828 /// Maps a string to its interned representation.
1829 pub fn intern(string: &str) -> Self {
1830 with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
1833 /// Access the underlying string. This is a slowish operation because it
1834 /// requires locking the symbol interner.
1836 /// Note that the lifetime of the return value is a lie. It's not the same
1837 /// as `&self`, but actually tied to the lifetime of the underlying
1838 /// interner. Interners are long-lived, and there are very few of them, and
1839 /// this function is typically used for short-lived things, so in practice
1840 /// it works out ok.
1841 pub fn as_str(&self) -> &str {
1842 with_session_globals(|session_globals| unsafe {
1843 std::mem::transmute::<&str, &str>(session_globals.symbol_interner.get(*self))
1847 pub fn as_u32(self) -> u32 {
1851 pub fn is_empty(self) -> bool {
1855 /// This method is supposed to be used in error messages, so it's expected to be
1856 /// identical to printing the original identifier token written in source code
1857 /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1858 /// or edition, so we have to guess the rawness using the global edition.
1859 pub fn to_ident_string(self) -> String {
1860 Ident::with_dummy_span(self).to_string()
1864 impl fmt::Debug for Symbol {
1865 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1866 fmt::Debug::fmt(self.as_str(), f)
1870 impl fmt::Display for Symbol {
1871 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1872 fmt::Display::fmt(self.as_str(), f)
1876 impl<S: Encoder> Encodable<S> for Symbol {
1877 default fn encode(&self, s: &mut S) {
1878 s.emit_str(self.as_str());
1882 impl<D: Decoder> Decodable<D> for Symbol {
1884 default fn decode(d: &mut D) -> Symbol {
1885 Symbol::intern(&d.read_str())
1889 impl<CTX> HashStable<CTX> for Symbol {
1891 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1892 self.as_str().hash_stable(hcx, hasher);
1896 impl<CTX> ToStableHashKey<CTX> for Symbol {
1897 type KeyType = String;
1899 fn to_stable_hash_key(&self, _: &CTX) -> String {
1900 self.as_str().to_string()
1905 pub(crate) struct Interner(Lock<InternerInner>);
1907 // The `&'static str`s in this type actually point into the arena.
1909 // The `FxHashMap`+`Vec` pair could be replaced by `FxIndexSet`, but #75278
1910 // found that to regress performance up to 2% in some cases. This might be
1911 // revisited after further improvements to `indexmap`.
1913 // This type is private to prevent accidentally constructing more than one
1914 // `Interner` on the same thread, which makes it easy to mix up `Symbol`s
1915 // between `Interner`s.
1917 struct InternerInner {
1918 arena: DroplessArena,
1919 names: FxHashMap<&'static str, Symbol>,
1920 strings: Vec<&'static str>,
1924 fn prefill(init: &[&'static str]) -> Self {
1925 Interner(Lock::new(InternerInner {
1926 strings: init.into(),
1927 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1928 ..Default::default()
1933 fn intern(&self, string: &str) -> Symbol {
1934 let mut inner = self.0.lock();
1935 if let Some(&name) = inner.names.get(string) {
1939 let name = Symbol::new(inner.strings.len() as u32);
1941 // SAFETY: we convert from `&str` to `&[u8]`, clone it into the arena,
1942 // and immediately convert the clone back to `&[u8], all because there
1943 // is no `inner.arena.alloc_str()` method. This is clearly safe.
1945 unsafe { str::from_utf8_unchecked(inner.arena.alloc_slice(string.as_bytes())) };
1947 // SAFETY: we can extend the arena allocation to `'static` because we
1948 // only access these while the arena is still alive.
1949 let string: &'static str = unsafe { &*(string as *const str) };
1950 inner.strings.push(string);
1952 // This second hash table lookup can be avoided by using `RawEntryMut`,
1953 // but this code path isn't hot enough for it to be worth it. See
1954 // #91445 for details.
1955 inner.names.insert(string, name);
1959 // Get the symbol as a string. `Symbol::as_str()` should be used in
1960 // preference to this function.
1961 fn get(&self, symbol: Symbol) -> &str {
1962 self.0.lock().strings[symbol.0.as_usize()]
1966 // This module has a very short name because it's used a lot.
1967 /// This module contains all the defined keyword `Symbol`s.
1969 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1970 /// For example `kw::Loop` or `kw::Break`.
1972 pub use super::kw_generated::*;
1975 // This module has a very short name because it's used a lot.
1976 /// This module contains all the defined non-keyword `Symbol`s.
1978 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1979 /// For example `sym::rustfmt` or `sym::u8`.
1982 use std::convert::TryInto;
1985 pub use super::sym_generated::*;
1987 // Used from a macro in `librustc_feature/accepted.rs`
1988 pub use super::kw::MacroRules as macro_rules;
1990 /// Get the symbol for an integer.
1992 /// The first few non-negative integers each have a static symbol and therefore
1994 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1995 if let Result::Ok(idx) = n.try_into() {
1997 return Symbol::new(super::SYMBOL_DIGITS_BASE + idx as u32);
2000 Symbol::intern(&n.to_string())
2005 fn is_special(self) -> bool {
2006 self <= kw::Underscore
2009 fn is_used_keyword_always(self) -> bool {
2010 self >= kw::As && self <= kw::While
2013 fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
2014 (self >= kw::Async && self <= kw::Dyn) && edition() >= Edition::Edition2018
2017 fn is_unused_keyword_always(self) -> bool {
2018 self >= kw::Abstract && self <= kw::Yield
2021 fn is_unused_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
2022 self == kw::Try && edition() >= Edition::Edition2018
2025 pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool {
2027 || self.is_used_keyword_always()
2028 || self.is_unused_keyword_always()
2029 || self.is_used_keyword_conditional(edition)
2030 || self.is_unused_keyword_conditional(edition)
2033 /// A keyword or reserved identifier that can be used as a path segment.
2034 pub fn is_path_segment_keyword(self) -> bool {
2036 || self == kw::SelfLower
2037 || self == kw::SelfUpper
2038 || self == kw::Crate
2039 || self == kw::PathRoot
2040 || self == kw::DollarCrate
2043 /// Returns `true` if the symbol is `true` or `false`.
2044 pub fn is_bool_lit(self) -> bool {
2045 self == kw::True || self == kw::False
2048 /// Returns `true` if this symbol can be a raw identifier.
2049 pub fn can_be_raw(self) -> bool {
2050 self != kw::Empty && self != kw::Underscore && !self.is_path_segment_keyword()
2053 /// Is this symbol was interned in compiler's `symbols!` macro
2054 pub fn is_preinterned(self) -> bool {
2055 self.as_u32() < PREINTERNED_SYMBOLS_COUNT
2060 // Returns `true` for reserved identifiers used internally for elided lifetimes,
2061 // unnamed method parameters, crate root module, error recovery etc.
2062 pub fn is_special(self) -> bool {
2063 self.name.is_special()
2066 /// Returns `true` if the token is a keyword used in the language.
2067 pub fn is_used_keyword(self) -> bool {
2068 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2069 self.name.is_used_keyword_always()
2070 || self.name.is_used_keyword_conditional(|| self.span.edition())
2073 /// Returns `true` if the token is a keyword reserved for possible future use.
2074 pub fn is_unused_keyword(self) -> bool {
2075 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2076 self.name.is_unused_keyword_always()
2077 || self.name.is_unused_keyword_conditional(|| self.span.edition())
2080 /// Returns `true` if the token is either a special identifier or a keyword.
2081 pub fn is_reserved(self) -> bool {
2082 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2083 self.name.is_reserved(|| self.span.edition())
2086 /// A keyword or reserved identifier that can be used as a path segment.
2087 pub fn is_path_segment_keyword(self) -> bool {
2088 self.name.is_path_segment_keyword()
2091 /// We see this identifier in a normal identifier position, like variable name or a type.
2092 /// How was it written originally? Did it use the raw form? Let's try to guess.
2093 pub fn is_raw_guess(self) -> bool {
2094 self.name.can_be_raw() && self.is_reserved()