Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Replace hoedown with pull in rustdoc #40338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Mar 29, 2017
Merged

Replace hoedown with pull in rustdoc #40338

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
08a80cb
Replace hoedown with pull in rustdoc
GuillaumeGomez Mar 8, 2017
c9415eb
Remains to fix tables
GuillaumeGomez Mar 8, 2017
b96fef8
End of pulldown switch and remove completely hoedown
GuillaumeGomez Mar 10, 2017
f6baea2
Fix external doc errors
GuillaumeGomez Mar 10, 2017
d5b6c04
Add missing markdown tags
GuillaumeGomez Mar 11, 2017
6d470a9
Add a macro to improve code
GuillaumeGomez Mar 11, 2017
6a2190c
Remove unneeded comment
GuillaumeGomez Mar 11, 2017
e51f325
Handle html in markdown as well
GuillaumeGomez Mar 11, 2017
474cc09
Update pulldown version after fix merged
GuillaumeGomez Mar 12, 2017
e133821
Update to last pulldown version
GuillaumeGomez Mar 17, 2017
cba67ad
Add feature for rustdoc binary
GuillaumeGomez Mar 24, 2017
47e4abf
Fix plain_summary_line function
GuillaumeGomez Mar 25, 2017
286a51d
Fix id generation
GuillaumeGomez Mar 25, 2017
a7c6d3e
Improve function naming
GuillaumeGomez Mar 28, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Improve function naming
  • Loading branch information
@GuillaumeGomez
GuillaumeGomez committed Mar 28, 2017
commit a7c6d3e16a71fc0dcce4c9be09d031d746f84a69
45 changes: 22 additions & 23 deletions src/librustdoc/html/markdown.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@

//! Markdown formatting for rustdoc
//!
//! This module implements markdown formatting through the hoedown C-library
//! (bundled into the rust runtime). This module self-contains the C bindings
//! and necessary legwork to render markdown, and exposes all of the
//! This module implements markdown formatting through the pulldown-cmark
//! rust-library. This module exposes all of the
//! functionality through a unit-struct, `Markdown`, which has an implementation
//! of `fmt::Display`. Example usage:
//!
//! ```rust,ignore
//! use rustdoc::html::markdown::Markdown;
//! use rustdoc::html::markdown::{Markdown, MarkdownOutputStyle};
//!
//! let s = "My *markdown* _text_";
//! let html = format!("{}", Markdown(s));
//! let html = format!("{}", Markdown(s, MarkdownOutputStyle::Fancy));
//! // ... something using html
//! ```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't tell whether or not the documentation for this is rendered anywhere (?), but it seems like this comment should be updated, regardless. It talks about the "hoedown C-library" and "the C bindings." Also, the example might not work anymore, it uses Markdown(s), but that appears to now be Markdown(s, style)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent point!

Expand Down Expand Up @@ -138,7 +137,7 @@ pub fn render(w: &mut fmt::Formatter,
s: &str,
print_toc: bool,
shorter: MarkdownOutputStyle) -> fmt::Result {
fn block(parser: &mut Parser, buffer: &mut String, lang: &str) {
fn code_block(parser: &mut Parser, buffer: &mut String, lang: &str) {
let mut origtext = String::new();
while let Some(event) = parser.next() {
match event {
Expand Down Expand Up @@ -216,8 +215,8 @@ pub fn render(w: &mut fmt::Formatter,
});
}

fn header(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle, level: i32) {
fn heading(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle, level: i32) {
let mut ret = String::new();
let mut id = String::new();
event_loop_break!(parser, toc_builder, shorter, ret, true, &mut Some(&mut id),
Expand Down Expand Up @@ -250,8 +249,8 @@ pub fn render(w: &mut fmt::Formatter,
ret, lvl = level, id = id, sec = sec));
}

fn codespan(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle, id: &mut Option<&mut String>) {
fn inline_code(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle, id: &mut Option<&mut String>) {
let mut content = String::new();
event_loop_break!(parser, toc_builder, shorter, content, false, id, Event::End(Tag::Code));
buffer.push_str(&format!("<code>{}</code>",
Expand All @@ -274,8 +273,8 @@ pub fn render(w: &mut fmt::Formatter,
buffer.push_str(&format!("<p>{}</p>", content.trim_right()));
}

fn cell(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
fn table_cell(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
let mut content = String::new();
event_loop_break!(parser, toc_builder, shorter, content, true, &mut None,
Event::End(Tag::TableHead) |
Expand All @@ -285,16 +284,16 @@ pub fn render(w: &mut fmt::Formatter,
buffer.push_str(&format!("<td>{}</td>", content.trim()));
}

fn row(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
fn table_row(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
let mut content = String::new();
while let Some(event) = parser.next() {
match event {
Event::End(Tag::TableHead) |
Event::End(Tag::Table(_)) |
Event::End(Tag::TableRow) => break,
Event::Start(Tag::TableCell) => {
cell(parser, &mut content, toc_builder, shorter);
table_cell(parser, &mut content, toc_builder, shorter);
}
x => {
looper(parser, &mut content, Some(x), toc_builder, shorter, &mut None);
Expand All @@ -304,14 +303,14 @@ pub fn render(w: &mut fmt::Formatter,
buffer.push_str(&format!("<tr>{}</tr>", content));
}

fn head(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
fn table_head(parser: &mut Parser, buffer: &mut String, toc_builder: &mut Option<TocBuilder>,
shorter: MarkdownOutputStyle) {
let mut content = String::new();
while let Some(event) = parser.next() {
match event {
Event::End(Tag::TableHead) | Event::End(Tag::Table(_)) => break,
Event::Start(Tag::TableCell) => {
cell(parser, &mut content, toc_builder, shorter);
table_cell(parser, &mut content, toc_builder, shorter);
}
x => {
looper(parser, &mut content, Some(x), toc_builder, shorter, &mut None);
Expand All @@ -331,10 +330,10 @@ pub fn render(w: &mut fmt::Formatter,
match event {
Event::End(Tag::Table(_)) => break,
Event::Start(Tag::TableHead) => {
head(parser, &mut content, toc_builder, shorter);
table_head(parser, &mut content, toc_builder, shorter);
}
Event::Start(Tag::TableRow) => {
row(parser, &mut rows, toc_builder, shorter);
table_row(parser, &mut rows, toc_builder, shorter);
}
_ => {}
}
Expand Down Expand Up @@ -412,13 +411,13 @@ pub fn render(w: &mut fmt::Formatter,
if let Some(event) = next_event {
match event {
Event::Start(Tag::CodeBlock(lang)) => {
block(parser, buffer, &*lang);
code_block(parser, buffer, &*lang);
}
Event::Start(Tag::Header(level)) => {
header(parser, buffer, toc_builder, shorter, level);
heading(parser, buffer, toc_builder, shorter, level);
}
Event::Start(Tag::Code) => {
codespan(parser, buffer, toc_builder, shorter, id);
inline_code(parser, buffer, toc_builder, shorter, id);
}
Event::Start(Tag::Paragraph) => {
paragraph(parser, buffer, toc_builder, shorter, id);
Expand Down