src/libsyntax_pos/symbol.rs

   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.
   4
   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};
  11
  12 use std::fmt;
  13 use std::str;
  14 use std::cmp::{PartialEq, Ordering, PartialOrd, Ord};
  15 use std::hash::{Hash, Hasher};
  16
  17 use crate::hygiene::SyntaxContext;
  18 use crate::{Span, DUMMY_SP, GLOBALS};
  19
  20 symbols! {
  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.
  23     Keywords {
  24         // Special reserved identifiers used internally for elided lifetimes,
  25         // unnamed method parameters, crate root module, error recovery etc.
  26         Invalid:            "",
  27         PathRoot:           "{{root}}",
  28         DollarCrate:        "$crate",
  29         Underscore:         "_",
  30
  31         // Keywords that are used in stable Rust.
  32         As:                 "as",
  33         Break:              "break",
  34         Const:              "const",
  35         Continue:           "continue",
  36         Crate:              "crate",
  37         Else:               "else",
  38         Enum:               "enum",
  39         Extern:             "extern",
  40         False:              "false",
  41         Fn:                 "fn",
  42         For:                "for",
  43         If:                 "if",
  44         Impl:               "impl",
  45         In:                 "in",
  46         Let:                "let",
  47         Loop:               "loop",
  48         Match:              "match",
  49         Mod:                "mod",
  50         Move:               "move",
  51         Mut:                "mut",
  52         Pub:                "pub",
  53         Ref:                "ref",
  54         Return:             "return",
  55         SelfLower:          "self",
  56         SelfUpper:          "Self",
  57         Static:             "static",
  58         Struct:             "struct",
  59         Super:              "super",
  60         Trait:              "trait",
  61         True:               "true",
  62         Type:               "type",
  63         Unsafe:             "unsafe",
  64         Use:                "use",
  65         Where:              "where",
  66         While:              "while",
  67
  68         // Keywords that are used in unstable Rust or reserved for future use.
  69         Abstract:           "abstract",
  70         Become:             "become",
  71         Box:                "box",
  72         Do:                 "do",
  73         Final:              "final",
  74         Macro:              "macro",
  75         Override:           "override",
  76         Priv:               "priv",
  77         Typeof:             "typeof",
  78         Unsized:            "unsized",
  79         Virtual:            "virtual",
  80         Yield:              "yield",
  81
  82         // Edition-specific keywords that are used in stable Rust.
  83         Dyn:                "dyn", // >= 2018 Edition only
  84
  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
  89
  90         // Special lifetime names
  91         UnderscoreLifetime: "'_",
  92         StaticLifetime:     "'static",
  93
  94         // Weak keywords, have special meaning only in specific contexts.
  95         Auto:               "auto",
  96         Catch:              "catch",
  97         Default:            "default",
  98         Existential:        "existential",
  99         Union:              "union",
 100     }
 101
 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").
 105     Symbols {
 106         aarch64_target_feature,
 107         abi,
 108         abi_amdgpu_kernel,
 109         abi_msp430_interrupt,
 110         abi_ptx,
 111         abi_sysv64,
 112         abi_thiscall,
 113         abi_unadjusted,
 114         abi_vectorcall,
 115         abi_x86_interrupt,
 116         aborts,
 117         advanced_slice_patterns,
 118         adx_target_feature,
 119         alias,
 120         align,
 121         alignstack,
 122         all,
 123         allocator,
 124         allocator_internals,
 125         alloc_error_handler,
 126         allow,
 127         allowed,
 128         allow_fail,
 129         allow_internal_unsafe,
 130         allow_internal_unstable,
 131         allow_internal_unstable_backcompat_hack,
 132         always,
 133         any,
 134         arbitrary_self_types,
 135         arm_target_feature,
 136         asm,
 137         associated_consts,
 138         associated_type_defaults,
 139         associated_types,
 140         async_await,
 141         attr,
 142         attributes,
 143         attr_literals,
 144         augmented_assignments,
 145         automatically_derived,
 146         avx512_target_feature,
 147         await_macro,
 148         bin,
 149         bind_by_move_pattern_guards,
 150         block,
 151         borrowck_graphviz_postflow,
 152         borrowck_graphviz_preflow,
 153         box_patterns,
 154         box_syntax,
 155         braced_empty_structs,
 156         C,
 157         cdylib,
 158         cfg,
 159         cfg_attr,
 160         cfg_attr_multi,
 161         cfg_target_feature,
 162         cfg_target_has_atomic,
 163         cfg_target_thread_local,
 164         cfg_target_vendor,
 165         clone,
 166         clone_closures,
 167         clone_from,
 168         closure_to_fn_coercion,
 169         cmpxchg16b_target_feature,
 170         cold,
 171         compile_error,
 172         compiler_builtins,
 173         concat_idents,
 174         conservative_impl_trait,
 175         console,
 176         const_compare_raw_pointers,
 177         const_fn,
 178         const_fn_union,
 179         const_generics,
 180         const_indexing,
 181         const_let,
 182         const_panic,
 183         const_raw_ptr_deref,
 184         const_raw_ptr_to_usize_cast,
 185         const_transmute,
 186         contents,
 187         convert,
 188         copy_closures,
 189         core,
 190         core_intrinsics,
 191         crate_id,
 192         crate_in_paths,
 193         crate_name,
 194         crate_type,
 195         crate_visibility_modifier,
 196         custom_attribute,
 197         custom_derive,
 198         custom_inner_attributes,
 199         custom_test_frameworks,
 200         c_variadic,
 201         decl_macro,
 202         default_lib_allocator,
 203         default_type_parameter_fallback,
 204         default_type_params,
 205         deny,
 206         deprecated,
 207         derive,
 208         doc,
 209         doc_alias,
 210         doc_cfg,
 211         doc_keyword,
 212         doc_masked,
 213         doc_spotlight,
 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}}",
 224         dropck_eyepatch,
 225         dropck_parametricity,
 226         drop_types_in_const,
 227         dylib,
 228         dyn_trait,
 229         eh_personality,
 230         eh_unwind_resume,
 231         enable,
 232         err,
 233         Err,
 234         except,
 235         exclusive_range_pattern,
 236         exhaustive_integer_patterns,
 237         exhaustive_patterns,
 238         existential_type,
 239         expected,
 240         export_name,
 241         extern_absolute_paths,
 242         external_doc,
 243         extern_crate_item_prelude,
 244         extern_crate_self,
 245         extern_in_paths,
 246         extern_prelude,
 247         extern_types,
 248         f16c_target_feature,
 249         feature,
 250         ffi_returns_twice,
 251         field_init_shorthand,
 252         file,
 253         fn_must_use,
 254         forbid,
 255         format_args_nl,
 256         from,
 257         From,
 258         from_error,
 259         from_generator,
 260         from_ok,
 261         fundamental,
 262         future,
 263         Future,
 264         gen_future,
 265         generators,
 266         generic_associated_types,
 267         generic_param_attrs,
 268         global_allocator,
 269         global_asm,
 270         globs,
 271         hexagon_target_feature,
 272         hidden,
 273         homogeneous_aggregate,
 274         html_favicon_url,
 275         html_logo_url,
 276         html_no_source,
 277         html_playground_url,
 278         html_root_url,
 279         i128,
 280         i128_type,
 281         i16,
 282         i32,
 283         i64,
 284         i8,
 285         ident,
 286         if_let,
 287         if_while_or_patterns,
 288         ignore,
 289         impl_header_lifetime_elision,
 290         impl_trait_in_bindings,
 291         import_shadowing,
 292         in_band_lifetimes,
 293         include,
 294         inclusive_range_syntax,
 295         infer_outlives_requirements,
 296         infer_static_outlives_requirements,
 297         inline,
 298         intel,
 299         into_iter,
 300         IntoIterator,
 301         into_result,
 302         intrinsics,
 303         irrefutable_let_patterns,
 304         isize,
 305         issue,
 306         issue_5723_bootstrap,
 307         issue_tracker_base_url,
 308         item_like_imports,
 309         iter,
 310         Iterator,
 311         keyword,
 312         kind,
 313         label,
 314         label_break_value,
 315         lang,
 316         lang_items,
 317         lib,
 318         link,
 319         linkage,
 320         link_args,
 321         link_cfg,
 322         link_llvm_intrinsics,
 323         link_name,
 324         link_section,
 325         lint_reasons,
 326         local_inner_macros,
 327         log_syntax,
 328         loop_break_value,
 329         macro_at_most_once_rep,
 330         macro_escape,
 331         macro_export,
 332         macro_lifetime_matcher,
 333         macro_literal_matcher,
 334         macro_reexport,
 335         macro_rules,
 336         macros_in_extern,
 337         macro_use,
 338         macro_vis_matcher,
 339         main,
 340         managed_boxes,
 341         marker,
 342         marker_trait_attr,
 343         masked,
 344         match_beginning_vert,
 345         match_default_bindings,
 346         may_dangle,
 347         message,
 348         meta,
 349         min_const_fn,
 350         min_const_unsafe_fn,
 351         mips_target_feature,
 352         mmx_target_feature,
 353         module,
 354         more_struct_aliases,
 355         movbe_target_feature,
 356         must_use,
 357         naked,
 358         naked_functions,
 359         name,
 360         needs_allocator,
 361         needs_panic_runtime,
 362         negate_unsigned,
 363         never,
 364         never_type,
 365         next,
 366         __next,
 367         nll,
 368         no_builtins,
 369         no_core,
 370         no_crate_inject,
 371         no_debug,
 372         no_default_passes,
 373         no_implicit_prelude,
 374         no_inline,
 375         no_link,
 376         no_main,
 377         no_mangle,
 378         non_ascii_idents,
 379         None,
 380         non_exhaustive,
 381         non_modrs_mods,
 382         no_stack_check,
 383         no_start,
 384         no_std,
 385         not,
 386         note,
 387         Ok,
 388         omit_gdb_pretty_printer_section,
 389         on,
 390         on_unimplemented,
 391         oom,
 392         ops,
 393         optimize,
 394         optimize_attribute,
 395         optin_builtin_traits,
 396         option,
 397         Option,
 398         opt_out_copy,
 399         Output,
 400         overlapping_marker_traits,
 401         packed,
 402         panic_handler,
 403         panic_impl,
 404         panic_implementation,
 405         panic_runtime,
 406         passes,
 407         path,
 408         pattern_parentheses,
 409         Pending,
 410         pin,
 411         Pin,
 412         pinned,
 413         platform_intrinsics,
 414         plugin,
 415         plugin_registrar,
 416         plugins,
 417         Poll,
 418         poll_with_tls_context,
 419         powerpc_target_feature,
 420         precise_pointer_size_matching,
 421         prelude,
 422         prelude_import,
 423         primitive,
 424         proc_dash_macro: "proc-macro",
 425         proc_macro,
 426         proc_macro_attribute,
 427         proc_macro_derive,
 428         proc_macro_expr,
 429         proc_macro_gen,
 430         proc_macro_hygiene,
 431         proc_macro_mod,
 432         proc_macro_non_items,
 433         proc_macro_path_invoc,
 434         profiler_runtime,
 435         pub_restricted,
 436         pushpop_unsafe,
 437         quad_precision_float,
 438         question_mark,
 439         quote,
 440         Range,
 441         RangeFrom,
 442         RangeFull,
 443         RangeInclusive,
 444         RangeTo,
 445         RangeToInclusive,
 446         raw_identifiers,
 447         Ready,
 448         reason,
 449         recursion_limit,
 450         reexport_test_harness_main,
 451         reflect,
 452         relaxed_adts,
 453         repr,
 454         repr128,
 455         repr_align,
 456         repr_align_enum,
 457         repr_packed,
 458         repr_simd,
 459         repr_transparent,
 460         re_rebalance_coherence,
 461         result,
 462         Result,
 463         Return,
 464         rlib,
 465         rtm_target_feature,
 466         rust,
 467         rust_2015_preview,
 468         rust_2018_preview,
 469         rust_begin_unwind,
 470         rustc_allocator_nounwind,
 471         rustc_allow_const_fn_ptr,
 472         rustc_args_required_const,
 473         rustc_attrs,
 474         rustc_clean,
 475         rustc_const_unstable,
 476         rustc_conversion_suggestion,
 477         rustc_copy_clone_marker,
 478         rustc_def_path,
 479         rustc_deprecated,
 480         rustc_diagnostic_macros,
 481         rustc_dirty,
 482         rustc_doc_only_macro,
 483         rustc_dump_env_program_clauses,
 484         rustc_dump_program_clauses,
 485         rustc_dump_user_substs,
 486         rustc_error,
 487         rustc_expected_cgu_reuse,
 488         rustc_if_this_changed,
 489         rustc_inherit_overflow_checks,
 490         rustc_layout,
 491         rustc_layout_scalar_valid_range_end,
 492         rustc_layout_scalar_valid_range_start,
 493         rustc_mir,
 494         rustc_nonnull_optimization_guaranteed,
 495         rustc_object_lifetime_default,
 496         rustc_on_unimplemented,
 497         rustc_outlives,
 498         rustc_paren_sugar,
 499         rustc_partition_codegened,
 500         rustc_partition_reused,
 501         rustc_peek,
 502         rustc_peek_definite_init,
 503         rustc_peek_maybe_init,
 504         rustc_peek_maybe_uninit,
 505         rustc_private,
 506         rustc_proc_macro_decls,
 507         rustc_promotable,
 508         rustc_regions,
 509         rustc_stable,
 510         rustc_std_internal_symbol,
 511         rustc_symbol_name,
 512         rustc_synthetic,
 513         rustc_test_marker,
 514         rustc_then_this_would_need,
 515         rustc_transparent_macro,
 516         rustc_variance,
 517         rustdoc,
 518         rust_eh_personality,
 519         rust_eh_unwind_resume,
 520         rust_oom,
 521         __rust_unstable_column,
 522         rvalue_static_promotion,
 523         sanitizer_runtime,
 524         self_in_typedefs,
 525         self_struct_ctor,
 526         Send,
 527         should_panic,
 528         simd,
 529         simd_ffi,
 530         since,
 531         size,
 532         slice_patterns,
 533         slicing_syntax,
 534         Some,
 535         specialization,
 536         speed,
 537         spotlight,
 538         sse4a_target_feature,
 539         stable,
 540         staged_api,
 541         start,
 542         static_in_const,
 543         staticlib,
 544         static_nobundle,
 545         static_recursion,
 546         std,
 547         str,
 548         stmt_expr_attributes,
 549         stop_after_dataflow,
 550         struct_field_attributes,
 551         struct_inherit,
 552         structural_match,
 553         struct_variant,
 554         suggestion,
 555         target_feature,
 556         target_has_atomic,
 557         target_thread_local,
 558         task,
 559         tbm_target_feature,
 560         termination_trait,
 561         termination_trait_test,
 562         test,
 563         test_2018_feature,
 564         test_accepted_feature,
 565         test_removed_feature,
 566         test_runner,
 567         thread_local,
 568         tool_attributes,
 569         tool_lints,
 570         trace_macros,
 571         trait_alias,
 572         transmute,
 573         transparent,
 574         trivial_bounds,
 575         Try,
 576         try_blocks,
 577         try_trait,
 578         tuple_indexing,
 579         ty,
 580         type_alias_enum_variants,
 581         type_ascription,
 582         type_length_limit,
 583         type_macros,
 584         u128,
 585         u16,
 586         u32,
 587         u64,
 588         u8,
 589         unboxed_closures,
 590         underscore_const_names,
 591         underscore_imports,
 592         underscore_lifetimes,
 593         uniform_paths,
 594         universal_impl_trait,
 595         unmarked_api,
 596         unreachable_code,
 597         unrestricted_attribute_tokens,
 598         unsafe_destructor_blind_to_params,
 599         unsafe_no_drop_flag,
 600         unsized_locals,
 601         unsized_tuple_coercion,
 602         unstable,
 603         untagged_unions,
 604         unwind,
 605         unwind_attributes,
 606         used,
 607         use_extern_macros,
 608         use_nested_groups,
 609         usize,
 610         v1,
 611         val,
 612         vis,
 613         visible_private_types,
 614         volatile,
 615         warn,
 616         warn_directory_ownership,
 617         wasm_import_module,
 618         wasm_target_feature,
 619         while_let,
 620         windows,
 621         windows_subsystem,
 622         Yield,
 623     }
 624 }
 625
 626 #[derive(Copy, Clone, Eq)]
 627 pub struct Ident {
 628     pub name: Symbol,
 629     pub span: Span,
 630 }
 631
 632 impl Ident {
 633     #[inline]
 634     /// Constructs a new identifier from a symbol and a span.
 635     pub const fn new(name: Symbol, span: Span) -> Ident {
 636         Ident { name, span }
 637     }
 638
 639     /// Constructs a new identifier with an empty syntax context.
 640     #[inline]
 641     pub const fn with_empty_ctxt(name: Symbol) -> Ident {
 642         Ident::new(name, DUMMY_SP)
 643     }
 644
 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())
 648     }
 649
 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))
 653     }
 654
 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)
 658     }
 659
 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()))
 663     }
 664
 665     pub fn without_first_quote(self) -> Ident {
 666         Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
 667     }
 668
 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())
 676     }
 677
 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())
 685     }
 686
 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)
 691     }
 692
 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 }
 697     }
 698
 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))
 702     }
 703
 704     pub fn as_str(self) -> LocalInternedString {
 705         self.name.as_str()
 706     }
 707
 708     pub fn as_interned_str(self) -> InternedString {
 709         self.name.as_interned_str()
 710     }
 711 }
 712
 713 impl PartialEq for Ident {
 714     fn eq(&self, rhs: &Self) -> bool {
 715         self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
 716     }
 717 }
 718
 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);
 723     }
 724 }
 725
 726 impl fmt::Debug for Ident {
 727     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 728         write!(f, "{}{:?}", self.name, self.span.ctxt())
 729     }
 730 }
 731
 732 impl fmt::Display for Ident {
 733     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 734         fmt::Display::fmt(&self.name, f)
 735     }
 736 }
 737
 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());
 745             s.emit_str(&string)
 746         }
 747     }
 748 }
 749
 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()
 757         })
 758     }
 759 }
 760
 761 /// A symbol is an interned or gensymed string. A gensym is a symbol that is
 762 /// never equal to any other symbol.
 763 ///
 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.)
 770 ///
 771 /// Examples:
 772 /// ```
 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())
 776 /// ```
 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.
 781 ///
 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);
 786
 787 newtype_index! {
 788     pub struct SymbolIndex { .. }
 789 }
 790
 791 impl Symbol {
 792     const fn new(n: u32) -> Self {
 793         Symbol(SymbolIndex::from_u32_const(n))
 794     }
 795
 796     /// Maps a string to its interned representation.
 797     pub fn intern(string: &str) -> Self {
 798         with_interner(|interner| interner.intern(string))
 799     }
 800
 801     pub fn as_str(self) -> LocalInternedString {
 802         with_interner(|interner| unsafe {
 803             LocalInternedString {
 804                 string: std::mem::transmute::<&str, &str>(interner.get(self))
 805             }
 806         })
 807     }
 808
 809     pub fn as_interned_str(self) -> InternedString {
 810         with_interner(|interner| InternedString {
 811             symbol: interner.interned(self)
 812         })
 813     }
 814
 815     pub fn as_u32(self) -> u32 {
 816         self.0.as_u32()
 817     }
 818 }
 819
 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));
 823         if is_gensymed {
 824             write!(f, "{}({:?})", self, self.0)
 825         } else {
 826             write!(f, "{}", self)
 827         }
 828     }
 829 }
 830
 831 impl fmt::Display for Symbol {
 832     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 833         fmt::Display::fmt(&self.as_str(), f)
 834     }
 835 }
 836
 837 impl Encodable for Symbol {
 838     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 839         s.emit_str(&self.as_str())
 840     }
 841 }
 842
 843 impl Decodable for Symbol {
 844     fn decode<D: Decoder>(d: &mut D) -> Result<Symbol, D::Error> {
 845         Ok(Symbol::intern(&d.read_str()?))
 846     }
 847 }
 848
 849 // The `&'static str`s in this type actually point into the arena.
 850 //
 851 // Note that normal symbols are indexed upward from 0, and gensyms are indexed
 852 // downward from SymbolIndex::MAX_AS_U32.
 853 #[derive(Default)]
 854 pub struct Interner {
 855     arena: DroplessArena,
 856     names: FxHashMap<&'static str, Symbol>,
 857     strings: Vec<&'static str>,
 858     gensyms: Vec<Symbol>,
 859 }
 860
 861 impl Interner {
 862     fn prefill(init: &[&str]) -> Self {
 863         let mut this = Interner::default();
 864         this.names.reserve(init.len());
 865         this.strings.reserve(init.len());
 866
 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("");
 871
 872         for string in &init[1..] {
 873             this.intern(string);
 874         }
 875         this
 876     }
 877
 878     pub fn intern(&mut self, string: &str) -> Symbol {
 879         if let Some(&name) = self.names.get(string) {
 880             return name;
 881         }
 882
 883         let name = Symbol::new(self.strings.len() as u32);
 884
 885         // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
 886         // UTF-8.
 887         let string: &str = unsafe {
 888             str::from_utf8_unchecked(self.arena.alloc_slice(string.as_bytes()))
 889         };
 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)
 894         };
 895         self.strings.push(string);
 896         self.names.insert(string, name);
 897         name
 898     }
 899
 900     fn interned(&self, symbol: Symbol) -> Symbol {
 901         if (symbol.0.as_usize()) < self.strings.len() {
 902             symbol
 903         } else {
 904             self.gensyms[(SymbolIndex::MAX_AS_U32 - symbol.0.as_u32()) as usize]
 905         }
 906     }
 907
 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)
 911     }
 912
 913     fn is_gensymed(&mut self, symbol: Symbol) -> bool {
 914         symbol.0.as_usize() >= self.strings.len()
 915     }
 916
 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,
 922             None => {
 923                 let symbol = self.gensyms[(SymbolIndex::MAX_AS_U32 - symbol.0.as_u32()) as usize];
 924                 self.strings[symbol.0.as_usize()]
 925             }
 926         }
 927     }
 928 }
 929
 930 pub mod keywords {
 931     use super::{Symbol, Ident};
 932
 933     #[derive(Clone, Copy, PartialEq, Eq)]
 934     pub struct Keyword {
 935         ident: Ident,
 936     }
 937
 938     impl Keyword {
 939         #[inline]
 940         pub fn ident(self) -> Ident {
 941             self.ident
 942         }
 943
 944         #[inline]
 945         pub fn name(self) -> Symbol {
 946             self.ident.name
 947         }
 948     }
 949
 950     keywords!();
 951 }
 952
 953 // This module has a very short name because it's used a lot.
 954 pub mod sym {
 955     use super::Symbol;
 956     symbols!();
 957 }
 958
 959 impl Symbol {
 960     fn is_used_keyword_2018(self) -> bool {
 961         self == keywords::Dyn.name()
 962     }
 963
 964     fn is_unused_keyword_2018(self) -> bool {
 965         self >= keywords::Async.name() && self <= keywords::Try.name()
 966     }
 967 }
 968
 969 impl Ident {
 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()
 974     }
 975
 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()
 981     }
 982
 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()
 988     }
 989
 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()
 993     }
 994
 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()
