Implement --source-code-external-url option

Author: GuillaumeGomez

src/librustdoc/config.rs

@@ -220,6 +220,8 @@ pub struct RenderOptions {
     pub generate_search_filter: bool,
     /// Option (disabled by default) to generate files used by RLS and some other tools.
     pub generate_redirect_pages: bool,
+    /// Base URL to use for source code linking.
+    pub source_code_external_url: Option<String>,
 }
 
 impl Options {
@@ -496,6 +498,21 @@ impl Options {
         let enable_per_target_ignores = matches.opt_present("enable-per-target-ignores");
         let document_private = matches.opt_present("document-private-items");
         let document_hidden = matches.opt_present("document-hidden-items");
+        let source_code_external_url = matches.opt_str("source-code-external-url").map(|mut h| {
+            if !h.ends_with('/') {
+                h.push('/');
+            }
+            h
+        });
+        if let Some(ref source_code_external_url) = source_code_external_url {
+            if !source_code_external_url.starts_with("http://")
+                && !source_code_external_url.starts_with("https://")
+            {
+                diag.struct_err("option `--source-code-external-url` argument must be an URL")
+                    .emit();
+                return Err(1);
+            }
+        }
 
         let (lint_opts, describe_lints, lint_cap) = get_cmd_lint_options(matches, error_format);
 
@@ -552,6 +569,7 @@ impl Options {
                 markdown_playground_url,
                 generate_search_filter,
                 generate_redirect_pages,
+                source_code_external_url,
             },
         })
     }

src/librustdoc/html/render.rs

@@ -200,6 +200,7 @@ crate struct SharedContext {
     /// The default edition used to parse doctests.
     pub edition: Edition,
     pub codes: ErrorCodes,
+    pub source_code_external_url: Option<String>,
     playground: Option<markdown::Playground>,
 }
 
@@ -409,6 +410,7 @@ pub fn run(
         static_root_path,
         generate_search_filter,
         generate_redirect_pages,
+        source_code_external_url,
         ..
     } = options;
 
@@ -467,6 +469,7 @@ pub fn run(
         collapsed: krate.collapsed,
         src_root,
         include_sources,
+        source_code_external_url,
         local_sources: Default::default(),
         issue_tracker_base_url,
         layout,
@@ -1602,13 +1605,23 @@ impl Context {
         } else {
             format!("{}-{}", item.source.loline, item.source.hiline)
         };
-        Some(format!(
-            "{root}src/{krate}/{path}#{lines}",
-            root = Escape(&root),
-            krate = krate,
-            path = path,
-            lines = lines
-        ))
+        if let Some(ref source_code_external_url) = self.shared.source_code_external_url {
+            Some(format!(
+                "{root}{krate}/{path}#{lines}",
+                root = source_code_external_url,
+                krate = krate,
+                path = path,
+                lines = lines
+            ))
+        } else {
+            Some(format!(
+                "{root}src/{krate}/{path}#{lines}",
+                root = Escape(&root),
+                krate = krate,
+                path = path,
+                lines = lines
+            ))
+        }
     }
 }
 

src/librustdoc/html/sources.rs

@@ -74,17 +74,6 @@ impl<'a> SourceCollector<'a> {
             return Ok(());
         }
 
-        let contents = match fs::read_to_string(&p) {
-            Ok(contents) => contents,
-            Err(e) => {
-                return Err(Error::new(e, &p));
-            }
-        };
-
-        // Remove the utf-8 BOM if any
-        let contents =
-            if contents.starts_with("\u{feff}") { &contents[3..] } else { &contents[..] };
-
         // Create the intermediate directories
         let mut cur = self.dst.clone();
         let mut root_path = String::from("../../");
@@ -101,30 +90,44 @@ impl<'a> SourceCollector<'a> {
         cur.push(&fname);
         href.push_str(&fname.to_string_lossy());
 
-        let title = format!(
-            "{} -- source",
-            cur.file_name().expect("failed to get file name").to_string_lossy()
-        );
-        let desc = format!("Source to the Rust file `{}`.", filename);
-        let page = layout::Page {
-            title: &title,
-            css_class: "source",
-            root_path: &root_path,
-            static_root_path: self.scx.static_root_path.as_deref(),
-            description: &desc,
-            keywords: BASIC_KEYWORDS,
-            resource_suffix: &self.scx.resource_suffix,
-            extra_scripts: &[&format!("source-files{}", self.scx.resource_suffix)],
-            static_extra_scripts: &[&format!("source-script{}", self.scx.resource_suffix)],
-        };
-        let v = layout::render(
-            &self.scx.layout,
-            &page,
-            "",
-            |buf: &mut _| print_src(buf, &contents),
-            &self.scx.themes,
-        );
-        self.scx.fs.write(&cur, v.as_bytes())?;
+        // we don't emit source if we have an external location for it
+        if self.scx.source_code_external_url.is_none() {
+            let contents = match fs::read_to_string(&p) {
+                Ok(contents) => contents,
+                Err(e) => {
+                    return Err(Error::new(e, &p));
+                }
+            };
+
+            // Remove the utf-8 BOM if any
+            let contents =
+                if contents.starts_with("\u{feff}") { &contents[3..] } else { &contents[..] };
+
+            let title = format!(
+                "{} -- source",
+                cur.file_name().expect("failed to get file name").to_string_lossy()
+            );
+            let desc = format!("Source to the Rust file `{}`.", filename);
+            let page = layout::Page {
+                title: &title,
+                css_class: "source",
+                root_path: &root_path,
+                static_root_path: self.scx.static_root_path.as_deref(),
+                description: &desc,
+                keywords: BASIC_KEYWORDS,
+                resource_suffix: &self.scx.resource_suffix,
+                extra_scripts: &[&format!("source-files{}", self.scx.resource_suffix)],
+                static_extra_scripts: &[&format!("source-script{}", self.scx.resource_suffix)],
+            };
+            let v = layout::render(
+                &self.scx.layout,
+                &page,
+                "",
+                |buf: &mut _| print_src(buf, &contents),
+                &self.scx.themes,
+            );
+            self.scx.fs.write(&cur, v.as_bytes())?;
+        }
         self.scx.local_sources.insert(p.clone(), href);
         Ok(())
     }

src/librustdoc/lib.rs

@@ -418,6 +418,14 @@ fn opts() -> Vec<RustcOptGroup> {
                 "specified the rustc-like binary to use as the test builder",
             )
         }),
+        unstable("source-code-external-url", |o| {
+            o.optopt(
+                "",
+                "source-code-external-url",
+                "Base URL for external source code linking",
+                "URL",
+            )
+        }),
     ]
 }