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
// 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: //! //! ```rust,ignore //! #![crate_name = "myplugin"] //! #![crate_type = "dylib"] //! #![feature(plugin_registrar)] //! //! extern crate rustc; //! //! use rustc::plugin::Registry; //! //! #[plugin_registrar] //! pub fn plugin_registrar(reg: &mut Registry) { //! reg.register_macro("mymacro", expand_mymacro); //! } //! //! fn expand_mymacro(...) { // details elided //! ``` //! //! 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 compiler plugin guide](../../guide-plugin.html) //! for more examples. pub use self::registry::Registry; pub mod registry; pub mod load; pub mod build;