1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
// Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Infrastructure for compiler plugins. //! //! Plugins are Rust libraries which extend the behavior of `rustc` //! in various ways. //! //! Plugin authors will use the `Registry` type re-exported by //! this module, along with its methods. The rest of the module //! is for use by `rustc` itself. //! //! To define a plugin, build a dylib crate with a //! `#[plugin_registrar]` function: //! //! ```no_run //! #![crate_name = "myplugin"] //! #![crate_type = "dylib"] //! #![feature(plugin_registrar)] //! #![feature(rustc_private)] //! //! extern crate rustc_plugin; //! extern crate syntax; //! extern crate syntax_pos; //! //! use rustc_plugin::Registry; //! use syntax::ext::base::{ExtCtxt, MacResult}; //! use syntax_pos::Span; //! use syntax::tokenstream::TokenTree; //! //! #[plugin_registrar] //! pub fn plugin_registrar(reg: &mut Registry) { //! reg.register_macro("mymacro", expand_mymacro); //! } //! //! fn expand_mymacro(cx: &mut ExtCtxt, span: Span, tt: &[TokenTree]) -> Box<MacResult> { //! unimplemented!() //! } //! //! # fn main() {} //! ``` //! //! WARNING: We currently don't check that the registrar function //! has the appropriate type! //! //! To use a plugin while compiling another crate: //! //! ```rust //! #![feature(plugin)] //! #![plugin(myplugin)] //! ``` //! //! See the [`plugin` feature](../unstable-book/language-features/plugin.html) of //! the Unstable Book for more examples. #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://doc.rust-lang.org/favicon.ico", html_root_url = "https://doc.rust-lang.org/nightly/")] #![cfg_attr(not(stage0), feature(nll))] #![cfg_attr(not(stage0), feature(infer_outlives_requirements))] #![feature(rustc_diagnostic_macros)] #[macro_use] extern crate syntax; extern crate rustc; extern crate rustc_metadata; extern crate syntax_pos; extern crate rustc_errors as errors; pub use self::registry::Registry; mod diagnostics; pub mod registry; pub mod load; pub mod build; __build_diagnostic_array! { librustc_plugin, DIAGNOSTICS }