1 //! An "interner" is a data structure that associates values with usize tags and
2 //! allows bidirectional lookup; i.e., given a value, one can easily find the
3 //! type, and vice versa.
5 use arena::DroplessArena;
6 use rustc_data_structures::fx::FxHashMap;
7 use rustc_data_structures::indexed_vec::Idx;
8 use rustc_data_structures::newtype_index;
9 use rustc_macros::symbols;
10 use serialize::{Decodable, Decoder, Encodable, Encoder};
14 use std::cmp::{PartialEq, Ordering, PartialOrd, Ord};
15 use std::hash::{Hash, Hasher};
17 use crate::hygiene::SyntaxContext;
18 use crate::{Span, DUMMY_SP, GLOBALS};
21 // After modifying this list adjust `is_special`, `is_used_keyword`/`is_unused_keyword`,
22 // this should be rarely necessary though if the keywords are kept in alphabetic order.
24 // Special reserved identifiers used internally for elided lifetimes,
25 // unnamed method parameters, crate root module, error recovery etc.
28 DollarCrate: "$crate",
31 // Keywords that are used in stable Rust.
68 // Keywords that are used in unstable Rust or reserved for future use.
82 // Edition-specific keywords that are used in stable Rust.
83 Dyn: "dyn", // >= 2018 Edition only
85 // Edition-specific keywords that are used in unstable Rust or reserved for future use.
86 Async: "async", // >= 2018 Edition only
87 Await: "await", // >= 2018 Edition only
88 Try: "try", // >= 2018 Edition only
90 // Special lifetime names
91 UnderscoreLifetime: "'_",
92 StaticLifetime: "'static",
94 // Weak keywords, have special meaning only in specific contexts.
98 Existential: "existential",
102 // Symbols that can be referred to with syntax_pos::sym::*. The symbol is
103 // the stringified identifier unless otherwise specified (e.g.
104 // `proc_dash_macro` represents "proc-macro").
106 aarch64_target_feature,
109 abi_msp430_interrupt,
117 advanced_slice_patterns,
129 allow_internal_unsafe,
130 allow_internal_unstable,
131 allow_internal_unstable_backcompat_hack,
134 arbitrary_self_types,
138 associated_type_defaults,
144 augmented_assignments,
145 automatically_derived,
146 avx512_target_feature,
149 bind_by_move_pattern_guards,
151 borrowck_graphviz_postflow,
152 borrowck_graphviz_preflow,
155 braced_empty_structs,
162 cfg_target_has_atomic,
163 cfg_target_thread_local,
168 closure_to_fn_coercion,
169 cmpxchg16b_target_feature,
174 conservative_impl_trait,
176 const_compare_raw_pointers,
184 const_raw_ptr_to_usize_cast,
195 crate_visibility_modifier,
198 custom_inner_attributes,
199 custom_test_frameworks,
202 default_lib_allocator,
203 default_type_parameter_fallback,
214 document_private_items,
215 dotdoteq_in_patterns,
216 dotdot_in_tuple_patterns,
217 double_braced_crate: "{{crate}}",
218 double_braced_impl: "{{impl}}",
219 double_braced_misc: "{{misc}}",
220 double_braced_closure: "{{closure}}",
221 double_braced_constructor: "{{constructor}}",
222 double_braced_constant: "{{constant}}",
223 double_braced_opaque: "{{opaque}}",
225 dropck_parametricity,
235 exclusive_range_pattern,
236 exhaustive_integer_patterns,
241 extern_absolute_paths,
243 extern_crate_item_prelude,
251 field_init_shorthand,
266 generic_associated_types,
271 hexagon_target_feature,
273 homogeneous_aggregate,
287 if_while_or_patterns,
289 impl_header_lifetime_elision,
290 impl_trait_in_bindings,
294 inclusive_range_syntax,
295 infer_outlives_requirements,
296 infer_static_outlives_requirements,
303 irrefutable_let_patterns,
306 issue_5723_bootstrap,
307 issue_tracker_base_url,
322 link_llvm_intrinsics,
329 macro_at_most_once_rep,
332 macro_lifetime_matcher,
333 macro_literal_matcher,
344 match_beginning_vert,
345 match_default_bindings,
355 movbe_target_feature,
388 omit_gdb_pretty_printer_section,
395 optin_builtin_traits,
400 overlapping_marker_traits,
404 panic_implementation,
418 poll_with_tls_context,
419 powerpc_target_feature,
420 precise_pointer_size_matching,
424 proc_dash_macro: "proc-macro",
426 proc_macro_attribute,
432 proc_macro_non_items,
433 proc_macro_path_invoc,
437 quad_precision_float,
450 reexport_test_harness_main,
460 re_rebalance_coherence,
470 rustc_allocator_nounwind,
471 rustc_allow_const_fn_ptr,
472 rustc_args_required_const,
475 rustc_const_unstable,
476 rustc_conversion_suggestion,
477 rustc_copy_clone_marker,
480 rustc_diagnostic_macros,
482 rustc_doc_only_macro,
483 rustc_dump_env_program_clauses,
484 rustc_dump_program_clauses,
485 rustc_dump_user_substs,
487 rustc_expected_cgu_reuse,
488 rustc_if_this_changed,
489 rustc_inherit_overflow_checks,
491 rustc_layout_scalar_valid_range_end,
492 rustc_layout_scalar_valid_range_start,
494 rustc_nonnull_optimization_guaranteed,
495 rustc_object_lifetime_default,
496 rustc_on_unimplemented,
499 rustc_partition_codegened,
500 rustc_partition_reused,
502 rustc_peek_definite_init,
503 rustc_peek_maybe_init,
504 rustc_peek_maybe_uninit,
506 rustc_proc_macro_decls,
510 rustc_std_internal_symbol,
514 rustc_then_this_would_need,
515 rustc_transparent_macro,
519 rust_eh_unwind_resume,
521 __rust_unstable_column,
522 rvalue_static_promotion,
538 sse4a_target_feature,
548 stmt_expr_attributes,
550 struct_field_attributes,
561 termination_trait_test,
564 test_accepted_feature,
565 test_removed_feature,
580 type_alias_enum_variants,
590 underscore_const_names,
592 underscore_lifetimes,
594 universal_impl_trait,
597 unrestricted_attribute_tokens,
598 unsafe_destructor_blind_to_params,
601 unsized_tuple_coercion,
613 visible_private_types,
616 warn_directory_ownership,
626 #[derive(Copy, Clone, Eq)]
634 /// Constructs a new identifier from a symbol and a span.
635 pub const fn new(name: Symbol, span: Span) -> Ident {
639 /// Constructs a new identifier with an empty syntax context.
641 pub const fn with_empty_ctxt(name: Symbol) -> Ident {
642 Ident::new(name, DUMMY_SP)
645 /// Maps an interned string to an identifier with an empty syntax context.
646 pub fn from_interned_str(string: InternedString) -> Ident {
647 Ident::with_empty_ctxt(string.as_symbol())
650 /// Maps a string to an identifier with an empty span.
651 pub fn from_str(string: &str) -> Ident {
652 Ident::with_empty_ctxt(Symbol::intern(string))
655 /// Maps a string and a span to an identifier.
656 pub fn from_str_and_span(string: &str, span: Span) -> Ident {
657 Ident::new(Symbol::intern(string), span)
660 /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
661 pub fn with_span_pos(self, span: Span) -> Ident {
662 Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
665 pub fn without_first_quote(self) -> Ident {
666 Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
669 /// "Normalize" ident for use in comparisons using "item hygiene".
670 /// Identifiers with same string value become same if they came from the same "modern" macro
671 /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
672 /// different "modern" macros.
673 /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
674 pub fn modern(self) -> Ident {
675 Ident::new(self.name, self.span.modern())
678 /// "Normalize" ident for use in comparisons using "local variable hygiene".
679 /// Identifiers with same string value become same if they came from the same non-transparent
680 /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
681 /// non-transparent macros.
682 /// Technically, this operation strips all transparent marks from ident's syntactic context.
683 pub fn modern_and_legacy(self) -> Ident {
684 Ident::new(self.name, self.span.modern_and_legacy())
687 /// Transforms an identifier into one with the same name, but gensymed.
688 pub fn gensym(self) -> Ident {
689 let name = with_interner(|interner| interner.gensymed(self.name));
690 Ident::new(name, self.span)
693 /// Transforms an underscore identifier into one with the same name, but
694 /// gensymed. Leaves non-underscore identifiers unchanged.
695 pub fn gensym_if_underscore(self) -> Ident {
696 if self.name == keywords::Underscore.name() { self.gensym() } else { self }
699 // WARNING: this function is deprecated and will be removed in the future.
700 pub fn is_gensymed(self) -> bool {
701 with_interner(|interner| interner.is_gensymed(self.name))
704 pub fn as_str(self) -> LocalInternedString {
708 pub fn as_interned_str(self) -> InternedString {
709 self.name.as_interned_str()
713 impl PartialEq for Ident {
714 fn eq(&self, rhs: &Self) -> bool {
715 self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
719 impl Hash for Ident {
720 fn hash<H: Hasher>(&self, state: &mut H) {
721 self.name.hash(state);
722 self.span.ctxt().hash(state);
726 impl fmt::Debug for Ident {
727 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
728 write!(f, "{}{:?}", self.name, self.span.ctxt())
732 impl fmt::Display for Ident {
733 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
734 fmt::Display::fmt(&self.name, f)
738 impl Encodable for Ident {
739 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
740 if self.span.ctxt().modern() == SyntaxContext::empty() {
741 s.emit_str(&self.as_str())
742 } else { // FIXME(jseyfried): intercrate hygiene
743 let mut string = "#".to_owned();
744 string.push_str(&self.as_str());
750 impl Decodable for Ident {
751 fn decode<D: Decoder>(d: &mut D) -> Result<Ident, D::Error> {
752 let string = d.read_str()?;
753 Ok(if !string.starts_with('#') {
754 Ident::from_str(&string)
755 } else { // FIXME(jseyfried): intercrate hygiene
756 Ident::from_str(&string[1..]).gensym()
761 /// A symbol is an interned or gensymed string. A gensym is a symbol that is
762 /// never equal to any other symbol.
764 /// Conceptually, a gensym can be thought of as a normal symbol with an
765 /// invisible unique suffix. Gensyms are useful when creating new identifiers
766 /// that must not match any existing identifiers, e.g. during macro expansion
767 /// and syntax desugaring. Because gensyms should always be identifiers, all
768 /// gensym operations are on `Ident` rather than `Symbol`. (Indeed, in the
769 /// future the gensym-ness may be moved from `Symbol` to hygiene data.)
773 /// assert_eq!(Ident::from_str("x"), Ident::from_str("x"))
774 /// assert_ne!(Ident::from_str("x").gensym(), Ident::from_str("x"))
775 /// assert_ne!(Ident::from_str("x").gensym(), Ident::from_str("x").gensym())
777 /// Internally, a symbol is implemented as an index, and all operations
778 /// (including hashing, equality, and ordering) operate on that index. The use
779 /// of `newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
780 /// because `newtype_index!` reserves the last 256 values for tagging purposes.
782 /// Note that `Symbol` cannot directly be a `newtype_index!` because it
783 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
784 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
785 pub struct Symbol(SymbolIndex);
788 pub struct SymbolIndex { .. }
792 const fn new(n: u32) -> Self {
793 Symbol(SymbolIndex::from_u32_const(n))
796 /// Maps a string to its interned representation.
797 pub fn intern(string: &str) -> Self {
798 with_interner(|interner| interner.intern(string))
801 pub fn as_str(self) -> LocalInternedString {
802 with_interner(|interner| unsafe {
803 LocalInternedString {
804 string: std::mem::transmute::<&str, &str>(interner.get(self))
809 pub fn as_interned_str(self) -> InternedString {
810 with_interner(|interner| InternedString {
811 symbol: interner.interned(self)
815 pub fn as_u32(self) -> u32 {
820 impl fmt::Debug for Symbol {
821 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
822 let is_gensymed = with_interner(|interner| interner.is_gensymed(*self));
824 write!(f, "{}({:?})", self, self.0)
826 write!(f, "{}", self)
831 impl fmt::Display for Symbol {
832 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
833 fmt::Display::fmt(&self.as_str(), f)
837 impl Encodable for Symbol {
838 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
839 s.emit_str(&self.as_str())
843 impl Decodable for Symbol {
844 fn decode<D: Decoder>(d: &mut D) -> Result<Symbol, D::Error> {
845 Ok(Symbol::intern(&d.read_str()?))
849 // The `&'static str`s in this type actually point into the arena.
851 // Note that normal symbols are indexed upward from 0, and gensyms are indexed
852 // downward from SymbolIndex::MAX_AS_U32.
854 pub struct Interner {
855 arena: DroplessArena,
856 names: FxHashMap<&'static str, Symbol>,
857 strings: Vec<&'static str>,
858 gensyms: Vec<Symbol>,
862 fn prefill(init: &[&str]) -> Self {
863 let mut this = Interner::default();
864 this.names.reserve(init.len());
865 this.strings.reserve(init.len());
867 // We can't allocate empty strings in the arena, so handle this here.
868 assert!(keywords::Invalid.name().as_u32() == 0 && init[0].is_empty());
869 this.names.insert("", keywords::Invalid.name());
870 this.strings.push("");
872 for string in &init[1..] {
878 pub fn intern(&mut self, string: &str) -> Symbol {
879 if let Some(&name) = self.names.get(string) {
883 let name = Symbol::new(self.strings.len() as u32);
885 // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
887 let string: &str = unsafe {
888 str::from_utf8_unchecked(self.arena.alloc_slice(string.as_bytes()))
890 // It is safe to extend the arena allocation to `'static` because we only access
891 // these while the arena is still alive.
892 let string: &'static str = unsafe {
893 &*(string as *const str)
895 self.strings.push(string);
896 self.names.insert(string, name);
900 fn interned(&self, symbol: Symbol) -> Symbol {
901 if (symbol.0.as_usize()) < self.strings.len() {
904 self.gensyms[(SymbolIndex::MAX_AS_U32 - symbol.0.as_u32()) as usize]
908 fn gensymed(&mut self, symbol: Symbol) -> Symbol {
909 self.gensyms.push(symbol);
910 Symbol::new(SymbolIndex::MAX_AS_U32 - self.gensyms.len() as u32 + 1)
913 fn is_gensymed(&mut self, symbol: Symbol) -> bool {
914 symbol.0.as_usize() >= self.strings.len()
917 // Get the symbol as a string. `Symbol::as_str()` should be used in
918 // preference to this function.
919 pub fn get(&self, symbol: Symbol) -> &str {
920 match self.strings.get(symbol.0.as_usize()) {
921 Some(string) => string,
923 let symbol = self.gensyms[(SymbolIndex::MAX_AS_U32 - symbol.0.as_u32()) as usize];
924 self.strings[symbol.0.as_usize()]
931 use super::{Symbol, Ident};
933 #[derive(Clone, Copy, PartialEq, Eq)]
940 pub fn ident(self) -> Ident {
945 pub fn name(self) -> Symbol {
953 // This module has a very short name because it's used a lot.
960 fn is_used_keyword_2018(self) -> bool {
961 self == keywords::Dyn.name()
964 fn is_unused_keyword_2018(self) -> bool {
965 self >= keywords::Async.name() && self <= keywords::Try.name()
970 // Returns `true` for reserved identifiers used internally for elided lifetimes,
971 // unnamed method parameters, crate root module, error recovery etc.
972 pub fn is_special(self) -> bool {
973 self.name <= keywords::Underscore.name()
976 /// Returns `true` if the token is a keyword used in the language.
977 pub fn is_used_keyword(self) -> bool {
978 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
979 self.name >= keywords::As.name() && self.name <= keywords::While.name() ||
980 self.name.is_used_keyword_2018() && self.span.rust_2018()
983 /// Returns `true` if the token is a keyword reserved for possible future use.
984 pub fn is_unused_keyword(self) -> bool {
985 // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
986 self.name >= keywords::Abstract.name() && self.name <= keywords::Yield.name() ||
987 self.name.is_unused_keyword_2018() && self.span.rust_2018()
990 /// Returns `true` if the token is either a special identifier or a keyword.
991 pub fn is_reserved(self) -> bool {
992 self.is_special() || self.is_used_keyword() || self.is_unused_keyword()
995 /// A keyword or reserved identifier that can be used as a path segment.
996 pub fn is_path_segment_keyword(self) -> bool {
997 self.name == keywords::Super.name() ||
998 self.name == keywords::SelfLower.name() ||
999 self.name == keywords::SelfUpper.name() ||
1000 self.name == keywords::Crate.name() ||
1001 self.name == keywords::PathRoot.name() ||
1002 self.name == keywords::DollarCrate.name()
1005 /// This identifier can be a raw identifier.
1006 pub fn can_be_raw(self) -> bool {
1007 self.name != keywords::Invalid.name() && self.name != keywords::Underscore.name() &&
1008 !self.is_path_segment_keyword()
1011 /// We see this identifier in a normal identifier position, like variable name or a type.
1012 /// How was it written originally? Did it use the raw form? Let's try to guess.
1013 pub fn is_raw_guess(self) -> bool {
1014 self.can_be_raw() && self.is_reserved()
1018 // If an interner exists, return it. Otherwise, prepare a fresh one.
1020 fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
1021 GLOBALS.with(|globals| f(&mut *globals.symbol_interner.lock()))
1024 /// An alternative to `Symbol` and `InternedString`, useful when the chars
1025 /// within the symbol need to be accessed. It is best used for temporary
1028 /// Because the interner outlives any thread which uses this type, we can
1029 /// safely treat `string` which points to interner data, as an immortal string,
1030 /// as long as this type never crosses between threads.
1032 // FIXME: ensure that the interner outlives any thread which uses
1033 // `LocalInternedString`, by creating a new thread right after constructing the
1035 #[derive(Clone, Copy, Hash, PartialOrd, Eq, Ord)]
1036 pub struct LocalInternedString {
1037 string: &'static str,
1040 impl LocalInternedString {
1041 /// Maps a string to its interned representation.
1042 pub fn intern(string: &str) -> Self {
1043 let string = with_interner(|interner| {
1044 let symbol = interner.intern(string);
1045 interner.strings[symbol.0.as_usize()]
1047 LocalInternedString {
1048 string: unsafe { std::mem::transmute::<&str, &str>(string) }
1052 pub fn as_interned_str(self) -> InternedString {
1054 symbol: Symbol::intern(self.string)
1058 pub fn get(&self) -> &str {
1059 // This returns a valid string since we ensure that `self` outlives the interner
1060 // by creating the interner on a thread which outlives threads which can access it.
1061 // This type cannot move to a thread which outlives the interner since it does
1062 // not implement Send.
1067 impl<U: ?Sized> std::convert::AsRef<U> for LocalInternedString
1069 str: std::convert::AsRef<U>
1071 fn as_ref(&self) -> &U {
1072 self.string.as_ref()
1076 impl<T: std::ops::Deref<Target = str>> std::cmp::PartialEq<T> for LocalInternedString {
1077 fn eq(&self, other: &T) -> bool {
1078 self.string == other.deref()
1082 impl std::cmp::PartialEq<LocalInternedString> for str {
1083 fn eq(&self, other: &LocalInternedString) -> bool {
1084 self == other.string
1088 impl<'a> std::cmp::PartialEq<LocalInternedString> for &'a str {
1089 fn eq(&self, other: &LocalInternedString) -> bool {
1090 *self == other.string
1094 impl std::cmp::PartialEq<LocalInternedString> for String {
1095 fn eq(&self, other: &LocalInternedString) -> bool {
1096 self == other.string
1100 impl<'a> std::cmp::PartialEq<LocalInternedString> for &'a String {
1101 fn eq(&self, other: &LocalInternedString) -> bool {
1102 *self == other.string
1106 impl !Send for LocalInternedString {}
1107 impl !Sync for LocalInternedString {}
1109 impl std::ops::Deref for LocalInternedString {
1111 fn deref(&self) -> &str { self.string }
1114 impl fmt::Debug for LocalInternedString {
1115 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1116 fmt::Debug::fmt(self.string, f)
1120 impl fmt::Display for LocalInternedString {
1121 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1122 fmt::Display::fmt(self.string, f)
1126 impl Decodable for LocalInternedString {
1127 fn decode<D: Decoder>(d: &mut D) -> Result<LocalInternedString, D::Error> {
1128 Ok(LocalInternedString::intern(&d.read_str()?))
1132 impl Encodable for LocalInternedString {
1133 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1134 s.emit_str(self.string)
1138 /// An alternative to `Symbol` that is focused on string contents. It has two
1139 /// main differences to `Symbol`.
1141 /// First, its implementations of `Hash`, `PartialOrd` and `Ord` work with the
1142 /// string chars rather than the symbol integer. This is useful when hash
1143 /// stability is required across compile sessions, or a guaranteed sort
1144 /// ordering is required.
1146 /// Second, gensym-ness is irrelevant. E.g.:
1148 /// assert_ne!(Symbol::gensym("x"), Symbol::gensym("x"))
1149 /// assert_eq!(Symbol::gensym("x").as_interned_str(), Symbol::gensym("x").as_interned_str())
1151 #[derive(Clone, Copy, PartialEq, Eq)]
1152 pub struct InternedString {
1156 impl InternedString {
1157 /// Maps a string to its interned representation.
1158 pub fn intern(string: &str) -> Self {
1160 symbol: Symbol::intern(string)
1164 pub fn with<F: FnOnce(&str) -> R, R>(self, f: F) -> R {
1165 let str = with_interner(|interner| {
1166 interner.get(self.symbol) as *const str
1168 // This is safe because the interner keeps string alive until it is dropped.
1169 // We can access it because we know the interner is still alive since we use a
1170 // scoped thread local to access it, and it was alive at the beginning of this scope
1174 fn with2<F: FnOnce(&str, &str) -> R, R>(self, other: &InternedString, f: F) -> R {
1175 let (self_str, other_str) = with_interner(|interner| {
1176 (interner.get(self.symbol) as *const str,
1177 interner.get(other.symbol) as *const str)
1179 // This is safe for the same reason that `with` is safe.
1180 unsafe { f(&*self_str, &*other_str) }
1183 pub fn as_symbol(self) -> Symbol {
1187 pub fn as_str(self) -> LocalInternedString {
1188 self.symbol.as_str()
1192 impl Hash for InternedString {
1193 fn hash<H: Hasher>(&self, state: &mut H) {
1194 self.with(|str| str.hash(state))
1198 impl PartialOrd<InternedString> for InternedString {
1199 fn partial_cmp(&self, other: &InternedString) -> Option<Ordering> {
1200 if self.symbol == other.symbol {
1201 return Some(Ordering::Equal);
1203 self.with2(other, |self_str, other_str| self_str.partial_cmp(other_str))
1207 impl Ord for InternedString {
1208 fn cmp(&self, other: &InternedString) -> Ordering {
1209 if self.symbol == other.symbol {
1210 return Ordering::Equal;
1212 self.with2(other, |self_str, other_str| self_str.cmp(other_str))
1216 impl fmt::Debug for InternedString {
1217 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1218 self.with(|str| fmt::Debug::fmt(&str, f))
1222 impl fmt::Display for InternedString {
1223 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1224 self.with(|str| fmt::Display::fmt(&str, f))
1228 impl Decodable for InternedString {
1229 fn decode<D: Decoder>(d: &mut D) -> Result<InternedString, D::Error> {
1230 Ok(InternedString::intern(&d.read_str()?))
1234 impl Encodable for InternedString {
1235 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1236 self.with(|string| s.emit_str(string))
1247 fn interner_tests() {
1248 let mut i: Interner = Interner::default();
1249 // first one is zero:
1250 assert_eq!(i.intern("dog"), Symbol::new(0));
1251 // re-use gets the same entry:
1252 assert_eq!(i.intern("dog"), Symbol::new(0));
1253 // different string gets a different #:
1254 assert_eq!(i.intern("cat"), Symbol::new(1));
1255 assert_eq!(i.intern("cat"), Symbol::new(1));
1256 // dog is still at zero
1257 assert_eq!(i.intern("dog"), Symbol::new(0));
1258 let z = i.intern("zebra");
1259 assert_eq!(i.gensymed(z), Symbol::new(SymbolIndex::MAX_AS_U32));
1260 // gensym of same string gets new number:
1261 assert_eq!(i.gensymed(z), Symbol::new(SymbolIndex::MAX_AS_U32 - 1));
1262 // gensym of *existing* string gets new number:
1263 let d = i.intern("dog");
1264 assert_eq!(i.gensymed(d), Symbol::new(SymbolIndex::MAX_AS_U32 - 2));
1268 fn without_first_quote_test() {
1269 GLOBALS.set(&Globals::new(edition::DEFAULT_EDITION), || {
1270 let i = Ident::from_str("'break");
1271 assert_eq!(i.without_first_quote().name, keywords::Break.name());