src/librustc/util/common.rs

   1 // Copyright 2012-2014 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 #![allow(non_camel_case_types)]
  12
  13 use std::cell::{RefCell, Cell};
  14 use std::collections::HashMap;
  15 use std::fmt::Show;
  16 use std::hash::{Hash, Hasher};
  17 use std::time::Duration;
  18
  19 use syntax::ast;
  20 use syntax::visit;
  21 use syntax::visit::Visitor;
  22
  23 // Useful type to use with `Result<>` indicate that an error has already
  24 // been reported to the user, so no need to continue checking.
  25 #[deriving(Clone,Show)]
  26 pub struct ErrorReported;
  27
  28 pub fn time<T, U>(do_it: bool, what: &str, u: U, f: |U| -> T) -> T {
  29     thread_local!(static DEPTH: Cell<uint> = Cell::new(0));
  30     if !do_it { return f(u); }
  31
  32     let old = DEPTH.with(|slot| {
  33         let r = slot.get();
  34         slot.set(r + 1);
  35         r
  36     });
  37
  38     let mut u = Some(u);
  39     let mut rv = None;
  40     let dur = Duration::span(|| {
  41         rv = Some(f(u.take().unwrap()))
  42     });
  43     let rv = rv.unwrap();
  44
  45     println!("{}time: {}.{:03} \t{}", "  ".repeat(old),
  46              dur.num_seconds(), dur.num_milliseconds() % 1000, what);
  47     DEPTH.with(|slot| slot.set(old));
  48
  49     rv
  50 }
  51
  52 pub fn indent<R: Show>(op: || -> R) -> R {
  53     // Use in conjunction with the log post-processor like `src/etc/indenter`
  54     // to make debug output more readable.
  55     debug!(">>");
  56     let r = op();
  57     debug!("<< (Result = {})", r);
  58     r
  59 }
  60
  61 pub struct Indenter {
  62     _cannot_construct_outside_of_this_module: ()
  63 }
  64
  65 impl Drop for Indenter {
  66     fn drop(&mut self) { debug!("<<"); }
  67 }
  68
  69 pub fn indenter() -> Indenter {
  70     debug!(">>");
  71     Indenter { _cannot_construct_outside_of_this_module: () }
  72 }
  73
  74 struct LoopQueryVisitor<'a> {
  75     p: |&ast::Expr_|: 'a -> bool,
  76     flag: bool,
  77 }
  78
  79 impl<'a, 'v> Visitor<'v> for LoopQueryVisitor<'a> {
  80     fn visit_expr(&mut self, e: &ast::Expr) {
  81         self.flag |= (self.p)(&e.node);
  82         match e.node {
  83           // Skip inner loops, since a break in the inner loop isn't a
  84           // break inside the outer loop
  85           ast::ExprLoop(..) | ast::ExprWhile(..) | ast::ExprForLoop(..) => {}
  86           _ => visit::walk_expr(self, e)
  87         }
  88     }
  89 }
  90
  91 // Takes a predicate p, returns true iff p is true for any subexpressions
  92 // of b -- skipping any inner loops (loop, while, loop_body)
  93 pub fn loop_query(b: &ast::Block, p: |&ast::Expr_| -> bool) -> bool {
  94     let mut v = LoopQueryVisitor {
  95         p: p,
  96         flag: false,
  97     };
  98     visit::walk_block(&mut v, b);
  99     return v.flag;
 100 }
 101
 102 struct BlockQueryVisitor<'a> {
 103     p: |&ast::Expr|: 'a -> bool,
 104     flag: bool,
 105 }
 106
 107 impl<'a, 'v> Visitor<'v> for BlockQueryVisitor<'a> {
 108     fn visit_expr(&mut self, e: &ast::Expr) {
 109         self.flag |= (self.p)(e);
 110         visit::walk_expr(self, e)
 111     }
 112 }
 113
 114 // Takes a predicate p, returns true iff p is true for any subexpressions
 115 // of b -- skipping any inner loops (loop, while, loop_body)
 116 pub fn block_query(b: &ast::Block, p: |&ast::Expr| -> bool) -> bool {
 117     let mut v = BlockQueryVisitor {
 118         p: p,
 119         flag: false,
 120     };
 121     visit::walk_block(&mut v, &*b);
 122     return v.flag;
 123 }
 124
 125 /// K: Eq + Hash<S>, V, S, H: Hasher<S>
 126 ///
 127 /// Determines whether there exists a path from `source` to `destination`.  The graph is defined by
 128 /// the `edges_map`, which maps from a node `S` to a list of its adjacent nodes `T`.
 129 ///
 130 /// Efficiency note: This is implemented in an inefficient way because it is typically invoked on
 131 /// very small graphs. If the graphs become larger, a more efficient graph representation and
 132 /// algorithm would probably be advised.
 133 pub fn can_reach<S,H:Hasher<S>,T:Eq+Clone+Hash<S>>(
 134     edges_map: &HashMap<T,Vec<T>,H>,
 135     source: T,
 136     destination: T)
 137     -> bool
 138 {
 139     if source == destination {
 140         return true;
 141     }
 142
 143     // Do a little breadth-first-search here.  The `queue` list
 144     // doubles as a way to detect if we've seen a particular FR
 145     // before.  Note that we expect this graph to be an *extremely
 146     // shallow* tree.
 147     let mut queue = vec!(source);
 148     let mut i = 0;
 149     while i < queue.len() {
 150         match edges_map.get(&queue[i]) {
 151             Some(edges) => {
 152                 for target in edges.iter() {
 153                     if *target == destination {
 154                         return true;
 155                     }
 156
 157                     if !queue.iter().any(|x| x == target) {
 158                         queue.push((*target).clone());
 159                     }
 160                 }
 161             }
 162             None => {}
 163         }
 164         i += 1;
 165     }
 166     return false;
 167 }
 168
 169 /// Memoizes a one-argument closure using the given RefCell containing
 170 /// a type implementing MutableMap to serve as a cache.
 171 ///
 172 /// In the future the signature of this function is expected to be:
 173 /// ```
 174 /// pub fn memoized<T: Clone, U: Clone, M: MutableMap<T, U>>(
 175 ///    cache: &RefCell<M>,
 176 ///    f: &|&: T| -> U
 177 /// ) -> impl |&: T| -> U {
 178 /// ```
 179 /// but currently it is not possible.
 180 ///
 181 /// # Example
 182 /// ```
 183 /// struct Context {
 184 ///    cache: RefCell<HashMap<uint, uint>>
 185 /// }
 186 ///
 187 /// fn factorial(ctxt: &Context, n: uint) -> uint {
 188 ///     memoized(&ctxt.cache, n, |n| match n {
 189 ///         0 | 1 => n,
 190 ///         _ => factorial(ctxt, n - 2) + factorial(ctxt, n - 1)
 191 ///     })
 192 /// }
 193 /// ```
 194 #[inline(always)]
 195 pub fn memoized<T: Clone + Hash<S> + Eq, U: Clone, S, H: Hasher<S>>(
 196     cache: &RefCell<HashMap<T, U, H>>,
 197     arg: T,
 198     f: |T| -> U
 199 ) -> U {
 200     let key = arg.clone();
 201     let result = cache.borrow().get(&key).map(|result| result.clone());
 202     match result {
 203         Some(result) => result,
 204         None => {
 205             let result = f(arg);
 206             cache.borrow_mut().insert(key, result.clone());
 207             result
 208         }
 209     }
 210 }