1003     }
1004
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()
1009     }
1010
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()
1015     }
1016 }
1017
1018 // If an interner exists, return it. Otherwise, prepare a fresh one.
1019 #[inline]
1020 fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
1021     GLOBALS.with(|globals| f(&mut *globals.symbol_interner.lock()))
1022 }
1023
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
1026 /// values.
1027 ///
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.
1031 //
1032 // FIXME: ensure that the interner outlives any thread which uses
1033 // `LocalInternedString`, by creating a new thread right after constructing the
1034 // interner.
1035 #[derive(Clone, Copy, Hash, PartialOrd, Eq, Ord)]
1036 pub struct LocalInternedString {
1037     string: &'static str,
1038 }
1039
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()]
1046         });
1047         LocalInternedString {
1048             string: unsafe { std::mem::transmute::<&str, &str>(string) }
1049         }
1050     }
1051
1052     pub fn as_interned_str(self) -> InternedString {
1053         InternedString {
1054             symbol: Symbol::intern(self.string)
1055         }
1056     }
1057
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.
1063         self.string
1064     }
1065 }
1066
1067 impl<U: ?Sized> std::convert::AsRef<U> for LocalInternedString
1068 where
1069     str: std::convert::AsRef<U>
1070 {
1071     fn as_ref(&self) -> &U {
1072         self.string.as_ref()
1073     }
1074 }
1075
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()
1079     }
1080 }
1081
1082 impl std::cmp::PartialEq<LocalInternedString> for str {
1083     fn eq(&self, other: &LocalInternedString) -> bool {
1084         self == other.string
1085     }
1086 }
1087
1088 impl<'a> std::cmp::PartialEq<LocalInternedString> for &'a str {
1089     fn eq(&self, other: &LocalInternedString) -> bool {
1090         *self == other.string
1091     }
1092 }
1093
1094 impl std::cmp::PartialEq<LocalInternedString> for String {
1095     fn eq(&self, other: &LocalInternedString) -> bool {
1096         self == other.string
1097     }
1098 }
1099
1100 impl<'a> std::cmp::PartialEq<LocalInternedString> for &'a String {
1101     fn eq(&self, other: &LocalInternedString) -> bool {
1102         *self == other.string
1103     }
1104 }
1105
1106 impl !Send for LocalInternedString {}
1107 impl !Sync for LocalInternedString {}
1108
1109 impl std::ops::Deref for LocalInternedString {
1110     type Target = str;
1111     fn deref(&self) -> &str { self.string }
1112 }
1113
1114 impl fmt::Debug for LocalInternedString {
1115     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1116         fmt::Debug::fmt(self.string, f)
1117     }
1118 }
1119
1120 impl fmt::Display for LocalInternedString {
1121     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1122         fmt::Display::fmt(self.string, f)
1123     }
1124 }
1125
1126 impl Decodable for LocalInternedString {
1127     fn decode<D: Decoder>(d: &mut D) -> Result<LocalInternedString, D::Error> {
1128         Ok(LocalInternedString::intern(&d.read_str()?))
1129     }
1130 }
1131
1132 impl Encodable for LocalInternedString {
1133     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1134         s.emit_str(self.string)
1135     }
1136 }
1137
1138 /// An alternative to `Symbol` that is focused on string contents. It has two
1139 /// main differences to `Symbol`.
1140 ///
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.
1145 ///
1146 /// Second, gensym-ness is irrelevant. E.g.:
1147 /// ```
1148 /// assert_ne!(Symbol::gensym("x"), Symbol::gensym("x"))
1149 /// assert_eq!(Symbol::gensym("x").as_interned_str(), Symbol::gensym("x").as_interned_str())
1150 /// ```
1151 #[derive(Clone, Copy, PartialEq, Eq)]
1152 pub struct InternedString {
1153     symbol: Symbol,
1154 }
1155
1156 impl InternedString {
1157     /// Maps a string to its interned representation.
1158     pub fn intern(string: &str) -> Self {
1159         InternedString {
1160             symbol: Symbol::intern(string)
1161         }
1162     }
1163
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
1167         });
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
1171         unsafe { f(&*str) }
1172     }
1173
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)
1178         });
1179         // This is safe for the same reason that `with` is safe.
1180         unsafe { f(&*self_str, &*other_str) }
1181     }
1182
1183     pub fn as_symbol(self) -> Symbol {
1184         self.symbol
1185     }
1186
1187     pub fn as_str(self) -> LocalInternedString {
1188         self.symbol.as_str()
1189     }
1190 }
1191
1192 impl Hash for InternedString {
1193     fn hash<H: Hasher>(&self, state: &mut H) {
1194         self.with(|str| str.hash(state))
1195     }
1196 }
1197
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);
1202         }
1203         self.with2(other, |self_str, other_str| self_str.partial_cmp(other_str))
1204     }
1205 }
1206
1207 impl Ord for InternedString {
1208     fn cmp(&self, other: &InternedString) -> Ordering {
1209         if self.symbol == other.symbol {
1210             return Ordering::Equal;
1211         }
1212         self.with2(other, |self_str, other_str| self_str.cmp(other_str))
1213     }
1214 }
1215
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))
1219     }
1220 }
1221
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))
1225     }
1226 }
1227
1228 impl Decodable for InternedString {
1229     fn decode<D: Decoder>(d: &mut D) -> Result<InternedString, D::Error> {
1230         Ok(InternedString::intern(&d.read_str()?))
1231     }
1232 }
1233
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))
1237     }
1238 }
1239
1240 #[cfg(test)]
1241 mod tests {
1242     use super::*;
1243     use crate::Globals;
1244     use crate::edition;
1245
1246     #[test]
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));
1265     }
1266
1267     #[test]
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());
1272         });
1273     }
1274 }