Compare commits

...

10 Commits
v0.1.3 ... main

Author SHA1 Message Date
Luke Street b86dcc3483 Add version to cwdemangle dep in bin 2024-03-13 17:34:46 -06:00
Luke Street 852fb537c4 Separate lib/bin, update README.md, release v1.0.0 2024-03-13 17:32:23 -06:00
Luke Street f31edda06e Support MW extensions & double underscore fixes
Enable MW extensions (`__int128`,
`__vec2x32float__`) with `--mw-extensions`.
Disabled by default since these extensions
use `1` and `2` as type indicators, conflicting
with other demangling schemes (template args,
type names).

Includes extra logic to handle cases where
a function's class or template arguments
contain a type with a double underscore.

Fixes #2
2024-03-13 10:44:15 -06:00
Luke Street ad2154fc66 Support negative template literals
Fixes #1
2023-12-11 13:29:25 -05:00
Luke Street 0f20b45a49 Handle trailing underscores in function name 2023-08-23 09:57:38 -04:00
Luke Street 4ddceaec0e Version 0.1.5 2023-02-02 16:00:00 -05:00
Luke Street 53a5797881 Update MSRV to 1.58 2023-02-02 15:59:55 -05:00
Luke Street c595c9dc86 Fix argument-less function pointer arguments with return type 2023-02-02 15:56:09 -05:00
Luke Street 286f3d1d29 Version 0.1.4 2022-11-27 16:29:28 -05:00
Luke Street 3ae8273bf3 Update CI workflow 2022-11-27 16:23:05 -05:00
11 changed files with 433 additions and 166 deletions

5
.cargo/config.toml Normal file
View File

@ -0,0 +1,5 @@
[target.aarch64-unknown-linux-gnu]
linker = "aarch64-linux-gnu-gcc"
[target.armv7-unknown-linux-gnueabihf]
linker = "arm-linux-gnueabihf-gcc"

View File

