aboutsummaryrefslogtreecommitdiffstats
path: root/components/script_plugins/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'components/script_plugins/lib.rs')
-rw-r--r--components/script_plugins/lib.rs48
1 files changed, 48 insertions, 0 deletions
diff --git a/components/script_plugins/lib.rs b/components/script_plugins/lib.rs
new file mode 100644
index 00000000000..79aa5a4752d
--- /dev/null
+++ b/components/script_plugins/lib.rs
@@ -0,0 +1,48 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+//! Servo's compiler plugin/macro crate
+//!
+//! Attributes this crate provides:
+//!
+//! - `#[derive(DenyPublicFields)]` : Forces all fields in a struct/enum to be private
+//! - `#[derive(JSTraceable)]` : Auto-derives an implementation of `JSTraceable` for a struct in the script crate
+//! - `#[must_root]` : Prevents data of the marked type from being used on the stack.
+//! See the lints module for more details
+//! - `#[dom_struct]` : Implies #[derive(JSTraceable, DenyPublicFields)]`, and `#[must_root]`.
+//! Use this for structs that correspond to a DOM type
+
+
+#![deny(unsafe_code)]
+#![feature(box_syntax, plugin, plugin_registrar, quote, rustc_private, slice_patterns)]
+
+#[macro_use]
+extern crate rustc;
+extern crate rustc_plugin;
+extern crate syntax;
+
+use rustc_plugin::Registry;
+use syntax::ext::base::*;
+use syntax::feature_gate::AttributeType::Whitelisted;
+use syntax::symbol::Symbol;
+
+mod ban;
+// Public for documentation to show up
+/// Handles the auto-deriving for `#[derive(JSTraceable)]`
+pub mod jstraceable;
+mod unrooted_must_root;
+/// Utilities for writing plugins
+mod utils;
+
+#[plugin_registrar]
+pub fn plugin_registrar(reg: &mut Registry) {
+ reg.register_syntax_extension(
+ Symbol::intern("dom_struct"),
+ MultiModifier(box jstraceable::expand_dom_struct));
+
+ reg.register_late_lint_pass(box unrooted_must_root::UnrootedPass::new());
+ reg.register_early_lint_pass(box ban::BanPass);
+ reg.register_attribute("allow_unrooted_interior".to_string(), Whitelisted);
+ reg.register_attribute("must_root".to_string(), Whitelisted);
+}