diff options
Diffstat (limited to 'src/librustdoc/html/render.rs')
| -rw-r--r-- | src/librustdoc/html/render.rs | 129 |
1 files changed, 99 insertions, 30 deletions
diff --git a/src/librustdoc/html/render.rs b/src/librustdoc/html/render.rs index 464a4e4b736..4f8c11d8285 100644 --- a/src/librustdoc/html/render.rs +++ b/src/librustdoc/html/render.rs @@ -32,7 +32,7 @@ use syntax::ast; use clean; use doctree; use fold::DocFolder; -use html::format::{VisSpace, Method}; +use html::format::{VisSpace, Method, PuritySpace}; use html::layout; use html::markdown::Markdown; @@ -288,7 +288,9 @@ impl<'self> DocFolder for Cache { } else { false }; match item.inner { clean::StructItem(*) | clean::EnumItem(*) | - clean::TypedefItem(*) | clean::TraitItem(*) => { + clean::TypedefItem(*) | clean::TraitItem(*) | + clean::FunctionItem(*) | clean::ModuleItem(*) | + clean::VariantItem(*) => { self.paths.insert(item.id, (self.stack.clone(), shortty(&item))); } _ => {} @@ -401,8 +403,16 @@ impl Context { let mut task = task::task(); task.unlinked(); // we kill things manually task.name(format!("worker{}", i)); - do task.spawn_with(cache.clone()) |cache| { + task.spawn_with(cache.clone(), + |cache| worker(cache, &port, &chan, &prog_chan)); + + fn worker(cache: RWArc<Cache>, + port: &SharedPort<Work>, + chan: &SharedChan<Work>, + prog_chan: &SharedChan<Progress>) { + #[fixed_stack_segment]; // we hit markdown FFI *a lot* local_data::set(cache_key, cache); + loop { match port.recv() { Process(cx, item) => { @@ -425,28 +435,20 @@ impl Context { } } - let watcher_chan = chan.clone(); - let (done_port, done_chan) = comm::stream(); - do task::spawn { - let mut jobs = 0; - loop { - match prog_port.recv() { - JobNew => jobs += 1, - JobDone => jobs -= 1, - } - - if jobs == 0 { break } + chan.send(Process(self, item)); + let mut jobs = 1; + loop { + match prog_port.recv() { + JobNew => jobs += 1, + JobDone => jobs -= 1, } - for _ in range(0, WORKERS) { - watcher_chan.send(Die); - } - done_chan.send(()); + if jobs == 0 { break } } - prog_chan.send(JobNew); - chan.send(Process(self, item)); - done_port.recv(); + for _ in range(0, WORKERS) { + chan.send(Die); + } } fn item(&mut self, item: clean::Item, f: &fn(&mut Context, clean::Item)) { @@ -479,6 +481,8 @@ impl Context { } match item.inner { + // modules are special because they add a namespace. We also need to + // recurse into the items of the module as well. clean::ModuleItem(*) => { let name = item.name.get_ref().to_owned(); let item = Cell::new(item); @@ -498,11 +502,29 @@ impl Context { } } } + + // Things which don't have names (like impls) don't get special + // pages dedicated to them. _ if item.name.is_some() => { let dst = self.dst.push(item_path(&item)); let writer = dst.open_writer(io::CreateOrTruncate); render(writer.unwrap(), self, &item, true); + + // recurse if necessary + let name = item.name.get_ref().clone(); + match item.inner { + clean::EnumItem(e) => { + let mut it = e.variants.move_iter(); + do self.recurse(name) |this| { + for item in it { + f(this, item); + } + } + } + _ => {} + } } + _ => {} } } @@ -567,6 +589,7 @@ impl<'self> fmt::Default for Item<'self> { clean::StructItem(ref s) => item_struct(fmt.buf, it.item, s), clean::EnumItem(ref e) => item_enum(fmt.buf, it.item, e), clean::TypedefItem(ref t) => item_typedef(fmt.buf, it.item, t), + clean::VariantItem(*) => item_variant(fmt.buf, it.cx, it.item), _ => {} } } @@ -615,13 +638,21 @@ fn document(w: &mut io::Writer, item: &clean::Item) { fn item_module(w: &mut io::Writer, cx: &Context, item: &clean::Item, items: &[clean::Item]) { document(w, item); + debug2!("{:?}", items); let mut indices = vec::from_fn(items.len(), |i| i); - fn lt(i1: &clean::Item, i2: &clean::Item) -> bool { + fn lt(i1: &clean::Item, i2: &clean::Item, idx1: uint, idx2: uint) -> bool { if shortty(i1) == shortty(i2) { return i1.name < i2.name; } match (&i1.inner, &i2.inner) { + (&clean::ViewItemItem(ref a), &clean::ViewItemItem(ref b)) => { + match (&a.inner, &b.inner) { + (&clean::ExternMod(*), _) => true, + (_, &clean::ExternMod(*)) => false, + _ => idx1 < idx2, + } + } (&clean::ViewItemItem(*), _) => true, (_, &clean::ViewItemItem(*)) => false, (&clean::ModuleItem(*), _) => true, @@ -638,18 +669,19 @@ fn item_module(w: &mut io::Writer, cx: &Context, (_, &clean::FunctionItem(*)) => false, (&clean::TypedefItem(*), _) => true, (_, &clean::TypedefItem(*)) => false, - _ => false, + _ => idx1 < idx2, } } + debug2!("{:?}", indices); do sort::quick_sort(indices) |&i1, &i2| { - lt(&items[i1], &items[i2]) + lt(&items[i1], &items[i2], i1, i2) } + debug2!("{:?}", indices); let mut curty = ""; for &idx in indices.iter() { let myitem = &items[idx]; - if myitem.name.is_none() { loop } let myty = shortty(myitem); if myty != curty { @@ -687,17 +719,43 @@ fn item_module(w: &mut io::Writer, cx: &Context, write!(w, " <tr> - <td><code>{}: {} = </code>{}</td> + <td><code>{}static {}: {} = </code>{}</td> <td class='docblock'>{} </td> </tr> ", + VisSpace(myitem.visibility), *myitem.name.get_ref(), s.type_, Initializer(s.expr), Markdown(blank(myitem.doc_value()))); } + clean::ViewItemItem(ref item) => { + match item.inner { + clean::ExternMod(ref name, ref src, _, _) => { + write!(w, "<tr><td><code>extern mod {}", + name.as_slice()); + match *src { + Some(ref src) => write!(w, " = \"{}\"", + src.as_slice()), + None => {} + } + write!(w, ";</code></td></tr>"); + } + + clean::Import(ref imports) => { + for import in imports.iter() { + write!(w, "<tr><td><code>{}{}</code></td></tr>", + VisSpace(myitem.visibility), + *import); + } + } + } + + } + _ => { + if myitem.name.is_none() { loop } write!(w, " <tr> <td><a class='{class}' href='{href}' @@ -717,8 +775,9 @@ fn item_module(w: &mut io::Writer, cx: &Context, } fn item_function(w: &mut io::Writer, it: &clean::Item, f: &clean::Function) { - write!(w, "<pre class='fn'>{vis}fn {name}{generics}{decl}</pre>", + write!(w, "<pre class='fn'>{vis}{purity}fn {name}{generics}{decl}</pre>", vis = VisSpace(it.visibility), + purity = PuritySpace(f.purity), name = it.name.get_ref().as_slice(), generics = f.generics, decl = f.decl); @@ -830,8 +889,8 @@ fn render_method(w: &mut io::Writer, meth: &clean::Item, withlink: bool) { g: &clean::Generics, selfty: &clean::SelfTy, d: &clean::FnDecl, withlink: bool) { write!(w, "{}fn {withlink, select, - true{<a href='\\#fn.{name}'>{name}</a>} - other{{name}} + true{<a href='\\#fn.{name}' class='fnname'>{name}</a>} + other{<span class='fnname'>{name}</span>} }{generics}{decl}", match purity { ast::unsafe_fn => "unsafe ", @@ -872,7 +931,8 @@ fn item_enum(w: &mut io::Writer, it: &clean::Item, e: &clean::Enum) { } else { write!(w, " \\{\n"); for v in e.variants.iter() { - let name = v.name.get_ref().as_slice(); + let name = format!("<a name='variant.{0}'>{0}</a>", + v.name.get_ref().as_slice()); match v.inner { clean::VariantItem(ref var) => { match var.kind { @@ -1101,3 +1161,12 @@ fn build_sidebar(m: &clean::Module) -> HashMap<~str, ~[~str]> { } return map; } + +fn item_variant(w: &mut io::Writer, cx: &Context, it: &clean::Item) { + write!(w, "<DOCTYPE html><html><head>\ + <meta http-equiv='refresh' content='0; \ + url=../enum.{}.html\\#variant.{}'>\ + </head><body></body></html>", + *cx.current.last(), + it.name.get_ref().as_slice()); +} |