@ -2,60 +2,131 @@ name: Build
on: [ push, pull_request ]
env:
CARGO_BIN_NAME: cwdemangle
CARGO_TARGET_DIR: target
jobs:
check:
name: Check
runs-on: ubuntu-latest
strategy:
matrix:
toolchain: [ stable, 1.51.0, nightly ]
fail-fast: false
env:
RUSTFLAGS: -D warnings
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
- name: Checkout
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
profile: minimal
toolchain: ${{ matrix.toolchain }}
override: true
components: rustfmt, clippy
- name: Cargo check
run: cargo check --all-features
- name: Cargo clippy
run: cargo clippy --all-features
deny:
name: Deny
runs-on: ubuntu-latest
strategy:
matrix:
checks:
- advisories
- bans licenses sources
# Prevent new advisories from failing CI
continue-on-error: ${{ matrix.checks == 'advisories' }}
steps:
- uses: actions/checkout@v4
- uses: EmbarkStudios/cargo-deny-action@v1
- uses: actions-rs/cargo@v1
with:
command: check
args: --all-features
- uses: actions-rs/cargo@v1
with:
command: clippy
args: --all-features
command: check ${{ matrix.checks }}
test:
name: Test
strategy:
matrix:
platform: [ ubuntu-latest, windows-latest, macos-latest ]
fail-fast: false
runs-on: ${{ matrix.platform }}
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@stable
- name: Cargo test
run: cargo test --release --all-features
build:
name: Build
strategy:
matrix:
platform: [ ubuntu-latest, macos-latest, windows-latest ]
toolchain: [ stable, 1.51.0, nightly ]
include:
- platform: ubuntu-latest
target: x86_64-unknown-linux-gnu
name: linux-x86_64
- platform: ubuntu-latest
target: aarch64-unknown-linux-gnu
name: linux-aarch64
packages: gcc-aarch64-linux-gnu
- platform: ubuntu-latest
target: armv7-unknown-linux-gnueabihf
name: linux-armv7l
packages: gcc-arm-linux-gnueabihf
- platform: windows-latest
target: x86_64-pc-windows-msvc
name: windows-x86_64
- platform: windows-latest
target: aarch64-pc-windows-msvc
name: windows-arm64
- platform: macos-latest
target: x86_64-apple-darwin
name: macos-x86_64
- platform: macos-latest
target: aarch64-apple-darwin
name: macos-arm64
fail-fast: false
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v2
- uses: actions-rs/toolchain@v1
- name: Checkout
uses: actions/checkout@v4
- name: Install dependencies
if: matrix.packages != ''
run: sudo apt-get -y install ${{ matrix.packages }}
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
profile: minimal
toolchain: ${{ matrix.toolchain }}
override: true
- uses: actions-rs/cargo@v1
targets: ${{ matrix.target }}
- name: Cargo build
run: cargo build --release --all-features --target ${{ matrix.target }} --bin ${{ env.CARGO_BIN_NAME }}
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
command: test
args: --release --all-features
- uses: actions-rs/cargo@v1
with:
command: build
args: --release --all-features
- uses: actions/upload-artifact@v2
with:
name: ${{ matrix.platform }}-${{ matrix.toolchain }}
name: ${{ matrix.name }}
path: |
target/release/cwdemangle
target/release/cwdemangle.exe
${{ env.CARGO_TARGET_DIR }}/release/${{ env.CARGO_BIN_NAME }}
${{ env.CARGO_TARGET_DIR }}/release/${{ env.CARGO_BIN_NAME }}.exe
${{ env.CARGO_TARGET_DIR }}/${{ matrix.target }}/release/${{ env.CARGO_BIN_NAME }}
${{ env.CARGO_TARGET_DIR }}/${{ matrix.target }}/release/${{ env.CARGO_BIN_NAME }}.exe
if-no-files-found: error
release:
name: Release
if: startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
needs: [ build ]
steps:
- name: Download artifacts
uses: actions/download-artifact@v4
with:
path: artifacts
- name: Rename artifacts
working-directory: artifacts
run: |
mkdir ../out
for i in */*/release/$CARGO_BIN_NAME*; do
mv "$i" "../out/$(sed -E "s/([^/]+)\/[^/]+\/release\/($CARGO_BIN_NAME)/\2-\1/" <<< "$i")"
done
ls -R ../out
- name: Release
uses: softprops/action-gh-release@v2
with:
files: out/*

2
.gitignore vendored
View File

@ -1,3 +1,3 @@
/target
target/
Cargo.lock
.idea

View File

@ -1,15 +1,3 @@
[package]
name = "cwdemangle"
version = "0.1.3"
edition = "2018"
authors = ["Luke Street <luke@street.dev>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/encounter/cwdemangle"
readme = "README.md"
description = """
CodeWarrior C++ symbol demangler
"""
categories = ["command-line-utilities"]
[dependencies]
argh = "0.1.8"
[workspace]
members = ["lib", "bin"]
resolver = "2"

View File

@ -6,28 +6,41 @@
[crates.io]: https://crates.io/crates/cwdemangle
[Api Rustdoc]: https://img.shields.io/badge/api-rustdoc-blue.svg
[rustdoc]: https://docs.rs/cwdemangle
[Rust Version]: https://img.shields.io/badge/rust-1.51+-blue.svg?maxAge=3600
[Rust Version]: https://img.shields.io/badge/rust-1.58+-blue.svg?maxAge=3600
A CodeWarrior C++ symbol demangler.
### Usage
## Usage
CLI:
### CLI
Static binaries available from [releases](https://github.com/encounter/cwdemangle/releases) or install via `cargo install cwdemangle-bin`.
```shell
cwdemangle 'BuildLight__9CGuiLightCFv'
```
Library:
Pass `--help` to see available options.
### Library
- No dependencies
- `#![no_std]` compatible (requires `alloc`)
Cargo.toml:
```toml
[dependencies]
cwdemangle = "0.2"
```
Usage:
```rust
use cwdemangle::{demangle, DemangleOptions};
if let Some(result) = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default()) {
println!("{}", result);
} else {
eprintln!("Couldn't demangle symbol (not a C++ symbol?)");
}
let result = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default());
assert_eq!(result, Some("CGuiLight::BuildLight() const".to_string()));
```
### License

19
bin/Cargo.toml Normal file
View File

@ -0,0 +1,19 @@
[package]
name = "cwdemangle-bin"
version = "1.0.0"
edition = "2021"
authors = ["Luke Street <luke@street.dev>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/encounter/cwdemangle"
readme = "../README.md"
description = "CodeWarrior C++ symbol demangler (binary)"
categories = ["command-line-utilities"]
rust-version = "1.58"
[[bin]]
name = "cwdemangle"
path = "src/main.rs"
[dependencies]
argh = "0.1.12"
cwdemangle = { path = "../lib", version = "1.0.0" }

View File

@ -42,8 +42,7 @@ where T: FromArgs
};
Err(argh::EarlyExit {
output: format!(
"{} -V, --version print version information and exit",
help
"{help} -V, --version print version information and exit"
),
status: Ok(()),
})

View File

@ -14,14 +14,18 @@ struct Args {
/// disable replacing `(void)` with `()`
#[argh(switch)]
keep_void: bool,
/// enable Metrowerks extensions
#[argh(switch)]
mw_extensions: bool,
}
fn main() -> Result<(), &'static str> {
let args: Args = from_env();
return if let Some(symbol) =
demangle(args.symbol.as_str(), &DemangleOptions { omit_empty_parameters: !args.keep_void })
{
println!("{}", symbol);
return if let Some(symbol) = demangle(args.symbol.as_str(), &DemangleOptions {
omit_empty_parameters: !args.keep_void,
mw_extensions: args.mw_extensions,
}) {
println!("{symbol}");
Ok(())
} else {
Err("Failed to demangle symbol")

172
deny.toml
View File

@ -9,6 +9,11 @@
# The values provided in this template are the default values that will be used
# when any section or field is not specified in your own configuration
# Root options
# The graph table configures how the dependency graph is constructed and thus
# which crates the checks are performed against
[graph]
# If 1 or more target triples (and optionally, target_features) are specified,
# only the specified targets will be checked when running `cargo deny check`.
# This means, if a particular package is only ever used as a target specific
@ -20,53 +25,67 @@
targets = [
# The triple can be any string, but only the target triples built in to
# rustc (as of 1.40) can be checked against actual config expressions
#{ triple = "x86_64-unknown-linux-musl" },
#"x86_64-unknown-linux-musl",
# You can also specify which target_features you promise are enabled for a
# particular target. target_features are currently not validated against
# the actual valid features supported by the target architecture.
#{ triple = "wasm32-unknown-unknown", features = ["atomics"] },
]
# When creating the dependency graph used as the source of truth when checks are
# executed, this field can be used to prune crates from the graph, removing them
# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate
# is pruned from the graph, all of its dependencies will also be pruned unless
# they are connected to another crate in the graph that hasn't been pruned,
# so it should be used with care. The identifiers are [Package ID Specifications]
# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html)
#exclude = []
# If true, metadata will be collected with `--all-features`. Note that this can't
# be toggled off if true, if you want to conditionally enable `--all-features` it
# is recommended to pass `--all-features` on the cmd line instead
all-features = false
# If true, metadata will be collected with `--no-default-features`. The same
# caveat with `all-features` applies
no-default-features = false
# If set, these feature will be enabled when collecting metadata. If `--features`
# is specified on the cmd line they will take precedence over this option.
#features = []
# The output table provides options for how/if diagnostics are outputted
[output]
# When outputting inclusion graphs in diagnostics that include features, this
# option can be used to specify the depth at which feature edges will be added.
# This option is included since the graphs can be quite large and the addition
# of features from the crate(s) to all of the graph roots can be far too verbose.
# This option can be overridden via `--feature-depth` on the cmd line
feature-depth = 1
# This section is considered when running `cargo deny check advisories`
# More documentation for the advisories section can be found here:
# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html
[advisories]
# The path where the advisory database is cloned/fetched into
db-path = "~/.cargo/advisory-db"
# The path where the advisory databases are cloned/fetched into
#db-path = "$CARGO_HOME/advisory-dbs"
# The url(s) of the advisory databases to use
db-urls = ["https://github.com/rustsec/advisory-db"]
# The lint level for security vulnerabilities
vulnerability = "deny"
# The lint level for unmaintained crates
unmaintained = "warn"
# The lint level for crates that have been yanked from their source registry
yanked = "warn"
# The lint level for crates with security notices. Note that as of
# 2019-12-17 there are no security notice advisories in
# https://github.com/rustsec/advisory-db
notice = "warn"
#db-urls = ["https://github.com/rustsec/advisory-db"]
# A list of advisory IDs to ignore. Note that ignored advisories will still
# output a note when they are encountered.
ignore = [
#"RUSTSEC-0000-0000",
#{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" },
#"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish
#{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" },
]
# Threshold for security vulnerabilities, any vulnerability with a CVSS score
# lower than the range specified will be ignored. Note that ignored advisories
# will still output a note when they are encountered.
# * None - CVSS Score 0.0
# * Low - CVSS Score 0.1 - 3.9
# * Medium - CVSS Score 4.0 - 6.9
# * High - CVSS Score 7.0 - 8.9
# * Critical - CVSS Score 9.0 - 10.0
#severity-threshold =
# If this is true, then cargo deny will use the git executable to fetch advisory database.
# If this is false, then it uses a built-in git library.
# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support.
# See Git Authentication for more information about setting up git authentication.
#git-fetch-with-cli = true
# This section is considered when running `cargo deny check licenses`
# More documentation for the licenses section can be found here:
# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html
[licenses]
# The lint level for crates which do not have a detectable license
unlicensed = "deny"
# List of explictly allowed licenses
# List of explicitly allowed licenses
# See https://spdx.org/licenses/ for list of possible licenses
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
allow = [
@ -75,26 +94,6 @@ allow = [
"BSD-3-Clause",
"Unicode-DFS-2016",
]
# List of explictly disallowed licenses
# See https://spdx.org/licenses/ for list of possible licenses
# [possible values: any SPDX 3.11 short identifier (+ optional exception)].
deny = [
#"Nokia",
]
# Lint level for licenses considered copyleft
copyleft = "warn"
# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses
# * both - The license will be approved if it is both OSI-approved *AND* FSF
# * either - The license will be approved if it is either OSI-approved *OR* FSF
# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF
# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved
# * neither - This predicate is ignored and the default lint level is used
allow-osi-fsf-free = "neither"
# Lint level used when no other predicates are matched
# 1. License isn't in the allow or deny lists
# 2. License isn't copyleft
# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither"
default = "deny"
# The confidence threshold for detecting a license from license text.
# The higher the value, the more closely the license text must be to the
# canonical license text of a valid SPDX license file.
@ -105,32 +104,32 @@ confidence-threshold = 0.8
exceptions = [
# Each entry is the crate and version constraint, and its specific allow
# list
#{ allow = ["Zlib"], name = "adler32", version = "*" },
#{ allow = ["Zlib"], crate = "adler32" },
]
# Some crates don't have (easily) machine readable licensing information,
# adding a clarification entry for it allows you to manually specify the
# licensing information
[[licenses.clarify]]
# The name of the crate the clarification applies to
name = "encoding_rs"
# The optional version constraint for the crate
#version = "*"
#[[licenses.clarify]]
# The package spec the clarification applies to
#crate = "ring"
# The SPDX expression for the license requirements of the crate
expression = "(Apache-2.0 OR MIT) AND BSD-3-Clause"
#expression = "MIT AND ISC AND OpenSSL"
# One or more files in the crate's source used as the "source of truth" for
# the license expression. If the contents match, the clarification will be used
# when running the license check, otherwise the clarification will be ignored
# and the crate will be checked normally, which may produce warnings or errors
# depending on the rest of your configuration
license-files = [
# Each entry is a crate relative path, and the (opaque) hash of its contents
{ path = "COPYRIGHT", hash = 0x39f8ad31 }
]
#license-files = [
# Each entry is a crate relative path, and the (opaque) hash of its contents
#{ path = "LICENSE", hash = 0xbd0eed23 }
#]
[licenses.private]
# If true, ignores workspace crates that aren't published, or are only
# published to private registries
# published to private registries.
# To see how to mark a crate as unpublished (to the official registry),
# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field.
ignore = false
# One or more private registries that you might publish crates to, if a crate
# is only published to private registries, and ignore is true, the crate will
@ -153,30 +152,63 @@ wildcards = "allow"
# * simplest-path - The path to the version with the fewest edges is highlighted
# * all - Both lowest-version and simplest-path are used
highlight = "all"
# The default lint level for `default` features for crates that are members of
# the workspace that is being checked. This can be overridden by allowing/denying
# `default` on a crate-by-crate basis if desired.
workspace-default-features = "allow"
# The default lint level for `default` features for external crates that are not
# members of the workspace. This can be overridden by allowing/denying `default`
# on a crate-by-crate basis if desired.
external-default-features = "allow"
# List of crates that are allowed. Use with care!
allow = [
#{ name = "ansi_term", version = "=0.11.0" },
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" },
]
# List of crates to deny
deny = [
# Each entry the name of a crate and a version range. If version is
# not specified, all versions will be matched.
#{ name = "ansi_term", version = "=0.11.0" },
#
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" },
# Wrapper crates can optionally be specified to allow the crate when it
# is a direct dependency of the otherwise banned crate
#{ name = "ansi_term", version = "=0.11.0", wrappers = [] },
#{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] },
]
# List of features to allow/deny
# Each entry the name of a crate and a version range. If version is
# not specified, all versions will be matched.
#[[bans.features]]
#crate = "reqwest"
# Features to not allow
#deny = ["json"]
# Features to allow
#allow = [
# "rustls",
# "__rustls",
# "__tls",
# "hyper-rustls",
# "rustls",
# "rustls-pemfile",
# "rustls-tls-webpki-roots",
# "tokio-rustls",
# "webpki-roots",
#]
# If true, the allowed features must exactly match the enabled feature set. If
# this is set there is no point setting `deny`
#exact = true
# Certain crates/versions that will be skipped when doing duplicate detection.
skip = [
#{ name = "ansi_term", version = "=0.11.0" },
#"ansi_term@0.11.0",
#{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" },
]
# Similarly to `skip` allows you to skip certain crates during duplicate
# detection. Unlike skip, it also includes the entire tree of transitive
# dependencies starting at the specified crate, up to a certain depth, which is
# by default infinite
# by default infinite.
skip-tree = [
#{ name = "ansi_term", version = "=0.11.0", depth = 20 },
#"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies
#{ crate = "ansi_term@0.11.0", depth = 20 },
]
# This section is considered when running `cargo deny check sources`.
@ -197,8 +229,8 @@ allow-git = []
[sources.allow-org]
# 1 or more github.com organizations to allow git sources for
#github = [""]
github = []
# 1 or more gitlab.com organizations to allow git sources for
#gitlab = [""]
gitlab = []
# 1 or more bitbucket.org organizations to allow git sources for
#bitbucket = [""]
bitbucket = []

14
lib/Cargo.toml Normal file
View File

@ -0,0 +1,14 @@
[package]
name = "cwdemangle"
version = "1.0.0"
edition = "2021"
authors = ["Luke Street <luke@street.dev>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/encounter/cwdemangle"
readme = "../README.md"
description = "CodeWarrior C++ symbol demangler"
categories = ["parser-implementations", "no-std"]
rust-version = "1.58"
[dependencies]
# Intentionally left blank.

View File

@ -1,12 +1,35 @@
use std::str::FromStr;
//! A CodeWarrior C++ symbol demangler.
//!
//! # Usage
//! ```
//! use cwdemangle::{demangle, DemangleOptions};
//!
//! let result = demangle("BuildLight__9CGuiLightCFv", &DemangleOptions::default());
//! assert_eq!(result, Some("CGuiLight::BuildLight() const".to_string()));
//! ```
#![no_std]
extern crate alloc;
use alloc::{
format,
str::FromStr,
string::{String, ToString},
};
/// Options for [demangle].
pub struct DemangleOptions {
/// Replace `(void)` function parameters with `()`
pub omit_empty_parameters: bool,
/// Enable Metrowerks extension types (`__int128`, `__vec2x32float__`, etc.)
///
/// Disabled by default since they conflict with template argument literals
/// and can't always be demangled correctly.
pub mw_extensions: bool,
}
impl Default for DemangleOptions {
fn default() -> Self { DemangleOptions { omit_empty_parameters: true } }
fn default() -> Self { DemangleOptions { omit_empty_parameters: true, mw_extensions: false } }
}
fn parse_qualifiers(mut str: &str) -> (String, String, &str) {
@ -84,16 +107,11 @@ fn demangle_template_args<'a>(
fn demangle_name<'a>(str: &'a str, options: &DemangleOptions) -> Option<(String, String, &'a str)> {
let (size, rest) = parse_digits(str)?;
// hack for template argument constants
if rest.is_empty() || rest.starts_with(',') {
let out = format!("{}", size);
return Some((out.clone(), out, rest));
}
if rest.len() < size {
return None;
}
let (name, args) = demangle_template_args(&rest[..size], options)?;
Some((name.to_string(), format!("{}{}", name, args), &rest[size..]))
Some((name.to_string(), format!("{name}{args}"), &rest[size..]))
}
fn demangle_qualified_name<'a>(
@ -127,11 +145,44 @@ fn demangle_arg<'a>(
mut str: &'a str,
options: &DemangleOptions,
) -> Option<(String, String, &'a str)> {
// Negative constant
if let Some(str) = str.strip_prefix('-') {
let (size, rest) = parse_digits(str)?;
let out = format!("-{size}");
return Some((out.clone(), String::new(), rest));
}
let mut result = String::new();
let (mut pre, mut post, rest) = parse_qualifiers(str);
result += pre.as_str();
str = rest;
if str.starts_with('Q') || str.starts_with(|c: char| c.is_ascii_digit()) {
// Disambiguate arguments starting with a number
if str.starts_with(|c: char| c.is_ascii_digit()) {
let (num, rest) = parse_digits(str)?;
// If the number is followed by a comma or the end of the string, it's a template argument
if rest.is_empty() || rest.starts_with(',') {
// ...or a Metrowerks extension type
if options.mw_extensions {
if let Some(t) = match num {
1 => Some("__int128"),
2 => Some("__vec2x32float__"),
_ => None,
} {
result += t;
return Some((result, post, rest));
}
}
result += &format!("{num}");
result += post.as_str();
return Some((result, String::new(), rest));
}
// Otherwise, it's (probably) the size of a type
let (_, qualified, rest) = demangle_name(str, options)?;
result += qualified.as_str();
result += post.as_str();
return Some((result, String::new(), rest));
}
// Handle qualified names
if str.starts_with('Q') {
let (_, qualified, rest) = demangle_qualified_name(str, options)?;
result += qualified.as_str();
result += post.as_str();
@ -142,7 +193,7 @@ fn demangle_arg<'a>(
if str.starts_with('M') {
is_member = true;
let (_, member, rest) = demangle_qualified_name(&str[1..], options)?;
pre = format!("{}::*{}", member, pre);
pre = format!("{member}::*{pre}");
if !rest.starts_with('F') {
return None;
}
@ -162,7 +213,7 @@ fn demangle_arg<'a>(
}
} else if post.starts_with('*') {
post = post[1..].trim_start().to_string();
pre = format!("*{}", pre);
pre = format!("*{pre}");
} else {
return None;
}
@ -172,8 +223,8 @@ fn demangle_arg<'a>(
}
let (ret_pre, ret_post, rest) = demangle_arg(&rest[1..], options)?;
let const_str = if const_member { " const" } else { "" };
let res_pre = format!("{} ({}{}", ret_pre, pre, post);
let res_post = format!(")({}){}{}", args, const_str, ret_post);
let res_pre = format!("{ret_pre} ({pre}{post}");
let res_post = format!(")({args}){const_str}{ret_post}");
return Some((res_pre, res_post, rest));
}
if let Some(rest) = str.strip_prefix('A') {
@ -183,10 +234,10 @@ fn demangle_arg<'a>(
}
let (arg_pre, arg_post, rest) = demangle_arg(&rest[1..], options)?;
if !post.is_empty() {
post = format!("({})", post);
post = format!("({post})");
}
result = format!("{}{}{}", pre, arg_pre, post);
let ret_post = format!("[{}]{}", count, arg_post);
result = format!("{pre}{arg_pre}{post}");
let ret_post = format!("[{count}]{arg_post}");
return Some((result, ret_post, rest));
}
result.push_str(match str.chars().next()? {
@ -201,6 +252,9 @@ fn demangle_arg<'a>(
'w' => "wchar_t",
'v' => "void",
'e' => "...",
'1' if options.mw_extensions => "__int128",
'2' if options.mw_extensions => "__vec2x32float__",
'_' => return Some((result, String::new(), rest)),
_ => return None,
});
result += post.as_str();
@ -234,13 +288,13 @@ fn demangle_special_function(
) -> Option<String> {
if let Some(rest) = str.strip_prefix("op") {
let (arg_pre, arg_post, _) = demangle_arg(rest, options)?;
return Some(format!("operator {}{}", arg_pre, arg_post));
return Some(format!("operator {arg_pre}{arg_post}"));
}
let (op, args) = demangle_template_args(str, options)?;
Some(format!(
"{}{}",
match op {
"dt" => return Some(format!("~{}{}", class_name, args)),
"dt" => return Some(format!("~{class_name}{args}")),
"ct" => class_name,
"nw" => "operator new",
"nwa" => "operator new[]",
@ -285,12 +339,15 @@ fn demangle_special_function(
"cl" => "operator()",
"vc" => "operator[]",
"vt" => "__vtable",
_ => return Some(format!("__{}{}", op, args)),
_ => return Some(format!("__{op}{args}")),
},
args
))
}
/// Demangle a symbol name.
///
/// Returns `None` if the input is not a valid mangled name.
pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
if !str.is_ascii() {
return None;
@ -323,7 +380,11 @@ pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
str = &str[2..];
}
{
let idx = str.find("__")?;
let mut idx = find_split(str, special, options)?;
// Handle any trailing underscores in the function name
while str.chars().nth(idx + 2) == Some('_') {
idx += 1;
}
let (fn_name_out, mut rest) = str.split_at(idx);
if special {
if fn_name_out == "init" {
@ -336,7 +397,7 @@ pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
}
} else {
let (name, args) = demangle_template_args(fn_name_out, options)?;
fn_name = format!("{}{}", name, args);
fn_name = format!("{name}{args}");
}
// Handle old static function variables (GC CW)
@ -349,7 +410,7 @@ pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
}
if var == "init" {
// Sadly, $localstatic doesn't provide the variable name in guard/init
static_var = format!("{} guard", var_type);
static_var = format!("{var_type} guard");
} else {
static_var = var.to_string();
}
@ -376,9 +437,9 @@ pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
str = &str[1..];
let (args, rest) = demangle_function_args(str, options)?;
if options.omit_empty_parameters && args == "void" {
fn_name = format!("{}()", fn_name);
fn_name = format!("{fn_name}()");
} else {
fn_name = format!("{}({})", fn_name, args);
fn_name = format!("{fn_name}({args})");
}
str = rest;
}
@ -393,20 +454,45 @@ pub fn demangle(mut str: &str, options: &DemangleOptions) -> Option<String> {
return None;
}
if cnst {
fn_name = format!("{} const", fn_name);
fn_name = format!("{fn_name} const");
}
if !qualified.is_empty() {
fn_name = format!("{}::{}", qualified, fn_name);
fn_name = format!("{qualified}::{fn_name}");
}
if !return_type_pre.is_empty() {
fn_name = format!("{} {}{}", return_type_pre, fn_name, return_type_post);
fn_name = format!("{return_type_pre} {fn_name}{return_type_post}");
}
if !static_var.is_empty() {
fn_name = format!("{}::{}", fn_name, static_var);
fn_name = format!("{fn_name}::{static_var}");
}
Some(fn_name)
}
/// Finds the first double underscore in the string, excluding any that are part of a
/// template argument list or operator name.
fn find_split(s: &str, special: bool, options: &DemangleOptions) -> Option<usize> {
let mut start = 0;
if special && s.starts_with("op") {
let (_, _, rest) = demangle_arg(&s[2..], options)?;
start = s.len() - rest.len();
}
let mut depth = 0;
let bytes = s.as_bytes();
for i in start..s.len() {
match bytes[i] {
b'<' => depth += 1,
b'>' => depth -= 1,
b'_' => {
if bytes.get(i + 1).cloned() == Some(b'_') && depth == 0 {
return Some(i);
}
}
_ => {}
}
}
None
}
#[cfg(test)]
mod tests {
use super::*;
@ -678,19 +764,55 @@ mod tests {
demangle("test__FRCPCPCi", &options),
Some("test(const int* const* const&)".to_string()),
);
assert_eq!(
demangle(
"__ct__Q34nw4r2ut14CharStrmReaderFMQ34nw4r2ut14CharStrmReaderFPCvPv_Us",
&options
),
Some("nw4r::ut::CharStrmReader::CharStrmReader(unsigned short (nw4r::ut::CharStrmReader::*)())".to_string())
);
assert_eq!(
demangle("QuerySymbolToMapFile___Q24nw4r2dbFPUcPC12OSModuleInfoUlPUcUl", &options),
Some("nw4r::db::QuerySymbolToMapFile_(unsigned char*, const OSModuleInfo*, unsigned long, unsigned char*, unsigned long)".to_string())
);
assert_eq!(
demangle("__ct__Q37JGadget27TLinkList<10JUTConsole,-24>8iteratorFQ37JGadget13TNodeLinkList8iterator", &options),
Some("JGadget::TLinkList<JUTConsole, -24>::iterator::iterator(JGadget::TNodeLinkList::iterator)".to_string())
);
assert_eq!(
demangle("do_assign<Q23std126__convert_iterator<PP16GAM_eEngineState,Q33std68__cdeque<P16GAM_eEngineState,36ubiSTLAllocator<P16GAM_eEngineState>>8iterator>>__Q23std36__cdeque<PCv,20ubiSTLAllocator<PCv>>FQ23std126__convert_iterator<PP16GAM_eEngineState,Q33std68__cdeque<P16GAM_eEngineState,36ubiSTLAllocator<P16GAM_eEngineState>>8iterator>Q23std126__convert_iterator<PP16GAM_eEngineState,Q33std68__cdeque<P16GAM_eEngineState,36ubiSTLAllocator<P16GAM_eEngineState>>8iterator>Q23std20forward_iterator_tag", &options),
Some("std::__cdeque<const void*, ubiSTLAllocator<const void*>>::do_assign<std::__convert_iterator<GAM_eEngineState**, std::__cdeque<GAM_eEngineState*, ubiSTLAllocator<GAM_eEngineState*>>::iterator>>(std::__convert_iterator<GAM_eEngineState**, std::__cdeque<GAM_eEngineState*, ubiSTLAllocator<GAM_eEngineState*>>::iterator>, std::__convert_iterator<GAM_eEngineState**, std::__cdeque<GAM_eEngineState*, ubiSTLAllocator<GAM_eEngineState*>>::iterator>, std::forward_iterator_tag)".to_string())
);
assert_eq!(
demangle("__opPCQ23std15__locale_imp<1>__Q23std80_RefCountedPtr<Q23std15__locale_imp<1>,Q23std32_Single<Q23std15__locale_imp<1>>>CFv", &options),
Some("std::_RefCountedPtr<std::__locale_imp<1>, std::_Single<std::__locale_imp<1>>>::operator const std::__locale_imp<1>*() const".to_string())
);
assert_eq!(
demangle("__partition_const_ref<PP12CSpaceObject,Q23std74unary_negate<Q23std52__binder1st_const_ref<Q23std21less<P12CSpaceObject>>>>__3stdFPP12CSpaceObjectPP12CSpaceObjectRCQ23std74unary_negate<Q23std52__binder1st_const_ref<Q23std21less<P12CSpaceObject>>>", &options),
Some("std::__partition_const_ref<CSpaceObject**, std::unary_negate<std::__binder1st_const_ref<std::less<CSpaceObject*>>>>(CSpaceObject**, CSpaceObject**, const std::unary_negate<std::__binder1st_const_ref<std::less<CSpaceObject*>>>&)".to_string())
);
}
#[test]
fn test_demangle_options() {
let options = DemangleOptions { omit_empty_parameters: true };
let options = DemangleOptions { omit_empty_parameters: true, mw_extensions: false };
assert_eq!(
demangle("__dt__26__partial_array_destructorFv", &options),
Some("__partial_array_destructor::~__partial_array_destructor()".to_string())
);
let options = DemangleOptions { omit_empty_parameters: false };
let options = DemangleOptions { omit_empty_parameters: false, mw_extensions: false };
assert_eq!(
demangle("__dt__26__partial_array_destructorFv", &options),
Some("__partial_array_destructor::~__partial_array_destructor(void)".to_string())
);
let options = DemangleOptions { omit_empty_parameters: true, mw_extensions: true };
assert_eq!(
demangle("__opPCQ23std15__locale_imp<1>__Q23std80_RefCountedPtr<Q23std15__locale_imp<1>,Q23std32_Single<Q23std15__locale_imp<1>>>CFv", &options),
Some("std::_RefCountedPtr<std::__locale_imp<__int128>, std::_Single<std::__locale_imp<__int128>>>::operator const std::__locale_imp<__int128>*() const".to_string())
);
assert_eq!(
demangle("fn<3,PV2>__FPC2", &options),
Some("fn<3, volatile __vec2x32float__*>(const __vec2x32float__*)".to_string())
);
}
}