rust/src/rustdoc/prune_unexported_pass.rs

//! Prunes branches of the tree that are not exported

import syntax::ast;
import syntax::ast_util;
import syntax::ast_map;
import std::map::hashmap;

export mk_pass;

fn mk_pass() -> pass {
    {
        name: "prune_unexported",
        f: run
    }
}

fn run(srv: astsrv::srv, doc: doc::doc) -> doc::doc {
    let fold = fold::fold({
        fold_mod: fold_mod
        with *fold::default_any_fold(srv)
    });
    fold.fold_doc(fold, doc)
}

fn fold_mod(fold: fold::fold<astsrv::srv>, doc: doc::moddoc) -> doc::moddoc {
    let doc = fold::default_any_fold_mod(fold, doc);
    {
        items: exported_items(fold.ctxt, doc)
        with doc
    }
}

fn exported_items(srv: astsrv::srv, doc: doc::moddoc) -> ~[doc::itemtag] {
    exported_things(
        srv, doc,
        exported_items_from_crate,
        exported_items_from_mod
    )
}

fn exported_things<T>(
    srv: astsrv::srv,
    doc: doc::moddoc,
    from_crate: fn(astsrv::srv, doc::moddoc) -> ~[T],
    from_mod: fn(astsrv::srv, doc::moddoc) -> ~[T]
) -> ~[T] {
    if doc.id() == ast::crate_node_id {
        from_crate(srv, doc)
    } else {
        from_mod(srv, doc)
    }
}

fn exported_items_from_crate(
    srv: astsrv::srv,
    doc: doc::moddoc
) -> ~[doc::itemtag] {
    exported_items_from(srv, doc, is_exported_from_crate)
}

fn exported_items_from_mod(
    srv: astsrv::srv,
    doc: doc::moddoc
) -> ~[doc::itemtag] {
    exported_items_from(srv, doc, |a,b| {
        is_exported_from_mod(a, doc.id(), b)
    })
}

fn exported_items_from(
    srv: astsrv::srv,
    doc: doc::moddoc,
    is_exported: fn(astsrv::srv, str) -> bool
) -> ~[doc::itemtag] {
    do vec::filter_map(doc.items) |itemtag| {
        let itemtag = alt itemtag {
          doc::enumtag(enumdoc) {
            // Also need to check variant exportedness
            doc::enumtag({
                variants: exported_variants_from(srv, enumdoc, is_exported)
                with enumdoc
            })
          }
          _ { itemtag }
        };

        if itemtag.item().reexport || is_exported(srv, itemtag.name()) {
            some(itemtag)
        } else {
            none
        }
    }
}

fn exported_variants_from(
    srv: astsrv::srv,
    doc: doc::enumdoc,
    is_exported: fn(astsrv::srv, str) -> bool
) -> ~[doc::variantdoc] {
    do vec::filter_map(doc.variants) |doc| {
        if is_exported(srv, doc.name) {
            some(doc)
        } else {
            none
        }
    }
}

fn is_exported_from_mod(
    srv: astsrv::srv,
    mod_id: doc::ast_id,
    item_name: str
) -> bool {
    do astsrv::exec(srv) |ctxt| {
        alt ctxt.ast_map.get(mod_id) {
          ast_map::node_item(item, _) {
            alt item.node {
              ast::item_mod(m) {
                ast_util::is_exported(@item_name, m)
              }
              _ {
                fail "is_exported_from_mod: not a mod";
              }
            }
          }
          _ { fail "is_exported_from_mod: not an item"; }
        }
    }
}

fn is_exported_from_crate(
    srv: astsrv::srv,
    item_name: str
) -> bool {
    do astsrv::exec(srv) |ctxt| {
        ast_util::is_exported(@item_name, ctxt.ast.node.module)
    }
}

#[test]
fn should_prune_unexported_fns() {
    let doc = test::mk_doc("mod b { export a; fn a() { } fn b() { } }");
    assert vec::len(doc.cratemod().mods()[0].fns()) == 1u;
}

#[test]
fn should_prune_unexported_fns_from_top_mod() {
    let doc = test::mk_doc("export a; fn a() { } fn b() { }");
    assert vec::len(doc.cratemod().fns()) == 1u;
}

#[test]
fn should_prune_unexported_modules() {
    let doc = test::mk_doc("mod a { export a; mod a { } mod b { } }");
    assert vec::len(doc.cratemod().mods()[0].mods()) == 1u;
}

#[test]
fn should_prune_unexported_modules_from_top_mod() {
    let doc = test::mk_doc("export a; mod a { } mod b { }");
    assert vec::len(doc.cratemod().mods()) == 1u;
}

#[test]
fn should_prune_unexported_consts() {
    let doc = test::mk_doc(
        "mod a { export a; \
         const a: bool = true; \
         const b: bool = true; }");
    assert vec::len(doc.cratemod().mods()[0].consts()) == 1u;
}

#[test]
fn should_prune_unexported_consts_from_top_mod() {
    let doc = test::mk_doc(
        "export a; const a: bool = true; const b: bool = true;");
    assert vec::len(doc.cratemod().consts()) == 1u;
}

#[test]
fn should_prune_unexported_enums_from_top_mod() {
    let doc = test::mk_doc("export a; mod a { } enum b { c }");
    assert vec::len(doc.cratemod().enums()) == 0u;
}

#[test]
fn should_prune_unexported_enums() {
    let doc = test::mk_doc("mod a { export a; mod a { } enum b { c } }");
    assert vec::len(doc.cratemod().mods()[0].enums()) == 0u;
}

#[test]
fn should_prune_unexported_variants_from_top_mod() {
    let doc = test::mk_doc("export b::{}; enum b { c }");
    assert vec::len(doc.cratemod().enums()[0].variants) == 0u;
}

#[test]
fn should_prune_unexported_variants() {
    let doc = test::mk_doc("mod a { export b::{}; enum b { c } }");
    assert vec::len(doc.cratemod().mods()[0].enums()[0].variants) == 0u;
}

#[test]
fn should_prune_unexported_traits_from_top_mod() {
    let doc = test::mk_doc("export a; mod a { } iface b { fn c(); }");
    assert vec::is_empty(doc.cratemod().traits());
}

#[test]
fn should_prune_unexported_impls_from_top_mod() {
    let doc = test::mk_doc(
        "export a; mod a { } impl b for int { fn c() { } }");
    assert vec::is_empty(doc.cratemod().impls())
}

#[test]
fn should_prune_unexported_types() {
    let doc = test::mk_doc("export a; mod a { } type b = int;");
    assert vec::is_empty(doc.cratemod().types());
}

#[test]
fn should_not_prune_reexports() {
    fn mk_doc(source: str) -> doc::doc {
        do astsrv::from_str(source) |srv| {
            let doc = extract::from_srv(srv, "");
            let doc = reexport_pass::mk_pass().f(srv, doc);
            run(srv, doc)
        }
    }
    let doc = mk_doc("import a::b; \
                      export b; \
                      mod a { fn b() { } }");
    assert vec::is_not_empty(doc.cratemod().fns());
}

#[cfg(test)]
mod test {
    fn mk_doc(source: str) -> doc::doc {
        do astsrv::from_str(source) |srv| {
            let doc = extract::from_srv(srv, "");
            run(srv, doc)
        }
    }
}