Skip to content

Commit 79f888d

Browse files
GuillaumeGomezGuillaumeGomez
committed
Add arrow and improve display
1 parent 9c12e5d commit 79f888d

File tree

6 files changed

+98
-36
lines changed

6 files changed

+98
-36
lines changed

‎src/librustdoc/html/highlight.rs

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
2323
use html::escape::Escape;
2424

25-
use std::collections::HashMap;
2625
use std::fmt::Display;
2726
use std::io;
2827
use std::io::prelude::*;
@@ -36,7 +35,7 @@ use syntax_pos::Span;
3635
/// Highlights `src`, returning the HTML output.
3736
pub fn render_with_highlighting(src: &str, class: Option<&str>, id: Option<&str>,
3837
extension: Option<&str>,
39-
extras: Option<HashMap<String, String>>) -> String {
38+
tooltip: Option<(&str, &str)>) -> String {
4039
debug!("highlighting: ================\n{}\n==============", src);
4140
let sess = parse::ParseSess::new(FilePathMapping::empty());
4241
let fm = sess.codemap().new_filemap("<stdin>".to_string(), src.to_string());
@@ -396,18 +395,12 @@ impl Class {
396395

397396
fn write_header(class: Option<&str>,
398397
id: Option<&str>,
399-
out: &mut Write,
400-
extras: Option<HashMap<String, String>>)
398+
out: &mut Write)
401399
-> io::Result<()> {
402400
write!(out, "<pre ")?;
403401
if let Some(id) = id {
404402
write!(out, "id='{}' ", id)?;
405403
}
406-
if let Some(extras) = extras {
407-
for (key, value) in &extras {
408-
write!(out, "{}=\"{}\" ", key, value)?;
409-
}
410-
}
411404
write!(out, "class=\"rust {}\">\n", class.unwrap_or(""))
412405
}
413406

‎src/librustdoc/html/markdown.rs

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -225,16 +225,10 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'a, I> {
225225
url, test_escaped, channel
226226
))
227227
});
228-
let title = if ignore {
229-
let mut tmp = HashMap::new();
230-
tmp.insert("title".to_owned(),
231-
"Be careful when using this code, it's not being tested!".to_owned());
232-
Some(tmp)
228+
let tooltip = if ignore {
229+
Some(("Be careful when using this code, it's not being tested!", "ignore"))
233230
} else if compile_fail {
234-
let mut tmp = HashMap::new();
235-
tmp.insert("title".to_owned(),
236-
"This code doesn't compile so be extra careful!".to_owned());
237-
Some(tmp)
231+
Some(("This code doesn't compile so be extra careful!", "compile_fail"))
238232
} else {
239233
None
240234
};
@@ -246,7 +240,7 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'a, I> {
246240
else { "" })),
247241
None,
248242
playground_button.as_ref().map(String::as_str),
249-
title));
243+
tooltip));
250244
Some(Event::Html(s.into()))
251245
})
252246
}
@@ -642,18 +636,10 @@ pub fn render(w: &mut fmt::Formatter,
642636
url, test_escaped, channel
643637
))
644638
});
645-
let title = if ignore {
646-
let mut tmp = HashMap::new();
647-
tmp.insert("title".to_owned(),
648-
"Be careful when using this code, it's not being \
649-
tested!".to_owned());
650-
Some(tmp)
639+
let tooltip = if ignore {
640+
Some(("Be careful when using this code, it's not being tested!", "ignore"))
651641
} else if compile_fail {
652-
let mut tmp = HashMap::new();
653-
tmp.insert("title".to_owned(),
654-
"This code doesn't compile so be extra \
655-
careful!".to_owned());
656-
Some(tmp)
642+
Some(("This code doesn't compile so be extra careful!", "compile_fail"))
657643
} else {
658644
None
659645
};
@@ -665,7 +651,7 @@ pub fn render(w: &mut fmt::Formatter,
665651
else { "" })),
666652
None,
667653
playground_button.as_ref().map(String::as_str),
668-
title));
654+
tooltip));
669655
hoedown_buffer_put(ob, s.as_ptr(), s.len());
670656
})
671657
}

