Handle notable trait popup differently

GuillaumeGomez · GuillaumeGomez · commit 09102d5efa0b · 2021-12-16T16:47:58.000+01:00
diff --git a/src/librustdoc/html/format.rs b/src/librustdoc/html/format.rs
@@ -79,10 +79,6 @@ impl Buffer {
         self.buffer
     }
 
-    crate fn insert_str(&mut self, idx: usize, s: &str) {
-        self.buffer.insert_str(idx, s);
-    }
-
     crate fn push_str(&mut self, s: &str) {
         self.buffer.push_str(s);
     }
diff --git a/src/librustdoc/html/markdown.rs b/src/librustdoc/html/markdown.rs
@@ -1439,6 +1439,8 @@ fn init_id_map() -> FxHashMap<String, usize> {
     let mut map = FxHashMap::default();
     // This is the list of IDs used in Javascript.
     map.insert("help".to_owned(), 1);
+    // This is the ID used to generate the notable traits popup in Javascript.
+    map.insert("notable-traits-tooltiptext".to_owned(), 1);
     // This is the list of IDs used in HTML generated in Rust (including the ones
     // used in tera template files).
     map.insert("mainThemeStyle".to_owned(), 1);
diff --git a/src/librustdoc/html/render/context.rs b/src/librustdoc/html/render/context.rs
@@ -129,6 +129,9 @@ crate struct SharedContext<'tcx> {
     crate cache: Cache,
 
     crate call_locations: AllCallLocations,
+    /// The key is the notable trait text and the value is its index (we add it in the DOM so the
+    /// JS knows which notable trait to pick).
+    crate notable_traits: RefCell<FxHashMap<(String, String), usize>>,
 }
 
 impl SharedContext<'_> {
@@ -369,6 +372,34 @@ impl<'tcx> Context<'tcx> {
             anchor = anchor
         ))
     }
+
+    fn generate_notable_trait_index(&self, crate_name: &str) -> Result<(), Error> {
+        let notable_traits = self.shared.notable_traits.borrow();
+        if !notable_traits.is_empty() {
+            // This is crate specific.
+            let notable_traits_file = self.dst.join(crate_name).join("notable-traits.js");
+            let out = "window.NOTABLE_TRAITS = [".to_owned();
+
+            // We need to put them back into a vec to sort them by their index.
+            let mut notables = notable_traits.iter().collect::<Vec<_>>();
+            notables.sort_by(|(_, pos1), (_, pos2)| pos1.cmp(pos2));
+
+            let mut out = notables.into_iter().fold(out, |mut acc, ((for_, content), pos)| {
+                if *pos > 0 {
+                    acc.push(',');
+                }
+                acc.push_str(&format!(
+                    "[\"{}\",\"{}\"]",
+                    for_.replace("\"", "\\\""),
+                    content.replace("\\", "\\\\").replace("\"", "\\\""),
+                ));
+                acc
+            });
+            out.push_str("];");
+            self.shared.fs.write(notable_traits_file, out)?;
+        }
+        Ok(())
+    }
 }
 
 /// Generates the documentation for `crate` into the directory `dst`
@@ -493,6 +524,7 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
             span_correspondance_map: matches,
             cache,
             call_locations,
+            notable_traits: RefCell::new(Default::default()),
         };
 
         // Add the default themes to the `Vec` of stylepaths
