Skip to content

Commit

Permalink
Add #[privatize] to allow enforcing private fields for struct definit…
Browse files Browse the repository at this point in the history
…ions
  • Loading branch information
ttaubert committed Oct 13, 2014
1 parent c87f34f commit 5b72087
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 1 deletion.
1 change: 1 addition & 0 deletions components/plugins/lib.rs
Expand Up @@ -27,6 +27,7 @@ mod jstraceable;
pub fn plugin_registrar(reg: &mut Registry) {
reg.register_lint_pass(box lints::TransmutePass as LintPassObject);
reg.register_lint_pass(box lints::UnrootedPass as LintPassObject);
reg.register_lint_pass(box lints::PrivatizePass as LintPassObject);
reg.register_syntax_extension(intern("jstraceable"), Decorator(box jstraceable::expand_jstraceable))
}

25 changes: 24 additions & 1 deletion components/plugins/lints.rs
Expand Up @@ -2,7 +2,8 @@
* 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/. */

use syntax::{ast, codemap, visit};
use syntax::{ast, ast_util, codemap, visit};
use syntax::ast::Public;
use syntax::attr::AttrMetaMethods;
use rustc::lint::{Context, LintPass, LintArray};
use rustc::middle::ty::expr_ty;
Expand All @@ -14,9 +15,12 @@ declare_lint!(TRANSMUTE_TYPE_LINT, Allow,
"Warn and report types being transmuted")
declare_lint!(UNROOTED_MUST_ROOT, Deny,
"Warn and report usage of unrooted jsmanaged objects")
declare_lint!(PRIVATIZE, Deny,
"Allows to enforce private fields for struct definitions")

pub struct TransmutePass;
pub struct UnrootedPass;
pub struct PrivatizePass;

impl LintPass for TransmutePass {
fn get_lints(&self) -> LintArray {
Expand Down Expand Up @@ -146,3 +150,22 @@ impl LintPass for UnrootedPass {
}
}

impl LintPass for PrivatizePass {
fn get_lints(&self) -> LintArray {
lint_array!(PRIVATIZE)
}

fn check_struct_def(&mut self, cx: &Context, def: &ast::StructDef, _i: ast::Ident, _gen: &ast::Generics, id: ast::NodeId) {
if ty::has_attr(cx.tcx, ast_util::local_def(id), "privatize") {
for field in def.fields.iter() {
match field.node {
ast::StructField_ { kind: ast::NamedField(ident, visibility), .. } if visibility == Public => {
cx.span_lint(PRIVATIZE, field.span,
format!("Field {} is public where only private fields are allowed", ident.name).as_slice());
}
_ => {}
}
}
}
}
}

0 comments on commit 5b72087

Please sign in to comment.