g2dem 0.3.0

`c++filt` clone cli tool for GNU V2 mangled symbols
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

/* SPDX-FileCopyrightText: © 2025 Decompollaborate */
/* SPDX-License-Identifier: MIT OR Apache-2.0 */

#![doc = include_str!("../README.md")]

use std::io::{self, BufRead};

use argp::{FromArgValue, FromArgs};
use gnuv2_demangle::{demangle, DemangleConfig};

pub mod built_info {
    // The file has been placed there by the build script.
    include!(concat!(env!("OUT_DIR"), "/built.rs"));
}

/// GNUv2 C++ symbol demangler
#[derive(FromArgs)]
struct Args {
    /// List of symbols to demangle.
    ///
    /// If no symbols are passed then demangles symbols from stdin. Remember to escape `$`.
    #[argp(positional)]
    syms: Vec<String>,

    /// Demangling flavor. Valid values: {"g2dem", "g", "cfilt", "c"}. Defaults to "g2dem".
    #[argp(option, short = 'm', default = "Mode::default()")]
    mode: Mode,

    /// Print current version information and exit.
    #[argp(switch, short = 'V')]
    version: bool,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
enum Mode {
    #[default]
    G2dem,
    Cfilt,
}

impl FromArgValue for Mode {
    fn from_arg_value(value: &std::ffi::OsStr) -> Result<Self, String> {
        const ERROR: &str = "Valid options are: `g2dem`, `g`, `cfilt` and `c`";

        let value = value.to_str().ok_or_else(|| ERROR.to_string())?;
        match value {
            "g2dem" | "g" => Ok(Self::G2dem),
            "cfilt" | "c" => Ok(Self::Cfilt),
            _ => Err(ERROR.to_string()),
        }
    }
}

fn show_version() {
    let (dirty, hash_short) = if built_info::GIT_DIRTY == Some(true) {
        let hash_short = built_info::GIT_COMMIT_HASH_SHORT.unwrap_or("");
        (" (dirty) ", hash_short)
    } else {
        ("", "")
    };
    println!(
        "{} {}{}{}",
        built_info::PKG_NAME,
        built_info::PKG_VERSION,
        dirty,
        hash_short
    );
    println!();

    if let (Some(git_version), Some(git_hash_short)) =
        (built_info::GIT_VERSION, built_info::GIT_COMMIT_HASH_SHORT)
    {
        // If the current commit is tagged then `git_version` will end with
        // that tag name, otherwise it ends with the short hash.
        if git_version.ends_with(git_hash_short) {
            println!("Untagged git info: {}", git_version);
        } else {
            // empty
        }
    } else {
        println!("No git information?");
    }

    println!("Built time (UTC): {}", built_info::BUILT_TIME_UTC);
    println!("Build profile: {}", built_info::PROFILE);
    println!("Repository: {}", built_info::PKG_REPOSITORY);

    if let Some(ci) = built_info::CI_PLATFORM {
        println!("Built on CI platform: {}", ci);
    } else {
        println!("Built locally.");
    }
}

fn main() {
    let args: Args = argp::parse_args_or_exit(argp::DEFAULT);

    if args.version {
        show_version();
        return;
    }

    let config = match args.mode {
        Mode::G2dem => DemangleConfig::new_g2dem(),
        Mode::Cfilt => DemangleConfig::new_cfilt(),
    };

    if args.syms.is_empty() {
        for line in io::stdin().lock().lines() {
            let line = line.expect("Error reading from stdin");

            if let Ok(demangled) = demangle(&line, &config) {
                println!("{demangled}");
            } else {
                println!("{line}");
            }
        }
    } else {
        for mangled in args.syms {
            if let Ok(demangled) = demangle(&mangled, &config) {
                println!("{demangled}");
            } else {
                println!("{mangled}");
            }
        }
    }
}