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