src/libsyntax_pos/symbol.rs

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