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",
106 // Pre-interned symbols that can be referred to with `rustc_span::sym::*`.
108 // The symbol is the stringified identifier unless otherwise specified, in
109 // which case the name should mention the non-identifier punctuation.
110 // E.g. `sym::proc_dash_macro` represents "proc-macro", and it shouldn't be
111 // called `sym::proc_macro` because then it's easy to mistakenly think it
112 // represents "proc_macro".
114 // As well as the symbols listed, there are symbols for the strings
115 // "0", "1", ..., "9", which are accessible via `sym::integer`.
117 // The proc macro will abort if symbols are not in alphabetical order (as
118 // defined by `impl Ord for str`) or if any symbols are duplicated. Vim
119 // users can sort the list by selecting it and executing the command
120 // `:'<,'>!LC_ALL=C sort`.
122 // There is currently no checking that all symbols are used; that would be
231 ProceduralMasqueradeDummyType,
280 aarch64_target_feature,
284 abi_c_cmse_nonsecure_call,
286 abi_msp430_interrupt,
300 advanced_slice_patterns,
316 allow_internal_unsafe,
317 allow_internal_unstable,
324 arbitrary_enum_discriminant,
325 arbitrary_self_types,
336 asm_experimental_arch,
344 assert_receiver_is_total_eq,
347 associated_const_equality,
349 associated_type_bounds,
350 associated_type_defaults,
363 augmented_assignments,
365 automatically_derived,
367 avx512_target_feature,
375 bind_by_move_pattern_guards,
387 borrowck_graphviz_format,
388 borrowck_graphviz_postflow,
389 borrowck_graphviz_preflow,
394 braced_empty_structs,
406 capture_disjoint_fields,
422 cfg_target_has_atomic,
423 cfg_target_thread_local,
435 closure_to_fn_coercion,
436 closure_track_caller,
440 cmpxchg16b_target_feature,
441 cmse_nonsecure_entry,
448 compare_exchange_weak,
457 conservative_impl_trait,
461 const_compare_raw_pointers,
465 const_eval_select_ct,
466 const_evaluatable_checked,
469 const_fn_floating_point_arithmetic,
470 const_fn_fn_ptr_basics,
471 const_fn_trait_bound,
477 const_generic_defaults,
479 const_generics_defaults,
482 const_in_array_repeat_expressions,
489 const_precise_live_drops,
492 const_raw_ptr_to_usize_cast,
495 const_trait_bound_opt_out,
512 core_panic_2015_macro,
523 crate_visibility_modifier,
524 crt_dash_static: "crt-static",
533 custom_inner_attributes,
534 custom_test_frameworks,
540 debug_assert_eq_macro,
542 debug_assert_ne_macro,
550 default_alloc_error_handler,
551 default_lib_allocator,
552 default_method_body_is_const,
553 default_type_parameter_fallback,
555 delay_span_bug_from_inside_query,
564 destructuring_assignment,
585 document_private_items,
587 dotdot_in_tuple_patterns,
588 dotdoteq_in_patterns,
596 dropck_parametricity,
607 emit_enum_variant_arg,
619 ermsb_target_feature,
623 exclusive_range_pattern,
624 exhaustive_integer_patterns,
633 explicit_generic_args_with_impl_trait,
636 extended_key_value_attributes,
637 extern_absolute_paths,
638 extern_crate_item_prelude,
663 field_init_shorthand,
669 float_to_int_unchecked,
702 from_size_align_unchecked,
716 generic_associated_types,
724 half_open_range_patterns,
726 hexagon_target_feature,
728 homogeneous_aggregate,
745 if_while_or_patterns,
747 impl_header_lifetime_elision,
750 impl_trait_in_bindings,
760 inclusive_range_syntax,
763 infer_outlives_requirements,
764 infer_static_outlives_requirements,
765 inherent_associated_types,
777 irrefutable_let_patterns,
781 issue_5723_bootstrap,
782 issue_tracker_base_url,
796 lazy_normalization_consts,
811 link_llvm_intrinsics,
831 macro_at_most_once_rep,
832 macro_attributes_in_derive_output,
835 macro_lifetime_matcher,
836 macro_literal_matcher,
848 match_beginning_vert,
849 match_default_bindings,
878 min_type_alias_impl_trait,
888 more_qualified_paths,
890 movbe_target_feature,
903 native_link_modifiers,
904 native_link_modifiers_as_needed,
905 native_link_modifiers_bundle,
906 native_link_modifiers_verbatim,
907 native_link_modifiers_whole_archive,
945 non_exhaustive_omitted_patterns_lint,
957 object_safe_for_dispatch,
960 omit_gdb_pretty_printer_section,
969 optin_builtin_traits,
978 overlapping_marker_traits,
990 panic_implementation,
1005 pattern_parentheses,
1009 platform_intrinsics,
1018 post_dash_lto: "post-lto",
1019 powerpc_target_feature,
1024 pre_dash_lto: "pre-lto",
1025 precise_pointer_size_matching,
1029 prefetch_read_instruction,
1030 prefetch_write_data,
1031 prefetch_write_instruction,
1039 proc_dash_macro: "proc-macro",
1041 proc_macro_attribute,
1042 proc_macro_def_site,
1047 proc_macro_internals,
1049 proc_macro_non_items,
1050 proc_macro_path_invoc,
1065 quad_precision_float,
1068 range_inclusive_new,
1073 re_rebalance_coherence,
1076 read_enum_variant_arg,
1084 reexport_test_harness_main,
1085 ref_unwind_safe_trait,
1102 relaxed_struct_unsize,
1113 reserved_r9: "reserved-r9",
1119 riscv_target_feature,
1135 rust_eh_catch_typeinfo,
1136 rust_eh_personality,
1137 rust_eh_register_frames,
1138 rust_eh_unregister_frames,
1142 rustc_allocator_nounwind,
1143 rustc_allow_const_fn_unstable,
1145 rustc_builtin_macro,
1146 rustc_capture_analysis,
1149 rustc_const_unstable,
1150 rustc_conversion_suggestion,
1153 rustc_diagnostic_item,
1154 rustc_diagnostic_macros,
1156 rustc_do_not_const_check,
1158 rustc_dump_env_program_clauses,
1159 rustc_dump_program_clauses,
1160 rustc_dump_user_substs,
1163 rustc_evaluate_where_clauses,
1164 rustc_expected_cgu_reuse,
1165 rustc_if_this_changed,
1166 rustc_inherit_overflow_checks,
1167 rustc_insignificant_dtor,
1169 rustc_layout_scalar_valid_range_end,
1170 rustc_layout_scalar_valid_range_start,
1171 rustc_legacy_const_generics,
1172 rustc_macro_transparency,
1175 rustc_must_implement_one_of,
1176 rustc_nonnull_optimization_guaranteed,
1177 rustc_object_lifetime_default,
1178 rustc_on_unimplemented,
1181 rustc_partition_codegened,
1182 rustc_partition_reused,
1183 rustc_pass_by_value,
1185 rustc_peek_definite_init,
1186 rustc_peek_liveness,
1187 rustc_peek_maybe_init,
1188 rustc_peek_maybe_uninit,
1189 rustc_polymorphize_error,
1191 rustc_proc_macro_decls,
1194 rustc_reservation_impl,
1196 rustc_skip_array_during_method_dispatch,
1197 rustc_specialization_trait,
1199 rustc_std_internal_symbol,
1200 rustc_strict_coherence,
1203 rustc_then_this_would_need,
1204 rustc_trivial_field_reads,
1205 rustc_unsafe_specialization_marker,
1210 rvalue_static_promotion,
1260 simd_reduce_add_ordered,
1261 simd_reduce_add_unordered,
1266 simd_reduce_max_nanless,
1268 simd_reduce_min_nanless,
1269 simd_reduce_mul_ordered,
1270 simd_reduce_mul_unordered,
1275 simd_saturating_add,
1276 simd_saturating_sub,
1279 simd_select_bitmask,
1310 sse4a_target_feature,
1322 std_panic_2015_macro,
1325 stmt_expr_attributes,
1326 stop_after_dataflow,
1332 struct_field_attributes,
1354 target_has_atomic_equal_alignment,
1355 target_has_atomic_load_store,
1357 target_pointer_width,
1358 target_target_vendor,
1359 target_thread_local,
1365 termination_trait_test,
1368 test_accepted_feature,
1370 test_removed_feature,
1377 thumb_mode: "thumb-mode",
1402 type_alias_enum_variants,
1403 type_alias_impl_trait,
1405 type_changing_struct_update,
1415 unaligned_volatile_load,
1416 unaligned_volatile_store,
1425 underscore_const_names,
1427 underscore_lifetimes,
1429 unimplemented_macro,
1431 universal_impl_trait,
1439 unrestricted_attribute_tokens,
1440 unsafe_block_in_unsafe_fn,
1442 unsafe_no_drop_flag,
1446 unsized_tuple_coercion,
1449 unused_qualifications,
1473 visible_private_types,
1475 volatile_copy_memory,
1476 volatile_copy_nonoverlapping_memory,
1478 volatile_set_memory,
1485 wasm_target_feature,
1506 #[derive(Copy, Clone, Eq, HashStable_Generic, Encodable, Decodable)]
1514 /// Constructs a new identifier from a symbol and a span.
1515 pub const fn new(name: Symbol, span: Span) -> Ident {
1516 Ident { name, span }
1519 /// Constructs a new identifier with a dummy span.
1521 pub const fn with_dummy_span(name: Symbol) -> Ident {
1522 Ident::new(name, DUMMY_SP)
1526 pub fn empty() -> Ident {
1527 Ident::with_dummy_span(kw::Empty)
1530 /// Maps a string to an identifier with a dummy span.
1531 pub fn from_str(string: &str) -> Ident {
1532 Ident::with_dummy_span(Symbol::intern(string))
1535 /// Maps a string and a span to an identifier.
1536 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
1537 Ident::new(Symbol::intern(string), span)
1540 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
1541 pub fn with_span_pos(self, span: Span) -> Ident {
1542 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
1545 pub fn without_first_quote(self) -> Ident {
1546 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
1549 /// "Normalize" ident for use in comparisons using "item hygiene".
1550 /// Identifiers with same string value become same if they came from the same macro 2.0 macro
1551 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
1552 /// different macro 2.0 macros.
1553 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
1554 pub fn normalize_to_macros_2_0(self) -> Ident {
1555 Ident::new(self.name, self.span.normalize_to_macros_2_0())
1558 /// "Normalize" ident for use in comparisons using "local variable hygiene".
1559 /// Identifiers with same string value become same if they came from the same non-transparent
1560 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
1561 /// non-transparent macros.
1562 /// Technically, this operation strips all transparent marks from ident's syntactic context.
1563 pub fn normalize_to_macro_rules(self) -> Ident {
1564 Ident::new(self.name, self.span.normalize_to_macro_rules())
1567 /// Access the underlying string. This is a slowish operation because it
1568 /// requires locking the symbol interner.
1570 /// Note that the lifetime of the return value is a lie. See
1571 /// `Symbol::as_str()` for details.
1572 pub fn as_str(&self) -> &str {
1577 impl PartialEq for Ident {
1578 fn eq(&self, rhs: &Self) -> bool {
1579 self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
1583 impl Hash for Ident {
1584 fn hash<H: Hasher>(&self, state: &mut H) {
1585 self.name.hash(state);
1586 self.span.ctxt().hash(state);
1590 impl fmt::Debug for Ident {
1591 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1592 fmt::Display::fmt(self, f)?;
1593 fmt::Debug::fmt(&self.span.ctxt(), f)
1597 /// This implementation is supposed to be used in error messages, so it's expected to be identical
1598 /// to printing the original identifier token written in source code (`token_to_string`),
1599 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
1600 impl fmt::Display for Ident {
1601 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1602 fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
1606 /// This is the most general way to print identifiers.
1607 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
1608 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
1609 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
1610 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
1611 /// hygiene data, most importantly name of the crate it refers to.
1612 /// As a result we print `$crate` as `crate` if it refers to the local crate
1613 /// and as `::other_crate_name` if it refers to some other crate.
1614 /// Note, that this is only done if the ident token is printed from inside of AST pretty-pringing,
1615 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
1616 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
1617 /// done for a token stream or a single token.
1618 pub struct IdentPrinter {
1621 /// Span used for retrieving the crate name to which `$crate` refers to,
1622 /// if this field is `None` then the `$crate` conversion doesn't happen.
1623 convert_dollar_crate: Option<Span>,
1627 /// The most general `IdentPrinter` constructor. Do not use this.
1628 pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
1629 IdentPrinter { symbol, is_raw, convert_dollar_crate }
1632 /// This implementation is supposed to be used when printing identifiers
1633 /// as a part of pretty-printing for larger AST pieces.
1634 /// Do not use this either.
1635 pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1636 IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1640 impl fmt::Display for IdentPrinter {
1641 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1644 } else if self.symbol == kw::DollarCrate {
1645 if let Some(span) = self.convert_dollar_crate {
1646 let converted = span.ctxt().dollar_crate_name();
1647 if !converted.is_path_segment_keyword() {
1650 return fmt::Display::fmt(&converted, f);
1653 fmt::Display::fmt(&self.symbol, f)
1657 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1659 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1660 // `ModernIdent` struct and use that as well.
1661 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1662 pub struct MacroRulesNormalizedIdent(Ident);
1664 impl MacroRulesNormalizedIdent {
1665 pub fn new(ident: Ident) -> Self {
1666 Self(ident.normalize_to_macro_rules())
1670 impl fmt::Debug for MacroRulesNormalizedIdent {
1671 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1672 fmt::Debug::fmt(&self.0, f)
1676 impl fmt::Display for MacroRulesNormalizedIdent {
1677 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1678 fmt::Display::fmt(&self.0, f)
1682 /// An interned string.
1684 /// Internally, a `Symbol` is implemented as an index, and all operations
1685 /// (including hashing, equality, and ordering) operate on that index. The use
1686 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1687 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1689 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1690 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1691 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1692 pub struct Symbol(SymbolIndex);
1694 rustc_index::newtype_index! {
1695 struct SymbolIndex { .. }
1699 const fn new(n: u32) -> Self {
1700 Symbol(SymbolIndex::from_u32(n))
1703 /// Maps a string to its interned representation.
1704 pub fn intern(string: &str) -> Self {
1705 with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
1708 /// Access the underlying string. This is a slowish operation because it
1709 /// requires locking the symbol interner.
1711 /// Note that the lifetime of the return value is a lie. It's not the same
1712 /// as `&self`, but actually tied to the lifetime of the underlying
1713 /// interner. Interners are long-lived, and there are very few of them, and
1714 /// this function is typically used for short-lived things, so in practice
1715 /// it works out ok.
1716 pub fn as_str(&self) -> &str {
1717 with_session_globals(|session_globals| unsafe {
1718 std::mem::transmute::<&str, &str>(session_globals.symbol_interner.get(*self))
1722 pub fn as_u32(self) -> u32 {
1726 pub fn is_empty(self) -> bool {
1730 /// This method is supposed to be used in error messages, so it's expected to be
1731 /// identical to printing the original identifier token written in source code
1732 /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1733 /// or edition, so we have to guess the rawness using the global edition.
1734 pub fn to_ident_string(self) -> String {
1735 Ident::with_dummy_span(self).to_string()
1739 impl fmt::Debug for Symbol {
1740 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1741 fmt::Debug::fmt(self.as_str(), f)
1745 impl fmt::Display for Symbol {
1746 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1747 fmt::Display::fmt(self.as_str(), f)
1751 impl<S: Encoder> Encodable<S> for Symbol {
1752 fn encode(&self, s: &mut S) -> Result<(), S::Error> {
1753 s.emit_str(self.as_str())
1757 impl<D: Decoder> Decodable<D> for Symbol {
1759 fn decode(d: &mut D) -> Symbol {
1760 Symbol::intern(&d.read_str())
1764 impl<CTX> HashStable<CTX> for Symbol {
1766 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1767 self.as_str().hash_stable(hcx, hasher);
1771 impl<CTX> ToStableHashKey<CTX> for Symbol {
1772 type KeyType = String;
1774 fn to_stable_hash_key(&self, _: &CTX) -> String {
1775 self.as_str().to_string()
1780 pub(crate) struct Interner(Lock<InternerInner>);
1782 // The `&'static str`s in this type actually point into the arena.
1784 // The `FxHashMap`+`Vec` pair could be replaced by `FxIndexSet`, but #75278
1785 // found that to regress performance up to 2% in some cases. This might be
1786 // revisited after further improvements to `indexmap`.
1788 // This type is private to prevent accidentally constructing more than one
1789 // `Interner` on the same thread, which makes it easy to mixup `Symbol`s
1790 // between `Interner`s.
1792 struct InternerInner {
1793 arena: DroplessArena,
1794 names: FxHashMap<&'static str, Symbol>,
1795 strings: Vec<&'static str>,
1799 fn prefill(init: &[&'static str]) -> Self {
1800 Interner(Lock::new(InternerInner {
1801 strings: init.into(),
1802 names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1803 ..Default::default()
1808 fn intern(&self, string: &str) -> Symbol {
1809 let mut inner = self.0.lock();
1810 if let Some(&name) = inner.names.get(string) {
1814 let name = Symbol::new(inner.strings.len() as u32);
1816 // SAFETY: we convert from `&str` to `&[u8]`, clone it into the arena,
1817 // and immediately convert the clone back to `&[u8], all because there
1818 // is no `inner.arena.alloc_str()` method. This is clearly safe.
1820 unsafe { str::from_utf8_unchecked(inner.arena.alloc_slice(string.as_bytes())) };
1822 // SAFETY: we can extend the arena allocation to `'static` because we
1823 // only access these while the arena is still alive.
1824 let string: &'static str = unsafe { &*(string as *const str) };
1825 inner.strings.push(string);
1827 // This second hash table lookup can be avoided by using `RawEntryMut`,
1828 // but this code path isn't hot enough for it to be worth it. See
1829 // #91445 for details.
1830 inner.names.insert(string, name);
1834 // Get the symbol as a string. `Symbol::as_str()` should be used in
1835 // preference to this function.
1836 fn get(&self, symbol: Symbol) -> &str {
1837 self.0.lock().strings[symbol.0.as_usize()]
1841 // This module has a very short name because it's used a lot.
1842 /// This module contains all the defined keyword `Symbol`s.
1844 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1845 /// For example `kw::Loop` or `kw::Break`.
1847 pub use super::kw_generated::*;
1850 // This module has a very short name because it's used a lot.
1851 /// This module contains all the defined non-keyword `Symbol`s.
1853 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1854 /// For example `sym::rustfmt` or `sym::u8`.
1857 use std::convert::TryInto;
1860 pub use super::sym_generated::*;
1862 // Used from a macro in `librustc_feature/accepted.rs`
1863 pub use super::kw::MacroRules as macro_rules;
1865 /// Get the symbol for an integer.
1867 /// The first few non-negative integers each have a static symbol and therefore
1869 pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1870 if let Result::Ok(idx) = n.try_into() {
1872 return Symbol::new(super::SYMBOL_DIGITS_BASE + idx as u32);
1875 Symbol::intern(&n.to_string())
1880 fn is_special(self) -> bool {
1881 self <= kw::Underscore
1884 fn is_used_keyword_always(self) -> bool {
1885 self >= kw::As && self <= kw::While
1888 fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1889 (self >= kw::Async && self <= kw::Dyn) && edition() >= Edition::Edition2018
1892 fn is_unused_keyword_always(self) -> bool {
1893 self >= kw::Abstract && self <= kw::Yield
1896 fn is_unused_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1897 self == kw::Try && edition() >= Edition::Edition2018
1900 pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool {
1902 || self.is_used_keyword_always()
1903 || self.is_unused_keyword_always()
1904 || self.is_used_keyword_conditional(edition)
1905 || self.is_unused_keyword_conditional(edition)
1908 /// A keyword or reserved identifier that can be used as a path segment.
1909 pub fn is_path_segment_keyword(self) -> bool {
1911 || self == kw::SelfLower
1912 || self == kw::SelfUpper
1913 || self == kw::Crate
1914 || self == kw::PathRoot
1915 || self == kw::DollarCrate
1918 /// Returns `true` if the symbol is `true` or `false`.
1919 pub fn is_bool_lit(self) -> bool {
1920 self == kw::True || self == kw::False
1923 /// Returns `true` if this symbol can be a raw identifier.
1924 pub fn can_be_raw(self) -> bool {
1925 self != kw::Empty && self != kw::Underscore && !self.is_path_segment_keyword()
1930 // Returns `true` for reserved identifiers used internally for elided lifetimes,
1931 // unnamed method parameters, crate root module, error recovery etc.
1932 pub fn is_special(self) -> bool {
1933 self.name.is_special()
1936 /// Returns `true` if the token is a keyword used in the language.
1937 pub fn is_used_keyword(self) -> bool {
1938 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1939 self.name.is_used_keyword_always()
1940 || self.name.is_used_keyword_conditional(|| self.span.edition())
1943 /// Returns `true` if the token is a keyword reserved for possible future use.
1944 pub fn is_unused_keyword(self) -> bool {
1945 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1946 self.name.is_unused_keyword_always()
1947 || self.name.is_unused_keyword_conditional(|| self.span.edition())
1950 /// Returns `true` if the token is either a special identifier or a keyword.
1951 pub fn is_reserved(self) -> bool {
1952 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1953 self.name.is_reserved(|| self.span.edition())
1956 /// A keyword or reserved identifier that can be used as a path segment.
1957 pub fn is_path_segment_keyword(self) -> bool {
1958 self.name.is_path_segment_keyword()
1961 /// We see this identifier in a normal identifier position, like variable name or a type.
1962 /// How was it written originally? Did it use the raw form? Let's try to guess.
1963 pub fn is_raw_guess(self) -> bool {
1964 self.name.can_be_raw() && self.is_reserved()