1 //! Detecting usage of the `#[debugger_visualizer]` attribute.
4 use rustc_data_structures::fx::FxHashSet;
5 use rustc_expand::base::resolve_path;
7 use rustc_hir::def_id::CrateNum;
9 use rustc_middle::ty::query::Providers;
10 use rustc_middle::ty::TyCtxt;
11 use rustc_span::def_id::LOCAL_CRATE;
12 use rustc_span::{sym, DebuggerVisualizerFile, DebuggerVisualizerType};
16 fn check_for_debugger_visualizer<'tcx>(
19 debugger_visualizers: &mut FxHashSet<DebuggerVisualizerFile>,
21 let attrs = tcx.hir().attrs(hir_id);
23 if attr.has_name(sym::debugger_visualizer) {
24 let Some(list) = attr.meta_item_list() else {
28 let meta_item = match list.len() {
29 1 => match list[0].meta_item() {
30 Some(meta_item) => meta_item,
36 let visualizer_type = match meta_item.name_or_empty() {
37 sym::natvis_file => DebuggerVisualizerType::Natvis,
38 sym::gdb_script_file => DebuggerVisualizerType::GdbPrettyPrinter,
42 let file = match meta_item.value_str() {
44 match resolve_path(&tcx.sess.parse_sess, value.as_str(), attr.span) {
52 match std::fs::read(&file) {
55 .insert(DebuggerVisualizerFile::new(Arc::from(contents), visualizer_type));
61 &format!("couldn't read {}: {}", file.display(), err),
70 /// Traverses and collects the debugger visualizers for a specific crate.
71 fn debugger_visualizers<'tcx>(tcx: TyCtxt<'tcx>, cnum: CrateNum) -> Vec<DebuggerVisualizerFile> {
72 assert_eq!(cnum, LOCAL_CRATE);
74 // Initialize the collector.
75 let mut debugger_visualizers = FxHashSet::default();
77 // Collect debugger visualizers in this crate.
78 tcx.hir().for_each_module(|id| {
79 check_for_debugger_visualizer(
81 tcx.hir().local_def_id_to_hir_id(id),
82 &mut debugger_visualizers,
86 // Collect debugger visualizers on the crate attributes.
87 check_for_debugger_visualizer(tcx, CRATE_HIR_ID, &mut debugger_visualizers);
89 // Extract out the found debugger_visualizer items.
90 let mut visualizers = debugger_visualizers.into_iter().collect::<Vec<_>>();
92 // Sort the visualizers so we always get a deterministic query result.
97 pub fn provide(providers: &mut Providers) {
98 providers.debugger_visualizers = debugger_visualizers;