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.
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.
11 //! Infrastructure for compiler plugins.
13 //! Plugins are Rust libraries which extend the behavior of `rustc`
16 //! Plugin authors will use the `Registry` type re-exported by
17 //! this module, along with its methods. The rest of the module
18 //! is for use by `rustc` itself.
20 //! To define a plugin, build a dylib crate with a
21 //! `#[plugin_registrar]` function:
24 //! #![crate_name = "myplugin"]
25 //! #![crate_type = "dylib"]
26 //! #![feature(plugin_registrar)]
27 //! #![feature(rustc_private)]
29 //! extern crate rustc_plugin;
30 //! extern crate syntax;
31 //! extern crate syntax_pos;
33 //! use rustc_plugin::Registry;
34 //! use syntax::ext::base::{ExtCtxt, MacResult};
35 //! use syntax_pos::Span;
36 //! use syntax::tokenstream::TokenTree;
38 //! #[plugin_registrar]
39 //! pub fn plugin_registrar(reg: &mut Registry) {
40 //! reg.register_macro("mymacro", expand_mymacro);
43 //! fn expand_mymacro(cx: &mut ExtCtxt, span: Span, tt: &[TokenTree]) -> Box<MacResult> {
50 //! WARNING: We currently don't check that the registrar function
51 //! has the appropriate type!
53 //! To use a plugin while compiling another crate:
56 //! #![feature(plugin)]
57 //! #![plugin(myplugin)]
60 //! See the [`plugin` feature](../unstable-book/language-features/plugin.html) of
61 //! the Unstable Book for more examples.
63 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
64 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
65 html_root_url = "https://doc.rust-lang.org/nightly/")]
67 #![feature(rustc_diagnostic_macros)]
68 #![feature(staged_api)]
70 #[macro_use] extern crate syntax;
73 extern crate rustc_metadata;
74 extern crate syntax_pos;
75 extern crate rustc_errors as errors;
77 pub use self::registry::Registry;
84 __build_diagnostic_array! { librustc_plugin, DIAGNOSTICS }