src/utils.rs

   1 // Copyright 2015 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.
   4 //
   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.
  10
  11 use std::cmp::Ordering;
  12
  13 use syntax::ast::{self, Visibility, Attribute, MetaItem, MetaItemKind};
  14 use syntax::codemap::{CodeMap, Span, BytePos};
  15 use syntax::abi;
  16
  17 use Indent;
  18 use comment::FindUncommented;
  19 use rewrite::{Rewrite, RewriteContext};
  20
  21 use SKIP_ANNOTATION;
  22
  23 pub trait CodeMapSpanUtils {
  24     fn span_after(&self, original: Span, needle: &str) -> BytePos;
  25     fn span_after_last(&self, original: Span, needle: &str) -> BytePos;
  26     fn span_before(&self, original: Span, needle: &str) -> BytePos;
  27 }
  28
  29 impl CodeMapSpanUtils for CodeMap {
  30     #[inline]
  31     fn span_after(&self, original: Span, needle: &str) -> BytePos {
  32         let snippet = self.span_to_snippet(original).unwrap();
  33         let offset = snippet.find_uncommented(needle).unwrap() + needle.len();
  34
  35         original.lo + BytePos(offset as u32)
  36     }
  37
  38     #[inline]
  39     fn span_after_last(&self, original: Span, needle: &str) -> BytePos {
  40         let snippet = self.span_to_snippet(original).unwrap();
  41         let mut offset = 0;
  42
  43         while let Some(additional_offset) = snippet[offset..].find_uncommented(needle) {
  44             offset += additional_offset + needle.len();
  45         }
  46
  47         original.lo + BytePos(offset as u32)
  48     }
  49
  50     #[inline]
  51     fn span_before(&self, original: Span, needle: &str) -> BytePos {
  52         let snippet = self.span_to_snippet(original).unwrap();
  53         let offset = snippet.find_uncommented(needle).unwrap();
  54
  55         original.lo + BytePos(offset as u32)
  56     }
  57 }
  58
  59 // Computes the length of a string's last line, minus offset.
  60 #[inline]
  61 pub fn extra_offset(text: &str, offset: Indent) -> usize {
  62     match text.rfind('\n') {
  63         // 1 for newline character
  64         Some(idx) => text.len() - idx - 1 - offset.width(),
  65         None => text.len(),
  66     }
  67 }
  68
  69 #[inline]
  70 pub fn format_visibility(vis: Visibility) -> &'static str {
  71     match vis {
  72         Visibility::Public => "pub ",
  73         Visibility::Inherited => "",
  74     }
  75 }
  76
  77 #[inline]
  78 pub fn format_unsafety(unsafety: ast::Unsafety) -> &'static str {
  79     match unsafety {
  80         ast::Unsafety::Unsafe => "unsafe ",
  81         ast::Unsafety::Normal => "",
  82     }
  83 }
  84
  85 #[inline]
  86 pub fn format_mutability(mutability: ast::Mutability) -> &'static str {
  87     match mutability {
  88         ast::Mutability::Mutable => "mut ",
  89         ast::Mutability::Immutable => "",
  90     }
  91 }
  92
  93 #[inline]
  94 // FIXME(#451): include "C"?
  95 pub fn format_abi(abi: abi::Abi) -> String {
  96     format!("extern {} ", abi)
  97 }
  98
  99 // The width of the first line in s.
 100 #[inline]
 101 pub fn first_line_width(s: &str) -> usize {
 102     match s.find('\n') {
 103         Some(n) => n,
 104         None => s.len(),
 105     }
 106 }
 107
 108 // The width of the last line in s.
 109 #[inline]
 110 pub fn last_line_width(s: &str) -> usize {
 111     match s.rfind('\n') {
 112         Some(n) => s.len() - n - 1,
 113         None => s.len(),
 114     }
 115 }
 116
 117 #[inline]
 118 fn is_skip(meta_item: &MetaItem) -> bool {
 119     match meta_item.node {
 120         MetaItemKind::Word(ref s) => *s == SKIP_ANNOTATION,
 121         MetaItemKind::List(ref s, ref l) => *s == "cfg_attr" && l.len() == 2 && is_skip(&l[1]),
 122         _ => false,
 123     }
 124 }
 125
 126 #[inline]
 127 pub fn contains_skip(attrs: &[Attribute]) -> bool {
 128     attrs.iter().any(|a| is_skip(&a.node.value))
 129 }
 130
 131 // Find the end of a TyParam
 132 #[inline]
 133 pub fn end_typaram(typaram: &ast::TyParam) -> BytePos {
 134     typaram.bounds
 135            .last()
 136            .map_or(typaram.span, |bound| {
 137                match *bound {
 138                    ast::RegionTyParamBound(ref lt) => lt.span,
 139                    ast::TraitTyParamBound(ref prt, _) => prt.span,
 140                }
 141            })
 142            .hi
 143 }
 144
 145 #[inline]
 146 pub fn semicolon_for_expr(expr: &ast::Expr) -> bool {
 147     match expr.node {
 148         ast::ExprKind::Ret(..) |
 149         ast::ExprKind::Again(..) |
 150         ast::ExprKind::Break(..) => true,
 151         _ => false,
 152     }
 153 }
 154
 155 #[inline]
 156 pub fn semicolon_for_stmt(stmt: &ast::Stmt) -> bool {
 157     match stmt.node {
 158         ast::StmtKind::Semi(ref expr, _) => {
 159             match expr.node {
 160                 ast::ExprKind::While(..) |
 161                 ast::ExprKind::WhileLet(..) |
 162                 ast::ExprKind::Loop(..) |
 163                 ast::ExprKind::ForLoop(..) => false,
 164                 _ => true,
 165             }
 166         }
 167         ast::StmtKind::Expr(..) => false,
 168         _ => true,
 169     }
 170 }
 171
 172 #[inline]
 173 pub fn trim_newlines(input: &str) -> &str {
 174     match input.find(|c| c != '\n' && c != '\r') {
 175         Some(start) => {
 176             let end = input.rfind(|c| c != '\n' && c != '\r').unwrap_or(0) + 1;
 177             &input[start..end]
 178         }
 179         None => "",
 180     }
 181 }
 182
 183 // Macro for deriving implementations of Decodable for enums
 184 #[macro_export]
 185 macro_rules! impl_enum_decodable {
 186     ( $e:ident, $( $x:ident ),* ) => {
 187         impl ::rustc_serialize::Decodable for $e {
 188             fn decode<D: ::rustc_serialize::Decoder>(d: &mut D) -> Result<Self, D::Error> {
 189                 use std::ascii::AsciiExt;
 190                 let s = try!(d.read_str());
 191                 $(
 192                     if stringify!($x).eq_ignore_ascii_case(&s) {
 193                       return Ok($e::$x);
 194                     }
 195                 )*
 196                 Err(d.error("Bad variant"))
 197             }
 198         }
 199
 200         impl ::std::str::FromStr for $e {
 201             type Err = &'static str;
 202
 203             fn from_str(s: &str) -> Result<Self, Self::Err> {
 204                 use std::ascii::AsciiExt;
 205                 $(
 206                     if stringify!($x).eq_ignore_ascii_case(s) {
 207                         return Ok($e::$x);
 208                     }
 209                 )*
 210                 Err("Bad variant")
 211             }
 212         }
 213
 214         impl ::config::ConfigType for $e {
 215             fn get_variant_names() -> String {
 216                 let mut variants = Vec::new();
 217                 $(
 218                     variants.push(stringify!($x));
 219                 )*
 220                 format!("[{}]", variants.join("|"))
 221             }
 222         }
 223     };
 224 }
 225
 226 // Same as try!, but for Option
 227 #[macro_export]
 228 macro_rules! try_opt {
 229     ($expr:expr) => (match $expr {
 230         Some(val) => val,
 231         None => { return None; }
 232     })
 233 }
 234
 235 // Wraps string-like values in an Option. Returns Some when the string adheres
 236 // to the Rewrite constraints defined for the Rewrite trait and else otherwise.
 237 pub fn wrap_str<S: AsRef<str>>(s: S, max_width: usize, width: usize, offset: Indent) -> Option<S> {
 238     {
 239         let snippet = s.as_ref();
 240
 241         if !snippet.contains('\n') && snippet.len() > width {
 242             return None;
 243         } else {
 244             let mut lines = snippet.lines();
 245
 246             // The caller of this function has already placed `offset`
 247             // characters on the first line.
 248             let first_line_max_len = try_opt!(max_width.checked_sub(offset.width()));
 249             if lines.next().unwrap().len() > first_line_max_len {
 250                 return None;
 251             }
 252
 253             // The other lines must fit within the maximum width.
 254             if lines.find(|line| line.len() > max_width).is_some() {
 255                 return None;
 256             }
 257
 258             // `width` is the maximum length of the last line, excluding
 259             // indentation.
 260             // A special check for the last line, since the caller may
 261             // place trailing characters on this line.
 262             if snippet.lines().rev().next().unwrap().len() > offset.width() + width {
 263                 return None;
 264             }
 265         }
 266     }
 267
 268     Some(s)
 269 }
 270
 271 impl Rewrite for String {
 272     fn rewrite(&self, context: &RewriteContext, width: usize, offset: Indent) -> Option<String> {
 273         wrap_str(self, context.config.max_width, width, offset).map(ToOwned::to_owned)
 274     }
 275 }
 276
 277 // Binary search in integer range. Returns the first Ok value returned by the
 278 // callback.
 279 // The callback takes an integer and returns either an Ok, or an Err indicating
 280 // whether the `guess' was too high (Ordering::Less), or too low.
 281 // This function is guaranteed to try to the hi value first.
 282 pub fn binary_search<C, T>(mut lo: usize, mut hi: usize, callback: C) -> Option<T>
 283     where C: Fn(usize) -> Result<T, Ordering>
 284 {
 285     let mut middle = hi;
 286
 287     while lo <= hi {
 288         match callback(middle) {
 289             Ok(val) => return Some(val),
 290             Err(Ordering::Less) => {
 291                 hi = middle - 1;
 292             }
 293             Err(..) => {
 294                 lo = middle + 1;
 295             }
 296         }
 297         middle = (hi + lo) / 2;
 298     }
 299
 300     None
 301 }
 302
 303 #[test]
 304 fn bin_search_test() {
 305     let closure = |i| {
 306         match i {
 307             4 => Ok(()),
 308             j if j > 4 => Err(Ordering::Less),
 309             j if j < 4 => Err(Ordering::Greater),
 310             _ => unreachable!(),
 311         }
 312     };
 313
 314     assert_eq!(Some(()), binary_search(1, 10, &closure));
 315     assert_eq!(None, binary_search(1, 3, &closure));
 316     assert_eq!(Some(()), binary_search(0, 44, &closure));
 317     assert_eq!(Some(()), binary_search(4, 125, &closure));
 318     assert_eq!(None, binary_search(6, 100, &closure));
 319 }