src/rustdoc/path_pass.rs

//! Records the full path to items

use doc::ItemUtils;
use syntax::ast;

export mk_pass;

fn mk_pass() -> Pass {
    {
        name: ~"path",
        f: run
    }
}

type Ctxt = {
    srv: astsrv::Srv,
    mut path: ~[~str]
};

#[allow(non_implicitly_copyable_typarams)]
fn run(srv: astsrv::Srv, doc: doc::Doc) -> doc::Doc {
    let ctxt = {
        srv: srv,
        mut path: ~[]
    };
    let fold = fold::Fold({
        fold_item: fold_item,
        fold_mod: fold_mod,
        fold_nmod: fold_nmod,
        .. *fold::default_any_fold(ctxt)
    });
    fold.fold_doc(fold, doc)
}

fn fold_item(fold: fold::Fold<Ctxt>, doc: doc::ItemDoc) -> doc::ItemDoc {
    {
        path: fold.ctxt.path,
        .. doc
    }
}

#[allow(non_implicitly_copyable_typarams)]
fn fold_mod(fold: fold::Fold<Ctxt>, doc: doc::ModDoc) -> doc::ModDoc {
    let is_topmod = doc.id() == ast::crate_node_id;

    if !is_topmod { fold.ctxt.path.push(doc.name()); }
    let doc = fold::default_any_fold_mod(fold, doc);
    if !is_topmod { fold.ctxt.path.pop(); }

    doc::ModDoc_({
        item: fold.fold_item(fold, doc.item),
        .. *doc
    })
}

fn fold_nmod(fold: fold::Fold<Ctxt>, doc: doc::NmodDoc) -> doc::NmodDoc {
    fold.ctxt.path.push(doc.name());
    let doc = fold::default_seq_fold_nmod(fold, doc);
    fold.ctxt.path.pop();

    {
        item: fold.fold_item(fold, doc.item),
        .. doc
    }
}

#[test]
fn should_record_mod_paths() {
    let source = ~"mod a { mod b { mod c { } } mod d { mod e { } } }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv, ~"");
        let doc = run(srv, doc);
        assert doc.cratemod().mods()[0].mods()[0].mods()[0].path()
            == ~[~"a", ~"b"];
        assert doc.cratemod().mods()[0].mods()[1].mods()[0].path()
            == ~[~"a", ~"d"];
    }
}

#[test]
fn should_record_fn_paths() {
    let source = ~"mod a { fn b() { } }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv, ~"");
        let doc = run(srv, doc);
        assert doc.cratemod().mods()[0].fns()[0].path() == ~[~"a"];
    }
}

#[test]
fn should_record_foreign_mod_paths() {
    let source = ~"mod a { extern mod b { } }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv, ~"");
        let doc = run(srv, doc);
        assert doc.cratemod().mods()[0].nmods()[0].path() == ~[~"a"];
    }
}

#[test]
fn should_record_foreign_fn_paths() {
    let source = ~"extern mod a { fn b(); }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv, ~"");
        let doc = run(srv, doc);
        assert doc.cratemod().nmods()[0].fns[0].path() == ~[~"a"];
    }
}