Skip to content

Commit

Permalink
Change #[privatize] into #[derive(DenyPublicFields)]
Browse files Browse the repository at this point in the history
  • Loading branch information
nox committed Feb 15, 2017
1 parent 19c645f commit 8bcf36b
Show file tree
Hide file tree
Showing 16 changed files with 69 additions and 65 deletions.
10 changes: 10 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions components/deny_public_fields/Cargo.toml
@@ -0,0 +1,14 @@
[package]
name = "deny_public_fields"
version = "0.0.1"
authors = ["The Servo Project Developers"]
license = "MPL-2.0"
publish = false

[lib]
path = "lib.rs"
proc-macro = true

[dependencies]
syn = "0.10"
synstructure = "0.4"
26 changes: 26 additions & 0 deletions components/deny_public_fields/lib.rs
@@ -0,0 +1,26 @@
/* 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/. */

extern crate proc_macro;
extern crate syn;
extern crate synstructure;

#[proc_macro_derive(DenyPublicFields)]
pub fn expand_token_stream(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
expand_string(&input.to_string()).parse().unwrap()
}

fn expand_string(input: &str) -> String {
let type_ = syn::parse_macro_input(input).unwrap();

let style = synstructure::BindStyle::Ref.into();
synstructure::each_field(&type_, &style, |binding| {
if binding.field.vis != syn::Visibility::Inherited {
panic!("Field {} should not be public", binding.ident);
}
"".to_owned()
});

"".to_owned()
}
1 change: 0 additions & 1 deletion components/plugins/jstraceable.rs
Expand Up @@ -11,7 +11,6 @@ pub fn expand_dom_struct(cx: &mut ExtCtxt, sp: Span, _: &MetaItem, anno: Annotat
if let Annotatable::Item(item) = anno {
let mut item2 = (*item).clone();
item2.attrs.push(quote_attr!(cx, #[must_root]));
item2.attrs.push(quote_attr!(cx, #[privatize]));
item2.attrs.push(quote_attr!(cx, #[repr(C)]));
item2.attrs.push(quote_attr!(cx, #[derive(JSTraceable)]));
item2.attrs.push(quote_attr!(cx, #[derive(HeapSizeOf)]));
Expand Down
6 changes: 2 additions & 4 deletions components/plugins/lib.rs
Expand Up @@ -6,11 +6,11 @@
//!
//! Attributes this crate provides:
//!
//! - `#[privatize]` : Forces all fields in a struct/enum to be private
//! - `#[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 `#[privatize]`,`#[derive(JSTraceable)]`, and `#[must_root]`.
//! - `#[dom_struct]` : Implies #[derive(JSTraceable, DenyPublicFields)]`, and `#[must_root]`.
//! Use this for structs that correspond to a DOM type


Expand Down Expand Up @@ -44,13 +44,11 @@ pub fn plugin_registrar(reg: &mut Registry) {
MultiModifier(box jstraceable::expand_dom_struct));

reg.register_late_lint_pass(box lints::unrooted_must_root::UnrootedPass::new());
reg.register_late_lint_pass(box lints::privatize::PrivatizePass);
reg.register_late_lint_pass(box lints::inheritance_integrity::InheritancePass);
reg.register_early_lint_pass(box lints::ban::BanPass);
reg.register_attribute("_dom_struct_marker".to_string(), Whitelisted);
reg.register_attribute("allow_unrooted_interior".to_string(), Whitelisted);
reg.register_attribute("must_root".to_string(), Whitelisted);
reg.register_attribute("privatize".to_string(), Whitelisted);
reg.register_attribute("servo_lang".to_string(), Whitelisted);
register_clippy(reg);
}
Expand Down
1 change: 0 additions & 1 deletion components/plugins/lints/mod.rs
Expand Up @@ -4,5 +4,4 @@

pub mod ban;
pub mod inheritance_integrity;
pub mod privatize;
pub mod unrooted_must_root;
41 changes: 0 additions & 41 deletions components/plugins/lints/privatize.rs

This file was deleted.

1 change: 1 addition & 0 deletions components/script/Cargo.toml
Expand Up @@ -35,6 +35,7 @@ canvas_traits = {path = "../canvas_traits"}
caseless = "0.1.0"
cookie = {version = "0.2.5", features = ["serialize-rustc"]}
cssparser = {version = "0.8", features = ["heap_size", "serde-serialization"]}
deny_public_fields = {path = "../deny_public_fields"}
devtools_traits = {path = "../devtools_traits"}
domobject_derive = {path = "../domobject_derive"}
encoding = "0.2"
Expand Down
4 changes: 1 addition & 3 deletions components/script/dom/bindings/iterable.rs
Expand Up @@ -48,10 +48,8 @@ pub trait Iterable {
/// An iterator over the iterable entries of a given DOM interface.
//FIXME: #12811 prevents dom_struct with type parameters
//#[dom_struct]
#[derive(DenyPublicFields, HeapSizeOf, JSTraceable)]
#[must_root]
#[privatize]
#[derive(JSTraceable)]
#[derive(HeapSizeOf)]
pub struct IterableIterator<T: DomObject + JSTraceable + Iterable> {
reflector: Reflector,
iterable: JS<T>,
Expand Down
3 changes: 1 addition & 2 deletions components/script/dom/eventtarget.rs
Expand Up @@ -220,8 +220,7 @@ impl CompiledEventListener {
}
}

#[derive(JSTraceable, Clone, PartialEq, HeapSizeOf)]
#[privatize]
#[derive(Clone, DenyPublicFields, HeapSizeOf, JSTraceable, PartialEq)]
/// A listener in a collection of event listeners.
struct EventListenerEntry {
phase: ListenerPhase,
Expand Down
4 changes: 1 addition & 3 deletions components/script/dom/range.rs
Expand Up @@ -929,10 +929,8 @@ impl RangeMethods for Range {
}
}

#[derive(JSTraceable)]
#[derive(DenyPublicFields, HeapSizeOf, JSTraceable)]
#[must_root]
#[privatize]
#[derive(HeapSizeOf)]
pub struct BoundaryPoint {
node: MutJS<Node>,
offset: Cell<u32>,
Expand Down
2 changes: 2 additions & 0 deletions components/script/lib.rs
Expand Up @@ -38,6 +38,8 @@ extern crate cookie as cookie_rs;
extern crate core;
#[macro_use]
extern crate cssparser;
#[macro_use]
extern crate deny_public_fields;
extern crate devtools_traits;
#[macro_use]
extern crate domobject_derive;
Expand Down
9 changes: 3 additions & 6 deletions components/script/timers.rs
Expand Up @@ -28,8 +28,7 @@ use std::rc::Rc;
#[derive(JSTraceable, PartialEq, Eq, Copy, Clone, HeapSizeOf, Hash, PartialOrd, Ord, Debug)]
pub struct OneshotTimerHandle(i32);

#[derive(JSTraceable, HeapSizeOf)]
#[privatize]
#[derive(DenyPublicFields, HeapSizeOf, JSTraceable)]
pub struct OneshotTimers {
js_timers: JsTimers,
#[ignore_heap_size_of = "Defined in std"]
Expand All @@ -53,8 +52,7 @@ pub struct OneshotTimers {
expected_event_id: Cell<TimerEventId>,
}

#[derive(JSTraceable, HeapSizeOf)]
#[privatize]
#[derive(DenyPublicFields, HeapSizeOf, JSTraceable)]
struct OneshotTimer {
handle: OneshotTimerHandle,
source: TimerSource,
Expand Down Expand Up @@ -302,8 +300,7 @@ impl OneshotTimers {
#[derive(JSTraceable, PartialEq, Eq, Copy, Clone, HeapSizeOf, Hash, PartialOrd, Ord)]
pub struct JsTimerHandle(i32);

#[derive(JSTraceable, HeapSizeOf)]
#[privatize]
#[derive(DenyPublicFields, HeapSizeOf, JSTraceable)]
pub struct JsTimers {
next_timer_handle: Cell<JsTimerHandle>,
active_timers: DOMRefCell<HashMap<JsTimerHandle, JsTimerEntry>>,
Expand Down
1 change: 1 addition & 0 deletions tests/compiletest/plugin/Cargo.toml
Expand Up @@ -11,5 +11,6 @@ doctest = false

[dependencies]
compiletest_helper = {path = "../helper"}
deny_public_fields = {path = "../../../components/deny_public_fields"}
plugins = {path = "../../../components/plugins"}
script = {path = "../../../components/script"}
9 changes: 5 additions & 4 deletions tests/compiletest/plugin/compile-fail/privatize.rs
Expand Up @@ -2,14 +2,15 @@
* 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/. */

#![feature(plugin, custom_attribute)]
#![plugin(plugins)]
#![allow(dead_code)]

#[privatize]
#[macro_use]
extern crate deny_public_fields;

#[derive(DenyPublicFields)]
//~^ ERROR custom derive attribute panicked
struct Foo {
pub v1: i32,
//~^ ERROR Field v1 is public where only private fields are allowed
v2: i32
}

Expand Down
2 changes: 2 additions & 0 deletions tests/compiletest/plugin/lib.rs
Expand Up @@ -3,6 +3,8 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */

extern crate compiletest_helper;
#[macro_use]
extern crate deny_public_fields;

#[test]
fn compile_test() {
Expand Down

0 comments on commit 8bcf36b

Please sign in to comment.