src/libsyntax_pos/symbol.rs

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