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