compiler/rustc_span/src/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 rustc_arena::DroplessArena;
   6 use rustc_data_structures::fx::FxHashMap;
   7 use rustc_data_structures::stable_hasher::{HashStable, StableHasher, ToStableHashKey};
   8 use rustc_data_structures::sync::Lock;
   9 use rustc_macros::HashStable_Generic;
  10 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
  11
  12 use std::cmp::{Ord, PartialEq, PartialOrd};
  13 use std::fmt;
  14 use std::hash::{Hash, Hasher};
  15 use std::str;
  16
  17 use crate::{with_session_globals, Edition, Span, DUMMY_SP};
  18
  19 #[cfg(test)]
  20 mod tests;
  21
  22 // The proc macro code for this is in `compiler/rustc_macros/src/symbols.rs`.
  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         Empty:              "",
  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         MacroRules:         "macro_rules",
 102         Raw:                "raw",
 103         Union:              "union",
 104         Yeet:               "yeet",
 105     }
 106
 107     // Pre-interned symbols that can be referred to with `rustc_span::sym::*`.
 108     //
 109     // The symbol is the stringified identifier unless otherwise specified, in
 110     // which case the name should mention the non-identifier punctuation.
 111     // E.g. `sym::proc_dash_macro` represents "proc-macro", and it shouldn't be
 112     // called `sym::proc_macro` because then it's easy to mistakenly think it
 113     // represents "proc_macro".
 114     //
 115     // As well as the symbols listed, there are symbols for the strings
 116     // "0", "1", ..., "9", which are accessible via `sym::integer`.
 117     //
 118     // The proc macro will abort if symbols are not in alphabetical order (as
 119     // defined by `impl Ord for str`) or if any symbols are duplicated. Vim
 120     // users can sort the list by selecting it and executing the command
 121     // `:'<,'>!LC_ALL=C sort`.
 122     //
 123     // There is currently no checking that all symbols are used; that would be
 124     // nice to have.
 125     Symbols {
 126         AcqRel,
 127         Acquire,
 128         AddSubdiagnostic,
 129         Alignment,
 130         Any,
 131         Arc,
 132         Argument,
 133         ArgumentV1,
 134         ArgumentV1Methods,
 135         Arguments,
 136         AsMut,
 137         AsRef,
 138         AssertParamIsClone,
 139         AssertParamIsCopy,
 140         AssertParamIsEq,
 141         AtomicBool,
 142         AtomicI128,
 143         AtomicI16,
 144         AtomicI32,
 145         AtomicI64,
 146         AtomicI8,
 147         AtomicIsize,
 148         AtomicPtr,
 149         AtomicU128,
 150         AtomicU16,
 151         AtomicU32,
 152         AtomicU64,
 153         AtomicU8,
 154         AtomicUsize,
 155         BTreeEntry,
 156         BTreeMap,
 157         BTreeSet,
 158         BinaryHeap,
 159         Borrow,
 160         Break,
 161         C,
 162         CStr,
 163         CString,
 164         Capture,
 165         Center,
 166         Clone,
 167         Continue,
 168         Copy,
 169         Count,
 170         Cow,
 171         Debug,
 172         DebugStruct,
 173         DebugTuple,
 174         Decodable,
 175         Decoder,
 176         DecorateLint,
 177         Default,
 178         Deref,
 179         DiagnosticMessage,
 180         DirBuilder,
 181         Display,
 182         DoubleEndedIterator,
 183         Duration,
 184         Encodable,
 185         Encoder,
 186         Eq,
 187         Equal,
 188         Err,
 189         Error,
 190         File,
 191         FileType,
 192         Fn,
 193         FnMut,
 194         FnOnce,
 195         FormatSpec,
 196         Formatter,
 197         From,
 198         FromIterator,
 199         FromResidual,
 200         Future,
 201         FxHashMap,
 202         FxHashSet,
 203         GlobalAlloc,
 204         Hash,
 205         HashMap,
 206         HashMapEntry,
 207         HashSet,
 208         Hasher,
 209         Implied,
 210         Input,
 211         Into,
 212         IntoFuture,
 213         IntoIterator,
 214         IoRead,
 215         IoWrite,
 216         IrTyKind,
 217         Is,
 218         ItemContext,
 219         Iterator,
 220         Layout,
 221         Left,
 222         LinkedList,
 223         LintPass,
 224         Mutex,
 225         N,
 226         NonZeroI128,
 227         NonZeroI16,
 228         NonZeroI32,
 229         NonZeroI64,
 230         NonZeroI8,
 231         NonZeroU128,
 232         NonZeroU16,
 233         NonZeroU32,
 234         NonZeroU64,
 235         NonZeroU8,
 236         None,
 237         Ok,
 238         Option,
 239         Ord,
 240         Ordering,
 241         OsStr,
 242         OsString,
 243         Output,
 244         Param,
 245         PartialEq,
 246         PartialOrd,
 247         Path,
 248         PathBuf,
 249         Pending,
 250         Pin,
 251         Pointer,
 252         Poll,
 253         ProcMacro,
 254         ProcMacroHack,
 255         ProceduralMasqueradeDummyType,
 256         Range,
 257         RangeFrom,
 258         RangeFull,
 259         RangeInclusive,
 260         RangeTo,
 261         RangeToInclusive,
 262         Rc,
 263         Ready,
 264         Receiver,
 265         Relaxed,
 266         Release,
 267         Result,
 268         Return,
 269         Right,
 270         Rust,
 271         RustcDecodable,
 272         RustcEncodable,
 273         Send,
 274         SeqCst,
 275         SessionDiagnostic,
 276         SliceIndex,
 277         Some,
 278         String,
 279         StructuralEq,
 280         StructuralPartialEq,
 281         SubdiagnosticMessage,
 282         Sync,
 283         Target,
 284         ToOwned,
 285         ToString,
 286         Try,
 287         TryCaptureGeneric,
 288         TryCapturePrintable,
 289         TryFrom,
 290         TryInto,
 291         Ty,
 292         TyCtxt,
 293         TyKind,
 294         Unknown,
 295         UnsafeArg,
 296         Vec,
 297         VecDeque,
 298         Wrapper,
 299         Yield,
 300         _DECLS,
 301         _Self,
 302         __D,
 303         __H,
 304         __S,
 305         __awaitee,
 306         __try_var,
 307         _d,
 308         _e,
 309         _task_context,
 310         a32,
 311         aarch64_target_feature,
 312         aarch64_ver_target_feature,
 313         abi,
 314         abi_amdgpu_kernel,
 315         abi_avr_interrupt,
 316         abi_c_cmse_nonsecure_call,
 317         abi_efiapi,
 318         abi_msp430_interrupt,
 319         abi_ptx,
 320         abi_sysv64,
 321         abi_thiscall,
 322         abi_unadjusted,
 323         abi_vectorcall,
 324         abi_x86_interrupt,
 325         abort,
 326         aborts,
 327         add,
 328         add_assign,
 329         add_with_overflow,
 330         address,
 331         adt_const_params,
 332         advanced_slice_patterns,
 333         adx_target_feature,
 334         alias,
 335         align,
 336         align_offset,
 337         alignstack,
 338         all,
 339         alloc,
 340         alloc_error_handler,
 341         alloc_layout,
 342         alloc_zeroed,
 343         allocator,
 344         allocator_api,
 345         allocator_internals,
 346         allow,
 347         allow_fail,
 348         allow_internal_unsafe,
 349         allow_internal_unstable,
 350         allowed,
 351         alu32,
 352         always,
 353         and,
 354         and_then,
 355         anonymous_lifetime_in_impl_trait,
 356         any,
 357         append_const_msg,
 358         arbitrary_enum_discriminant,
 359         arbitrary_self_types,
 360         args,
 361         arith_offset,
 362         arm,
 363         arm_target_feature,
 364         array,
 365         arrays,
 366         as_ptr,
 367         as_ref,
 368         as_str,
 369         asm,
 370         asm_const,
 371         asm_experimental_arch,
 372         asm_sym,
 373         asm_unwind,
 374         assert,
 375         assert_eq_macro,
 376         assert_inhabited,
 377         assert_macro,
 378         assert_ne_macro,
 379         assert_receiver_is_total_eq,
 380         assert_uninit_valid,
 381         assert_zero_valid,
 382         asserting,
 383         associated_const_equality,
 384         associated_consts,
 385         associated_type_bounds,
 386         associated_type_defaults,
 387         associated_types,
 388         assume,
 389         assume_init,
 390         async_await,
 391         async_closure,
 392         atomic,
 393         atomic_mod,
 394         atomics,
 395         att_syntax,
 396         attr,
 397         attr_literals,
 398         attributes,
 399         augmented_assignments,
 400         auto_traits,
 401         automatically_derived,
 402         avx,
 403         avx512_target_feature,
 404         avx512bw,
 405         avx512f,
 406         await_macro,
 407         bang,
 408         begin_panic,
 409         bench,
 410         bin,
 411         bind_by_move_pattern_guards,
 412         bindings_after_at,
 413         bitand,
 414         bitand_assign,
 415         bitor,
 416         bitor_assign,
 417         bitreverse,
 418         bitxor,
 419         bitxor_assign,
 420         black_box,
 421         block,
 422         bool,
 423         borrowck_graphviz_format,
 424         borrowck_graphviz_postflow,
 425         borrowck_graphviz_preflow,
 426         box_free,
 427         box_patterns,
 428         box_syntax,
 429         bpf_target_feature,
 430         braced_empty_structs,
 431         branch,
 432         breakpoint,
 433         bridge,
 434         bswap,
 435         c_str,
 436         c_unwind,
 437         c_variadic,
 438         call,
 439         call_mut,
 440         call_once,
 441         caller_location,
 442         capture_disjoint_fields,
 443         cdylib,
 444         ceilf32,
 445         ceilf64,
 446         cfg,
 447         cfg_accessible,
 448         cfg_attr,
 449         cfg_attr_multi,
 450         cfg_doctest,
 451         cfg_eval,
 452         cfg_hide,
 453         cfg_macro,
 454         cfg_panic,
 455         cfg_sanitize,
 456         cfg_target_abi,
 457         cfg_target_compact,
 458         cfg_target_feature,
 459         cfg_target_has_atomic,
 460         cfg_target_has_atomic_equal_alignment,
 461         cfg_target_has_atomic_load_store,
 462         cfg_target_thread_local,
 463         cfg_target_vendor,
 464         cfg_version,
 465         cfi,
 466         char,
 467         client,
 468         clippy,
 469         clobber_abi,
 470         clone,
 471         clone_closures,
 472         clone_from,
 473         closure,
 474         closure_lifetime_binder,
 475         closure_to_fn_coercion,
 476         closure_track_caller,
 477         cmp,
 478         cmp_max,
 479         cmp_min,
 480         cmpxchg16b_target_feature,
 481         cmse_nonsecure_entry,
 482         coerce_unsized,
 483         cold,
 484         column,
 485         column_macro,
 486         compare_and_swap,
 487         compare_exchange,
 488         compare_exchange_weak,
 489         compile_error,
 490         compile_error_macro,
 491         compiler,
 492         compiler_builtins,
 493         compiler_fence,
 494         concat,
 495         concat_bytes,
 496         concat_idents,
 497         concat_macro,
 498         conservative_impl_trait,
 499         console,
 500         const_allocate,
 501         const_async_blocks,
 502         const_compare_raw_pointers,
 503         const_constructor,
 504         const_deallocate,
 505         const_eval_limit,
 506         const_eval_select,
 507         const_eval_select_ct,
 508         const_evaluatable_checked,
 509         const_extern_fn,
 510         const_fn,
 511         const_fn_floating_point_arithmetic,
 512         const_fn_fn_ptr_basics,
 513         const_fn_trait_bound,
 514         const_fn_transmute,
 515         const_fn_union,
 516         const_fn_unsize,
 517         const_for,
 518         const_format_args,
 519         const_generic_defaults,
 520         const_generics,
 521         const_generics_defaults,
 522         const_if_match,
 523         const_impl_trait,
 524         const_in_array_repeat_expressions,
 525         const_indexing,
 526         const_let,
 527         const_loop,
 528         const_mut_refs,
 529         const_panic,
 530         const_panic_fmt,
 531         const_precise_live_drops,
 532         const_raw_ptr_deref,
 533         const_raw_ptr_to_usize_cast,
 534         const_refs_to_cell,
 535         const_trait,
 536         const_trait_bound_opt_out,
 537         const_trait_impl,
 538         const_transmute,
 539         const_try,
 540         constant,
 541         constructor,
 542         contents,
 543         context,
 544         convert,
 545         copy,
 546         copy_closures,
 547         copy_nonoverlapping,
 548         copysignf32,
 549         copysignf64,
 550         core,
 551         core_intrinsics,
 552         core_panic,
 553         core_panic_2015_macro,
 554         core_panic_macro,
 555         cosf32,
 556         cosf64,
 557         count,
 558         cr,
 559         crate_id,
 560         crate_in_paths,
 561         crate_local,
 562         crate_name,
 563         crate_type,
 564         crate_visibility_modifier,
 565         crt_dash_static: "crt-static",
 566         cstring_type,
 567         ctlz,
 568         ctlz_nonzero,
 569         ctpop,
 570         cttz,
 571         cttz_nonzero,
 572         custom_attribute,
 573         custom_derive,
 574         custom_inner_attributes,
 575         custom_test_frameworks,
 576         d,
 577         d32,
 578         dbg_macro,
 579         dead_code,
 580         dealloc,
 581         debug,
 582         debug_assert_eq_macro,
 583         debug_assert_macro,
 584         debug_assert_ne_macro,
 585         debug_assertions,
 586         debug_struct,
 587         debug_struct_fields_finish,
 588         debug_trait_builder,
 589         debug_tuple,
 590         debug_tuple_fields_finish,
 591         debugger_visualizer,
 592         decl_macro,
 593         declare_lint_pass,
 594         decode,
 595         default_alloc_error_handler,
 596         default_lib_allocator,
 597         default_method_body_is_const,
 598         default_type_parameter_fallback,
 599         default_type_params,
 600         delay_span_bug_from_inside_query,
 601         deny,
 602         deprecated,
 603         deprecated_safe,
 604         deprecated_suggestion,
 605         deref,
 606         deref_method,
 607         deref_mut,
 608         deref_target,
 609         derive,
 610         derive_default_enum,
 611         destruct,
 612         destructuring_assignment,
 613         diagnostic,
 614         direct,
 615         discriminant_kind,
 616         discriminant_type,
 617         discriminant_value,
 618         dispatch_from_dyn,
 619         display_trait,
 620         div,
 621         div_assign,
 622         doc,
 623         doc_alias,
 624         doc_auto_cfg,
 625         doc_cfg,
 626         doc_cfg_hide,
 627         doc_keyword,
 628         doc_masked,
 629         doc_notable_trait,
 630         doc_primitive,
 631         doc_spotlight,
 632         doctest,
 633         document_private_items,
 634         dotdot: "..",
 635         dotdot_in_tuple_patterns,
 636         dotdoteq_in_patterns,
 637         dreg,
 638         dreg_low16,
 639         dreg_low8,
 640         drop,
 641         drop_in_place,
 642         drop_types_in_const,
 643         dropck_eyepatch,
 644         dropck_parametricity,
 645         dylib,
 646         dyn_metadata,
 647         dyn_trait,
 648         e,
 649         edition_macro_pats,
 650         edition_panic,
 651         eh_catch_typeinfo,
 652         eh_personality,
 653         emit_enum,
 654         emit_enum_variant,
 655         emit_enum_variant_arg,
 656         emit_struct,
 657         emit_struct_field,
 658         enable,
 659         enclosing_scope,
 660         encode,
 661         end,
 662         env,
 663         env_macro,
 664         eprint_macro,
 665         eprintln_macro,
 666         eq,
 667         ermsb_target_feature,
 668         exact_div,
 669         except,
 670         exchange_malloc,
 671         exclusive_range_pattern,
 672         exhaustive_integer_patterns,
 673         exhaustive_patterns,
 674         existential_type,
 675         exp2f32,
 676         exp2f64,
 677         expect,
 678         expected,
 679         expf32,
 680         expf64,
 681         explicit_generic_args_with_impl_trait,
 682         export_name,
 683         expr,
 684         extended_key_value_attributes,
 685         extern_absolute_paths,
 686         extern_crate_item_prelude,
 687         extern_crate_self,
 688         extern_in_paths,
 689         extern_prelude,
 690         extern_types,
 691         external_doc,
 692         f,
 693         f16c_target_feature,
 694         f32,
 695         f64,
 696         fabsf32,
 697         fabsf64,
 698         fadd_fast,
 699         fake_variadic,
 700         fdiv_fast,
 701         feature,
 702         fence,
 703         ferris: "🦀",
 704         fetch_update,
 705         ffi,
 706         ffi_const,
 707         ffi_pure,
 708         ffi_returns_twice,
 709         field,
 710         field_init_shorthand,
 711         file,
 712         file_macro,
 713         fill,
 714         finish,
 715         flags,
 716         float,
 717         float_to_int_unchecked,
 718         floorf32,
 719         floorf64,
 720         fmaf32,
 721         fmaf64,
 722         fmt,
 723         fmt_as_str,
 724         fmt_internals,
 725         fmul_fast,
 726         fn_align,
 727         fn_must_use,
 728         fn_mut,
 729         fn_once,
 730         fn_once_output,
 731         forbid,
 732         forget,
 733         format,
 734         format_args,
 735         format_args_capture,
 736         format_args_macro,
 737         format_args_nl,
 738         format_macro,
 739         fp,
 740         freeze,
 741         freg,
 742         frem_fast,
 743         from,
 744         from_desugaring,
 745         from_generator,
 746         from_iter,
 747         from_method,
 748         from_output,
 749         from_residual,
 750         from_size_align_unchecked,
 751         from_usize,
 752         from_yeet,
 753         fsub_fast,
 754         fundamental,
 755         future,
 756         future_trait,
 757         gdb_script_file,
 758         ge,
 759         gen_future,
 760         gen_kill,
 761         generator,
 762         generator_return,
 763         generator_state,
 764         generators,
 765         generic_arg_infer,
 766         generic_assert,
 767         generic_associated_types,
 768         generic_associated_types_extended,
 769         generic_const_exprs,
 770         generic_param_attrs,
 771         get_context,
 772         global_allocator,
 773         global_asm,
 774         globs,
 775         gt,
 776         half_open_range_patterns,
 777         hash,
 778         hexagon_target_feature,
 779         hidden,
 780         homogeneous_aggregate,
 781         html_favicon_url,
 782         html_logo_url,
 783         html_no_source,
 784         html_playground_url,
 785         html_root_url,
 786         hwaddress,
 787         i,
 788         i128,
 789         i128_type,
 790         i16,
 791         i32,
 792         i64,
 793         i8,
 794         ident,
 795         if_let,
 796         if_let_guard,
 797         if_while_or_patterns,
 798         ignore,
 799         impl_header_lifetime_elision,
 800         impl_lint_pass,
 801         impl_macros,
 802         impl_trait_in_bindings,
 803         implied_by,
 804         import,
 805         import_shadowing,
 806         imported_main,
 807         in_band_lifetimes,
 808         include,
 809         include_bytes,
 810         include_bytes_macro,
 811         include_macro,
 812         include_str,
 813         include_str_macro,
 814         inclusive_range_syntax,
 815         index,
 816         index_mut,
 817         infer_outlives_requirements,
 818         infer_static_outlives_requirements,
 819         inherent_associated_types,
 820         inlateout,
 821         inline,
 822         inline_const,
 823         inline_const_pat,
 824         inout,
 825         instruction_set,
 826         integer_: "integer",
 827         integral,
 828         intel,
 829         into_future,
 830         into_iter,
 831         intra_doc_pointers,
 832         intrinsics,
 833         irrefutable_let_patterns,
 834         isa_attribute,
 835         isize,
 836         issue,
 837         issue_5723_bootstrap,
 838         issue_tracker_base_url,
 839         item,
 840         item_like_imports,
 841         iter,
 842         iter_repeat,
 843         keyword,
 844         kind,
 845         kreg,
 846         kreg0,
 847         label,
 848         label_break_value,
 849         lang,
 850         lang_items,
 851         large_assignments,
 852         lateout,
 853         lazy_normalization_consts,
 854         le,
 855         len,
 856         let_chains,
 857         let_else,
 858         lhs,
 859         lib,
 860         libc,
 861         lifetime,
 862         likely,
 863         line,
 864         line_macro,
 865         link,
 866         link_args,
 867         link_cfg,
 868         link_llvm_intrinsics,
 869         link_name,
 870         link_ordinal,
 871         link_section,
 872         linkage,
 873         linker,
 874         lint_reasons,
 875         literal,
 876         load,
 877         loaded_from_disk,
 878         local,
 879         local_inner_macros,
 880         log10f32,
 881         log10f64,
 882         log2f32,
 883         log2f64,
 884         log_syntax,
 885         logf32,
 886         logf64,
 887         loop_break_value,
 888         lt,
 889         macro_at_most_once_rep,
 890         macro_attributes_in_derive_output,
 891         macro_escape,
 892         macro_export,
 893         macro_lifetime_matcher,
 894         macro_literal_matcher,
 895         macro_metavar_expr,
 896         macro_reexport,
 897         macro_use,
 898         macro_vis_matcher,
 899         macros_in_extern,
 900         main,
 901         managed_boxes,
 902         manually_drop,
 903         map,
 904         marker,
 905         marker_trait_attr,
 906         masked,
 907         match_beginning_vert,
 908         match_default_bindings,
 909         matches_macro,
 910         maxnumf32,
 911         maxnumf64,
 912         may_dangle,
 913         may_unwind,
 914         maybe_uninit,
 915         maybe_uninit_uninit,
 916         maybe_uninit_zeroed,
 917         mem_discriminant,
 918         mem_drop,
 919         mem_forget,
 920         mem_replace,
 921         mem_size_of,
 922         mem_size_of_val,
 923         mem_uninitialized,
 924         mem_variant_count,
 925         mem_zeroed,
 926         member_constraints,
 927         memory,
 928         memtag,
 929         message,
 930         meta,
 931         metadata_type,
 932         min_align_of,
 933         min_align_of_val,
 934         min_const_fn,
 935         min_const_generics,
 936         min_const_unsafe_fn,
 937         min_specialization,
 938         min_type_alias_impl_trait,
 939         minnumf32,
 940         minnumf64,
 941         mips_target_feature,
 942         miri,
 943         misc,
 944         mmx_reg,
 945         modifiers,
 946         module,
 947         module_path,
 948         module_path_macro,
 949         more_qualified_paths,
 950         more_struct_aliases,
 951         movbe_target_feature,
 952         move_ref_pattern,
 953         move_size_limit,
 954         mul,
 955         mul_assign,
 956         mul_with_overflow,
 957         must_not_suspend,
 958         must_use,
 959         naked,
 960         naked_functions,
 961         name,
 962         names,
 963         native_link_modifiers,
 964         native_link_modifiers_as_needed,
 965         native_link_modifiers_bundle,
 966         native_link_modifiers_verbatim,
 967         native_link_modifiers_whole_archive,
 968         natvis_file,
 969         ne,
 970         nearbyintf32,
 971         nearbyintf64,
 972         needs_allocator,
 973         needs_drop,
 974         needs_panic_runtime,
 975         neg,
 976         negate_unsigned,
 977         negative_impls,
 978         neon,
 979         never,
 980         never_type,
 981         never_type_fallback,
 982         new,
 983         new_unchecked,
 984         next,
 985         nll,
 986         no,
 987         no_builtins,
 988         no_core,
 989         no_coverage,
 990         no_crate_inject,
 991         no_debug,
 992         no_default_passes,
 993         no_implicit_prelude,
 994         no_inline,
 995         no_link,
 996         no_main,
 997         no_mangle,
 998         no_sanitize,
 999         no_stack_check,
1000         no_start,
1001         no_std,
1002         nomem,
1003         non_ascii_idents,
1004         non_exhaustive,
1005         non_exhaustive_omitted_patterns_lint,
1006         non_modrs_mods,
1007         none_error,
1008         nontemporal_store,
1009         noop_method_borrow,
1010         noop_method_clone,
1011         noop_method_deref,
1012         noreturn,
1013         nostack,
1014         not,
1015         notable_trait,
1016         note,
1017         object_safe_for_dispatch,
1018         of,
1019         offset,
1020         omit_gdb_pretty_printer_section,
1021         on,
1022         on_unimplemented,
1023         oom,
1024         opaque,
1025         ops,
1026         opt_out_copy,
1027         optimize,
1028         optimize_attribute,
1029         optin_builtin_traits,
1030         option,
1031         option_env,
1032         option_env_macro,
1033         options,
1034         or,
1035         or_patterns,
1036         other,
1037         out,
1038         overlapping_marker_traits,
1039         owned_box,
1040         packed,
1041         panic,
1042         panic_2015,
1043         panic_2021,
1044         panic_abort,
1045         panic_bounds_check,
1046         panic_display,
1047         panic_fmt,
1048         panic_handler,
1049         panic_impl,
1050         panic_implementation,
1051         panic_info,
1052         panic_location,
1053         panic_no_unwind,
1054         panic_runtime,
1055         panic_str,
1056         panic_unwind,
1057         panicking,
1058         param_attrs,
1059         partial_cmp,
1060         partial_ord,
1061         passes,
1062         pat,
1063         pat_param,
1064         path,
1065         pattern_parentheses,
1066         phantom_data,
1067         pin,
1068         platform_intrinsics,
1069         plugin,
1070         plugin_registrar,
1071         plugins,
1072         pointee_trait,
1073         pointer,
1074         pointer_trait_fmt,
1075         poll,
1076         position,
1077         post_dash_lto: "post-lto",
1078         powerpc_target_feature,
1079         powf32,
1080         powf64,
1081         powif32,
1082         powif64,
1083         pre_dash_lto: "pre-lto",
1084         precise_pointer_size_matching,
1085         precision,
1086         pref_align_of,
1087         prefetch_read_data,
1088         prefetch_read_instruction,
1089         prefetch_write_data,
1090         prefetch_write_instruction,
1091         preg,
1092         prelude,
1093         prelude_import,
1094         preserves_flags,
1095         primitive,
1096         print_macro,
1097         println_macro,
1098         proc_dash_macro: "proc-macro",
1099         proc_macro,
1100         proc_macro_attribute,
1101         proc_macro_def_site,
1102         proc_macro_derive,
1103         proc_macro_expr,
1104         proc_macro_gen,
1105         proc_macro_hygiene,
1106         proc_macro_internals,
1107         proc_macro_mod,
1108         proc_macro_non_items,
1109         proc_macro_path_invoc,
1110         profiler_builtins,
1111         profiler_runtime,
1112         ptr,
1113         ptr_guaranteed_eq,
1114         ptr_guaranteed_ne,
1115         ptr_null,
1116         ptr_null_mut,
1117         ptr_offset_from,
1118         ptr_offset_from_unsigned,
1119         pub_macro_rules,
1120         pub_restricted,
1121         pure,
1122         pushpop_unsafe,
1123         qreg,
1124         qreg_low4,
1125         qreg_low8,
1126         quad_precision_float,
1127         question_mark,
1128         quote,
1129         range_inclusive_new,
1130         raw_dylib,
1131         raw_eq,
1132         raw_identifiers,
1133         raw_ref_op,
1134         re_rebalance_coherence,
1135         read_enum,
1136         read_enum_variant,
1137         read_enum_variant_arg,
1138         read_struct,
1139         read_struct_field,
1140         readonly,
1141         realloc,
1142         reason,
1143         receiver,
1144         recursion_limit,
1145         reexport_test_harness_main,
1146         ref_unwind_safe_trait,
1147         reference,
1148         reflect,
1149         reg,
1150         reg16,
1151         reg32,
1152         reg64,
1153         reg_abcd,
1154         reg_byte,
1155         reg_iw,
1156         reg_nonzero,
1157         reg_pair,
1158         reg_ptr,
1159         reg_upper,
1160         register_attr,
1161         register_tool,
1162         relaxed_adts,
1163         relaxed_struct_unsize,
1164         rem,
1165         rem_assign,
1166         repr,
1167         repr128,
1168         repr_align,
1169         repr_align_enum,
1170         repr_packed,
1171         repr_simd,
1172         repr_transparent,
1173         residual,
1174         result,
1175         rhs,
1176         rintf32,
1177         rintf64,
1178         riscv_target_feature,
1179         rlib,
1180         rotate_left,
1181         rotate_right,
1182         roundf32,
1183         roundf64,
1184         rt,
1185         rtm_target_feature,
1186         rust,
1187         rust_2015,
1188         rust_2015_preview,
1189         rust_2018,
1190         rust_2018_preview,
1191         rust_2021,
1192         rust_2021_preview,
1193         rust_2024,
1194         rust_2024_preview,
1195         rust_begin_unwind,
1196         rust_cold_cc,
1197         rust_eh_catch_typeinfo,
1198         rust_eh_personality,
1199         rust_eh_register_frames,
1200         rust_eh_unregister_frames,
1201         rust_oom,
1202         rustc,
1203         rustc_allocator,
1204         rustc_allocator_nounwind,
1205         rustc_allocator_zeroed,
1206         rustc_allow_const_fn_unstable,
1207         rustc_allow_incoherent_impl,
1208         rustc_allowed_through_unstable_modules,
1209         rustc_attrs,
1210         rustc_box,
1211         rustc_builtin_macro,
1212         rustc_capture_analysis,
1213         rustc_clean,
1214         rustc_coherence_is_core,
1215         rustc_const_stable,
1216         rustc_const_unstable,
1217         rustc_conversion_suggestion,
1218         rustc_deallocator,
1219         rustc_def_path,
1220         rustc_diagnostic_item,
1221         rustc_diagnostic_macros,
1222         rustc_dirty,
1223         rustc_do_not_const_check,
1224         rustc_dummy,
1225         rustc_dump_env_program_clauses,
1226         rustc_dump_program_clauses,
1227         rustc_dump_user_substs,
1228         rustc_dump_vtable,
1229         rustc_error,
1230         rustc_evaluate_where_clauses,
1231         rustc_expected_cgu_reuse,
1232         rustc_has_incoherent_inherent_impls,
1233         rustc_if_this_changed,
1234         rustc_inherit_overflow_checks,
1235         rustc_insignificant_dtor,
1236         rustc_layout,
1237         rustc_layout_scalar_valid_range_end,
1238         rustc_layout_scalar_valid_range_start,
1239         rustc_legacy_const_generics,
1240         rustc_lint_diagnostics,
1241         rustc_lint_query_instability,
1242         rustc_macro_transparency,
1243         rustc_main,
1244         rustc_mir,
1245         rustc_must_implement_one_of,
1246         rustc_nonnull_optimization_guaranteed,
1247         rustc_object_lifetime_default,
1248         rustc_on_unimplemented,
1249         rustc_outlives,
1250         rustc_paren_sugar,
1251         rustc_partition_codegened,
1252         rustc_partition_reused,
1253         rustc_pass_by_value,
1254         rustc_peek,
1255         rustc_peek_definite_init,
1256         rustc_peek_liveness,
1257         rustc_peek_maybe_init,
1258         rustc_peek_maybe_uninit,
1259         rustc_polymorphize_error,
1260         rustc_private,
1261         rustc_proc_macro_decls,
1262         rustc_promotable,
1263         rustc_reallocator,
1264         rustc_regions,
1265         rustc_reservation_impl,
1266         rustc_serialize,
1267         rustc_skip_array_during_method_dispatch,
1268         rustc_specialization_trait,
1269         rustc_stable,
1270         rustc_std_internal_symbol,
1271         rustc_strict_coherence,
1272         rustc_symbol_name,
1273         rustc_test_marker,
1274         rustc_then_this_would_need,
1275         rustc_trivial_field_reads,
1276         rustc_unsafe_specialization_marker,
1277         rustc_variance,
1278         rustdoc,
1279         rustdoc_internals,
1280         rustfmt,
1281         rvalue_static_promotion,
1282         s,
1283         sanitize,
1284         sanitizer_runtime,
1285         saturating_add,
1286         saturating_sub,
1287         self_in_typedefs,
1288         self_struct_ctor,
1289         semitransparent,
1290         shadow_call_stack,
1291         shl,
1292         shl_assign,
1293         should_panic,
1294         shr,
1295         shr_assign,
1296         simd,
1297         simd_add,
1298         simd_and,
1299         simd_arith_offset,
1300         simd_as,
1301         simd_bitmask,
1302         simd_cast,
1303         simd_ceil,
1304         simd_div,
1305         simd_eq,
1306         simd_extract,
1307         simd_fabs,
1308         simd_fcos,
1309         simd_fexp,
1310         simd_fexp2,
1311         simd_ffi,
1312         simd_flog,
1313         simd_flog10,
1314         simd_flog2,
1315         simd_floor,
1316         simd_fma,
1317         simd_fmax,
1318         simd_fmin,
1319         simd_fpow,
1320         simd_fpowi,
1321         simd_fsin,
1322         simd_fsqrt,
1323         simd_gather,
1324         simd_ge,
1325         simd_gt,
1326         simd_insert,
1327         simd_le,
1328         simd_lt,
1329         simd_mul,
1330         simd_ne,
1331         simd_neg,
1332         simd_or,
1333         simd_reduce_add_ordered,
1334         simd_reduce_add_unordered,
1335         simd_reduce_all,
1336         simd_reduce_and,
1337         simd_reduce_any,
1338         simd_reduce_max,
1339         simd_reduce_max_nanless,
1340         simd_reduce_min,
1341         simd_reduce_min_nanless,
1342         simd_reduce_mul_ordered,
1343         simd_reduce_mul_unordered,
1344         simd_reduce_or,
1345         simd_reduce_xor,
1346         simd_rem,
1347         simd_round,
1348         simd_saturating_add,
1349         simd_saturating_sub,
1350         simd_scatter,
1351         simd_select,
1352         simd_select_bitmask,
1353         simd_shl,
1354         simd_shr,
1355         simd_shuffle,
1356         simd_sub,
1357         simd_trunc,
1358         simd_xor,
1359         since,
1360         sinf32,
1361         sinf64,
1362         size,
1363         size_of,
1364         size_of_val,
1365         sized,
1366         skip,
1367         slice,
1368         slice_len_fn,
1369         slice_patterns,
1370         slicing_syntax,
1371         soft,
1372         specialization,
1373         speed,
1374         spotlight,
1375         sqrtf32,
1376         sqrtf64,
1377         sreg,
1378         sreg_low16,
1379         sse,
1380         sse4a_target_feature,
1381         stable,
1382         staged_api,
1383         start,
1384         state,
1385         static_in_const,
1386         static_nobundle,
1387         static_recursion,
1388         staticlib,
1389         std,
1390         std_inject,
1391         std_panic,
1392         std_panic_2015_macro,
1393         std_panic_macro,
1394         stmt,
1395         stmt_expr_attributes,
1396         stop_after_dataflow,
1397         store,
1398         str,
1399         str_split_whitespace,
1400         str_trim,
1401         str_trim_end,
1402         str_trim_start,
1403         strict_provenance,
1404         stringify,
1405         stringify_macro,
1406         struct_field_attributes,
1407         struct_inherit,
1408         struct_variant,
1409         structural_match,
1410         structural_peq,
1411         structural_teq,
1412         sty,
1413         sub,
1414         sub_assign,
1415         sub_with_overflow,
1416         suggestion,
1417         sym,
1418         sync,
1419         t32,
1420         target,
1421         target_abi,
1422         target_arch,
1423         target_endian,
1424         target_env,
1425         target_family,
1426         target_feature,
1427         target_feature_11,
1428         target_has_atomic,
1429         target_has_atomic_equal_alignment,
1430         target_has_atomic_load_store,
1431         target_os,
1432         target_pointer_width,
1433         target_target_vendor,
1434         target_thread_local,
1435         target_vendor,
1436         task,
1437         tbm_target_feature,
1438         termination,
1439         termination_trait,
1440         termination_trait_test,
1441         test,
1442         test_2018_feature,
1443         test_accepted_feature,
1444         test_case,
1445         test_removed_feature,
1446         test_runner,
1447         test_unstable_lint,
1448         then_with,
1449         thread,
1450         thread_local,
1451         thread_local_macro,
1452         thumb2,
1453         thumb_mode: "thumb-mode",
1454         tmm_reg,
1455         to_string,
1456         to_vec,
1457         todo_macro,
1458         tool_attributes,
1459         tool_lints,
1460         trace_macros,
1461         track_caller,
1462         trait_alias,
1463         trait_upcasting,
1464         transmute,
1465         transparent,
1466         transparent_enums,
1467         transparent_unions,
1468         trivial_bounds,
1469         truncf32,
1470         truncf64,
1471         try_blocks,
1472         try_capture,
1473         try_from,
1474         try_into,
1475         try_trait_v2,
1476         tt,
1477         tuple,
1478         tuple_from_req,
1479         tuple_indexing,
1480         two_phase,
1481         ty,
1482         type_alias_enum_variants,
1483         type_alias_impl_trait,
1484         type_ascription,
1485         type_changing_struct_update,
1486         type_id,
1487         type_length_limit,
1488         type_macros,
1489         type_name,
1490         u128,
1491         u16,
1492         u32,
1493         u64,
1494         u8,
1495         unaligned_volatile_load,
1496         unaligned_volatile_store,
1497         unboxed_closures,
1498         unchecked_add,
1499         unchecked_div,
1500         unchecked_mul,
1501         unchecked_rem,
1502         unchecked_shl,
1503         unchecked_shr,
1504         unchecked_sub,
1505         underscore_const_names,
1506         underscore_imports,
1507         underscore_lifetimes,
1508         uniform_paths,
1509         unimplemented_macro,
1510         unit,
1511         universal_impl_trait,
1512         unix,
1513         unlikely,
1514         unmarked_api,
1515         unpin,
1516         unreachable,
1517         unreachable_2015,
1518         unreachable_2015_macro,
1519         unreachable_2021,
1520         unreachable_2021_macro,
1521         unreachable_code,
1522         unreachable_display,
1523         unreachable_macro,
1524         unrestricted_attribute_tokens,
1525         unsafe_block_in_unsafe_fn,
1526         unsafe_cell,
1527         unsafe_no_drop_flag,
1528         unsafe_pin_internals,
1529         unsize,
1530         unsized_fn_params,
1531         unsized_locals,
1532         unsized_tuple_coercion,
1533         unstable,
1534         unstable_location_reason_default: "this crate is being loaded from the sysroot, an \
1535                           unstable location; did you mean to load this crate \
1536                           from crates.io via `Cargo.toml` instead?",
1537         untagged_unions,
1538         unused_imports,
1539         unused_qualifications,
1540         unwind,
1541         unwind_attributes,
1542         unwind_safe_trait,
1543         unwrap,
1544         unwrap_or,
1545         use_extern_macros,
1546         use_nested_groups,
1547         used,
1548         used_with_arg,
1549         using,
1550         usize,
1551         v1,
1552         va_arg,
1553         va_copy,
1554         va_end,
1555         va_list,
1556         va_start,
1557         val,
1558         values,
1559         var,
1560         variant_count,
1561         vec,
1562         vec_macro,
1563         version,
1564         vfp2,
1565         vis,
1566         visible_private_types,
1567         volatile,
1568         volatile_copy_memory,
1569         volatile_copy_nonoverlapping_memory,
1570         volatile_load,
1571         volatile_set_memory,
1572         volatile_store,
1573         vreg,
1574         vreg_low16,
1575         vtable_align,
1576         vtable_size,
1577         warn,
1578         wasm_abi,
1579         wasm_import_module,
1580         wasm_target_feature,
1581         while_let,
1582         width,
1583         windows,
1584         windows_subsystem,
1585         with_negative_coherence,
1586         wrapping_add,
1587         wrapping_mul,
1588         wrapping_sub,
1589         wreg,
1590         write_bytes,
1591         write_macro,
1592         write_str,
1593         writeln_macro,
1594         x87_reg,
1595         xer,
1596         xmm_reg,
1597         yeet_desugar_details,
1598         yeet_expr,
1599         ymm_reg,
1600         zmm_reg,
1601     }
1602 }
1603
1604 #[derive(Copy, Clone, Eq, HashStable_Generic, Encodable, Decodable)]
1605 pub struct Ident {
1606     pub name: Symbol,
1607     pub span: Span,
1608 }
1609
1610 impl Ident {
1611     #[inline]
1612     /// Constructs a new identifier from a symbol and a span.
1613     pub const fn new(name: Symbol, span: Span) -> Ident {
1614         Ident { name, span }
1615     }
1616
1617     /// Constructs a new identifier with a dummy span.
1618     #[inline]
1619     pub const fn with_dummy_span(name: Symbol) -> Ident {
1620         Ident::new(name, DUMMY_SP)
1621     }
1622
1623     #[inline]
1624     pub fn empty() -> Ident {
1625         Ident::with_dummy_span(kw::Empty)
1626     }
1627
1628     /// Maps a string to an identifier with a dummy span.
1629     pub fn from_str(string: &str) -> Ident {
1630         Ident::with_dummy_span(Symbol::intern(string))
1631     }
1632
1633     /// Maps a string and a span to an identifier.
1634     pub fn from_str_and_span(string: &str, span: Span) -> Ident {
1635         Ident::new(Symbol::intern(string), span)
1636     }
1637
1638     /// Replaces `lo` and `hi` with those from `span`, but keep hygiene context.
1639     pub fn with_span_pos(self, span: Span) -> Ident {
1640         Ident::new(self.name, span.with_ctxt(self.span.ctxt()))
1641     }
1642
1643     pub fn without_first_quote(self) -> Ident {
1644         Ident::new(Symbol::intern(self.as_str().trim_start_matches('\'')), self.span)
1645     }
1646
1647     /// "Normalize" ident for use in comparisons using "item hygiene".
1648     /// Identifiers with same string value become same if they came from the same macro 2.0 macro
1649     /// (e.g., `macro` item, but not `macro_rules` item) and stay different if they came from
1650     /// different macro 2.0 macros.
1651     /// Technically, this operation strips all non-opaque marks from ident's syntactic context.
1652     pub fn normalize_to_macros_2_0(self) -> Ident {
1653         Ident::new(self.name, self.span.normalize_to_macros_2_0())
1654     }
1655
1656     /// "Normalize" ident for use in comparisons using "local variable hygiene".
1657     /// Identifiers with same string value become same if they came from the same non-transparent
1658     /// macro (e.g., `macro` or `macro_rules!` items) and stay different if they came from different
1659     /// non-transparent macros.
1660     /// Technically, this operation strips all transparent marks from ident's syntactic context.
1661     pub fn normalize_to_macro_rules(self) -> Ident {
1662         Ident::new(self.name, self.span.normalize_to_macro_rules())
1663     }
1664
1665     /// Access the underlying string. This is a slowish operation because it
1666     /// requires locking the symbol interner.
1667     ///
1668     /// Note that the lifetime of the return value is a lie. See
1669     /// `Symbol::as_str()` for details.
1670     pub fn as_str(&self) -> &str {
1671         self.name.as_str()
1672     }
1673 }
1674
1675 impl PartialEq for Ident {
1676     fn eq(&self, rhs: &Self) -> bool {
1677         self.name == rhs.name && self.span.eq_ctxt(rhs.span)
1678     }
1679 }
1680
1681 impl Hash for Ident {
1682     fn hash<H: Hasher>(&self, state: &mut H) {
1683         self.name.hash(state);
1684         self.span.ctxt().hash(state);
1685     }
1686 }
1687
1688 impl fmt::Debug for Ident {
1689     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1690         fmt::Display::fmt(self, f)?;
1691         fmt::Debug::fmt(&self.span.ctxt(), f)
1692     }
1693 }
1694
1695 /// This implementation is supposed to be used in error messages, so it's expected to be identical
1696 /// to printing the original identifier token written in source code (`token_to_string`),
1697 /// except that AST identifiers don't keep the rawness flag, so we have to guess it.
1698 impl fmt::Display for Ident {
1699     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1700         fmt::Display::fmt(&IdentPrinter::new(self.name, self.is_raw_guess(), None), f)
1701     }
1702 }
1703
1704 /// This is the most general way to print identifiers.
1705 /// AST pretty-printer is used as a fallback for turning AST structures into token streams for
1706 /// proc macros. Additionally, proc macros may stringify their input and expect it survive the
1707 /// stringification (especially true for proc macro derives written between Rust 1.15 and 1.30).
1708 /// So we need to somehow pretty-print `$crate` in a way preserving at least some of its
1709 /// hygiene data, most importantly name of the crate it refers to.
1710 /// As a result we print `$crate` as `crate` if it refers to the local crate
1711 /// and as `::other_crate_name` if it refers to some other crate.
1712 /// Note, that this is only done if the ident token is printed from inside of AST pretty-printing,
1713 /// but not otherwise. Pretty-printing is the only way for proc macros to discover token contents,
1714 /// so we should not perform this lossy conversion if the top level call to the pretty-printer was
1715 /// done for a token stream or a single token.
1716 pub struct IdentPrinter {
1717     symbol: Symbol,
1718     is_raw: bool,
1719     /// Span used for retrieving the crate name to which `$crate` refers to,
1720     /// if this field is `None` then the `$crate` conversion doesn't happen.
1721     convert_dollar_crate: Option<Span>,
1722 }
1723
1724 impl IdentPrinter {
1725     /// The most general `IdentPrinter` constructor. Do not use this.
1726     pub fn new(symbol: Symbol, is_raw: bool, convert_dollar_crate: Option<Span>) -> IdentPrinter {
1727         IdentPrinter { symbol, is_raw, convert_dollar_crate }
1728     }
1729
1730     /// This implementation is supposed to be used when printing identifiers
1731     /// as a part of pretty-printing for larger AST pieces.
1732     /// Do not use this either.
1733     pub fn for_ast_ident(ident: Ident, is_raw: bool) -> IdentPrinter {
1734         IdentPrinter::new(ident.name, is_raw, Some(ident.span))
1735     }
1736 }
1737
1738 impl fmt::Display for IdentPrinter {
1739     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1740         if self.is_raw {
1741             f.write_str("r#")?;
1742         } else if self.symbol == kw::DollarCrate {
1743             if let Some(span) = self.convert_dollar_crate {
1744                 let converted = span.ctxt().dollar_crate_name();
1745                 if !converted.is_path_segment_keyword() {
1746                     f.write_str("::")?;
1747                 }
1748                 return fmt::Display::fmt(&converted, f);
1749             }
1750         }
1751         fmt::Display::fmt(&self.symbol, f)
1752     }
1753 }
1754
1755 /// An newtype around `Ident` that calls [Ident::normalize_to_macro_rules] on
1756 /// construction.
1757 // FIXME(matthewj, petrochenkov) Use this more often, add a similar
1758 // `ModernIdent` struct and use that as well.
1759 #[derive(Copy, Clone, Eq, PartialEq, Hash)]
1760 pub struct MacroRulesNormalizedIdent(Ident);
1761
1762 impl MacroRulesNormalizedIdent {
1763     pub fn new(ident: Ident) -> Self {
1764         Self(ident.normalize_to_macro_rules())
1765     }
1766 }
1767
1768 impl fmt::Debug for MacroRulesNormalizedIdent {
1769     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1770         fmt::Debug::fmt(&self.0, f)
1771     }
1772 }
1773
1774 impl fmt::Display for MacroRulesNormalizedIdent {
1775     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1776         fmt::Display::fmt(&self.0, f)
1777     }
1778 }
1779
1780 /// An interned string.
1781 ///
1782 /// Internally, a `Symbol` is implemented as an index, and all operations
1783 /// (including hashing, equality, and ordering) operate on that index. The use
1784 /// of `rustc_index::newtype_index!` means that `Option<Symbol>` only takes up 4 bytes,
1785 /// because `rustc_index::newtype_index!` reserves the last 256 values for tagging purposes.
1786 ///
1787 /// Note that `Symbol` cannot directly be a `rustc_index::newtype_index!` because it
1788 /// implements `fmt::Debug`, `Encodable`, and `Decodable` in special ways.
1789 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
1790 pub struct Symbol(SymbolIndex);
1791
1792 rustc_index::newtype_index! {
1793     struct SymbolIndex { .. }
1794 }
1795
1796 impl Symbol {
1797     const fn new(n: u32) -> Self {
1798         Symbol(SymbolIndex::from_u32(n))
1799     }
1800
1801     /// Maps a string to its interned representation.
1802     pub fn intern(string: &str) -> Self {
1803         with_session_globals(|session_globals| session_globals.symbol_interner.intern(string))
1804     }
1805
1806     /// Access the underlying string. This is a slowish operation because it
1807     /// requires locking the symbol interner.
1808     ///
1809     /// Note that the lifetime of the return value is a lie. It's not the same
1810     /// as `&self`, but actually tied to the lifetime of the underlying
1811     /// interner. Interners are long-lived, and there are very few of them, and
1812     /// this function is typically used for short-lived things, so in practice
1813     /// it works out ok.
1814     pub fn as_str(&self) -> &str {
1815         with_session_globals(|session_globals| unsafe {
1816             std::mem::transmute::<&str, &str>(session_globals.symbol_interner.get(*self))
1817         })
1818     }
1819
1820     pub fn as_u32(self) -> u32 {
1821         self.0.as_u32()
1822     }
1823
1824     pub fn is_empty(self) -> bool {
1825         self == kw::Empty
1826     }
1827
1828     /// This method is supposed to be used in error messages, so it's expected to be
1829     /// identical to printing the original identifier token written in source code
1830     /// (`token_to_string`, `Ident::to_string`), except that symbols don't keep the rawness flag
1831     /// or edition, so we have to guess the rawness using the global edition.
1832     pub fn to_ident_string(self) -> String {
1833         Ident::with_dummy_span(self).to_string()
1834     }
1835 }
1836
1837 impl fmt::Debug for Symbol {
1838     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1839         fmt::Debug::fmt(self.as_str(), f)
1840     }
1841 }
1842
1843 impl fmt::Display for Symbol {
1844     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1845         fmt::Display::fmt(self.as_str(), f)
1846     }
1847 }
1848
1849 impl<S: Encoder> Encodable<S> for Symbol {
1850     fn encode(&self, s: &mut S) {
1851         s.emit_str(self.as_str());
1852     }
1853 }
1854
1855 impl<D: Decoder> Decodable<D> for Symbol {
1856     #[inline]
1857     fn decode(d: &mut D) -> Symbol {
1858         Symbol::intern(&d.read_str())
1859     }
1860 }
1861
1862 impl<CTX> HashStable<CTX> for Symbol {
1863     #[inline]
1864     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
1865         self.as_str().hash_stable(hcx, hasher);
1866     }
1867 }
1868
1869 impl<CTX> ToStableHashKey<CTX> for Symbol {
1870     type KeyType = String;
1871     #[inline]
1872     fn to_stable_hash_key(&self, _: &CTX) -> String {
1873         self.as_str().to_string()
1874     }
1875 }
1876
1877 #[derive(Default)]
1878 pub(crate) struct Interner(Lock<InternerInner>);
1879
1880 // The `&'static str`s in this type actually point into the arena.
1881 //
1882 // The `FxHashMap`+`Vec` pair could be replaced by `FxIndexSet`, but #75278
1883 // found that to regress performance up to 2% in some cases. This might be
1884 // revisited after further improvements to `indexmap`.
1885 //
1886 // This type is private to prevent accidentally constructing more than one
1887 // `Interner` on the same thread, which makes it easy to mix up `Symbol`s
1888 // between `Interner`s.
1889 #[derive(Default)]
1890 struct InternerInner {
1891     arena: DroplessArena,
1892     names: FxHashMap<&'static str, Symbol>,
1893     strings: Vec<&'static str>,
1894 }
1895
1896 impl Interner {
1897     fn prefill(init: &[&'static str]) -> Self {
1898         Interner(Lock::new(InternerInner {
1899             strings: init.into(),
1900             names: init.iter().copied().zip((0..).map(Symbol::new)).collect(),
1901             ..Default::default()
1902         }))
1903     }
1904
1905     #[inline]
1906     fn intern(&self, string: &str) -> Symbol {
1907         let mut inner = self.0.lock();
1908         if let Some(&name) = inner.names.get(string) {
1909             return name;
1910         }
1911
1912         let name = Symbol::new(inner.strings.len() as u32);
1913
1914         // SAFETY: we convert from `&str` to `&[u8]`, clone it into the arena,
1915         // and immediately convert the clone back to `&[u8], all because there
1916         // is no `inner.arena.alloc_str()` method. This is clearly safe.
1917         let string: &str =
1918             unsafe { str::from_utf8_unchecked(inner.arena.alloc_slice(string.as_bytes())) };
1919
1920         // SAFETY: we can extend the arena allocation to `'static` because we
1921         // only access these while the arena is still alive.
1922         let string: &'static str = unsafe { &*(string as *const str) };
1923         inner.strings.push(string);
1924
1925         // This second hash table lookup can be avoided by using `RawEntryMut`,
1926         // but this code path isn't hot enough for it to be worth it. See
1927         // #91445 for details.
1928         inner.names.insert(string, name);
1929         name
1930     }
1931
1932     // Get the symbol as a string. `Symbol::as_str()` should be used in
1933     // preference to this function.
1934     fn get(&self, symbol: Symbol) -> &str {
1935         self.0.lock().strings[symbol.0.as_usize()]
1936     }
1937 }
1938
1939 // This module has a very short name because it's used a lot.
1940 /// This module contains all the defined keyword `Symbol`s.
1941 ///
1942 /// Given that `kw` is imported, use them like `kw::keyword_name`.
1943 /// For example `kw::Loop` or `kw::Break`.
1944 pub mod kw {
1945     pub use super::kw_generated::*;
1946 }
1947
1948 // This module has a very short name because it's used a lot.
1949 /// This module contains all the defined non-keyword `Symbol`s.
1950 ///
1951 /// Given that `sym` is imported, use them like `sym::symbol_name`.
1952 /// For example `sym::rustfmt` or `sym::u8`.
1953 pub mod sym {
1954     use super::Symbol;
1955     use std::convert::TryInto;
1956
1957     #[doc(inline)]
1958     pub use super::sym_generated::*;
1959
1960     // Used from a macro in `librustc_feature/accepted.rs`
1961     pub use super::kw::MacroRules as macro_rules;
1962
1963     /// Get the symbol for an integer.
1964     ///
1965     /// The first few non-negative integers each have a static symbol and therefore
1966     /// are fast.
1967     pub fn integer<N: TryInto<usize> + Copy + ToString>(n: N) -> Symbol {
1968         if let Result::Ok(idx) = n.try_into() {
1969             if idx < 10 {
1970                 return Symbol::new(super::SYMBOL_DIGITS_BASE + idx as u32);
1971             }
1972         }
1973         Symbol::intern(&n.to_string())
1974     }
1975 }
1976
1977 impl Symbol {
1978     fn is_special(self) -> bool {
1979         self <= kw::Underscore
1980     }
1981
1982     fn is_used_keyword_always(self) -> bool {
1983         self >= kw::As && self <= kw::While
1984     }
1985
1986     fn is_used_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1987         (self >= kw::Async && self <= kw::Dyn) && edition() >= Edition::Edition2018
1988     }
1989
1990     fn is_unused_keyword_always(self) -> bool {
1991         self >= kw::Abstract && self <= kw::Yield
1992     }
1993
1994     fn is_unused_keyword_conditional(self, edition: impl FnOnce() -> Edition) -> bool {
1995         self == kw::Try && edition() >= Edition::Edition2018
1996     }
1997
1998     pub fn is_reserved(self, edition: impl Copy + FnOnce() -> Edition) -> bool {
1999         self.is_special()
2000             || self.is_used_keyword_always()
2001             || self.is_unused_keyword_always()
2002             || self.is_used_keyword_conditional(edition)
2003             || self.is_unused_keyword_conditional(edition)
2004     }
2005
2006     /// A keyword or reserved identifier that can be used as a path segment.
2007     pub fn is_path_segment_keyword(self) -> bool {
2008         self == kw::Super
2009             || self == kw::SelfLower
2010             || self == kw::SelfUpper
2011             || self == kw::Crate
2012             || self == kw::PathRoot
2013             || self == kw::DollarCrate
2014     }
2015
2016     /// Returns `true` if the symbol is `true` or `false`.
2017     pub fn is_bool_lit(self) -> bool {
2018         self == kw::True || self == kw::False
2019     }
2020
2021     /// Returns `true` if this symbol can be a raw identifier.
2022     pub fn can_be_raw(self) -> bool {
2023         self != kw::Empty && self != kw::Underscore && !self.is_path_segment_keyword()
2024     }
2025 }
2026
2027 impl Ident {
2028     // Returns `true` for reserved identifiers used internally for elided lifetimes,
2029     // unnamed method parameters, crate root module, error recovery etc.
2030     pub fn is_special(self) -> bool {
2031         self.name.is_special()
2032     }
2033
2034     /// Returns `true` if the token is a keyword used in the language.
2035     pub fn is_used_keyword(self) -> bool {
2036         // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2037         self.name.is_used_keyword_always()
2038             || self.name.is_used_keyword_conditional(|| self.span.edition())
2039     }
2040
2041     /// Returns `true` if the token is a keyword reserved for possible future use.
2042     pub fn is_unused_keyword(self) -> bool {
2043         // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2044         self.name.is_unused_keyword_always()
2045             || self.name.is_unused_keyword_conditional(|| self.span.edition())
2046     }
2047
2048     /// Returns `true` if the token is either a special identifier or a keyword.
2049     pub fn is_reserved(self) -> bool {
2050         // Note: `span.edition()` is relatively expensive, don't call it unless necessary.
2051         self.name.is_reserved(|| self.span.edition())
2052     }
2053
2054     /// A keyword or reserved identifier that can be used as a path segment.
2055     pub fn is_path_segment_keyword(self) -> bool {
2056         self.name.is_path_segment_keyword()
2057     }
2058
2059     /// We see this identifier in a normal identifier position, like variable name or a type.
2060     /// How was it written originally? Did it use the raw form? Let's try to guess.
2061     pub fn is_raw_guess(self) -> bool {
2062         self.name.can_be_raw() && self.is_reserved()
2063     }
2064 }