cargo-valgrind 2.4.1

A cargo subcommand for running valgrind
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

//! Provides the panic handling neceises.
//!
//! This module allows to customize the panicking of the application. First, it
//! changes the normal panic handler to print a custom message, that guides the
//! user to the bug tracker. Secondly, the panic message presented will change
//! depending on the payload-type. If that panic is an implementation bug, some
//! addition information is printed (e.g. for [`Error::MalformedOutput`]).
//!
//! [`Error::MalformedOutput`]: crate::valgrind::Error::MalformedOutput
#![allow(clippy::module_name_repetitions)]

use crate::valgrind::Error;
use std::panic;

/// The header used in the custom panic message.
///
/// Every panic is prefixed with this string (but formatting might be applied).
/// After that text, some more panic information is printed.
const PANIC_HEADER: &str = "
    Oooops. cargo valgrind unexpectedly crashed. This is a bug!

    This is an error in this program, which should be fixed. If you can, \
    please submit a bug report at

        https://github.com/jfrimmel/cargo-valgrind/issues/new/choose

    To make fixing the error more easy, please provide the information below \
    as well as additional information on which project the error occurred or \
    how to reproduce it.
    ";

/// Replaces any previous hook with the custom hook of this application.
///
/// This custom hook points the user to the project repository and asks them to
/// open a bug report.
pub fn replace_hook() {
    let old_hook = panic::take_hook();
    panic::set_hook(Box::new(move |panic| {
        #[cfg(not(feature = "textwrap"))]
        let text = PANIC_HEADER;
        #[cfg(feature = "textwrap")]
        let text = textwrap::wrap(
            textwrap::dedent(PANIC_HEADER).trim_start(),
            textwrap::Options::with_termwidth(),
        )
        .join("\n");
        eprintln!("{text}");

        eprintln!(
            "{}: version {}",
            env!("CARGO_PKG_NAME"),
            env!("CARGO_PKG_VERSION")
        );

        // intentionally not wrapped using `textwrap`, since own formatting
        // might be applied.
        if let Some(Error::MalformedOutput(e, content)) = panic.payload().downcast_ref() {
            eprintln!("XML format mismatch between `valgrind` and `cargo valgrind`: {e}");
            eprintln!(
                "XML output of valgrind:\n```xml\n{}```",
                String::from_utf8_lossy(content)
            );
        } else {
            old_hook(panic);
        }
    }));
}