‎src/librustdoc/html/render.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3679,7 +3679,8 @@ impl<'a> fmt::Display for Source<'a> {
36793679
write!(fmt, "<span id=\"{0}\">{0:1$}</span>\n", i, cols)?;
36803680
}
36813681
write!(fmt, "</pre>")?;
3682-
write!(fmt, "{}", highlight::render_with_highlighting(s, None, None, None, None))?;
3682+
write!(fmt, "{}",
3683+
highlight::render_with_highlighting(s, None, None, None, None))?;
36833684
Ok(())
36843685
}
36853686
}

‎src/librustdoc/html/static/main.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1296,6 +1296,24 @@
12961296
collapseDocs(i_e.previousSibling.childNodes[0]);
12971297
});
12981298
});
1299+
1300+
onEach(document.getElementsByClassName('rust-example-rendered'), function(e) {
1301+
if (hasClass(e, 'compile_fail')) {
1302+
e.addEventListener("mouseover", function(event) {
1303+
e.previousElementSibling.childNodes[0].style.color = '#f00';
1304+
});
1305+
e.addEventListener("mouseout", function(event) {
1306+
e.previousElementSibling.childNodes[0].style.color = '';
1307+
});
1308+
} else if (hasClass(e, 'ignore')) {
1309+
e.addEventListener("mouseover", function(event) {
1310+
e.previousElementSibling.childNodes[0].style.color = '#ff9200';
1311+
});
1312+
e.addEventListener("mouseout", function(event) {
1313+
e.previousElementSibling.childNodes[0].style.color = '';
1314+
});
1315+
}
1316+
});
12991317
}());
13001318

13011319
// Sets the focus on the search bar at the top of the page

‎src/librustdoc/html/static/rustdoc.css

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,6 @@ pre.rust .question-mark {
612612
font-weight: bold;
613613
}
614614

615-
pre.rust { position: relative; }
616615
a.test-arrow {
617616
display: inline-block;
618617
position: absolute;
@@ -813,3 +812,44 @@ span.since {
813812
display: none;
814813
}
815814
}
815+
816+
.information {
817+
position: absolute;
818+
left: -1px;
819+
margin-top: 7px;
820+
}
821+
822+
.tooltip {
823+
position: relative;
824+
display: inline-block;
825+
cursor: pointer;
826+
}
827+
828+
.tooltip .tooltiptext {
829+
width: 120px;
830+
display: none;
831+
background-color: black;
832+
color: #fff;
833+
text-align: center;
834+
padding: 5px 3px;
835+
border-radius: 6px;
836+
margin-left: 5px;
837+
top: -5px;
838+
left: 105%;
839+
z-index: 1;
840+
}
841+
842+
.tooltip:hover .tooltiptext {
843+
display: inline;
844+
}
845+
846+
.tooltip .tooltiptext::after {
847+
content: " ";
848+
position: absolute;
849+
top: 50%;
850+
left: 11px;
851+
margin-top: -5px;
852+
border-width: 5px;
853+
border-style: solid;
854+
border-color: transparent black transparent transparent;
855+
}

‎src/librustdoc/html/static/styles/main.css

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -205,9 +205,33 @@ a.test-arrow:hover{
205205
}
206206

207207
pre.compile_fail {
208-
box-shadow: -6px 0 5px -3px #f00;
208+
border-left: 2px solid rgba(255,0,0,.4);
209+
}
210+
211+
pre.compile_fail:hover, .information:hover + pre.compile_fail {
212+
border-left: 2px solid #f00;
209213
}
210214

211215
pre.ignore {
212-
box-shadow: -6px 0 5px -3px #ff9200;
213-
}
216+
border-left: 2px solid rgba(255,142,0,.4);
217+
}
218+
219+
pre.ignore:hover, .information:hover + pre.ignore {
220+
border-left: 2px solid #ff9200;
221+
}
222+
223+
.tooltip.compile_fail {
224+
color: rgba(255,0,0,.3);
225+
}
226+
227+
.information > .compile_fail:hover {
228+
color: #f00;
229+
}
230+
231+
.tooltip.ignore {
232+
color: rgba(255,142,0,.3);
233+
}
234+
235+
.information > .ignore:hover {
236+
color: rgba(255,142,0,1);
237+
}

0 commit comments

Comments
 (0)