// 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 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Build indexes as appropriate for the markdown pass use core::prelude::*; use astsrv; use config; use doc::ItemUtils; use doc; use fold::Fold; use fold; use markdown_pass; use markdown_writer; use pass::Pass; use core::str; pub fn mk_pass(config: config::Config) -> Pass { Pass { name: ~"markdown_index", f: |srv, doc| run(srv, doc, copy config) } } pub fn run( _srv: astsrv::Srv, doc: doc::Doc, config: config::Config ) -> doc::Doc { let fold = Fold { fold_mod: fold_mod, fold_nmod: fold_nmod, .. fold::default_any_fold(config) }; (fold.fold_doc)(&fold, doc) } fn fold_mod( fold: &fold::Fold, doc: doc::ModDoc ) -> doc::ModDoc { let doc = fold::default_any_fold_mod(fold, doc); doc::ModDoc { index: Some(build_mod_index(copy doc, copy fold.ctxt)), .. doc } } fn fold_nmod( fold: &fold::Fold, doc: doc::NmodDoc ) -> doc::NmodDoc { let doc = fold::default_any_fold_nmod(fold, doc); doc::NmodDoc { index: Some(build_nmod_index(copy doc, copy fold.ctxt)), .. doc } } fn build_mod_index( doc: doc::ModDoc, config: config::Config ) -> doc::Index { doc::Index { entries: doc.items.map(|doc| { item_to_entry(copy *doc, copy config) }) } } fn build_nmod_index( doc: doc::NmodDoc, config: config::Config ) -> doc::Index { doc::Index { entries: doc.fns.map(|doc| { item_to_entry(doc::FnTag(copy *doc), copy config) }) } } fn item_to_entry( doc: doc::ItemTag, config: config::Config ) -> doc::IndexEntry { let link = match doc { doc::ModTag(_) | doc::NmodTag(_) if config.output_style == config::DocPerMod => { markdown_writer::make_filename(config, doc::ItemPage(copy doc)).to_str() } _ => { ~"#" + pandoc_header_id(markdown_pass::header_text(copy doc)) } }; doc::IndexEntry { kind: markdown_pass::header_kind(copy doc), name: markdown_pass::header_name(copy doc), brief: doc.brief(), link: link } } fn pandoc_header_id(header: &str) -> ~str { // http://johnmacfarlane.net/pandoc/README.html#headers let header = remove_formatting(header); let header = remove_punctuation(header); let header = replace_with_hyphens(header); let header = convert_to_lowercase(header); let header = remove_up_to_first_letter(header); let header = maybe_use_section_id(header); return header; fn remove_formatting(s: &str) -> ~str { str::replace(s, ~"`", ~"") } fn remove_punctuation(s: &str) -> ~str { let s = str::replace(s, ~"<", ~""); let s = str::replace(s, ~">", ~""); let s = str::replace(s, ~"[", ~""); let s = str::replace(s, ~"]", ~""); let s = str::replace(s, ~"(", ~""); let s = str::replace(s, ~")", ~""); let s = str::replace(s, ~"@~", ~""); let s = str::replace(s, ~"~", ~""); let s = str::replace(s, ~"/", ~""); let s = str::replace(s, ~":", ~""); let s = str::replace(s, ~"&", ~""); let s = str::replace(s, ~"^", ~""); return s; } fn replace_with_hyphens(s: &str) -> ~str { // Collapse sequences of whitespace to a single dash // XXX: Hacky implementation here that only covers // one or two spaces. let s = str::replace(s, ~" ", ~"-"); let s = str::replace(s, ~" ", ~"-"); return s; } fn convert_to_lowercase(s: &str) -> ~str { str::to_lower(s) } fn remove_up_to_first_letter(s: &str) -> ~str { s.to_str() } fn maybe_use_section_id(s: &str) -> ~str { s.to_str() } } #[test] fn should_remove_punctuation_from_headers() { fail_unless!(pandoc_header_id(~"impl foo of bar") == ~"impl-foo-of-bara"); fail_unless!(pandoc_header_id(~"impl of num::num for int") == ~"impl-of-numnum-for-int"); fail_unless!(pandoc_header_id(~"impl of num::num for int/&") == ~"impl-of-numnum-for-int"); fail_unless!(pandoc_header_id(~"impl of num::num for ^int") == ~"impl-of-numnum-for-int"); fail_unless!(pandoc_header_id(~"impl for & condvar") == ~"impl-for-condvar"); } #[test] fn should_index_mod_contents() { let doc = test::mk_doc( config::DocPerCrate, ~"mod a { } fn b() { }" ); fail_unless!((&doc.cratemod().index).get().entries[0] == doc::IndexEntry { kind: ~"Module", name: ~"a", brief: None, link: ~"#module-a" }); fail_unless!((&doc.cratemod().index).get().entries[1] == doc::IndexEntry { kind: ~"Function", name: ~"b", brief: None, link: ~"#function-b" }); } #[test] fn should_index_mod_contents_multi_page() { let doc = test::mk_doc( config::DocPerMod, ~"mod a { } fn b() { }" ); fail_unless!((&doc.cratemod().index).get().entries[0] == doc::IndexEntry { kind: ~"Module", name: ~"a", brief: None, link: ~"a.html" }); fail_unless!((&doc.cratemod().index).get().entries[1] == doc::IndexEntry { kind: ~"Function", name: ~"b", brief: None, link: ~"#function-b" }); } #[test] fn should_index_foreign_mod_pages() { let doc = test::mk_doc( config::DocPerMod, ~"extern mod a { }" ); fail_unless!((&doc.cratemod().index).get().entries[0] == doc::IndexEntry { kind: ~"Foreign module", name: ~"a", brief: None, link: ~"a.html" }); } #[test] fn should_add_brief_desc_to_index() { let doc = test::mk_doc( config::DocPerMod, ~"#[doc = \"test\"] mod a { }" ); fail_unless!((&doc.cratemod().index).get().entries[0].brief == Some(~"test")); } #[test] fn should_index_foreign_mod_contents() { let doc = test::mk_doc( config::DocPerCrate, ~"extern mod a { fn b(); }" ); fail_unless!((&doc.cratemod().nmods()[0].index).get().entries[0] == doc::IndexEntry { kind: ~"Function", name: ~"b", brief: None, link: ~"#function-b" }); } #[cfg(test)] mod test { use astsrv; use attr_pass; use config; use desc_to_brief_pass; use doc; use extract; use markdown_index_pass::run; use path_pass; use core::path::Path; pub fn mk_doc(output_style: config::OutputStyle, source: ~str) -> doc::Doc { do astsrv::from_str(source) |srv| { let config = config::Config { output_style: output_style, .. config::default_config(&Path("whatever")) }; let doc = extract::from_srv(srv.clone(), ~""); let doc = (attr_pass::mk_pass().f)(srv.clone(), doc); let doc = (desc_to_brief_pass::mk_pass().f)(srv.clone(), doc); let doc = (path_pass::mk_pass().f)(srv.clone(), doc); run(srv.clone(), doc, config) } } }