2016-02-04 17:36:06 -06:00
|
|
|
use regex_syntax;
|
2016-04-07 10:46:48 -05:00
|
|
|
use rustc::hir::*;
|
2016-02-24 10:38:57 -06:00
|
|
|
use rustc::lint::*;
|
2016-03-31 10:05:43 -05:00
|
|
|
use rustc::middle::const_val::ConstVal;
|
|
|
|
use rustc_const_eval::EvalHint::ExprTypeChecked;
|
|
|
|
use rustc_const_eval::eval_const_expr_partial;
|
2016-02-08 16:48:04 -06:00
|
|
|
use std::collections::HashSet;
|
2016-02-24 10:38:57 -06:00
|
|
|
use std::error::Error;
|
2016-02-14 09:55:02 -06:00
|
|
|
use syntax::ast::{LitKind, NodeId};
|
2016-02-05 09:48:35 -06:00
|
|
|
use syntax::codemap::{Span, BytePos};
|
2016-11-23 14:19:03 -06:00
|
|
|
use syntax::symbol::InternedString;
|
2016-05-25 10:15:19 -05:00
|
|
|
use utils::{is_expn_of, match_def_path, match_type, paths, span_lint, span_help_and_lint};
|
2016-02-04 17:36:06 -06:00
|
|
|
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **What it does:** Checks [regex] creation (with `Regex::new`,
|
|
|
|
/// `RegexBuilder::new` or `RegexSet::new`) for correct regex syntax.
|
2016-02-04 17:36:06 -06:00
|
|
|
///
|
2016-07-15 17:25:44 -05:00
|
|
|
/// [regex]: https://crates.io/crates/regex
|
|
|
|
///
|
2016-02-04 17:36:06 -06:00
|
|
|
/// **Why is this bad?** This will lead to a runtime panic.
|
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
2016-07-15 17:25:44 -05:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// Regex::new("|")
|
|
|
|
/// ```
|
2016-02-04 17:36:06 -06:00
|
|
|
declare_lint! {
|
|
|
|
pub INVALID_REGEX,
|
|
|
|
Deny,
|
2016-08-06 03:18:36 -05:00
|
|
|
"invalid regular expressions"
|
2016-02-04 17:36:06 -06:00
|
|
|
}
|
|
|
|
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **What it does:** Checks for trivial [regex] creation (with `Regex::new`,
|
2016-05-25 17:08:31 -05:00
|
|
|
/// `RegexBuilder::new` or `RegexSet::new`).
|
2016-02-05 16:10:48 -06:00
|
|
|
///
|
2016-07-15 17:25:44 -05:00
|
|
|
/// [regex]: https://crates.io/crates/regex
|
|
|
|
///
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **Why is this bad?** Matching the regex can likely be replaced by `==` or
|
|
|
|
/// `str::starts_with`, `str::ends_with` or `std::contains` or other `str`
|
|
|
|
/// methods.
|
2016-02-05 16:10:48 -06:00
|
|
|
///
|
|
|
|
/// **Known problems:** None.
|
|
|
|
///
|
2016-07-15 17:25:44 -05:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// Regex::new("^foobar")
|
|
|
|
/// ```
|
2016-02-05 16:10:48 -06:00
|
|
|
declare_lint! {
|
|
|
|
pub TRIVIAL_REGEX,
|
|
|
|
Warn,
|
2016-08-06 03:18:36 -05:00
|
|
|
"trivial regular expressions"
|
2016-02-05 16:10:48 -06:00
|
|
|
}
|
|
|
|
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **What it does:** Checks for usage of `regex!(_)` which (as of now) is
|
|
|
|
/// usually slower than `Regex::new(_)` unless called in a loop (which is a bad
|
|
|
|
/// idea anyway).
|
2016-02-07 15:50:54 -06:00
|
|
|
///
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **Why is this bad?** Performance, at least for now. The macro version is
|
|
|
|
/// likely to catch up long-term, but for now the dynamic version is faster.
|
2016-02-07 15:50:54 -06:00
|
|
|
///
|
2016-08-06 02:55:04 -05:00
|
|
|
/// **Known problems:** None.
|
2016-02-07 15:50:54 -06:00
|
|
|
///
|
2016-07-15 17:25:44 -05:00
|
|
|
/// **Example:**
|
|
|
|
/// ```rust
|
|
|
|
/// regex!("foo|bar")
|
|
|
|
/// ```
|
2016-02-07 15:50:54 -06:00
|
|
|
declare_lint! {
|
|
|
|
pub REGEX_MACRO,
|
2016-02-08 16:48:04 -06:00
|
|
|
Warn,
|
2016-08-06 03:18:36 -05:00
|
|
|
"use of `regex!(_)` instead of `Regex::new(_)`"
|
2016-02-07 15:50:54 -06:00
|
|
|
}
|
|
|
|
|
2016-02-14 09:55:02 -06:00
|
|
|
#[derive(Clone, Default)]
|
2016-06-10 09:17:20 -05:00
|
|
|
pub struct Pass {
|
2016-02-14 09:55:02 -06:00
|
|
|
spans: HashSet<Span>,
|
2016-02-24 10:38:57 -06:00
|
|
|
last: Option<NodeId>,
|
2016-02-14 09:55:02 -06:00
|
|
|
}
|
2016-02-04 17:36:06 -06:00
|
|
|
|
2016-06-10 09:17:20 -05:00
|
|
|
impl LintPass for Pass {
|
2016-02-04 17:36:06 -06:00
|
|
|
fn get_lints(&self) -> LintArray {
|
2016-02-07 15:50:54 -06:00
|
|
|
lint_array!(INVALID_REGEX, REGEX_MACRO, TRIVIAL_REGEX)
|
2016-02-04 17:36:06 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-10 09:17:20 -05:00
|
|
|
impl LateLintPass for Pass {
|
2016-02-14 09:55:02 -06:00
|
|
|
fn check_crate(&mut self, _: &LateContext, _: &Crate) {
|
|
|
|
self.spans.clear();
|
2016-02-07 15:50:54 -06:00
|
|
|
}
|
|
|
|
|
2016-02-14 09:55:02 -06:00
|
|
|
fn check_block(&mut self, cx: &LateContext, block: &Block) {
|
|
|
|
if_let_chain!{[
|
|
|
|
self.last.is_none(),
|
|
|
|
let Some(ref expr) = block.expr,
|
2016-11-16 14:57:56 -06:00
|
|
|
match_type(cx, cx.tcx.tables().expr_ty(expr), &paths::REGEX),
|
2016-04-14 17:09:37 -05:00
|
|
|
let Some(span) = is_expn_of(cx, expr.span, "regex"),
|
2016-02-14 09:55:02 -06:00
|
|
|
], {
|
|
|
|
if !self.spans.contains(&span) {
|
|
|
|
span_lint(cx,
|
|
|
|
REGEX_MACRO,
|
|
|
|
span,
|
|
|
|
"`regex!(_)` found. \
|
|
|
|
Please use `Regex::new(_)`, which is faster for now.");
|
2016-05-25 10:15:19 -05:00
|
|
|
self.spans.insert(span);
|
2016-02-14 09:55:02 -06:00
|
|
|
}
|
|
|
|
self.last = Some(block.id);
|
|
|
|
}}
|
|
|
|
}
|
2016-02-24 10:38:57 -06:00
|
|
|
|
2016-02-14 09:55:02 -06:00
|
|
|
fn check_block_post(&mut self, _: &LateContext, block: &Block) {
|
|
|
|
if self.last.map_or(false, |id| block.id == id) {
|
2016-02-24 10:38:57 -06:00
|
|
|
self.last = None;
|
2016-02-14 09:55:02 -06:00
|
|
|
}
|
|
|
|
}
|
2016-02-07 15:50:54 -06:00
|
|
|
|
2016-02-04 17:36:06 -06:00
|
|
|
fn check_expr(&mut self, cx: &LateContext, expr: &Expr) {
|
|
|
|
if_let_chain!{[
|
|
|
|
let ExprCall(ref fun, ref args) = expr.node,
|
2016-05-25 10:15:19 -05:00
|
|
|
args.len() == 1,
|
|
|
|
let Some(def) = cx.tcx.def_map.borrow().get(&fun.id),
|
2016-02-04 17:36:06 -06:00
|
|
|
], {
|
2016-06-10 12:47:10 -05:00
|
|
|
let def_id = def.full_def().def_id();
|
2016-06-06 11:55:22 -05:00
|
|
|
if match_def_path(cx, def_id, &paths::REGEX_NEW) ||
|
|
|
|
match_def_path(cx, def_id, &paths::REGEX_BUILDER_NEW) {
|
2016-05-25 10:15:19 -05:00
|
|
|
check_regex(cx, &args[0], true);
|
2016-06-06 11:55:22 -05:00
|
|
|
} else if match_def_path(cx, def_id, &paths::REGEX_BYTES_NEW) ||
|
|
|
|
match_def_path(cx, def_id, &paths::REGEX_BYTES_BUILDER_NEW) {
|
2016-05-25 14:36:51 -05:00
|
|
|
check_regex(cx, &args[0], false);
|
2016-05-25 10:15:19 -05:00
|
|
|
} else if match_def_path(cx, def_id, &paths::REGEX_SET_NEW) {
|
|
|
|
check_set(cx, &args[0], true);
|
|
|
|
} else if match_def_path(cx, def_id, &paths::REGEX_BYTES_SET_NEW) {
|
|
|
|
check_set(cx, &args[0], false);
|
2016-02-05 09:48:35 -06:00
|
|
|
}
|
2016-02-04 17:36:06 -06:00
|
|
|
}}
|
|
|
|
}
|
|
|
|
}
|
2016-02-05 09:48:35 -06:00
|
|
|
|
|
|
|
#[allow(cast_possible_truncation)]
|
|
|
|
fn str_span(base: Span, s: &str, c: usize) -> Span {
|
2016-05-07 17:56:23 -05:00
|
|
|
let mut si = s.char_indices().skip(c);
|
|
|
|
|
2016-06-05 18:42:39 -05:00
|
|
|
match (si.next(), si.next()) {
|
2016-05-07 17:56:23 -05:00
|
|
|
(Some((l, _)), Some((h, _))) => {
|
|
|
|
Span {
|
|
|
|
lo: base.lo + BytePos(l as u32),
|
|
|
|
hi: base.lo + BytePos(h as u32),
|
|
|
|
..base
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => base,
|
2016-02-29 05:19:32 -06:00
|
|
|
}
|
2016-02-05 09:48:35 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
fn const_str(cx: &LateContext, e: &Expr) -> Option<InternedString> {
|
|
|
|
match eval_const_expr_partial(cx.tcx, e, ExprTypeChecked, None) {
|
|
|
|
Ok(ConstVal::Str(r)) => Some(r),
|
2016-02-24 10:38:57 -06:00
|
|
|
_ => None,
|
2016-02-05 09:48:35 -06:00
|
|
|
}
|
|
|
|
}
|
2016-02-05 16:10:48 -06:00
|
|
|
|
2016-02-06 11:06:39 -06:00
|
|
|
fn is_trivial_regex(s: ®ex_syntax::Expr) -> Option<&'static str> {
|
|
|
|
use regex_syntax::Expr;
|
2016-02-05 16:10:48 -06:00
|
|
|
|
2016-02-06 11:06:39 -06:00
|
|
|
match *s {
|
|
|
|
Expr::Empty | Expr::StartText | Expr::EndText => Some("the regex is unlikely to be useful as it is"),
|
2016-04-14 13:14:03 -05:00
|
|
|
Expr::Literal { .. } => Some("consider using `str::contains`"),
|
2016-02-06 11:06:39 -06:00
|
|
|
Expr::Concat(ref exprs) => {
|
|
|
|
match exprs.len() {
|
2016-02-24 10:38:57 -06:00
|
|
|
2 => {
|
|
|
|
match (&exprs[0], &exprs[1]) {
|
|
|
|
(&Expr::StartText, &Expr::EndText) => Some("consider using `str::is_empty`"),
|
2016-04-14 13:14:03 -05:00
|
|
|
(&Expr::StartText, &Expr::Literal { .. }) => Some("consider using `str::starts_with`"),
|
|
|
|
(&Expr::Literal { .. }, &Expr::EndText) => Some("consider using `str::ends_with`"),
|
2016-02-24 10:38:57 -06:00
|
|
|
_ => None,
|
|
|
|
}
|
|
|
|
}
|
2016-02-06 11:06:39 -06:00
|
|
|
3 => {
|
|
|
|
if let (&Expr::StartText, &Expr::Literal {..}, &Expr::EndText) = (&exprs[0], &exprs[1], &exprs[2]) {
|
|
|
|
Some("consider using `==` on `str`s")
|
2016-02-24 10:38:57 -06:00
|
|
|
} else {
|
2016-02-06 11:06:39 -06:00
|
|
|
None
|
|
|
|
}
|
2016-02-24 10:38:57 -06:00
|
|
|
}
|
2016-02-06 11:06:39 -06:00
|
|
|
_ => None,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
_ => None,
|
2016-02-05 16:10:48 -06:00
|
|
|
}
|
|
|
|
}
|
2016-05-25 10:15:19 -05:00
|
|
|
|
|
|
|
fn check_set(cx: &LateContext, expr: &Expr, utf8: bool) {
|
|
|
|
if_let_chain! {[
|
|
|
|
let ExprAddrOf(_, ref expr) = expr.node,
|
2016-09-30 08:35:24 -05:00
|
|
|
let ExprArray(ref exprs) = expr.node,
|
2016-05-25 10:15:19 -05:00
|
|
|
], {
|
|
|
|
for expr in exprs {
|
|
|
|
check_regex(cx, expr, utf8);
|
|
|
|
}
|
|
|
|
}}
|
|
|
|
}
|
|
|
|
|
|
|
|
fn check_regex(cx: &LateContext, expr: &Expr, utf8: bool) {
|
|
|
|
let builder = regex_syntax::ExprBuilder::new().unicode(utf8);
|
|
|
|
|
|
|
|
if let ExprLit(ref lit) = expr.node {
|
|
|
|
if let LitKind::Str(ref r, _) = lit.node {
|
2016-11-23 14:19:03 -06:00
|
|
|
let r = &*r.as_str();
|
2016-05-25 10:15:19 -05:00
|
|
|
match builder.parse(r) {
|
|
|
|
Ok(r) => {
|
|
|
|
if let Some(repl) = is_trivial_regex(&r) {
|
2016-06-05 18:42:39 -05:00
|
|
|
span_help_and_lint(cx,
|
|
|
|
TRIVIAL_REGEX,
|
|
|
|
expr.span,
|
2016-05-25 10:15:19 -05:00
|
|
|
"trivial regex",
|
|
|
|
&format!("consider using {}", repl));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Err(e) => {
|
|
|
|
span_lint(cx,
|
|
|
|
INVALID_REGEX,
|
|
|
|
str_span(expr.span, r, e.position()),
|
|
|
|
&format!("regex syntax error: {}",
|
|
|
|
e.description()));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
} else if let Some(r) = const_str(cx, expr) {
|
|
|
|
match builder.parse(&r) {
|
|
|
|
Ok(r) => {
|
|
|
|
if let Some(repl) = is_trivial_regex(&r) {
|
2016-06-05 18:42:39 -05:00
|
|
|
span_help_and_lint(cx,
|
|
|
|
TRIVIAL_REGEX,
|
|
|
|
expr.span,
|
2016-05-25 10:15:19 -05:00
|
|
|
"trivial regex",
|
|
|
|
&format!("consider using {}", repl));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
Err(e) => {
|
|
|
|
span_lint(cx,
|
|
|
|
INVALID_REGEX,
|
|
|
|
expr.span,
|
|
|
|
&format!("regex syntax error on position {}: {}",
|
|
|
|
e.position(),
|
|
|
|
e.description()));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|