mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
221d1a97e5
rust/src/librustdoc/markdown.rs

158 lines
4.8 KiB
Rust
Raw Normal View History

rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
// Copyright 2014 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
rustdoc: Allowing specifying attrs for doctests This adds support in rustdoc to blanket apply crate attributes to all doc tests for a crate at once. The syntax for doing this is: #![doc(test(attr(...)))] Each meta item in `...` will be applied to each doctest as a crate attribute. cc #18199
2015-04-06 20:39:39 -05:00
use std::default::Default;
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-26 23:00:43 -06:00
use std::fs::File;
Fallout of std::old_io deprecation
2015-03-11 17:24:14 -05:00
use std::io::prelude::*;
rustdoc: Allowing specifying attrs for doctests This adds support in rustdoc to blanket apply crate attributes to all doc tests for a crate at once. The syntax for doing this is: #![doc(test(attr(...)))] Each meta item in `...` will be applied to each doctest as a crate attribute. cc #18199
2015-04-06 20:39:39 -05:00
use std::io;
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-26 23:00:43 -06:00
use std::path::{PathBuf, Path};
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
use getopts;
use testing;
rustc: Add knowledge of separate lookup paths This commit adds support for the compiler to distinguish between different forms of lookup paths in the compiler itself. Issue #19767 has some background on this topic, as well as some sample bugs which can occur if these lookup paths are not separated. This commits extends the existing command line flag `-L` with the same trailing syntax as the `-l` flag. Each argument to `-L` can now have a trailing `:all`, `:native`, `:crate`, or `:dependency`. This suffix indicates what form of lookup path the compiler should add the argument to. The `dependency` lookup path is used when looking up crate dependencies, the `crate` lookup path is used when looking for immediate dependencies (`extern crate` statements), and the `native` lookup path is used for probing for native libraries to insert into rlibs. Paths with `all` are used for all of these purposes (the default). The default compiler lookup path (the rustlib libdir) is by default added to all of these paths. Additionally, the `RUST_PATH` lookup path is added to all of these paths. Closes #19767
2014-12-16 16:32:02 -06:00
use rustc::session::search_paths::SearchPaths;
Add the notion of a dependency tracking status to commandline arguments. Commandline arguments influence whether incremental compilation can use its compilation cache and thus their changes relative to previous compilation sessions need to be taking into account. This commit makes sure that one has to specify for every commandline argument whether it influences incremental compilation or not.
2016-08-02 15:53:58 -05:00
use rustc::session::config::Externs;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 05:35:25 -05:00
use externalfiles::ExternalHtml;
Move ID generator to a more suited location
2015-12-02 17:06:26 -06:00
use html::render::reset_ids;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
use html::escape::Escape;
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 11:12:18 -05:00
use html::markdown;
Move ID generator to a more suited location
2015-12-02 17:06:26 -06:00
use html::markdown::{Markdown, MarkdownWithToc, find_testable_code};
rustdoc: Allowing specifying attrs for doctests This adds support in rustdoc to blanket apply crate attributes to all doc tests for a crate at once. The syntax for doing this is: #![doc(test(attr(...)))] Each meta item in `...` will be applied to each doctest as a crate attribute. cc #18199
2015-04-06 20:39:39 -05:00
use test::{TestOptions, Collector};
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
/// Separate any lines at the start of the file that begin with `%`.
fn extract_leading_metadata<'a>(s: &'a str) -> (Vec<&'a str>, &'a str) {
let mut metadata = Vec::new();
fix rustdoc metadata parsing
2015-07-30 17:29:34 -05:00
let mut count = 0;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
for line in s.lines() {
if line.starts_with("%") {
// remove %<whitespace>
fix rustdoc metadata parsing
2015-07-30 17:29:34 -05:00
metadata.push(line[1..].trim_left());
count += line.len() + 1;
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
} else {
fix rustdoc metadata parsing
2015-07-30 17:29:34 -05:00
return (metadata, &s[count..]);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
}
}
// if we're here, then all lines were metadata % lines.
(metadata, "")
}
/// Render `input` (e.g. "foo.md") into an HTML file in `output`
/// (e.g. output = "bar" => "bar/foo.html").
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-26 23:00:43 -06:00
pub fn render(input: &str, mut output: PathBuf, matches: &getopts::Matches,
Mass rename uint/int to usize/isize Now that support has been removed, all lingering use cases are renamed.
2015-03-25 19:06:52 -05:00
external_html: &ExternalHtml, include_toc: bool) -> isize {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
let input_p = Path::new(input);
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-26 23:00:43 -06:00
output.push(input_p.file_stem().unwrap());
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
output.set_extension("html");
core: rename strbuf::StrBuf to string::String [breaking-change]
2014-05-22 18:57:53 -05:00
let mut css = String::new();
`for x in xs.iter()` -> `for x in &xs`
2015-01-31 11:20:46 -06:00
for name in &matches.opt_strs("markdown-css") {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
let s = format!("<link rel=\"stylesheet\" type=\"text/css\" href=\"{}\">\n", name);
cleanup: replace `as[_mut]_slice()` calls with deref coercions
2015-02-01 20:53:25 -06:00
css.push_str(&s)
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
}
let input_str = load_or_return!(input, 1, 2);
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 11:12:18 -05:00
let playground = matches.opt_str("markdown-playground-url");
if playground.is_some() {
book: Emit links to play.rust-lang.org to run examples Had to fix a bug in `--markdown-playground-url` for markdown files in rustdoc as well as adding some necessary JS to the rustbook output as well. Closes #21553
2015-04-07 13:23:14 -05:00
markdown::PLAYGROUND_KRATE.with(|s| { *s.borrow_mut() = Some(None); });
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 11:12:18 -05:00
}
let playground = playground.unwrap_or("".to_string());
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
std: Deprecate std::old_io::fs This commit deprecates the majority of std::old_io::fs in favor of std::fs and its new functionality. Some functions remain non-deprecated but are now behind a feature gate called `old_fs`. These functions will be deprecated once suitable replacements have been implemented. The compiler has been migrated to new `std::fs` and `std::path` APIs where appropriate as part of this change.
2015-02-26 23:00:43 -06:00
let mut out = match File::create(&output) {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
Err(e) => {
Fallout of std::old_io deprecation
2015-03-11 17:24:14 -05:00
let _ = writeln!(&mut io::stderr(),
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
"error opening `{}` for writing: {}",
output.display(), e);
return 4;
}
Ok(f) => f
};
cleanup: replace `as[_mut]_slice()` calls with deref coercions
2015-02-01 20:53:25 -06:00
let (metadata, text) = extract_leading_metadata(&input_str);
Positive case of `len()` -> `is_empty()` `s/(?<!\{ self)(?<=\.)len\(\) == 0/is_empty()/g`
2015-03-24 18:53:34 -05:00
if metadata.is_empty() {
Fallout of std::old_io deprecation
2015-03-11 17:24:14 -05:00
let _ = writeln!(&mut io::stderr(),
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
"invalid markdown file: expecting initial line with `% ...TITLE...`");
return 5;
}
cleanup: replace `as[_mut]_slice()` calls with deref coercions
2015-02-01 20:53:25 -06:00
let title = metadata[0];
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
Don't initialize id-map when rendering md files Adding these "known" values to the table of used ids is only required when embedding markdown into a rustdoc html page and may yield unexpected results when rendering a standalone `*.md` file.
2016-03-26 10:42:38 -05:00
reset_ids(false);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 17:43:03 -05:00
let rendered = if include_toc {
format!("{}", MarkdownWithToc(text))
} else {
format!("{}", Markdown(text))
};
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
let err = write!(
&mut out,
doc: CSS fixes - fixup and refactor highlighting code - have a proper print stylesheet
2014-03-09 06:29:25 -05:00
r#"<!DOCTYPE html>
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
<html lang="en">
<head>
<meta charset="utf-8">
Make the Rust Book more mobile friendly
2015-01-12 18:51:31 -06:00
<meta name="viewport" content="width=device-width, initial-scale=1.0">
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
<meta name="generator" content="rustdoc">
<title>{title}</title>
{css}
{in_header}
</head>
rustdoc: Add rustdoc class to <body> tag This allows for easier application of user stylesheets to rustdocs no matter where they are hosted.
2014-08-02 20:20:27 -05:00
<body class="rustdoc">
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
{before_content}
<h1 class="title">{title}</h1>
{text}
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 11:12:18 -05:00
<script type="text/javascript">
window.playgroundUrl = "{playground}";
</script>
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
{after_content}
</body>
</html>"#,
title = Escape(title),
css = css,
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 05:35:25 -05:00
in_header = external_html.in_header,
before_content = external_html.before_content,
rustdoc: make table of contents optional rustdoc currently determines whether to produce a table of contents (along with numbered sections) from the input type: yes for markdown input, no for Rust input. This commit adds a flag to disable the table of contents for markdown input, which is useful for embedding the output in a larger context.
2014-07-23 17:43:03 -05:00
text = rendered,
Allow external html in rustdoc for crates. Updated documentation to reflect md->html. Modularized external file loading.
2014-06-28 05:35:25 -05:00
after_content = external_html.after_content,
rustdoc: Submit examples to play.rust-lang.org This grows a new option inside of rustdoc to add the ability to submit examples to an external website. If the `--markdown-playground-url` command line option or crate doc attribute `html_playground_url` is present, then examples will have a button on hover to submit the code to the playground specified. This commit enables submission of example code to play.rust-lang.org. The code submitted is that which is tested by rustdoc, not necessarily the exact code shown in the example. Closes #14654
2014-06-06 11:12:18 -05:00
playground = playground,
);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
match err {
Err(e) => {
Fallout of std::old_io deprecation
2015-03-11 17:24:14 -05:00
let _ = writeln!(&mut io::stderr(),
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
"error writing to `{}`: {}",
output.display(), e);
6
}
Ok(_) => 0
}
}
/// Run any tests/code examples in the markdown file `input`.
Add the notion of a dependency tracking status to commandline arguments. Commandline arguments influence whether incremental compilation can use its compilation cache and thus their changes relative to previous compilation sessions need to be taking into account. This commit makes sure that one has to specify for every commandline argument whether it influences incremental compilation or not.
2016-08-02 15:53:58 -05:00
pub fn test(input: &str, cfgs: Vec<String>, libs: SearchPaths, externs: Externs,
Mass rename uint/int to usize/isize Now that support has been removed, all lingering use cases are renamed.
2015-03-25 19:06:52 -05:00
mut test_args: Vec<String>) -> isize {
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
let input_str = load_or_return!(input, 1, 2);
rustdoc: Allowing specifying attrs for doctests This adds support in rustdoc to blanket apply crate attributes to all doc tests for a crate at once. The syntax for doing this is: #![doc(test(attr(...)))] Each meta item in `...` will be applied to each doctest as a crate attribute. cc #18199
2015-04-06 20:39:39 -05:00
let mut opts = TestOptions::default();
opts.no_crate_inject = true;
Use --cfg when running doctests Previously passed --cfg was used only when collecting doctests.
2015-12-15 03:03:55 -06:00
let mut collector = Collector::new(input.to_string(), cfgs, libs, externs,
rustdoc: Allowing specifying attrs for doctests This adds support in rustdoc to blanket apply crate attributes to all doc tests for a crate at once. The syntax for doing this is: #![doc(test(attr(...)))] Each meta item in `...` will be applied to each doctest as a crate attribute. cc #18199
2015-04-06 20:39:39 -05:00
true, opts);
cleanup: replace `as[_mut]_slice()` calls with deref coercions
2015-02-01 20:53:25 -06:00
find_testable_code(&input_str, &mut collector);
collections: Deprecate shift/unshift Use insert/remove instead.
2014-07-14 15:54:10 -05:00
test_args.insert(0, "rustdoctest".to_string());
cleanup: replace `as[_mut]_slice()` calls with deref coercions
2015-02-01 20:53:25 -06:00
testing::test_main(&test_args, collector.tests);
rustdoc: run on plain Markdown files. This theoretically gives rustdoc the ability to render our guides, tutorial and manual (not in practice, since the files themselves need to be adjusted slightly to use Sundown-compatible functionality). Fixes #11392.
2014-03-06 21:31:41 -06:00
0
}
Reference in New Issue Copy Permalink