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 a deeper explanation of how the compiler works and is
  32 //! organized, see the README.md file in this directory.
  33 //!
  34 //! # Note
  35 //!
  36 //! This API is completely unstable and subject to change.
  37
  38 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
  39        html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
  40        html_root_url = "https://doc.rust-lang.org/nightly/")]
  41 #![deny(warnings)]
  42
  43 #![feature(box_patterns)]
  44 #![feature(box_syntax)]
  45 #![feature(conservative_impl_trait)]
  46 #![feature(const_fn)]
  47 #![feature(core_intrinsics)]
  48 #![feature(i128_type)]
  49 #![cfg_attr(windows, feature(libc))]
  50 #![feature(never_type)]
  51 #![feature(nonzero)]
  52 #![feature(quote)]
  53 #![feature(rustc_diagnostic_macros)]
  54 #![feature(slice_patterns)]
  55 #![feature(specialization)]
  56 #![feature(unboxed_closures)]
  57 #![feature(trace_macros)]
  58 #![feature(test)]
  59 #![feature(const_atomic_bool_new)]
  60
  61 #![recursion_limit="512"]
  62
  63 extern crate arena;
  64 #[macro_use] extern crate bitflags;
  65 extern crate core;
  66 extern crate fmt_macros;
  67 extern crate getopts;
  68 extern crate graphviz;
  69 #[cfg(windows)]
  70 extern crate libc;
  71 extern crate owning_ref;
  72 extern crate rustc_back;
  73 #[macro_use] extern crate rustc_data_structures;
  74 extern crate serialize;
  75 extern crate rustc_const_math;
  76 extern crate rustc_errors as errors;
  77 #[macro_use] extern crate log;
  78 #[macro_use] extern crate syntax;
  79 extern crate syntax_pos;
  80 extern crate jobserver;
  81
  82 extern crate serialize as rustc_serialize; // used by deriving
  83
  84 // Note that librustc doesn't actually depend on these crates, see the note in
  85 // `Cargo.toml` for this crate about why these are here.
  86 #[allow(unused_extern_crates)]
  87 extern crate flate2;
  88 #[allow(unused_extern_crates)]
  89 extern crate test;
  90
  91 #[macro_use]
  92 mod macros;
  93
  94 // NB: This module needs to be declared first so diagnostics are
  95 // registered before they are used.
  96 pub mod diagnostics;
  97
  98 pub mod cfg;
  99 pub mod dep_graph;
 100 pub mod hir;
 101 pub mod ich;
 102 pub mod infer;
 103 pub mod lint;
 104
 105 pub mod middle {
 106     pub mod allocator;
 107     pub mod borrowck;
 108     pub mod expr_use_visitor;
 109     pub mod const_val;
 110     pub mod cstore;
 111     pub mod dataflow;
 112     pub mod dead;
 113     pub mod dependency_format;
 114     pub mod entry;
 115     pub mod exported_symbols;
 116     pub mod free_region;
 117     pub mod intrinsicck;
 118     pub mod lang_items;
 119     pub mod liveness;
 120     pub mod mem_categorization;
 121     pub mod privacy;
 122     pub mod reachable;
 123     pub mod region;
 124     pub mod recursion_limit;
 125     pub mod resolve_lifetime;
 126     pub mod stability;
 127     pub mod trans;
 128     pub mod weak_lang_items;
 129 }
 130
 131 pub mod mir;
 132 pub mod session;
 133 pub mod traits;
 134 pub mod ty;
 135
 136 pub mod util {
 137     pub mod common;
 138     pub mod ppaux;
 139     pub mod nodemap;
 140     pub mod fs;
 141 }
 142
 143 // A private module so that macro-expanded idents like
 144 // `::rustc::lint::Lint` will also work in `rustc` itself.
 145 //
 146 // `libstd` uses the same trick.
 147 #[doc(hidden)]
 148 mod rustc {
 149     pub use lint;
 150 }
 151
 152 // FIXME(#27438): right now the unit tests of librustc don't refer to any actual
 153 //                functions generated in librustc_data_structures (all
 154 //                references are through generic functions), but statics are
 155 //                referenced from time to time. Due to this bug we won't
 156 //                actually correctly link in the statics unless we also
 157 //                reference a function, so be sure to reference a dummy
 158 //                function.
 159 #[test]
 160 fn noop() {
 161     rustc_data_structures::__noop_fix_for_27438();
 162 }
 163
 164
 165 // Build the diagnostics array at the end so that the metadata includes error use sites.
 166 __build_diagnostic_array! { librustc, DIAGNOSTICS }