rustdoc: Introduce the concept of a 'page'

Author: brson

src/rustdoc/attr_pass.rs

@@ -20,8 +20,8 @@ fn mk_pass() -> pass {
 
 fn run(
     srv: astsrv::srv,
-    doc: doc::cratedoc
-) -> doc::cratedoc {
+    doc: doc::doc
+) -> doc::doc {
     let fold = fold::fold({
         fold_crate: fold_crate,
         fold_item: fold_item,
@@ -32,7 +32,7 @@ fn run(
         fold_impl: fold_impl
         with *fold::default_any_fold(srv)
     });
-    fold.fold_crate(fold, doc)
+    fold.fold_doc(fold, doc)
 }
 
 fn fold_crate(
@@ -62,7 +62,7 @@ fn fold_crate(
 #[test]
 fn should_replace_top_module_name_with_crate_name() {
     let doc = test::mk_doc("#[link(name = \"bond\")];");
-    assert doc.topmod.name() == "bond";
+    assert doc.cratemod().name() == "bond";
 }
 
 fn fold_item(
@@ -108,25 +108,25 @@ fn parse_item_attrs<T:send>(
 #[test]
 fn should_should_extract_mod_attributes() {
     let doc = test::mk_doc("#[doc = \"test\"] mod a { }");
-    assert doc.topmod.mods()[0].desc() == some("test");
+    assert doc.cratemod().mods()[0].desc() == some("test");
 }
 
 #[test]
 fn should_extract_top_mod_attributes() {
     let doc = test::mk_doc("#[doc = \"test\"];");
-    assert doc.topmod.desc() == some("test");
+    assert doc.cratemod().desc() == some("test");
 }
 
 #[test]
 fn should_extract_native_mod_attributes() {
     let doc = test::mk_doc("#[doc = \"test\"] native mod a { }");
-    assert doc.topmod.nmods()[0].desc() == some("test");
+    assert doc.cratemod().nmods()[0].desc() == some("test");
 }
 
 #[test]
 fn should_extract_native_fn_attributes() {
     let doc = test::mk_doc("native mod a { #[doc = \"test\"] fn a(); }");
-    assert doc.topmod.nmods()[0].fns[0].desc() == some("test");
+    assert doc.cratemod().nmods()[0].fns[0].desc() == some("test");
 }
 
 fn fold_fn(
@@ -187,13 +187,13 @@ fn merge_ret_attrs(
 #[test]
 fn should_extract_fn_attributes() {
     let doc = test::mk_doc("#[doc = \"test\"] fn a() -> int { }");
-    assert doc.topmod.fns()[0].desc() == some("test");
+    assert doc.cratemod().fns()[0].desc() == some("test");
 }
 
 #[test]
 fn should_extract_fn_arg_attributes() {
     let doc = test::mk_doc("#[doc(args(a = \"b\"))] fn c(a: bool) { }");
-    assert doc.topmod.fns()[0].args[0].desc == some("b");
+    assert doc.cratemod().fns()[0].args[0].desc == some("b");
 }
 
 #[test]
@@ -203,7 +203,7 @@ fn should_extract_fn_return_attributes() {
         let doc = extract::from_srv(srv, "");
         let doc = tystr_pass::mk_pass().f(srv, doc);
         let fold = fold::default_any_fold(srv);
-        let doc = fold_fn(fold, doc.topmod.fns()[0]);
+        let doc = fold_fn(fold, doc.cratemod().fns()[0]);
         assert doc.return.desc == some("what");
     }
 }
@@ -215,23 +215,23 @@ fn should_preserve_fn_sig() {
         let doc = extract::from_srv(srv, "");
         let doc = tystr_pass::mk_pass().f(srv, doc);
         let fold = fold::default_any_fold(srv);
-        let doc = fold_fn(fold, doc.topmod.fns()[0]);
+        let doc = fold_fn(fold, doc.cratemod().fns()[0]);
         assert doc.sig == some("fn a() -> int");
     }
 }
 
 #[test]
 fn should_extract_fn_failure_conditions() {
     let doc = test::mk_doc("#[doc(failure = \"what\")] fn a() { }");
-    assert doc.topmod.fns()[0].failure == some("what");
+    assert doc.cratemod().fns()[0].failure == some("what");
 }
 
 #[test]
 fn should_extract_const_docs() {
     let doc = test::mk_doc("#[doc(brief = \"foo\", desc = \"bar\")]\
                             const a: bool = true;");
-    assert doc.topmod.consts()[0].brief() == some("foo");
-    assert doc.topmod.consts()[0].desc() == some("bar");
+    assert doc.cratemod().consts()[0].brief() == some("foo");
+    assert doc.cratemod().consts()[0].desc() == some("bar");
 }
 
 fn fold_enum(
@@ -273,14 +273,14 @@ fn fold_enum(
 fn should_extract_enum_docs() {
     let doc = test::mk_doc("#[doc(brief = \"a\", desc = \"b\")]\
                             enum a { v }");
-    assert doc.topmod.enums()[0].brief() == some("a");
-    assert doc.topmod.enums()[0].desc() == some("b");
+    assert doc.cratemod().enums()[0].brief() == some("a");
+    assert doc.cratemod().enums()[0].desc() == some("b");
 }
 
 #[test]
 fn should_extract_variant_docs() {
     let doc = test::mk_doc("enum a { #[doc = \"c\"] v }");
-    assert doc.topmod.enums()[0].variants[0].desc == some("c");
+    assert doc.cratemod().enums()[0].variants[0].desc == some("c");
 }
 
 fn fold_res(
@@ -314,16 +314,16 @@ fn fold_res(
 fn should_extract_res_docs() {
     let doc = test::mk_doc("#[doc(brief = \"a\", desc = \"b\")]\
                             resource r(b: bool) { }");
-    assert doc.topmod.resources()[0].brief() == some("a");
-    assert doc.topmod.resources()[0].desc() == some("b");
+    assert doc.cratemod().resources()[0].brief() == some("a");
+    assert doc.cratemod().resources()[0].desc() == some("b");
 }
 
 #[test]
 fn should_extract_res_arg_docs() {
     let doc = test::mk_doc("#[doc(args(a = \"b\"))]\
                             resource r(a: bool) { }");
-    assert doc.topmod.resources()[0].args[0].name == "a";
-    assert doc.topmod.resources()[0].args[0].desc == some("b");
+    assert doc.cratemod().resources()[0].args[0].name == "a";
+    assert doc.cratemod().resources()[0].args[0].desc == some("b");
 }
 
 fn fold_iface(
@@ -394,7 +394,7 @@ fn merge_method_attrs(
 #[test]
 fn should_extract_iface_docs() {
     let doc = test::mk_doc("#[doc = \"whatever\"] iface i { fn a(); }");
-    assert doc.topmod.ifaces()[0].desc() == some("whatever");
+    assert doc.cratemod().ifaces()[0].desc() == some("whatever");
 }
 
 #[test]
@@ -409,11 +409,12 @@ fn should_extract_iface_method_docs() {
          failure = \"failure\")]\
          fn f(a: bool) -> bool;\
          }");
-    assert doc.topmod.ifaces()[0].methods[0].brief == some("brief");
-    assert doc.topmod.ifaces()[0].methods[0].desc == some("desc");
-    assert doc.topmod.ifaces()[0].methods[0].args[0].desc == some("a");
-    assert doc.topmod.ifaces()[0].methods[0].return.desc == some("return");
-    assert doc.topmod.ifaces()[0].methods[0].failure == some("failure");
+    assert doc.cratemod().ifaces()[0].methods[0].brief == some("brief");
+    assert doc.cratemod().ifaces()[0].methods[0].desc == some("desc");
+    assert doc.cratemod().ifaces()[0].methods[0].args[0].desc == some("a");
+    assert doc.cratemod().ifaces()[0].methods[0].return.desc
+        == some("return");
+    assert doc.cratemod().ifaces()[0].methods[0].failure == some("failure");
 }
 
 
@@ -434,7 +435,7 @@ fn fold_impl(
 fn should_extract_impl_docs() {
     let doc = test::mk_doc(
         "#[doc = \"whatever\"] impl i for int { fn a() { } }");
-    assert doc.topmod.impls()[0].desc() == some("whatever");
+    assert doc.cratemod().impls()[0].desc() == some("whatever");
 }
 
 #[test]
@@ -449,25 +450,25 @@ fn should_extract_impl_method_docs() {
          failure = \"failure\")]\
          fn f(a: bool) -> bool { }\
          }");
-    assert doc.topmod.impls()[0].methods[0].brief == some("brief");
-    assert doc.topmod.impls()[0].methods[0].desc == some("desc");
-    assert doc.topmod.impls()[0].methods[0].args[0].desc == some("a");
-    assert doc.topmod.impls()[0].methods[0].return.desc == some("return");
-    assert doc.topmod.impls()[0].methods[0].failure == some("failure");
+    assert doc.cratemod().impls()[0].methods[0].brief == some("brief");
+    assert doc.cratemod().impls()[0].methods[0].desc == some("desc");
+    assert doc.cratemod().impls()[0].methods[0].args[0].desc == some("a");
+    assert doc.cratemod().impls()[0].methods[0].return.desc == some("return");
+    assert doc.cratemod().impls()[0].methods[0].failure == some("failure");
 }
 
 #[test]
 fn should_extract_type_docs() {
     let doc = test::mk_doc(
         "#[doc(brief = \"brief\", desc = \"desc\")]\
          type t = int;");
-    assert doc.topmod.types()[0].brief() == some("brief");
-    assert doc.topmod.types()[0].desc() == some("desc");
+    assert doc.cratemod().types()[0].brief() == some("brief");
+    assert doc.cratemod().types()[0].desc() == some("desc");
 }
 
 #[cfg(test)]
 mod test {
-    fn mk_doc(source: str) -> doc::cratedoc {
+    fn mk_doc(source: str) -> doc::doc {
         astsrv::from_str(source) {|srv|
             let doc = extract::from_srv(srv, "");
             run(srv, doc)