rust/src/librustdoc/sort_pass.rs

// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! A general sorting pass

use astsrv;
use doc;
use fold::Fold;
use fold;
use pass::Pass;
use util::NominalOp;

#[cfg(test)] use extract;

use std::sort;

pub type ItemLtEqOp = @pure fn(v1: &doc::ItemTag, v2:  &doc::ItemTag) -> bool;

type ItemLtEq = NominalOp<ItemLtEqOp>;

pub fn mk_pass(name: ~str, lteq: ItemLtEqOp) -> Pass {
    Pass {
        name: copy name,
        f: |srv, doc| run(srv, doc, NominalOp { op: lteq })
    }
}

#[allow(non_implicitly_copyable_typarams)]
fn run(
    _srv: astsrv::Srv,
    doc: doc::Doc,
    lteq: ItemLtEq
) -> doc::Doc {
    let fold = Fold {
        fold_mod: fold_mod,
        .. fold::default_any_fold(lteq)
    };
    (fold.fold_doc)(&fold, doc)
}

#[allow(non_implicitly_copyable_typarams)]
fn fold_mod(
    fold: &fold::Fold<ItemLtEq>,
    doc: doc::ModDoc
) -> doc::ModDoc {
    let doc = fold::default_any_fold_mod(fold, doc);
    doc::ModDoc {
        items: sort::merge_sort(doc.items, fold.ctxt.op),
        .. doc
    }
}

#[test]
fn test() {
    pure fn name_lteq(item1: &doc::ItemTag, item2: &doc::ItemTag) -> bool {
        (*item1).name() <= (*item2).name()
    }

    let source = ~"mod z { mod y { } fn x() { } } mod w { }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv.clone(), ~"");
        let doc = (mk_pass(~"", name_lteq).f)(srv.clone(), doc);
        fail_unless!(doc.cratemod().mods()[0].name() == ~"w");
        fail_unless!(doc.cratemod().mods()[1].items[0].name() == ~"x");
        fail_unless!(doc.cratemod().mods()[1].items[1].name() == ~"y");
        fail_unless!(doc.cratemod().mods()[1].name() == ~"z");
    }
}

#[test]
fn should_be_stable() {
    pure fn always_eq(_item1: &doc::ItemTag, _item2: &doc::ItemTag) -> bool {
        true
    }

    let source = ~"mod a { mod b { } } mod c { mod d { } }";
    do astsrv::from_str(source) |srv| {
        let doc = extract::from_srv(srv.clone(), ~"");
        let doc = (mk_pass(~"", always_eq).f)(srv.clone(), doc);
        fail_unless!(doc.cratemod().mods()[0].items[0].name() == ~"b");
        fail_unless!(doc.cratemod().mods()[1].items[0].name() == ~"d");
        let doc = (mk_pass(~"", always_eq).f)(srv.clone(), doc);
        fail_unless!(doc.cratemod().mods()[0].items[0].name() == ~"b");
        fail_unless!(doc.cratemod().mods()[1].items[0].name() == ~"d");
    }
}