2011-07-18 21:14:01 -05:00
|
|
|
// A pass that annotates for each loops and functions with the free
|
|
|
|
// variables that they contain.
|
2011-07-18 19:26:37 -05:00
|
|
|
|
2012-01-05 13:33:22 -06:00
|
|
|
import syntax::print::pprust::path_to_str;
|
2011-07-18 19:26:37 -05:00
|
|
|
import std::map::*;
|
2011-12-13 18:25:51 -06:00
|
|
|
import option::*;
|
2011-09-12 18:13:28 -05:00
|
|
|
import syntax::{ast, ast_util, visit};
|
2012-03-15 09:15:49 -05:00
|
|
|
import syntax::ast::{serialize_span, deserialize_span};
|
2011-07-18 19:26:37 -05:00
|
|
|
import syntax::codemap::span;
|
|
|
|
|
2011-07-18 21:14:01 -05:00
|
|
|
export annotate_freevars;
|
|
|
|
export freevar_map;
|
2011-12-16 18:07:54 -06:00
|
|
|
export freevar_info;
|
2012-03-15 09:15:49 -05:00
|
|
|
export freevar_entry, serialize_freevar_entry, deserialize_freevar_entry;
|
2011-07-21 16:49:58 -05:00
|
|
|
export get_freevars;
|
|
|
|
export has_freevars;
|
2011-07-18 19:26:37 -05:00
|
|
|
|
2011-09-01 07:35:00 -05:00
|
|
|
// A vector of defs representing the free variables referred to in a function.
|
|
|
|
// (The def_upvar will already have been stripped).
|
2012-03-15 09:15:49 -05:00
|
|
|
#[auto_serialize]
|
2011-12-16 18:07:54 -06:00
|
|
|
type freevar_entry = {
|
|
|
|
def: ast::def, //< The variable being accessed free.
|
|
|
|
span: span //< First span where it is accessed (there can be multiple)
|
|
|
|
};
|
2012-06-29 18:26:56 -05:00
|
|
|
type freevar_info = @~[@freevar_entry];
|
2011-08-12 09:15:18 -05:00
|
|
|
type freevar_map = hashmap<ast::node_id, freevar_info>;
|
2011-07-18 19:26:37 -05:00
|
|
|
|
|
|
|
// Searches through part of the AST for all references to locals or
|
|
|
|
// upvars in this frame and returns the list of definition IDs thus found.
|
|
|
|
// Since we want to be able to collect upvars in some arbitrary piece
|
|
|
|
// of the AST, we take a walker function that we invoke with a visitor
|
|
|
|
// in order to start the search.
|
2012-07-17 17:23:59 -05:00
|
|
|
fn collect_freevars(def_map: resolve3::DefMap, blk: ast::blk)
|
2011-12-20 13:03:21 -06:00
|
|
|
-> freevar_info {
|
2012-03-14 14:07:23 -05:00
|
|
|
let seen = int_hash();
|
2012-06-29 18:26:56 -05:00
|
|
|
let refs = @mut ~[];
|
2011-07-18 19:26:37 -05:00
|
|
|
|
2011-10-06 05:26:12 -05:00
|
|
|
fn ignore_item(_i: @ast::item, &&_depth: int, _v: visit::vt<int>) { }
|
2011-09-01 07:35:00 -05:00
|
|
|
|
2012-01-10 11:51:15 -06:00
|
|
|
let walk_expr = fn@(expr: @ast::expr, &&depth: int, v: visit::vt<int>) {
|
2012-08-06 14:34:08 -05:00
|
|
|
match expr.node {
|
2012-08-03 21:59:04 -05:00
|
|
|
ast::expr_fn(proto, decl, _, _) => {
|
2011-12-29 22:07:55 -06:00
|
|
|
if proto != ast::proto_bare {
|
2011-09-02 17:34:58 -05:00
|
|
|
visit::visit_expr(expr, depth + 1, v);
|
2011-08-19 17:16:48 -05:00
|
|
|
}
|
2011-09-02 17:34:58 -05:00
|
|
|
}
|
2012-08-03 21:59:04 -05:00
|
|
|
ast::expr_fn_block(_, _, _) => {
|
2011-12-20 13:03:21 -06:00
|
|
|
visit::visit_expr(expr, depth + 1, v);
|
|
|
|
}
|
2012-08-03 21:59:04 -05:00
|
|
|
ast::expr_path(path) => {
|
2012-03-15 08:47:03 -05:00
|
|
|
let mut i = 0;
|
2012-08-06 14:34:08 -05:00
|
|
|
match def_map.find(expr.id) {
|
2012-08-03 21:59:04 -05:00
|
|
|
none => fail (~"Not found: " + path_to_str(path)),
|
|
|
|
some(df) => {
|
2012-03-15 08:47:03 -05:00
|
|
|
let mut def = df;
|
2012-01-05 13:33:22 -06:00
|
|
|
while i < depth {
|
2012-08-06 14:34:08 -05:00
|
|
|
match copy def {
|
2012-08-03 21:59:04 -05:00
|
|
|
ast::def_upvar(_, inner, _) => { def = *inner; }
|
|
|
|
_ => break
|
2012-01-05 13:33:22 -06:00
|
|
|
}
|
|
|
|
i += 1;
|
|
|
|
}
|
|
|
|
if i == depth { // Made it to end of loop
|
|
|
|
let dnum = ast_util::def_id_of_def(def).node;
|
|
|
|
if !seen.contains_key(dnum) {
|
2012-06-28 17:00:03 -05:00
|
|
|
vec::push(*refs, @{def:def, span:expr.span});
|
|
|
|
seen.insert(dnum, ());
|
2012-01-05 13:33:22 -06:00
|
|
|
}
|
|
|
|
}
|
2011-09-02 17:34:58 -05:00
|
|
|
}
|
2012-01-05 13:33:22 -06:00
|
|
|
}
|
2011-09-02 17:34:58 -05:00
|
|
|
}
|
2012-08-03 21:59:04 -05:00
|
|
|
_ => visit::visit_expr(expr, depth, v)
|
2011-07-27 07:19:39 -05:00
|
|
|
}
|
2011-09-02 17:34:58 -05:00
|
|
|
};
|
2011-09-01 07:35:00 -05:00
|
|
|
|
2011-12-20 13:03:21 -06:00
|
|
|
let v = visit::mk_vt(@{visit_item: ignore_item, visit_expr: walk_expr
|
|
|
|
with *visit::default_visitor()});
|
|
|
|
v.visit_block(blk, 1, v);
|
2012-08-01 19:30:05 -05:00
|
|
|
return @*refs;
|
2011-07-18 19:26:37 -05:00
|
|
|
}
|
|
|
|
|
2011-07-18 21:14:01 -05:00
|
|
|
// Build a map from every function and for-each body to a set of the
|
|
|
|
// freevars contained in it. The implementation is not particularly
|
|
|
|
// efficient as it fully recomputes the free variables at every
|
|
|
|
// node of interest rather than building up the free variables in
|
|
|
|
// one pass. This could be improved upon if it turns out to matter.
|
2012-07-17 17:23:59 -05:00
|
|
|
fn annotate_freevars(def_map: resolve3::DefMap, crate: @ast::crate) ->
|
2011-09-02 17:34:58 -05:00
|
|
|
freevar_map {
|
2012-03-14 14:07:23 -05:00
|
|
|
let freevars = int_hash();
|
2011-07-18 21:14:01 -05:00
|
|
|
|
2012-01-10 11:51:15 -06:00
|
|
|
let walk_fn = fn@(_fk: visit::fn_kind, _decl: ast::fn_decl,
|
|
|
|
blk: ast::blk, _sp: span, nid: ast::node_id) {
|
2011-12-20 13:03:21 -06:00
|
|
|
let vars = collect_freevars(def_map, blk);
|
|
|
|
freevars.insert(nid, vars);
|
|
|
|
};
|
2011-07-18 21:14:01 -05:00
|
|
|
|
2011-07-27 07:19:39 -05:00
|
|
|
let visitor =
|
2011-12-23 11:45:02 -06:00
|
|
|
visit::mk_simple_visitor(@{visit_fn: walk_fn
|
2011-12-20 13:03:21 -06:00
|
|
|
with *visit::default_simple_visitor()});
|
2011-07-26 09:47:13 -05:00
|
|
|
visit::visit_crate(*crate, (), visitor);
|
2011-07-18 21:14:01 -05:00
|
|
|
|
2012-08-01 19:30:05 -05:00
|
|
|
return freevars;
|
2011-07-18 21:14:01 -05:00
|
|
|
}
|
|
|
|
|
2011-09-12 04:27:30 -05:00
|
|
|
fn get_freevars(tcx: ty::ctxt, fid: ast::node_id) -> freevar_info {
|
2012-08-06 14:34:08 -05:00
|
|
|
match tcx.freevars.find(fid) {
|
2012-08-03 21:59:04 -05:00
|
|
|
none => fail ~"get_freevars: " + int::str(fid) + ~" has no freevars",
|
|
|
|
some(d) => return d
|
2011-07-21 16:49:58 -05:00
|
|
|
}
|
|
|
|
}
|
2011-09-12 04:27:30 -05:00
|
|
|
fn has_freevars(tcx: ty::ctxt, fid: ast::node_id) -> bool {
|
2012-08-01 19:30:05 -05:00
|
|
|
return vec::len(*get_freevars(tcx, fid)) != 0u;
|
2011-07-21 16:49:58 -05:00
|
|
|
}
|
|
|
|
|
2011-07-18 19:26:37 -05:00
|
|
|
// Local Variables:
|
|
|
|
// mode: rust
|
|
|
|
// fill-column: 78;
|
|
|
|
// indent-tabs-mode: nil
|
|
|
|
// c-basic-offset: 4
|
|
|
|
// buffer-file-coding-system: utf-8-unix
|
|
|
|
// End:
|