@@ -549,9 +581,13 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
 
     fn after_krate(&mut self) -> Result<(), Error> {
         let crate_name = self.tcx().crate_name(LOCAL_CRATE);
-        let final_file = self.dst.join(&*crate_name.as_str()).join("all.html");
+        let crate_name = crate_name.as_str();
+        let crate_name: &str = &*crate_name;
+        let final_file = self.dst.join(crate_name).join("all.html");
         let settings_file = self.dst.join("settings.html");
 
+        self.generate_notable_trait_index(crate_name)?;
+
         let mut root_path = self.dst.to_str().expect("invalid path").to_owned();
         if !root_path.ends_with('/') {
             root_path.push('/');
@@ -618,10 +654,9 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> {
         self.shared.fs.write(settings_file, v)?;
         if let Some(ref redirections) = self.shared.redirections {
             if !redirections.borrow().is_empty() {
-                let redirect_map_path =
-                    self.dst.join(&*crate_name.as_str()).join("redirect-map.json");
+                let redirect_map_path = self.dst.join(crate_name).join("redirect-map.json");
                 let paths = serde_json::to_string(&*redirections.borrow()).unwrap();
-                self.shared.ensure_dir(&self.dst.join(&*crate_name.as_str()))?;
+                self.shared.ensure_dir(&self.dst.join(crate_name))?;
                 self.shared.fs.write(redirect_map_path, paths)?;
             }
         }
diff --git a/src/librustdoc/html/render/mod.rs b/src/librustdoc/html/render/mod.rs
@@ -37,6 +37,7 @@ mod write_shared;
 crate use self::context::*;
 crate use self::span_map::{collect_spans_and_sources, LinkFromSrc};
 
+use std::collections::hash_map::Entry;
 use std::collections::VecDeque;
 use std::default::Default;
 use std::fmt;
@@ -1241,7 +1242,8 @@ fn should_render_item(item: &clean::Item, deref_mut_: bool, tcx: TyCtxt<'_>) ->
 }
 
 fn notable_traits_decl(decl: &clean::FnDecl, cx: &Context<'_>) -> String {
-    let mut out = Buffer::html();
+    let mut out_for = Buffer::html();
+    let mut out_content = Buffer::html();
 
     if let Some((did, ty)) = decl.output.as_return().and_then(|t| Some((t.def_id(cx.cache())?, t)))
     {
@@ -1258,29 +1260,38 @@ fn notable_traits_decl(decl: &clean::FnDecl, cx: &Context<'_>) -> String {
                     let trait_did = trait_.def_id();
 
                     if cx.cache().traits.get(&trait_did).map_or(false, |t| t.is_notable) {
-                        if out.is_empty() {
+                        if out_for.is_empty() {
                             write!(
-                                &mut out,
-                                "<div class=\"notable\">Notable traits for {}</div>\
-                             <code class=\"content\">",
-                                impl_.for_.print(cx)
+                                &mut out_for,
+                                "{}",
+                                impl_.for_.print(cx),
+                                //    "<div class=\"notable\">Notable traits for {}</div>\
+                                // <code class=\"content\">",
                             );
                         }
 
                         //use the "where" class here to make it small
                         write!(
-                            &mut out,
+                            &mut out_content,
                             "<span class=\"where fmt-newline\">{}</span>",
                             impl_.print(false, cx)
                         );
                         for it in &impl_.items {
                             if let clean::TypedefItem(ref tydef, _) = *it.kind {
-                                out.push_str("<span class=\"where fmt-newline\">    ");
+                                out_content.push_str("<span class=\"where fmt-newline\">    ");
                                 let empty_set = FxHashSet::default();
                                 let src_link =
                                     AssocItemLink::GotoSource(trait_did.into(), &empty_set);
-                                assoc_type(&mut out, it, &[], Some(&tydef.type_), src_link, "", cx);
-                                out.push_str(";</span>");
+                                assoc_type(
+                                    &mut out_content,
+                                    it,
+                                    &[],
+                                    Some(&tydef.type_),
+                                    src_link,
+                                    "",
+                                    cx,
+                                );
+                                out_content.push_str(";</span>");
                             }
                         }
                     }
@@ -1289,16 +1300,26 @@ fn notable_traits_decl(decl: &clean::FnDecl, cx: &Context<'_>) -> String {
         }
     }
 
-    if !out.is_empty() {
-        out.insert_str(
-            0,
-            "<span class=\"notable-traits\"><span class=\"notable-traits-tooltip\">ⓘ\
-            <div class=\"notable-traits-tooltiptext\"><span class=\"docblock\">",
+    if !out_for.is_empty() && !out_content.is_empty() {
+        let mut notable_traits = cx.shared.notable_traits.borrow_mut();
+
+        let out_for = out_for.into_inner();
+        let out_content = out_content.into_inner();
+        let nb_notable = notable_traits.len();
+        let index = match notable_traits.entry((out_for, out_content)) {
+            Entry::Occupied(o) => *o.get(),
+            Entry::Vacant(v) => {
+                v.insert(nb_notable);
+                nb_notable
+            }
+        };
+        return format!(
+            "<span class=\"notable-traits\"><span class=\"notable-traits-tooltip\" data-index={}>ⓘ</span></span>",
+            index
         );
-        out.push_str("</code></span></div></span></span>");
     }
 
-    out.into_inner()
+    String::new()
 }
 
 #[derive(Clone, Copy, Debug)]
diff --git a/src/librustdoc/html/static/css/rustdoc.css b/src/librustdoc/html/static/css/rustdoc.css
@@ -1268,13 +1268,7 @@ h3.variant {
 	cursor: pointer;
 }
 
-.notable-traits:hover .notable-traits-tooltiptext,
-.notable-traits .notable-traits-tooltiptext.force-tooltip {
-	display: inline-block;
-}
-
-.notable-traits .notable-traits-tooltiptext {
-	display: none;
+#notable-traits-tooltiptext {
 	padding: 5px 3px 3px 3px;
 	border-radius: 6px;
 	margin-left: 5px;
@@ -1296,14 +1290,14 @@ h3.variant {
 	margin: 0;
 }
 
-.notable-traits .notable {
+#notable-traits-tooltiptext .notable {
 	margin: 0;
 	margin-bottom: 13px;
 	font-size: 19px;
 	font-weight: 600;
 }
 
-.notable-traits .docblock code.content{
+#notable-traits-tooltiptext code.content{
 	margin: 0;
 	padding: 0;
 	font-size: 20px;
@@ -1965,7 +1959,7 @@ details.rustdoc-toggle[open] > summary.hideme::after {
 		margin-top: 0;
 	}
 
-	.notable-traits .notable-traits-tooltiptext {
+	.notable-traits {
 		left: 0;
 		top: 100%;
 	}
diff --git a/src/librustdoc/html/static/css/themes/ayu.css b/src/librustdoc/html/static/css/themes/ayu.css
@@ -415,12 +415,12 @@ pre.ignore:hover, .information:hover + pre.ignore {
 	border-color: transparent #314559 transparent transparent;
 }
 
-.notable-traits-tooltiptext {
+#notable-traits-tooltiptext {
 	background-color: #314559;
 	border-color: #5c6773;
 }
 
-.notable-traits-tooltiptext .notable {
+#notable-traits-tooltiptext .notable {
 	border-bottom-color: #5c6773;
 }
 
diff --git a/src/librustdoc/html/static/css/themes/dark.css b/src/librustdoc/html/static/css/themes/dark.css
@@ -363,12 +363,12 @@ pre.ignore:hover, .information:hover + pre.ignore {
 	border-color: transparent black transparent transparent;
 }
 
-.notable-traits-tooltiptext {
+#notable-traits-tooltiptext {
 	background-color: #111;
 	border-color: #777;
 }
 
-.notable-traits-tooltiptext .notable {
+#notable-traits-tooltiptext .notable {
 	border-bottom-color: #d2d2d2;
 }
 
diff --git a/src/librustdoc/html/static/css/themes/light.css b/src/librustdoc/html/static/css/themes/light.css
@@ -349,12 +349,12 @@ pre.ignore:hover, .information:hover + pre.ignore {
 	border-color: transparent black transparent transparent;
 }
 
-.notable-traits-tooltiptext {
+#notable-traits-tooltiptext {
 	background-color: #eee;
 	border-color: #999;
 }
 
-.notable-traits-tooltiptext .notable {
+#notable-traits-tooltiptext .notable {
 	border-bottom-color: #DDDDDD;
 }
 
diff --git a/src/librustdoc/html/static/js/main.js b/src/librustdoc/html/static/js/main.js
@@ -171,6 +171,13 @@ function hideThemeButtonState() {
 (function() {
     "use strict";
 
+    function loadScript(url, callback) {
+        var script = document.createElement('script');
+        script.src = url;
+        script.onload = callback;
+        document.head.append(script);
+    }
+
     window.searchState = {
         loadingText: "Loading search results...",
         input: document.getElementsByClassName("search-input")[0],
@@ -254,11 +261,6 @@ function hideThemeButtonState() {
             if (!searchState.input) {
                 return;
             }
-            function loadScript(url) {
-                var script = document.createElement('script');
-                script.src = url;
-                document.head.append(script);
-            }
 
             var searchLoaded = false;
             function loadSearch() {
@@ -910,13 +912,6 @@ function hideThemeButtonState() {
         });
     });
 
-    onEachLazy(document.getElementsByClassName("notable-traits"), function(e) {
-        e.onclick = function() {
-            this.getElementsByClassName('notable-traits-tooltiptext')[0]
-                .classList.toggle("force-tooltip");
-        };
-    });
-
     var sidebar_menu = document.getElementsByClassName("sidebar-menu")[0];
     if (sidebar_menu) {
         sidebar_menu.onclick = function() {
@@ -1010,6 +1005,62 @@ function hideThemeButtonState() {
     onHashChange(null);
     window.addEventListener("hashchange", onHashChange);
     searchState.setup();
+
+    //
+    // Handling the notable traits popup.
+    //
+    function getNotablePopup(callback) {
+        var elemId = "notable-traits-tooltiptext";
+        var elem = document.getElementById(elemId);
+
+        if (!elem) {
+            // If the element cannot be found, it means it hasn't been created yet and that the
+            // notable traits index wasn't loaded either.
+            var script = getVar("root-path") + window.currentCrate + "/notable-traits.js";
+            loadScript(script, function() {
+                elem = document.createElement("code");
+                elem.id = elemId;
+                elem.classList = "docblock";
+                main.appendChild(elem);
+                callback(elem);
+            });
+            return;
+        }
+        callback(elem);
+    }
+    function showNotableTraitPopup(elem) {
+        getNotablePopup(function(popup) {
+            if (elem === window.currentNotableElem) {
+                popup.style.display = "none";
+                window.currentNotableElem = null;
+                return;
+            }
+            var elemRect = elem.getBoundingClientRect();
+            var containerRect = main.getBoundingClientRect();
+
+            var index = elem.getAttribute("data-index");
+            var notableTrait = window.NOTABLE_TRAITS[parseInt(index)];
+
+            popup.innerHTML = "<div class=\"notable\">Notable traits for " + notableTrait[0] + "</div><code class=\"content\">" + notableTrait[1] + "</code>";
+            popup.style.top = (elemRect.top - containerRect.top) + "px";
+            // In here, if the "i" is too much on the right, better put the popup on its left.
+            if (elem.offsetLeft > main.offsetWidth / 2) {
+                popup.style.left = "";
+                popup.style.right = (main.offsetWidth - elem.offsetLeft + 2) + "px";
+            } else {
+                popup.style.right = "";
+                popup.style.left = (elem.offsetLeft + 12) + "px";
+            }
+            popup.style.display = "";
+            window.currentNotableElem = elem;
+        });
+    }
+
+    onEachLazy(document.getElementsByClassName("notable-traits-tooltip"), function(e) {
+        e.onclick = function() {
+            showNotableTraitPopup(this);
+        };
+    });
 }());
 
 (function () {

Original file line number	Diff line number	Diff line change
`@@ -79,10 +79,6 @@ impl Buffer {`
`79`	`79`	`self.buffer`
`80`	`80`	`}`
`81`	`81`
`82`		`- crate fn insert_str(&mut self, idx: usize, s: &str) {`
`83`		`- self.buffer.insert_str(idx, s);`
`84`		`- }`
`85`		`-`
`86`	`82`	`crate fn push_str(&mut self, s: &str) {`
`87`	`83`	`self.buffer.push_str(s);`
`88`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -415,12 +415,12 @@ pre.ignore:hover, .information:hover + pre.ignore {`
`415`	`415`	`border-color: transparent #314559 transparent transparent;`
`416`	`416`	`}`
`417`	`417`
`418`		`-.notable-traits-tooltiptext {`
	`418`	`+#notable-traits-tooltiptext {`
`419`	`419`	`background-color: #314559;`
`420`	`420`	`border-color: #5c6773;`
`421`	`421`	`}`
`422`	`422`
`423`		`-.notable-traits-tooltiptext .notable {`
	`423`	`+#notable-traits-tooltiptext .notable {`
`424`	`424`	`border-bottom-color: #5c6773;`
`425`	`425`	`}`
`426`	`426`
Original file line number	Diff line number	Diff line change
`@@ -363,12 +363,12 @@ pre.ignore:hover, .information:hover + pre.ignore {`
`363`	`363`	`border-color: transparent black transparent transparent;`
`364`	`364`	`}`
`365`	`365`
`366`		`-.notable-traits-tooltiptext {`
	`366`	`+#notable-traits-tooltiptext {`
`367`	`367`	`background-color: #111;`
`368`	`368`	`border-color: #777;`
`369`	`369`	`}`
`370`	`370`
`371`		`-.notable-traits-tooltiptext .notable {`
	`371`	`+#notable-traits-tooltiptext .notable {`
`372`	`372`	`border-bottom-color: #d2d2d2;`
`373`	`373`	`}`
`374`	`374`
Original file line number	Diff line number	Diff line change
`@@ -349,12 +349,12 @@ pre.ignore:hover, .information:hover + pre.ignore {`
`349`	`349`	`border-color: transparent black transparent transparent;`
`350`	`350`	`}`
`351`	`351`
`352`		`-.notable-traits-tooltiptext {`
	`352`	`+#notable-traits-tooltiptext {`
`353`	`353`	`background-color: #eee;`
`354`	`354`	`border-color: #999;`
`355`	`355`	`}`
`356`	`356`
`357`		`-.notable-traits-tooltiptext .notable {`
	`357`	`+#notable-traits-tooltiptext .notable {`
`358`	`358`	`border-bottom-color: #DDDDDD;`
`359`	`359`	`}`
`360`	`360`