]> git.lizzy.rs Git - rust.git/blob - src/librustc/lib.rs
Rollup merge of #53110 - Xanewok:save-analysis-remap-path, r=nrc
[rust.git] / src / librustc / lib.rs
1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
4 //
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
10
11 //! The "main crate" of the Rust compiler. This crate contains common
12 //! type definitions that are used by the other crates in the rustc
13 //! "family". Some prominent examples (note that each of these modules
14 //! has their own README with further details).
15 //!
16 //! - **HIR.** The "high-level (H) intermediate representation (IR)" is
17 //!   defined in the `hir` module.
18 //! - **MIR.** The "mid-level (M) intermediate representation (IR)" is
19 //!   defined in the `mir` module. This module contains only the
20 //!   *definition* of the MIR; the passes that transform and operate
21 //!   on MIR are found in `librustc_mir` crate.
22 //! - **Types.** The internal representation of types used in rustc is
23 //!   defined in the `ty` module. This includes the **type context**
24 //!   (or `tcx`), which is the central context during most of
25 //!   compilation, containing the interners and other things.
26 //! - **Traits.** Trait resolution is implemented in the `traits` module.
27 //! - **Type inference.** The type inference code can be found in the `infer` module;
28 //!   this code handles low-level equality and subtyping operations. The
29 //!   type check pass in the compiler is found in the `librustc_typeck` crate.
30 //!
31 //! For more information about how rustc works, see the [rustc guide].
32 //!
33 //! [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/
34 //!
35 //! # Note
36 //!
37 //! This API is completely unstable and subject to change.
38
39 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
40        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
41        html_root_url = "https://doc.rust-lang.org/nightly/")]
42
43 #![feature(box_patterns)]
44 #![feature(box_syntax)]
45 #![feature(const_fn)]
46 #![feature(core_intrinsics)]
47 #![feature(drain_filter)]
48 #![feature(iterator_find_map)]
49 #![cfg_attr(windows, feature(libc))]
50 #![feature(macro_vis_matcher)]
51 #![feature(never_type)]
52 #![feature(exhaustive_patterns)]
53 #![feature(extern_types)]
54 #![feature(non_exhaustive)]
55 #![feature(proc_macro_internals)]
56 #![feature(quote)]
57 #![feature(optin_builtin_traits)]
58 #![feature(refcell_replace_swap)]
59 #![feature(rustc_diagnostic_macros)]
60 #![feature(slice_patterns)]
61 #![feature(slice_sort_by_cached_key)]
62 #![feature(specialization)]
63 #![feature(unboxed_closures)]
64 #![feature(trace_macros)]
65 #![feature(trusted_len)]
66 #![feature(vec_remove_item)]
67 #![feature(catch_expr)]
68 #![feature(step_trait)]
69 #![feature(integer_atomics)]
70 #![feature(test)]
71 #![cfg_attr(not(stage0), feature(impl_header_lifetime_elision))]
72 #![feature(in_band_lifetimes)]
73 #![feature(macro_at_most_once_rep)]
74 #![feature(crate_in_paths)]
75
76 #![recursion_limit="512"]
77
78 extern crate arena;
79 #[macro_use] extern crate bitflags;
80 extern crate core;
81 extern crate fmt_macros;
82 extern crate getopts;
83 extern crate graphviz;
84 #[macro_use] extern crate lazy_static;
85 #[macro_use] extern crate scoped_tls;
86 #[cfg(windows)]
87 extern crate libc;
88 extern crate polonius_engine;
89 extern crate rustc_target;
90 #[macro_use] extern crate rustc_data_structures;
91 extern crate serialize;
92 extern crate parking_lot;
93 extern crate rustc_errors as errors;
94 extern crate rustc_rayon as rayon;
95 extern crate rustc_rayon_core as rayon_core;
96 #[macro_use] extern crate log;
97 #[macro_use] extern crate syntax;
98 extern crate syntax_pos;
99 extern crate jobserver;
100 extern crate proc_macro;
101 extern crate chalk_engine;
102
103 extern crate serialize as rustc_serialize; // used by deriving
104
105 extern crate rustc_apfloat;
106 extern crate byteorder;
107 extern crate backtrace;
108
109 // Note that librustc doesn't actually depend on these crates, see the note in
110 // `Cargo.toml` for this crate about why these are here.
111 #[allow(unused_extern_crates)]
112 extern crate flate2;
113 #[allow(unused_extern_crates)]
114 extern crate test;
115
116 #[macro_use]
117 mod macros;
118
119 // NB: This module needs to be declared first so diagnostics are
120 // registered before they are used.
121 pub mod diagnostics;
122
123 pub mod cfg;
124 pub mod dep_graph;
125 pub mod hir;
126 pub mod ich;
127 pub mod infer;
128 pub mod lint;
129
130 pub mod middle {
131     pub mod allocator;
132     pub mod borrowck;
133     pub mod expr_use_visitor;
134     pub mod cstore;
135     pub mod dataflow;
136     pub mod dead;
137     pub mod dependency_format;
138     pub mod entry;
139     pub mod exported_symbols;
140     pub mod free_region;
141     pub mod intrinsicck;
142     pub mod lib_features;
143     pub mod lang_items;
144     pub mod liveness;
145     pub mod mem_categorization;
146     pub mod privacy;
147     pub mod reachable;
148     pub mod region;
149     pub mod recursion_limit;
150     pub mod resolve_lifetime;
151     pub mod stability;
152     pub mod weak_lang_items;
153 }
154
155 pub mod mir;
156 pub mod session;
157 pub mod traits;
158 pub mod ty;
159
160 pub mod util {
161     pub mod captures;
162     pub mod common;
163     pub mod ppaux;
164     pub mod nodemap;
165     pub mod fs;
166     pub mod time_graph;
167     pub mod profiling;
168 }
169
170 // A private module so that macro-expanded idents like
171 // `::rustc::lint::Lint` will also work in `rustc` itself.
172 //
173 // `libstd` uses the same trick.
174 #[doc(hidden)]
175 mod rustc {
176     pub use lint;
177 }
178
179 // FIXME(#27438): right now the unit tests of librustc don't refer to any actual
180 //                functions generated in librustc_data_structures (all
181 //                references are through generic functions), but statics are
182 //                referenced from time to time. Due to this bug we won't
183 //                actually correctly link in the statics unless we also
184 //                reference a function, so be sure to reference a dummy
185 //                function.
186 #[test]
187 fn noop() {
188     rustc_data_structures::__noop_fix_for_27438();
189 }
190
191
192 // Build the diagnostics array at the end so that the metadata includes error use sites.
193 __build_diagnostic_array! { librustc, DIAGNOSTICS }