src/librustdoc/html/markdown.rs

   1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Markdown formatting for rustdoc
  12 //!
  13 //! This module implements markdown formatting through the hoedown C-library
  14 //! (bundled into the rust runtime). This module self-contains the C bindings
  15 //! and necessary legwork to render markdown, and exposes all of the
  16 //! functionality through a unit-struct, `Markdown`, which has an implementation
  17 //! of `fmt::Show`. Example usage:
  18 //!
  19 //! ```rust,ignore
  20 //! use rustdoc::html::markdown::Markdown;
  21 //!
  22 //! let s = "My *markdown* _text_";
  23 //! let html = format!("{}", Markdown(s));
  24 //! // ... something using html
  25 //! ```
  26
  27 #![allow(dead_code)]
  28 #![allow(non_camel_case_types)]
  29
  30 use libc;
  31 use std::cell::{RefCell, Cell};
  32 use std::fmt;
  33 use std::slice;
  34 use std::str;
  35 use std::collections::HashMap;
  36
  37 use html::toc::TocBuilder;
  38 use html::highlight;
  39 use html::escape::Escape;
  40 use test;
  41
  42 /// A unit struct which has the `fmt::Show` trait implemented. When
  43 /// formatted, this struct will emit the HTML corresponding to the rendered
  44 /// version of the contained markdown string.
  45 pub struct Markdown<'a>(pub &'a str);
  46 /// A unit struct like `Markdown`, that renders the markdown with a
  47 /// table of contents.
  48 pub struct MarkdownWithToc<'a>(pub &'a str);
  49
  50 static DEF_OUNIT: libc::size_t = 64;
  51 static HOEDOWN_EXT_NO_INTRA_EMPHASIS: libc::c_uint = 1 << 10;
  52 static HOEDOWN_EXT_TABLES: libc::c_uint = 1 << 0;
  53 static HOEDOWN_EXT_FENCED_CODE: libc::c_uint = 1 << 1;
  54 static HOEDOWN_EXT_AUTOLINK: libc::c_uint = 1 << 3;
  55 static HOEDOWN_EXT_STRIKETHROUGH: libc::c_uint = 1 << 4;
  56 static HOEDOWN_EXT_SUPERSCRIPT: libc::c_uint = 1 << 8;
  57 static HOEDOWN_EXT_FOOTNOTES: libc::c_uint = 1 << 2;
  58
  59 static HOEDOWN_EXTENSIONS: libc::c_uint =
  60     HOEDOWN_EXT_NO_INTRA_EMPHASIS | HOEDOWN_EXT_TABLES |
  61     HOEDOWN_EXT_FENCED_CODE | HOEDOWN_EXT_AUTOLINK |
  62     HOEDOWN_EXT_STRIKETHROUGH | HOEDOWN_EXT_SUPERSCRIPT |
  63     HOEDOWN_EXT_FOOTNOTES;
  64
  65 type hoedown_document = libc::c_void;  // this is opaque to us
  66
  67 struct hoedown_renderer {
  68     opaque: *mut hoedown_html_renderer_state,
  69     blockcode: Option<extern "C" fn(*mut hoedown_buffer, *const hoedown_buffer,
  70                                     *const hoedown_buffer, *mut libc::c_void)>,
  71     blockquote: Option<extern "C" fn(*mut hoedown_buffer, *const hoedown_buffer,
  72                                      *mut libc::c_void)>,
  73     blockhtml: Option<extern "C" fn(*mut hoedown_buffer, *const hoedown_buffer,
  74                                     *mut libc::c_void)>,
  75     header: Option<extern "C" fn(*mut hoedown_buffer, *const hoedown_buffer,
  76                                  libc::c_int, *mut libc::c_void)>,
  77     other: [libc::size_t, ..28],
  78 }
  79
  80 struct hoedown_html_renderer_state {
  81     opaque: *mut libc::c_void,
  82     toc_data: html_toc_data,
  83     flags: libc::c_uint,
  84     link_attributes: Option<extern "C" fn(*mut hoedown_buffer,
  85                                           *const hoedown_buffer,
  86                                           *mut libc::c_void)>,
  87 }
  88
  89 struct html_toc_data {
  90     header_count: libc::c_int,
  91     current_level: libc::c_int,
  92     level_offset: libc::c_int,
  93     nesting_level: libc::c_int,
  94 }
  95
  96 struct MyOpaque {
  97     dfltblk: extern "C" fn(*mut hoedown_buffer, *const hoedown_buffer,
  98                            *const hoedown_buffer, *mut libc::c_void),
  99     toc_builder: Option<TocBuilder>,
 100 }
 101
 102 struct hoedown_buffer {
 103     data: *const u8,
 104     size: libc::size_t,
 105     asize: libc::size_t,
 106     unit: libc::size_t,
 107 }
 108
 109 // hoedown FFI
 110 #[link(name = "hoedown", kind = "static")]
 111 extern {
 112     fn hoedown_html_renderer_new(render_flags: libc::c_uint,
 113                                  nesting_level: libc::c_int)
 114         -> *mut hoedown_renderer;
 115     fn hoedown_html_renderer_free(renderer: *mut hoedown_renderer);
 116
 117     fn hoedown_document_new(rndr: *mut hoedown_renderer,
 118                             extensions: libc::c_uint,
 119                             max_nesting: libc::size_t) -> *mut hoedown_document;
 120     fn hoedown_document_render(doc: *mut hoedown_document,
 121                                ob: *mut hoedown_buffer,
 122                                document: *const u8,
 123                                doc_size: libc::size_t);
 124     fn hoedown_document_free(md: *mut hoedown_document);
 125
 126     fn hoedown_buffer_new(unit: libc::size_t) -> *mut hoedown_buffer;
 127     fn hoedown_buffer_puts(b: *mut hoedown_buffer, c: *const libc::c_char);
 128     fn hoedown_buffer_free(b: *mut hoedown_buffer);
 129
 130 }
 131
 132 /// Returns Some(code) if `s` is a line that should be stripped from
 133 /// documentation but used in example code. `code` is the portion of
 134 /// `s` that should be used in tests. (None for lines that should be
 135 /// left as-is.)
 136 fn stripped_filtered_line<'a>(s: &'a str) -> Option<&'a str> {
 137     let trimmed = s.trim();
 138     if trimmed.starts_with("# ") {
 139         Some(trimmed.slice_from(2))
 140     } else {
 141         None
 142     }
 143 }
 144
 145 local_data_key!(used_header_map: RefCell<HashMap<String, uint>>)
 146 local_data_key!(test_idx: Cell<uint>)
 147 // None == render an example, but there's no crate name
 148 local_data_key!(pub playground_krate: Option<String>)
 149
 150 pub fn render(w: &mut fmt::Formatter, s: &str, print_toc: bool) -> fmt::Result {
 151     extern fn block(ob: *mut hoedown_buffer, text: *const hoedown_buffer,
 152                     lang: *const hoedown_buffer, opaque: *mut libc::c_void) {
 153         unsafe {
 154             if text.is_null() { return }
 155
 156             let opaque = opaque as *mut hoedown_html_renderer_state;
 157             let my_opaque: &MyOpaque = &*((*opaque).opaque as *const MyOpaque);
 158             slice::raw::buf_as_slice((*text).data, (*text).size as uint, |text| {
 159                 let origtext = str::from_utf8(text).unwrap();
 160                 debug!("docblock: ==============\n{}\n=======", text);
 161                 let mut lines = origtext.lines().filter(|l| {
 162                     stripped_filtered_line(*l).is_none()
 163                 });
 164                 let text = lines.collect::<Vec<&str>>().connect("\n");
 165
 166                 let buf = hoedown_buffer {
 167                     data: text.as_bytes().as_ptr(),
 168                     size: text.len() as libc::size_t,
 169                     asize: text.len() as libc::size_t,
 170                     unit: 0,
 171                 };
 172                 let rendered = if lang.is_null() {
 173                     false
 174                 } else {
 175                     slice::raw::buf_as_slice((*lang).data,
 176                                            (*lang).size as uint, |rlang| {
 177                         let rlang = str::from_utf8(rlang).unwrap();
 178                         if LangString::parse(rlang).notrust {
 179                             (my_opaque.dfltblk)(ob, &buf, lang,
 180                                                 opaque as *mut libc::c_void);
 181                             true
 182                         } else {
 183                             false
 184                         }
 185                     })
 186                 };
 187
 188                 if !rendered {
 189                     let mut s = String::new();
 190                     let id = playground_krate.get().map(|krate| {
 191                         let idx = test_idx.get().unwrap();
 192                         let i = idx.get();
 193                         idx.set(i + 1);
 194
 195                         let test = origtext.lines().map(|l| {
 196                             stripped_filtered_line(l).unwrap_or(l)
 197                         }).collect::<Vec<&str>>().connect("\n");
 198                         let krate = krate.as_ref().map(|s| s.as_slice());
 199                         let test = test::maketest(test.as_slice(), krate, false, false);
 200                         s.push_str(format!("<span id='rust-example-raw-{}' \
 201                                              class='rusttest'>{}</span>",
 202                                            i, Escape(test.as_slice())).as_slice());
 203                         format!("rust-example-rendered-{}", i)
 204                     });
 205                     let id = id.as_ref().map(|a| a.as_slice());
 206                     s.push_str(highlight::highlight(text.as_slice(), None, id)
 207                                          .as_slice());
 208                     let output = s.to_c_str();
 209                     hoedown_buffer_puts(ob, output.as_ptr());
 210                 }
 211             })
 212         }
 213     }
 214
 215     extern fn header(ob: *mut hoedown_buffer, text: *const hoedown_buffer,
 216                      level: libc::c_int, opaque: *mut libc::c_void) {
 217         // hoedown does this, we may as well too
 218         "\n".with_c_str(|p| unsafe { hoedown_buffer_puts(ob, p) });
 219
 220         // Extract the text provided
 221         let s = if text.is_null() {
 222             "".to_string()
 223         } else {
 224             unsafe {
 225                 str::raw::from_buf_len((*text).data, (*text).size as uint)
 226             }
 227         };
 228
 229         // Transform the contents of the header into a hyphenated string
 230         let id = s.as_slice().words().map(|s| {
 231             match s.to_ascii_opt() {
 232                 Some(s) => s.to_lower().into_string(),
 233                 None => s.to_string()
 234             }
 235         }).collect::<Vec<String>>().connect("-");
 236
 237         // This is a terrible hack working around how hoedown gives us rendered
 238         // html for text rather than the raw text.
 239         let id = id.replace("<code>", "").replace("</code>", "").to_string();
 240
 241         let opaque = opaque as *mut hoedown_html_renderer_state;
 242         let opaque = unsafe { &mut *((*opaque).opaque as *mut MyOpaque) };
 243
 244         // Make sure our hyphenated ID is unique for this page
 245         let map = used_header_map.get().unwrap();
 246         let id = match map.borrow_mut().find_mut(&id) {
 247             None => id,
 248             Some(a) => { *a += 1; format!("{}-{}", id, *a - 1) }
 249         };
 250         map.borrow_mut().insert(id.clone(), 1);
 251
 252         let sec = match opaque.toc_builder {
 253             Some(ref mut builder) => {
 254                 builder.push(level as u32, s.clone(), id.clone())
 255             }
 256             None => {""}
 257         };
 258
 259         // Render the HTML
 260         let text = format!(r##"<h{lvl} id="{id}" class='section-header'><a
 261                            href="#{id}">{sec}{}</a></h{lvl}>"##,
 262                            s, lvl = level, id = id,
 263                            sec = if sec.len() == 0 {
 264                                sec.to_string()
 265                            } else {
 266                                format!("{} ", sec)
 267                            });
 268
 269         text.with_c_str(|p| unsafe { hoedown_buffer_puts(ob, p) });
 270     }
 271
 272     unsafe {
 273         let ob = hoedown_buffer_new(DEF_OUNIT);
 274         let renderer = hoedown_html_renderer_new(0, 0);
 275         let mut opaque = MyOpaque {
 276             dfltblk: (*renderer).blockcode.unwrap(),
 277             toc_builder: if print_toc {Some(TocBuilder::new())} else {None}
 278         };
 279         (*(*renderer).opaque).opaque = &mut opaque as *mut _ as *mut libc::c_void;
 280         (*renderer).blockcode = Some(block);
 281         (*renderer).header = Some(header);
 282
 283         let document = hoedown_document_new(renderer, HOEDOWN_EXTENSIONS, 16);
 284         hoedown_document_render(document, ob, s.as_ptr(),
 285                                 s.len() as libc::size_t);
 286         hoedown_document_free(document);
 287
 288         hoedown_html_renderer_free(renderer);
 289
 290         let mut ret = match opaque.toc_builder {
 291             Some(b) => write!(w, "<nav id=\"TOC\">{}</nav>", b.into_toc()),
 292             None => Ok(())
 293         };
 294
 295         if ret.is_ok() {
 296             ret = slice::raw::buf_as_slice((*ob).data, (*ob).size as uint, |buf| {
 297                 w.write(buf)
 298             });
 299         }
 300         hoedown_buffer_free(ob);
 301         ret
 302     }
 303 }
 304
 305 pub fn find_testable_code(doc: &str, tests: &mut ::test::Collector) {
 306     extern fn block(_ob: *mut hoedown_buffer,
 307                     text: *const hoedown_buffer,
 308                     lang: *const hoedown_buffer,
 309                     opaque: *mut libc::c_void) {
 310         unsafe {
 311             if text.is_null() { return }
 312             let block_info = if lang.is_null() {
 313                 LangString::all_false()
 314             } else {
 315                 slice::raw::buf_as_slice((*lang).data,
 316                                        (*lang).size as uint, |lang| {
 317                     let s = str::from_utf8(lang).unwrap();
 318                     LangString::parse(s)
 319                 })
 320             };
 321             if block_info.notrust { return }
 322             slice::raw::buf_as_slice((*text).data, (*text).size as uint, |text| {
 323                 let opaque = opaque as *mut hoedown_html_renderer_state;
 324                 let tests = &mut *((*opaque).opaque as *mut ::test::Collector);
 325                 let text = str::from_utf8(text).unwrap();
 326                 let mut lines = text.lines().map(|l| {
 327                     stripped_filtered_line(l).unwrap_or(l)
 328                 });
 329                 let text = lines.collect::<Vec<&str>>().connect("\n");
 330                 tests.add_test(text.to_string(),
 331                                block_info.should_fail, block_info.no_run,
 332                                block_info.ignore, block_info.test_harness);
 333             })
 334         }
 335     }
 336
 337     extern fn header(_ob: *mut hoedown_buffer,
 338                      text: *const hoedown_buffer,
 339                      level: libc::c_int, opaque: *mut libc::c_void) {
 340         unsafe {
 341             let opaque = opaque as *mut hoedown_html_renderer_state;
 342             let tests = &mut *((*opaque).opaque as *mut ::test::Collector);
 343             if text.is_null() {
 344                 tests.register_header("", level as u32);
 345             } else {
 346                 slice::raw::buf_as_slice((*text).data, (*text).size as uint, |text| {
 347                     let text = str::from_utf8(text).unwrap();
 348                     tests.register_header(text, level as u32);
 349                 })
 350             }
 351         }
 352     }
 353
 354     unsafe {
 355         let ob = hoedown_buffer_new(DEF_OUNIT);
 356         let renderer = hoedown_html_renderer_new(0, 0);
 357         (*renderer).blockcode = Some(block);
 358         (*renderer).header = Some(header);
 359         (*(*renderer).opaque).opaque = tests as *mut _ as *mut libc::c_void;
 360
 361         let document = hoedown_document_new(renderer, HOEDOWN_EXTENSIONS, 16);
 362         hoedown_document_render(document, ob, doc.as_ptr(),
 363                                 doc.len() as libc::size_t);
 364         hoedown_document_free(document);
 365
 366         hoedown_html_renderer_free(renderer);
 367         hoedown_buffer_free(ob);
 368     }
 369 }
 370
 371 #[deriving(Eq, PartialEq, Clone, Show)]
 372 struct LangString {
 373     should_fail: bool,
 374     no_run: bool,
 375     ignore: bool,
 376     notrust: bool,
 377     test_harness: bool,
 378 }
 379
 380 impl LangString {
 381     fn all_false() -> LangString {
 382         LangString {
 383             should_fail: false,
 384             no_run: false,
 385             ignore: false,
 386             notrust: false,
 387             test_harness: false,
 388         }
 389     }
 390
 391     fn parse(string: &str) -> LangString {
 392         let mut seen_rust_tags = false;
 393         let mut seen_other_tags = false;
 394         let mut data = LangString::all_false();
 395
 396         let mut tokens = string.as_slice().split(|c: char|
 397             !(c == '_' || c == '-' || c.is_alphanumeric())
 398         );
 399
 400         for token in tokens {
 401             match token {
 402                 "" => {},
 403                 "should_fail" => { data.should_fail = true; seen_rust_tags = true; },
 404                 "no_run" => { data.no_run = true; seen_rust_tags = true; },
 405                 "ignore" => { data.ignore = true; seen_rust_tags = true; },
 406                 "notrust" => { data.notrust = true; seen_rust_tags = true; },
 407                 "rust" => { data.notrust = false; seen_rust_tags = true; },
 408                 "test_harness" => { data.test_harness = true; seen_rust_tags = true; }
 409                 _ => { seen_other_tags = true }
 410             }
 411         }
 412
 413         data.notrust |= seen_other_tags && !seen_rust_tags;
 414
 415         data
 416     }
 417 }
 418
 419 /// By default this markdown renderer generates anchors for each header in the
 420 /// rendered document. The anchor name is the contents of the header separated
 421 /// by hyphens, and a task-local map is used to disambiguate among duplicate
 422 /// headers (numbers are appended).
 423 ///
 424 /// This method will reset the local table for these headers. This is typically
 425 /// used at the beginning of rendering an entire HTML page to reset from the
 426 /// previous state (if any).
 427 pub fn reset_headers() {
 428     used_header_map.replace(Some(RefCell::new(HashMap::new())));
 429     test_idx.replace(Some(Cell::new(0)));
 430 }
 431
 432 impl<'a> fmt::Show for Markdown<'a> {
 433     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 434         let Markdown(md) = *self;
 435         // This is actually common enough to special-case
 436         if md.len() == 0 { return Ok(()) }
 437         render(fmt, md.as_slice(), false)
 438     }
 439 }
 440
 441 impl<'a> fmt::Show for MarkdownWithToc<'a> {
 442     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
 443         let MarkdownWithToc(md) = *self;
 444         render(fmt, md.as_slice(), true)
 445     }
 446 }
 447
 448 #[cfg(test)]
 449 mod tests {
 450     use super::LangString;
 451
 452     #[test]
 453     fn test_lang_string_parse() {
 454         fn t(s: &str,
 455              should_fail: bool, no_run: bool, ignore: bool, notrust: bool, test_harness: bool) {
 456             assert_eq!(LangString::parse(s), LangString {
 457                 should_fail: should_fail,
 458                 no_run: no_run,
 459                 ignore: ignore,
 460                 notrust: notrust,
 461                 test_harness: test_harness,
 462             })
 463         }
 464
 465         t("", false,false,false,false,false);
 466         t("rust", false,false,false,false,false);
 467         t("sh", false,false,false,true,false);
 468         t("notrust", false,false,false,true,false);
 469         t("ignore", false,false,true,false,false);
 470         t("should_fail", true,false,false,false,false);
 471         t("no_run", false,true,false,false,false);
 472         t("test_harness", false,false,false,false,true);
 473         t("{.no_run .example}", false,true,false,false,false);
 474         t("{.sh .should_fail}", true,false,false,false,false);
 475         t("{.example .rust}", false,false,false,false,false);
 476         t("{.test_harness .rust}", false,false,false,false,true);
 477     }
 478 }