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_index::vec::Idx;
   8 use rustc_macros::{symbols, HashStable_Generic};
   9 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
  10 use rustc_serialize::{UseSpecializedDecodable, UseSpecializedEncodable};
  11 use rustc_data_structures::stable_hasher::{HashStable, ToStableHashKey, StableHasher};
  12
  13 use std::cmp::{PartialEq, PartialOrd, Ord};
  14 use std::fmt;
  15 use std::hash::{Hash, Hasher};
  16 use std::str;
  17
  18 use crate::{Span, DUMMY_SP, GLOBALS};
  19
  20 #[cfg(test)]
  21 mod tests;
  22
  23 symbols! {
  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.
  26     Keywords {
  27         // Special reserved identifiers used internally for elided lifetimes,
  28         // unnamed method parameters, crate root module, error recovery etc.
  29         Invalid:            "",
  30         PathRoot:           "{{root}}",
  31         DollarCrate:        "$crate",
  32         Underscore:         "_",
  33
  34         // Keywords that are used in stable Rust.
  35         As:                 "as",
  36         Break:              "break",
  37         Const:              "const",
  38         Continue:           "continue",
  39         Crate:              "crate",
  40         Else:               "else",
  41         Enum:               "enum",
  42         Extern:             "extern",
  43         False:              "false",
  44         Fn:                 "fn",
  45         For:                "for",
  46         If:                 "if",
  47         Impl:               "impl",
  48         In:                 "in",
  49         Let:                "let",
  50         Loop:               "loop",
  51         Match:              "match",
  52         Mod:                "mod",
  53         Move:               "move",
  54         Mut:                "mut",
  55         Pub:                "pub",
  56         Ref:                "ref",
  57         Return:             "return",
  58         SelfLower:          "self",
  59         SelfUpper:          "Self",
  60         Static:             "static",
  61         Struct:             "struct",
  62         Super:              "super",
  63         Trait:              "trait",
  64         True:               "true",
  65         Type:               "type",
  66         Unsafe:             "unsafe",
  67         Use:                "use",
  68         Where:              "where",
  69         While:              "while",
  70
  71         // Keywords that are used in unstable Rust or reserved for future use.
  72         Abstract:           "abstract",
  73         Become:             "become",
  74         Box:                "box",
  75         Do:                 "do",
  76         Final:              "final",
  77         Macro:              "macro",
  78         Override:           "override",
  79         Priv:               "priv",
  80         Typeof:             "typeof",
  81         Unsized:            "unsized",
  82         Virtual:            "virtual",
  83         Yield:              "yield",
  84
  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
  89
  90         // Edition-specific keywords that are used in unstable Rust or reserved for future use.
  91         Try:                "try", // >= 2018 Edition only
  92
  93         // Special lifetime names
  94         UnderscoreLifetime: "'_",
  95         StaticLifetime:     "'static",
  96
  97         // Weak keywords, have special meaning only in specific contexts.
  98         Auto:               "auto",
  99         Catch:              "catch",
 100         Default:            "default",
 101         Raw:                "raw",
 102         Union:              "union",
 103     }
 104
 105     // Symbols that can be referred to with syntax_pos::sym::*. The symbol is
 106     // the stringified identifier unless otherwise specified (e.g.
 107     // `proc_dash_macro` represents "proc-macro").
 108     //
 109     // As well as the symbols listed, there are symbols for the the strings
 110     // "0", "1", ..., "9", which are accessible via `sym::integer`.
 111     Symbols {
 112         aarch64_target_feature,
 113         abi,
 114         abi_amdgpu_kernel,
 115         abi_efiapi,
 116         abi_msp430_interrupt,
 117         abi_ptx,
 118         abi_sysv64,
 119         abi_thiscall,
 120         abi_unadjusted,
 121         abi_vectorcall,
 122         abi_x86_interrupt,
 123         aborts,
 124         add_with_overflow,
 125         advanced_slice_patterns,
 126         adx_target_feature,
 127         alias,
 128         align,
 129         alignstack,
 130         all,
 131         allocator,
 132         allocator_internals,
 133         alloc_error_handler,
 134         allow,
 135         allowed,
 136         allow_fail,
 137         allow_internal_unsafe,
 138         allow_internal_unstable,
 139         allow_internal_unstable_backcompat_hack,
 140         always,
 141         and,
 142         any,
 143         arbitrary_enum_discriminant,
 144         arbitrary_self_types,
 145         Arguments,
 146         ArgumentV1,
 147         arm_target_feature,
 148         asm,
 149         assert,
 150         associated_consts,
 151         associated_type_bounds,
 152         associated_type_defaults,
 153         associated_types,
 154         assume_init,
 155         async_await,
 156         async_closure,
 157         attr,
 158         attributes,
 159         attr_literals,
 160         augmented_assignments,
 161         automatically_derived,
 162         avx512_target_feature,
 163         await_macro,
 164         begin_panic,
 165         bench,
 166         bin,
 167         bind_by_move_pattern_guards,
 168         block,
 169         bool,
 170         borrowck_graphviz_postflow,
 171         borrowck_graphviz_preflow,
 172         box_patterns,
 173         box_syntax,
 174         braced_empty_structs,
 175         bswap,
 176         bitreverse,
 177         C,
 178         caller_location,
 179         cdylib,
 180         cfg,
 181         cfg_attr,
 182         cfg_attr_multi,
 183         cfg_doctest,
 184         cfg_sanitize,
 185         cfg_target_feature,
 186         cfg_target_has_atomic,
 187         cfg_target_thread_local,
 188         cfg_target_vendor,
 189         char,
 190         clippy,
 191         clone,
 192         Clone,
 193         clone_closures,
 194         clone_from,
 195         closure_to_fn_coercion,
 196         cmp,
 197         cmpxchg16b_target_feature,
 198         cold,
 199         column,
 200         compile_error,
 201         compiler_builtins,
 202         concat,
 203         concat_idents,
 204         conservative_impl_trait,
 205         console,
 206         const_compare_raw_pointers,
 207         const_constructor,
 208         const_extern_fn,
 209         const_fn,
 210         const_fn_union,
 211         const_generics,
 212         const_if_match,
 213         const_indexing,
 214         const_in_array_repeat_expressions,
 215         const_let,
 216         const_loop,
 217         const_mut_refs,
 218         const_panic,
 219         const_raw_ptr_deref,
 220         const_raw_ptr_to_usize_cast,
 221         const_transmute,
 222         contents,
 223         context,
 224         convert,
 225         Copy,
 226         copy_closures,
 227         core,
 228         core_intrinsics,
 229         crate_id,
 230         crate_in_paths,
 231         crate_local,
 232         crate_name,
 233         crate_type,
 234         crate_visibility_modifier,
 235         ctpop,
 236         cttz,
 237         cttz_nonzero,
 238         ctlz,
 239         ctlz_nonzero,
 240         custom_attribute,
 241         custom_derive,
 242         custom_inner_attributes,
 243         custom_test_frameworks,
 244         c_variadic,
 245         debug_trait,
 246         declare_lint_pass,
 247         decl_macro,
 248         Debug,
 249         Decodable,
 250         Default,
 251         default_lib_allocator,
 252         default_type_parameter_fallback,
 253         default_type_params,
 254         delay_span_bug_from_inside_query,
 255         deny,
 256         deprecated,
 257         deref,
 258         deref_mut,
 259         derive,
 260         diagnostic,
 261         direct,
 262         doc,
 263         doc_alias,
 264         doc_cfg,
 265         doc_keyword,
 266         doc_masked,
 267         doc_spotlight,
 268         doctest,
 269         document_private_items,
 270         dotdoteq_in_patterns,
 271         dotdot_in_tuple_patterns,
 272         double_braced_crate: "{{crate}}",
 273         double_braced_impl: "{{impl}}",
 274         double_braced_misc: "{{misc}}",
 275         double_braced_closure: "{{closure}}",
 276         double_braced_constructor: "{{constructor}}",
 277         double_braced_constant: "{{constant}}",
 278         double_braced_opaque: "{{opaque}}",
 279         dropck_eyepatch,
 280         dropck_parametricity,
 281         drop_types_in_const,
 282         dylib,
 283         dyn_trait,
 284         eh_personality,
 285         eh_unwind_resume,
 286         enable,
 287         Encodable,
 288         env,
 289         eq,
 290         err,
 291         Err,
 292         Eq,
 293         Equal,
 294         enclosing_scope,
 295         except,
 296         exclusive_range_pattern,
 297         exhaustive_integer_patterns,
 298         exhaustive_patterns,
 299         existential_type,
 300         expected,
 301         export_name,
 302         expr,
 303         extern_absolute_paths,
 304         external_doc,
 305         extern_crate_item_prelude,
 306         extern_crate_self,
 307         extern_in_paths,
 308         extern_prelude,
 309         extern_types,
 310         f16c_target_feature,
 311         f32,
 312         f64,
 313         feature,
 314         ffi_returns_twice,
 315         field,
 316         field_init_shorthand,
 317         file,
 318         fmt,
 319         fmt_internals,
 320         fn_must_use,
 321         forbid,
 322         format_args,
 323         format_args_nl,
 324         from,
 325         From,
 326         from_desugaring,
 327         from_error,
 328         from_generator,
 329         from_method,
 330         from_ok,
 331         from_usize,
 332         fundamental,
 333         future,
 334         Future,
 335         FxHashSet,
 336         FxHashMap,
 337         gen_future,
 338         generators,
 339         generic_associated_types,
 340         generic_param_attrs,
 341         global_allocator,
 342         global_asm,
 343         globs,
 344         hash,
 345         Hash,
 346         HashSet,
 347         HashMap,
 348         hexagon_target_feature,
 349         hidden,
 350         homogeneous_aggregate,
 351         html_favicon_url,
 352         html_logo_url,
 353         html_no_source,
 354         html_playground_url,
 355         html_root_url,
 356         i128,
 357         i128_type,
 358         i16,
 359         i32,
 360         i64,
 361         i8,
 362         ident,
 363         if_let,
 364         if_while_or_patterns,
 365         ignore,
 366         impl_header_lifetime_elision,
 367         impl_lint_pass,
 368         impl_trait_in_bindings,
 369         import_shadowing,
 370         index,
 371         index_mut,
 372         in_band_lifetimes,
 373         include,
 374         include_bytes,
 375         include_str,
 376         inclusive_range_syntax,
 377         infer_outlives_requirements,
 378         infer_static_outlives_requirements,
 379         inline,
 380         intel,
 381         into_iter,
 382         IntoIterator,
 383         into_result,
 384         intrinsics,
 385         irrefutable_let_patterns,
 386         isize,
 387         issue,
 388         issue_5723_bootstrap,
 389         issue_tracker_base_url,
 390         item,
 391         item_context: "ItemContext",
 392         item_like_imports,
 393         iter,
 394         Iterator,
 395         keyword,
 396         kind,
 397         label,
 398         label_break_value,
 399         lang,
 400         lang_items,
 401         let_chains,
 402         lhs,
 403         lib,
 404         lifetime,
 405         line,
 406         link,
 407         linkage,
 408         link_args,
 409         link_cfg,
 410         link_llvm_intrinsics,
 411         link_name,
 412         link_ordinal,
 413         link_section,
 414         LintPass,
 415         lint_reasons,
 416         literal,
 417         local_inner_macros,
 418         log_syntax,
 419         loop_break_value,
 420         macro_at_most_once_rep,
 421         macro_escape,
 422         macro_export,
 423         macro_lifetime_matcher,
 424         macro_literal_matcher,
 425         macro_reexport,
 426         macro_rules,
 427         macros_in_extern,
 428         macro_use,
 429         macro_vis_matcher,
 430         main,
 431         managed_boxes,
 432         marker,
 433         marker_trait_attr,
 434         masked,
 435         match_beginning_vert,
 436         match_default_bindings,
 437         may_dangle,
 438         maybe_uninit_uninit,
 439         maybe_uninit_zeroed,
 440         mem_uninitialized,
 441         mem_zeroed,
 442         member_constraints,
 443         message,
 444         meta,
 445         min_align_of,
 446         min_const_fn,
 447         min_const_unsafe_fn,
 448         mips_target_feature,
 449         mmx_target_feature,
 450         module,
 451         module_path,
 452         more_struct_aliases,
 453         move_val_init,
 454         movbe_target_feature,
 455         mul_with_overflow,
 456         must_use,
 457         naked,
 458         naked_functions,
 459         name,
 460         needs_allocator,
 461         needs_drop,
 462         needs_panic_runtime,
 463         negate_unsigned,
 464         never,
 465         never_type,
 466         never_type_fallback,
 467         new,
 468         next,
 469         __next,
 470         nll,
 471         no_builtins,
 472         no_core,
 473         no_crate_inject,
 474         no_debug,
 475         no_default_passes,
 476         no_implicit_prelude,
 477         no_inline,
 478         no_link,
 479         no_main,
 480         no_mangle,
 481         non_ascii_idents,
 482         None,
 483         non_exhaustive,
 484         non_modrs_mods,
 485         no_stack_check,
 486         no_start,
 487         no_std,
 488         not,
 489         note,
 490         object_safe_for_dispatch,
 491         Ok,
 492         omit_gdb_pretty_printer_section,
 493         on,
 494         on_unimplemented,
 495         oom,
 496         ops,
 497         optimize,
 498         optimize_attribute,
 499         optin_builtin_traits,
 500         option,
 501         Option,
 502         option_env,
 503         opt_out_copy,
 504         or,
 505         or_patterns,
 506         Ord,
 507         Ordering,
 508         Output,
 509         overlapping_marker_traits,
 510         packed,
 511         panic,
 512         panic_handler,
 513         panic_impl,
 514         panic_implementation,
 515         panic_runtime,
 516         parent_trait,
 517         partial_cmp,
 518         param_attrs,
 519         PartialEq,
 520         PartialOrd,
 521         passes,
 522         pat,
 523         path,
 524         pattern_parentheses,
 525         Pending,
 526         pin,
 527         Pin,
 528         pinned,
 529         platform_intrinsics,
 530         plugin,
 531         plugin_registrar,
 532         plugins,
 533         Poll,
 534         poll_with_tls_context,
 535         powerpc_target_feature,
 536         precise_pointer_size_matching,
 537         pref_align_of,
 538         prelude,
 539         prelude_import,
 540         primitive,
 541         proc_dash_macro: "proc-macro",
 542         proc_macro,
 543         proc_macro_attribute,
 544         proc_macro_def_site,
 545         proc_macro_derive,
 546         proc_macro_expr,
 547         proc_macro_gen,
 548         proc_macro_hygiene,
 549         proc_macro_internals,
 550         proc_macro_mod,
 551         proc_macro_non_items,
 552         proc_macro_path_invoc,
 553         profiler_runtime,
 554         ptr_offset_from,
 555         pub_restricted,
 556         pushpop_unsafe,
 557         quad_precision_float,
 558         question_mark,
 559         quote,
 560         Range,
 561         RangeFrom,
 562         RangeFull,
 563         RangeInclusive,
 564         RangeTo,
 565         RangeToInclusive,
 566         raw_dylib,
 567         raw_identifiers,
 568         raw_ref_op,
 569         Ready,
 570         reason,
 571         recursion_limit,
 572         reexport_test_harness_main,
 573         reflect,
 574         register_attr,
 575         register_tool,
 576         relaxed_adts,
 577         repr,
 578         repr128,
 579         repr_align,
 580         repr_align_enum,
 581         repr_packed,
 582         repr_simd,
 583         repr_transparent,
 584         re_rebalance_coherence,
 585         result,
 586         Result,
 587         Return,
 588         rhs,
 589         rlib,
 590         rotate_left,
 591         rotate_right,
 592         rt,
 593         rtm_target_feature,
 594         rust,
 595         rust_2015_preview,
 596         rust_2018_preview,
 597         rust_begin_unwind,
 598         rustc,
 599         RustcDecodable,
 600         RustcEncodable,
 601         rustc_allocator,
 602         rustc_allocator_nounwind,
 603         rustc_allow_const_fn_ptr,
 604         rustc_args_required_const,
 605         rustc_attrs,
 606         rustc_builtin_macro,
 607         rustc_clean,
 608         rustc_const_unstable,
 609         rustc_const_stable,
 610         rustc_conversion_suggestion,
 611         rustc_def_path,
 612         rustc_deprecated,
 613         rustc_diagnostic_item,
 614         rustc_diagnostic_macros,
 615         rustc_dirty,
 616         rustc_dummy,
 617         rustc_dump_env_program_clauses,
 618         rustc_dump_program_clauses,
 619         rustc_dump_user_substs,
 620         rustc_error,
 621         rustc_expected_cgu_reuse,
 622         rustc_if_this_changed,
 623         rustc_inherit_overflow_checks,
 624         rustc_layout,
 625         rustc_layout_scalar_valid_range_end,
 626         rustc_layout_scalar_valid_range_start,
 627         rustc_macro_transparency,
 628         rustc_mir,
 629         rustc_nonnull_optimization_guaranteed,
 630         rustc_object_lifetime_default,
 631         rustc_on_unimplemented,
 632         rustc_outlives,
 633         rustc_paren_sugar,
 634         rustc_partition_codegened,
 635         rustc_partition_reused,
 636         rustc_peek,
 637         rustc_peek_definite_init,
 638         rustc_peek_maybe_init,
 639         rustc_peek_maybe_uninit,
 640         rustc_peek_indirectly_mutable,
 641         rustc_private,
 642         rustc_proc_macro_decls,
 643         rustc_promotable,
 644         rustc_regions,
 645         rustc_stable,
 646         rustc_std_internal_symbol,
 647         rustc_symbol_name,
 648         rustc_synthetic,
 649         rustc_reservation_impl,
 650         rustc_test_marker,
 651         rustc_then_this_would_need,
 652         rustc_variance,
 653         rustfmt,
 654         rust_eh_personality,
 655         rust_eh_unwind_resume,
 656         rust_oom,
 657         rvalue_static_promotion,
 658         sanitize,
 659         sanitizer_runtime,
 660         saturating_add,
 661         saturating_sub,
 662         _Self,
 663         self_in_typedefs,
 664         self_struct_ctor,
 665         send_trait,
 666         should_panic,
 667         simd,
 668         simd_extract,
 669         simd_ffi,
 670         simd_insert,
 671         since,
 672         size,
 673         size_of,
 674         slice_patterns,
 675         slicing_syntax,
 676         soft,
 677         Some,
 678         specialization,
 679         speed,
 680         spotlight,
 681         sse4a_target_feature,
 682         stable,
 683         staged_api,
 684         start,
 685         static_in_const,
 686         staticlib,
 687         static_nobundle,
 688         static_recursion,
 689         std,
 690         std_inject,
 691         str,
 692         stringify,
 693         stmt,
 694         stmt_expr_attributes,
 695         stop_after_dataflow,
 696         struct_field_attributes,
 697         struct_inherit,
 698         structural_match,
 699         struct_variant,
 700         sty,
 701         sub_with_overflow,
 702         suggestion,
 703         sync_trait,
 704         target_feature,
 705         target_has_atomic,
 706         target_has_atomic_load_store,
 707         target_thread_local,
 708         task,
 709         tbm_target_feature,
 710         termination_trait,
 711         termination_trait_test,
 712         test,
 713         test_2018_feature,
 714         test_accepted_feature,
 715         test_case,
 716         test_removed_feature,
 717         test_runner,
 718         then_with,
 719         thread_local,
 720         tool_attributes,
 721         tool_lints,
 722         trace_macros,
 723         track_caller,
 724         trait_alias,
 725         transmute,
 726         transparent,
 727         transparent_enums,
 728         transparent_unions,
 729         trivial_bounds,
 730         Try,
 731         try_blocks,
 732         try_trait,
 733         tt,
 734         tuple_indexing,
 735         Ty,
 736         ty,
 737         type_alias_impl_trait,
 738         type_id,
 739         type_name,
 740         TyCtxt,
 741         TyKind,
 742         type_alias_enum_variants,
 743         type_ascription,
 744         type_length_limit,
 745         type_macros,
 746         u128,
 747         u16,
 748         u32,
 749         u64,
 750         u8,
 751         unboxed_closures,
 752         unchecked_shl,
 753         unchecked_shr,
 754         underscore_const_names,
 755         underscore_imports,
 756         underscore_lifetimes,
 757         uniform_paths,
 758         universal_impl_trait,
 759         unmarked_api,
 760         unreachable_code,
 761         unrestricted_attribute_tokens,
 762         unsafe_no_drop_flag,
 763         unsized_locals,
 764         unsized_tuple_coercion,
 765         unstable,
 766         untagged_unions,
 767         unwind,
 768         unwind_attributes,
 769         unwrap_or,
 770         used,
 771         use_extern_macros,
 772         use_nested_groups,
 773         usize,
 774         v1,
 775         val,
 776         vec,
 777         Vec,
 778         vis,
 779         visible_private_types,
 780         volatile,
 781         warn,
 782         wasm_import_module,
 783         wasm_target_feature,
 784         while_let,
 785         windows,
 786         windows_subsystem,
 787         wrapping_add,
 788         wrapping_sub,
 789         wrapping_mul,
 790         Yield,
 791     }
 792 }
 793
 794 #[derive(Copy, Clone, Eq, HashStable_Generic)]
 795 pub struct Ident {
 796     pub name: Symbol,
 797     pub span: Span,
 798 }
 799
 800 impl Ident {
 801     #[inline]
 802     /// Constructs a new identifier from a symbol and a span.
 803     pub const fn new(name: Symbol, span: Span) -> Ident {
 804         Ident { name, span }
 805     }
 806
 807     /// Constructs a new identifier with a dummy span.
 808     #[inline]
 809     pub const fn with_dummy_span(name: Symbol) -> Ident {
 810         Ident::new(name, DUMMY_SP)
 811     }
 812
 813     #[inline]
 814     pub fn invalid() -> Ident {
 815         Ident::with_dummy_span(kw::Invalid)
 816     }
 817
 818     /// Maps a string to an identifier with a dummy span.
 819     pub fn from_str(string: &str) -> Ident {
 820         Ident::with_dummy_span(Symbol::intern(string))
 821     }
 822
 823     /// Maps a string and a span to an identifier.
 824     pub fn from_str_and_span(string: &str, span: Span) -> Ident {
 825         Ident::new(Symbol::intern(string), span)
 826     }
 827
 828     /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
 829     pub fn with_span_pos(self, span: Span) -> Ident {
 830         Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
 831     }
 832
 833     pub fn without_first_quote(self) -> Ident {
 834         Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
 835     }
 836
 837     /// "Normalize" ident for use in comparisons using "item hygiene".
 838     /// Identifiers with same string value become same if they came from the same "modern" macro
 839     /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
 840     /// different "modern" macros.
 841     /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
 842     pub fn modern(self) -> Ident {
 843         Ident::new(self.name, self.span.modern())
 844     }
 845
 846     /// "Normalize" ident for use in comparisons using "local variable hygiene".
 847     /// Identifiers with same string value become same if they came from the same non-transparent
 848     /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
 849     /// non-transparent macros.
 850     /// Technically, this operation strips all transparent marks from ident's syntactic context.
 851     pub fn modern_and_legacy(self) -> Ident {
 852         Ident::new(self.name, self.span.modern_and_legacy())
 853     }
 854
 855     /// Convert the name to a `SymbolStr`. This is a slowish operation because
 856     /// it requires locking the symbol interner.
 857     pub fn as_str(self) -> SymbolStr {
 858         self.name.as_str()
 859     }
 860 }
 861
 862 impl PartialEq for Ident {
 863     fn eq(&self, rhs: &Self) -> bool {
 864         self.name == rhs.name && self.span.ctxt() == rhs.span.ctxt()
 865     }
 866 }
 867
 868 impl Hash for Ident {
 869     fn hash<H: Hasher>(&self, state: &mut H) {
 870         self.name.hash(state);
 871         self.span.ctxt().hash(state);
 872     }
 873 }
 874
 875 impl fmt::Debug for Ident {
 876     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 877         if self.is_raw_guess() {
 878             write!(f, "r#")?;
 879         }
 880         write!(f, "{}{:?}", self.name, self.span.ctxt())
 881     }
 882 }
 883
 884 impl fmt::Display for Ident {
 885     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 886         if self.is_raw_guess() {
 887             write!(f, "r#")?;
 888         }
 889         fmt::Display::fmt(&self.name, f)
 890     }
 891 }
 892
 893 impl UseSpecializedEncodable for Ident {
 894     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 895         s.emit_struct("Ident", 2, |s| {
 896             s.emit_struct_field("name", 0, |s| {
 897                 self.name.encode(s)
 898             })?;
 899             s.emit_struct_field("span", 1, |s| {
 900                 self.span.encode(s)
 901             })
 902         })
 903     }
 904 }
 905
 906 impl UseSpecializedDecodable for Ident {
 907     fn default_decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error> {
 908         d.read_struct("Ident", 2, |d| {
 909             Ok(Ident {
 910                 name: d.read_struct_field("name", 0, Decodable::decode)?,
 911                 span: d.read_struct_field("span", 1, Decodable::decode)?,
 912             })
 913         })
 914     }
 915 }
 916
 917 /// An interned string.
 918 ///
 919 /// Internally, a `Symbol` is implemented as an index, and all operations
 920 /// (including hashing, equality, and ordering) operate on that index. The use
 921 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
 922 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
 923 ///
 924 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
 925 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
 926 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 927 pub struct Symbol(SymbolIndex);
 928
 929 rustc_index::newtype_index! {
 930     pub struct SymbolIndex { .. }
 931 }
 932
 933 impl Symbol {
 934     const fn new(n: u32) -> Self {
 935         Symbol(SymbolIndex::from_u32_const(n))
 936     }
 937
 938     /// Maps a string to its interned representation.
 939     pub fn intern(string: &str) -> Self {
 940         with_interner(|interner| interner.intern(string))
 941     }
 942
 943     /// Access the symbol's chars. This is a slowish operation because it
 944     /// requires locking the symbol interner.
 945     pub fn with<F: FnOnce(&str) -> R, R>(self, f: F) -> R {
 946         with_interner(|interner| {
 947             f(interner.get(self))
 948         })
 949     }
 950
 951     /// Convert to a `SymbolStr`. This is a slowish operation because it
 952     /// requires locking the symbol interner.
 953     pub fn as_str(self) -> SymbolStr {
 954         with_interner(|interner| unsafe {
 955             SymbolStr {
 956                 string: std::mem::transmute::<&str, &str>(interner.get(self))
 957             }
 958         })
 959     }
 960
 961     pub fn as_u32(self) -> u32 {
 962         self.0.as_u32()
 963     }
 964 }
 965
 966 impl fmt::Debug for Symbol {
 967     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 968         self.with(|str| fmt::Debug::fmt(&str, f))
 969     }
 970 }
 971
 972 impl fmt::Display for Symbol {
 973     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 974         self.with(|str| fmt::Display::fmt(&str, f))
 975     }
 976 }
 977
 978 impl Encodable for Symbol {
 979     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 980         self.with(|string| s.emit_str(string))
 981     }
 982 }
 983
 984 impl Decodable for Symbol {
 985     fn decode<D: Decoder>(d: &mut D) -> Result<Symbol, D::Error> {
 986         Ok(Symbol::intern(&d.read_str()?))
 987     }
 988 }
 989
 990 impl<CTX> HashStable<CTX> for Symbol {
 991     #[inline]
 992     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
 993         self.as_str().hash_stable(hcx, hasher);
 994     }
 995 }
 996
 997 impl<CTX> ToStableHashKey<CTX> for Symbol {
 998     type KeyType = SymbolStr;
 999
1000     #[inline]
1001     fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {
1002         self.as_str()
1003     }
1004 }
1005
1006 // The `&'static str`s in this type actually point into the arena.
1007 #[derive(Default)]
1008 pub struct Interner {
1009     arena: DroplessArena,
1010     names: FxHashMap<&'static str, Symbol>,
1011     strings: Vec<&'static str>,
1012 }
1013
1014 impl Interner {
1015     fn prefill(init: &[&'static str]) -> Self {
1016         Interner {
1017             strings: init.into(),
1018             names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1019             ..Default::default()
1020         }
1021     }
1022
1023     pub fn intern(&mut self, string: &str) -> Symbol {
1024         if let Some(&name) = self.names.get(string) {
1025             return name;
1026         }
1027
1028         let name = Symbol::new(self.strings.len() as u32);
1029
1030         // `from_utf8_unchecked` is safe since we just allocated a `&str` which is known to be
1031         // UTF-8.
1032         let string: &str = unsafe {
1033             str::from_utf8_unchecked(self.arena.alloc_slice(string.as_bytes()))
1034         };
1035         // It is safe to extend the arena allocation to `'static` because we only access
1036         // these while the arena is still alive.
1037         let string: &'static str =  unsafe {
1038             &*(string as *const str)
1039         };
1040         self.strings.push(string);
1041         self.names.insert(string, name);
1042         name
1043     }
1044
1045     // Get the symbol as a string. `Symbol::as_str()` should be used in
1046     // preference to this function.
1047     pub fn get(&self, symbol: Symbol) -> &str {
1048         self.strings[symbol.0.as_usize()]
1049     }
1050 }
1051
1052 // This module has a very short name because it's used a lot.
1053 pub mod kw {
1054     use super::Symbol;
1055     keywords!();
1056 }
1057
1058 // This module has a very short name because it's used a lot.
1059 pub mod sym {
1060     use std::convert::TryInto;
1061     use super::Symbol;
1062
1063     symbols!();
1064
1065     // Get the symbol for an integer. The first few non-negative integers each
1066     // have a static symbol and therefore are fast.
1067     pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1068         if let Result::Ok(idx) = n.try_into() {
1069             if let Option::Some(&sym) = digits_array.get(idx) {
1070                 return sym;
1071             }
1072         }
1073         Symbol::intern(&n.to_string())
1074     }
1075 }
1076
1077 impl Symbol {
1078     fn is_used_keyword_2018(self) -> bool {
1079         self >= kw::Async && self <= kw::Dyn
1080     }
1081
1082     fn is_unused_keyword_2018(self) -> bool {
1083         self == kw::Try
1084     }
1085
1086     /// Used for sanity checking rustdoc keyword sections.
1087     pub fn is_doc_keyword(self) -> bool {
1088         self <= kw::Union
1089     }
1090
1091     /// A keyword or reserved identifier that can be used as a path segment.
1092     pub fn is_path_segment_keyword(self) -> bool {
1093         self == kw::Super ||
1094         self == kw::SelfLower ||
1095         self == kw::SelfUpper ||
1096         self == kw::Crate ||
1097         self == kw::PathRoot ||
1098         self == kw::DollarCrate
1099     }
1100
1101     /// Returns `true` if the symbol is `true` or `false`.
1102     pub fn is_bool_lit(self) -> bool {
1103         self == kw::True || self == kw::False
1104     }
1105
1106     /// This symbol can be a raw identifier.
1107     pub fn can_be_raw(self) -> bool {
1108         self != kw::Invalid && self != kw::Underscore && !self.is_path_segment_keyword()
1109     }
1110 }
1111
1112 impl Ident {
1113     // Returns `true` for reserved identifiers used internally for elided lifetimes,
1114     // unnamed method parameters, crate root module, error recovery etc.
1115     pub fn is_special(self) -> bool {
1116         self.name <= kw::Underscore
1117     }
1118
1119     /// Returns `true` if the token is a keyword used in the language.
1120     pub fn is_used_keyword(self) -> bool {
1121         // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1122         self.name >= kw::As && self.name <= kw::While ||
1123         self.name.is_used_keyword_2018() && self.span.rust_2018()
1124     }
1125
1126     /// Returns `true` if the token is a keyword reserved for possible future use.
1127     pub fn is_unused_keyword(self) -> bool {
1128         // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
1129         self.name >= kw::Abstract && self.name <= kw::Yield ||
1130         self.name.is_unused_keyword_2018() && self.span.rust_2018()
1131     }
1132
1133     /// Returns `true` if the token is either a special identifier or a keyword.
1134     pub fn is_reserved(self) -> bool {
1135         self.is_special() || self.is_used_keyword() || self.is_unused_keyword()
1136     }
1137
1138     /// A keyword or reserved identifier that can be used as a path segment.
1139     pub fn is_path_segment_keyword(self) -> bool {
1140         self.name.is_path_segment_keyword()
1141     }
1142
1143     /// We see this identifier in a normal identifier position, like variable name or a type.
1144     /// How was it written originally? Did it use the raw form? Let's try to guess.
1145     pub fn is_raw_guess(self) -> bool {
1146         self.name.can_be_raw() && self.is_reserved()
1147     }
1148 }
1149
1150 #[inline]
1151 fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
1152     GLOBALS.with(|globals| f(&mut *globals.symbol_interner.lock()))
1153 }
1154
1155 /// An alternative to `Symbol`, useful when the chars within the symbol need to
1156 /// be accessed. It deliberately has limited functionality and should only be
1157 /// used for temporary values.
1158 ///
1159 /// Because the interner outlives any thread which uses this type, we can
1160 /// safely treat `string` which points to interner data, as an immortal string,
1161 /// as long as this type never crosses between threads.
1162 //
1163 // FIXME: ensure that the interner outlives any thread which uses `SymbolStr`,
1164 // by creating a new thread right after constructing the interner.
1165 #[derive(Clone, Eq, PartialOrd, Ord)]
1166 pub struct SymbolStr {
1167     string: &'static str,
1168 }
1169
1170 // This impl allows a `SymbolStr` to be directly equated with a `String` or
1171 // `&str`.
1172 impl<T: std::ops::Deref<Target = str>> std::cmp::PartialEq<T> for SymbolStr {
1173     fn eq(&self, other: &T) -> bool {
1174         self.string == other.deref()
1175     }
1176 }
1177
1178 impl !Send for SymbolStr {}
1179 impl !Sync for SymbolStr {}
1180
1181 /// This impl means that if `ss` is a `SymbolStr`:
1182 /// - `*ss` is a `str`;
1183 /// - `&*ss` is a `&str`;
1184 /// - `&ss as &str` is a `&str`, which means that `&ss` can be passed to a
1185 ///   function expecting a `&str`.
1186 impl std::ops::Deref for SymbolStr {
1187     type Target = str;
1188     #[inline]
1189     fn deref(&self) -> &str { self.string }
1190 }
1191
1192 impl fmt::Debug for SymbolStr {
1193     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1194         fmt::Debug::fmt(self.string, f)
1195     }
1196 }
1197
1198 impl fmt::Display for SymbolStr {
1199     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1200         fmt::Display::fmt(self.string, f)
1201     }
1202 }
1203
1204 impl<CTX> HashStable<CTX> for SymbolStr {
1205     #[inline]
1206     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1207         self.string.hash_stable(hcx, hasher)
1208     }
1209 }
1210
1211 impl<CTX> ToStableHashKey<CTX> for SymbolStr {
1212     type KeyType = SymbolStr;
1213
1214     #[inline]
1215     fn to_stable_hash_key(&self, _: &CTX) -> SymbolStr {
1216         self.clone()
1217     }
1218 }