diff --git a/src/librustdoc/html/markdown/footnotes.rs b/src/librustdoc/html/markdown/footnotes.rs
index 47e248b891c3..3f0e586b8e37 100644
--- a/src/librustdoc/html/markdown/footnotes.rs
+++ b/src/librustdoc/html/markdown/footnotes.rs
@@ -10,7 +10,14 @@
/// references.
pub(super) struct Footnotes<'a, I> {
inner: I,
- footnotes: FxIndexMap>, u16)>,
+ footnotes: FxIndexMap>,
+}
+
+/// The definition of a single footnote.
+struct FootnoteDef<'a> {
+ content: Vec>,
+ /// The number that appears in the footnote reference and list.
+ id: u16,
}
impl<'a, I> Footnotes<'a, I> {
@@ -18,10 +25,15 @@ pub(super) fn new(iter: I) -> Self {
Footnotes { inner: iter, footnotes: FxIndexMap::default() }
}
- fn get_entry(&mut self, key: &str) -> &mut (Vec>, u16) {
+ fn get_entry(&mut self, key: &str) -> (&mut Vec>, u16) {
let new_id = self.footnotes.len() + 1;
let key = key.to_owned();
- self.footnotes.entry(key).or_insert((Vec::new(), new_id as u16))
+ let FootnoteDef { content, id } = self
+ .footnotes
+ .entry(key)
+ .or_insert(FootnoteDef { content: Vec::new(), id: new_id as u16 });
+ // Don't allow changing the ID of existing entrys, but allow changing the contents.
+ (content, *id)
}
}
@@ -32,46 +44,28 @@ fn next(&mut self) -> Option {
loop {
match self.inner.next() {
Some((Event::FootnoteReference(ref reference), range)) => {
- let entry = self.get_entry(reference);
- let reference = format!(
- "{0}",
- (*entry).1
- );
+ // When we see a reference (to a footnote we may not know) the definition of,
+ // reserve a number for it, and emit a link to that number.
+ let (_, id) = self.get_entry(reference);
+ let reference =
+ format!("{0}", id);
return Some((Event::Html(reference.into()), range));
}
Some((Event::Start(Tag::FootnoteDefinition(def)), _)) => {
- let mut content = Vec::new();
- for (event, _) in &mut self.inner {
- if let Event::End(TagEnd::FootnoteDefinition) = event {
- break;
- }
- content.push(event);
- }
- let entry = self.get_entry(&def);
- (*entry).0 = content;
+ // When we see a footnote definition, collect the assocated content, and store
+ // that for rendering later.
+ let content = collect_footnote_def(&mut self.inner);
+ let (entry_content, _) = self.get_entry(&def);
+ *entry_content = content;
}
Some(e) => return Some(e),
None => {
if !self.footnotes.is_empty() {
- let mut v: Vec<_> = self.footnotes.drain(..).map(|(_, x)| x).collect();
- v.sort_by(|a, b| a.1.cmp(&b.1));
- let mut ret = String::from("");
- return Some((Event::Html(ret.into()), 0..0));
+ // After all the markdown is emmited, emit an
then all the footnotes
+ // in a list.
+ let defs: Vec<_> = self.footnotes.drain(..).map(|(_, x)| x).collect();
+ let defs_html = render_footnotes_defs(defs);
+ return Some((Event::Html(defs_html.into()), 0..0));
} else {
return None;
}
@@ -80,3 +74,40 @@ fn next(&mut self) -> Option {
}
}
}
+
+fn collect_footnote_def<'a>(events: impl Iterator- >) -> Vec> {
+ let mut content = Vec::new();
+ for (event, _) in events {
+ if let Event::End(TagEnd::FootnoteDefinition) = event {
+ break;
+ }
+ content.push(event);
+ }
+ content
+}
+
+fn render_footnotes_defs(mut footnotes: Vec>) -> String {
+ let mut ret = String::from("");
+
+ ret
+}