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