2 use crate::docfs::PathError;
3 use crate::error::Error;
4 use crate::html::format::Buffer;
5 use crate::html::highlight;
6 use crate::html::layout;
7 use crate::html::render::{Context, BASIC_KEYWORDS};
8 use crate::visit::DocVisitor;
10 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
11 use rustc_hir::def_id::LOCAL_CRATE;
12 use rustc_middle::ty::TyCtxt;
13 use rustc_session::Session;
14 use rustc_span::edition::Edition;
15 use rustc_span::source_map::FileName;
19 use std::path::{Component, Path, PathBuf};
22 pub(crate) fn render(cx: &mut Context<'_>, krate: &clean::Crate) -> Result<(), Error> {
23 info!("emitting source files");
25 let dst = cx.dst.join("src").join(krate.name(cx.tcx()).as_str());
26 cx.shared.ensure_dir(&dst)?;
28 let mut collector = SourceCollector { dst, cx, emitted_local_sources: FxHashSet::default() };
29 collector.visit_crate(krate);
33 pub(crate) fn collect_local_sources<'tcx>(
37 ) -> FxHashMap<PathBuf, String> {
38 let mut lsc = LocalSourcesCollector { tcx, local_sources: FxHashMap::default(), src_root };
39 lsc.visit_crate(krate);
43 struct LocalSourcesCollector<'a, 'tcx> {
45 local_sources: FxHashMap<PathBuf, String>,
49 fn is_real_and_local(span: clean::Span, sess: &Session) -> bool {
50 span.cnum(sess) == LOCAL_CRATE && span.filename(sess).is_real()
53 impl LocalSourcesCollector<'_, '_> {
54 fn add_local_source(&mut self, item: &clean::Item) {
55 let sess = self.tcx.sess;
56 let span = item.span(self.tcx);
57 // skip all synthetic "files"
58 if !is_real_and_local(span, sess) {
61 let filename = span.filename(sess);
62 let p = if let FileName::Real(file) = filename {
63 match file.into_local_path() {
70 if self.local_sources.contains_key(&*p) {
71 // We've already emitted this source
75 let mut href = String::new();
76 clean_path(self.src_root, &p, false, |component| {
77 href.push_str(&component.to_string_lossy());
81 let mut src_fname = p.file_name().expect("source has no filename").to_os_string();
82 src_fname.push(".html");
83 href.push_str(&src_fname.to_string_lossy());
84 self.local_sources.insert(p, href);
88 impl DocVisitor for LocalSourcesCollector<'_, '_> {
89 fn visit_item(&mut self, item: &clean::Item) {
90 self.add_local_source(item);
92 self.visit_item_recur(item)
96 /// Helper struct to render all source code to HTML pages
97 struct SourceCollector<'a, 'tcx> {
98 cx: &'a mut Context<'tcx>,
100 /// Root destination to place all HTML output into
102 emitted_local_sources: FxHashSet<PathBuf>,
105 impl DocVisitor for SourceCollector<'_, '_> {
106 fn visit_item(&mut self, item: &clean::Item) {
107 if !self.cx.include_sources {
111 let tcx = self.cx.tcx();
112 let span = item.span(tcx);
115 // If we're not rendering sources, there's nothing to do.
116 // If we're including source files, and we haven't seen this file yet,
117 // then we need to render it out to the filesystem.
118 if is_real_and_local(span, sess) {
119 let filename = span.filename(sess);
120 let span = span.inner();
121 let pos = sess.source_map().lookup_source_file(span.lo());
122 let file_span = span.with_lo(pos.start_pos).with_hi(pos.end_pos);
123 // If it turns out that we couldn't read this file, then we probably
124 // can't read any of the files (generating html output from json or
125 // something like that), so just don't include sources for the
126 // entire crate. The other option is maintaining this mapping on a
127 // per-file basis, but that's probably not worth it...
128 self.cx.include_sources = match self.emit_source(&filename, file_span) {
131 self.cx.shared.tcx.sess.span_err(
134 "failed to render source code for `{}`: {}",
135 filename.prefer_local(),
144 self.visit_item_recur(item)
148 impl SourceCollector<'_, '_> {
149 /// Renders the given filename into its corresponding HTML source file.
153 file_span: rustc_span::Span,
154 ) -> Result<(), Error> {
155 let p = match *filename {
156 FileName::Real(ref file) => {
157 if let Some(local_path) = file.local_path() {
158 local_path.to_path_buf()
160 unreachable!("only the current crate should have sources emitted");
165 if self.emitted_local_sources.contains(&*p) {
166 // We've already emitted this source
170 let contents = match fs::read_to_string(&p) {
171 Ok(contents) => contents,
173 return Err(Error::new(e, &p));
177 // Remove the utf-8 BOM if any
178 let contents = contents.strip_prefix('\u{feff}').unwrap_or(&contents);
180 let shared = Rc::clone(&self.cx.shared);
181 // Create the intermediate directories
182 let mut cur = self.dst.clone();
183 let mut root_path = String::from("../../");
184 clean_path(&shared.src_root, &p, false, |component| {
186 root_path.push_str("../");
189 shared.ensure_dir(&cur)?;
191 let src_fname = p.file_name().expect("source has no filename").to_os_string();
192 let mut fname = src_fname.clone();
196 let title = format!("{} - source", src_fname.to_string_lossy());
197 let desc = format!("Source of the Rust file `{}`.", filename.prefer_remapped());
198 let page = layout::Page {
201 root_path: &root_path,
202 static_root_path: shared.static_root_path.as_deref(),
204 keywords: BASIC_KEYWORDS,
205 resource_suffix: &shared.resource_suffix,
206 extra_scripts: &[&format!("source-files{}", shared.resource_suffix)],
207 static_extra_scripts: &[&format!("source-script{}", shared.resource_suffix)],
209 let v = layout::render(
214 let cx = &mut self.cx;
223 SourceContext::Standalone,
228 shared.fs.write(cur, v)?;
229 self.emitted_local_sources.insert(p);
234 /// Takes a path to a source file and cleans the path to it. This canonicalizes
235 /// things like ".." to components which preserve the "top down" hierarchy of a
236 /// static HTML tree. Each component in the cleaned path will be passed as an
237 /// argument to `f`. The very last component of the path (ie the file name) will
238 /// be passed to `f` if `keep_filename` is true, and ignored otherwise.
239 pub(crate) fn clean_path<F>(src_root: &Path, p: &Path, keep_filename: bool, mut f: F)
243 // make it relative, if possible
244 let p = p.strip_prefix(src_root).unwrap_or(p);
246 let mut iter = p.components().peekable();
248 while let Some(c) = iter.next() {
249 if !keep_filename && iter.peek().is_none() {
254 Component::ParentDir => f("up".as_ref()),
255 Component::Normal(c) => f(c),
261 pub(crate) enum SourceContext {
263 Embedded { offset: usize },
266 /// Wrapper struct to render the source code of a file. This will do things like
267 /// adding line numbers to the left-hand side.
268 pub(crate) fn print_src(
272 file_span: rustc_span::Span,
273 context: &Context<'_>,
275 decoration_info: Option<highlight::DecorationInfo>,
276 source_context: SourceContext,
278 let lines = s.lines().count();
279 let mut line_numbers = Buffer::empty_from(buf);
280 line_numbers.write_str("<pre class=\"line-numbers\">");
281 match source_context {
282 SourceContext::Standalone => {
283 for line in 1..=lines {
284 writeln!(line_numbers, "<span id=\"{0}\">{0}</span>", line)
287 SourceContext::Embedded { offset } => {
288 for line in 1..=lines {
289 writeln!(line_numbers, "<span>{0}</span>", line + offset)
293 line_numbers.write_str("</pre>");
294 highlight::render_with_highlighting(
302 Some(highlight::ContextInfo { context, file_span, root_path }),