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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
// Copyright 2024 Ryan McKenzie
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![doc = include_str!("../README.md")]
#![warn(clippy::pedantic)]
#![deny(clippy::undocumented_unsafe_blocks)]
#![allow(
clippy::missing_errors_doc,
clippy::similar_names,
clippy::struct_field_names,
clippy::too_many_lines
)]
mod alloc;
mod cache;
mod demangler;
mod extensions;
mod mangled_string;
mod nodes;
#[cfg(test)]
mod tests;
use crate::demangler::Demangler;
use bumpalo::Bump;
use std::{
io,
str::Utf8Error,
string::FromUtf8Error,
};
type OutputFlags = Flags;
trait Writer: io::Write {
fn last_char(&self) -> Option<char>;
fn len_bytes(&self) -> usize;
}
#[non_exhaustive]
#[derive(thiserror::Error, Debug)]
pub enum Error {
#[error("failed to demangle anonymous namespace name")]
InvalidAnonymousNamespaceName,
#[error("failed to demangle array type")]
InvalidArrayType,
#[error("tried to access a backref that does not exist")]
InvalidBackRef,
#[error("failed to demangle calling convention")]
InvalidCallingConvention,
#[error("failed to demangle char literal")]
InvalidCharLiteral,
#[error("failed to demangle class type")]
InvalidClassType,
#[error("failed to demangle custom type")]
InvalidCustomType,
#[error("failed to demangle declarator")]
InvalidDeclarator,
#[error("failed to demangle encoded symbol")]
InvalidEncodedSymbol,
#[error("failed to demangle fully qualified symbol name")]
InvalidFullyQualifiedSymbolName,
#[error("failed to demangle function class")]
InvalidFunctionClass,
#[error("failed to demangle function encoding")]
InvalidFunctionEncoding,
#[error("failed to demangle function identifier code")]
InvalidFunctionIdentifierCode,
#[error("failed to demangle function parameter list")]
InvalidFunctionParameterList,
#[error("failed to demangle function type")]
InvalidFunctionType,
#[error("failed to demangle init fini stub")]
InvalidInitFiniStub,
#[error("failed to demangle intrinsic function code")]
InvalidIntrinsicFunctionCode,
#[error("failed to demangle locally scoped name piece")]
InvalidLocallyScopedNamePiece,
#[error("failed to demangle local static guard")]
InvalidLocalStaticGuard,
#[error("failed to demangle md5 name")]
InvalidMd5Name,
#[error("failed to demangle member pointer type")]
InvalidMemberPointerType,
#[error("failed to demangle name scope chain")]
InvalidNameScopeChain,
#[error("failed to demangle number")]
InvalidNumber,
#[error("failed to demangle pointer cv qualifiers")]
InvalidPointerCVQualifiers,
#[error("failed to demangle pointer type")]
InvalidPointerType,
#[error("failed to demangle primitive type")]
InvalidPrimitiveType,
#[error("failed to demangle qualifiers")]
InvalidQualifiers,
#[error("failed to demangle rtti base class descriptor node")]
InvalidRttiBaseClassDescriptorNode,
#[error("failed to demangle signed number")]
InvalidSigned,
#[error("failed to demangle simple string")]
InvalidSimpleString,
#[error("failed to demangle special intrinsic")]
InvalidSpecialIntrinsic,
#[error("failed to demangle special table symbol node")]
InvalidSpecialTableSymbolNode,
#[error("failed to demangle string literal")]
InvalidStringLiteral,
#[error("failed to demangle tag unique name")]
InvalidTagUniqueName,
#[error("failed to demangle template instantiation name")]
InvalidTemplateInstantiationName,
#[error("failed to demangle template parameter list")]
InvalidTemplateParameterList,
#[error("failed to demangle throw specification")]
InvalidThrowSpecification,
#[error("failed to demangle type")]
InvalidType,
#[error("failed to demangle typinfo name")]
InvalidTypeinfoName,
#[error("failed to demangle unsigned number")]
InvalidUnsigned,
#[error("failed to demangle untyped variable")]
InvalidUntypedVariable,
#[error("failed to demangle variable storage class")]
InvalidVariableStorageClass,
#[error("failed to demangle vcall thunk node")]
InvalidVcallThunkNode,
#[error(transparent)]
Io(#[from] io::Error),
#[error("string demangled to an invalid utf-8 sequence")]
Utf8Error,
#[error("input string was likely malicious and would have triggered an out of memory panic")]
MaliciousInput,
}
impl From<Utf8Error> for Error {
fn from(_: Utf8Error) -> Self {
Self::Utf8Error
}
}
impl From<FromUtf8Error> for Error {
fn from(_: FromUtf8Error) -> Self {
Self::Utf8Error
}
}
pub type Result<T> = std::result::Result<T, Error>;
bitflags::bitflags! {
/// `Flags` control how types are printed during demangling. See each flag for more info on what exactly they do.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub struct Flags: u16 {
/// Suppress calling conventions (`__cdecl`/`__fastcall`/`__thiscall`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?func@MyClass@@UEAAHHH@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_CALLING_CONVENTION).unwrap();
/// assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
/// assert_eq!(with_flag, "public: virtual int MyClass::func(int, int)");
/// ```
const NO_CALLING_CONVENTION = 1 << 0;
/// See also [`NO_CALLING_CONVENTION`](Self::NO_CALLING_CONVENTION).
const NO_ALLOCATION_LANGUAGE = Self::NO_CALLING_CONVENTION.bits();
/// Suppress tag specifiers (`class`/`struct`/`union`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?x@@3PEAVty@@EA";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_TAG_SPECIFIER).unwrap();
/// assert_eq!(without_flag, "class ty *x");
/// assert_eq!(with_flag, "ty *x");
/// ```
const NO_TAG_SPECIFIER = 1 << 1;
/// See also [`NO_TAG_SPECIFIER`](Self::NO_TAG_SPECIFIER).
const NO_ECSU = Self::NO_TAG_SPECIFIER.bits();
/// Suppress access specifiers (`private`/`public`/`protected`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?func@MyClass@@UEAAHHH@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_ACCESS_SPECIFIER).unwrap();
/// assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
/// assert_eq!(with_flag, "virtual int __cdecl MyClass::func(int, int)");
/// ```
const NO_ACCESS_SPECIFIER = 1 << 2;
/// See also [`NO_ACCESS_SPECIFIER`](Self::NO_ACCESS_SPECIFIER).
const NO_ACCESS_SPECIFIERS = Self::NO_ACCESS_SPECIFIER.bits();
/// Suppress member types (`static`/`virtual`/`extern "C"`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?func@MyClass@@UEAAHHH@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_MEMBER_TYPE).unwrap();
/// assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
/// assert_eq!(with_flag, "public: int __cdecl MyClass::func(int, int)");
/// ```
const NO_MEMBER_TYPE = 1 << 3;
/// Suppress return types from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?func@MyClass@@UEAAHHH@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_RETURN_TYPE).unwrap();
/// assert_eq!(without_flag, "public: virtual int __cdecl MyClass::func(int, int)");
/// assert_eq!(with_flag, "public: virtual __cdecl MyClass::func(int, int)");
/// ```
const NO_RETURN_TYPE = 1 << 4;
/// See also [`NO_RETURN_TYPE`](Self::NO_RETURN_TYPE).
const NO_FUNCTION_RETURNS = Self::NO_RETURN_TYPE.bits();
/// Suppress variable types from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?x@@3PEAEEA";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_VARIABLE_TYPE).unwrap();
/// assert_eq!(without_flag, "unsigned char *x");
/// assert_eq!(with_flag, "x");
/// ```
const NO_VARIABLE_TYPE = 1 << 5;
/// Suppress modifiers on the `this` type (`const`/`volatile`/`__restrict`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?world@hello@@QEDAXXZ";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_THISTYPE).unwrap();
/// assert_eq!(without_flag, "public: void __cdecl hello::world(void) const volatile");
/// assert_eq!(with_flag, "public: void __cdecl hello::world(void)");
/// ```
const NO_THISTYPE = 1 << 6;
/// Suppress leading underscores on Microsoft extended keywords (`__restrict`/`__cdecl`/`__fastcall`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?foo_piad@@YAXPIAD@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_LEADING_UNDERSCORES).unwrap();
/// assert_eq!(without_flag, "void __cdecl foo_piad(char *__restrict)");
/// assert_eq!(with_flag, "void cdecl foo_piad(char *restrict)");
/// ```
const NO_LEADING_UNDERSCORES = 1 << 7;
/// Suppress Microsoft keywords (`__restrict`/`__unaligned`/`__cdecl`) from being included in the output.
/// ```rust
/// use undname::Flags;
/// let input = "?f@@YAXPEIFAH@Z";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NO_MS_KEYWORDS).unwrap();
/// assert_eq!(without_flag, "void __cdecl f(int __unaligned *__restrict)");
/// assert_eq!(with_flag, "void f(int *)");
/// ```
const NO_MS_KEYWORDS = 1 << 8;
/// Output only the name for the primary declaration.
/// ```rust
/// use undname::Flags;
/// let input = "?world@hello@@QEDAXXZ";
/// let without_flag = undname::demangle(input, Flags::default()).unwrap();
/// let with_flag = undname::demangle(input, Flags::NAME_ONLY).unwrap();
/// assert_eq!(without_flag, "public: void __cdecl hello::world(void) const volatile");
/// assert_eq!(with_flag, "hello::world");
/// ```
const NAME_ONLY = 1 << 9;
}
}
impl Flags {
#[must_use]
fn no_calling_convention(self) -> bool {
self.contains(Self::NO_CALLING_CONVENTION)
}
#[must_use]
fn no_tag_specifier(self) -> bool {
self.contains(Self::NO_TAG_SPECIFIER)
}
#[must_use]
fn no_access_specifier(self) -> bool {
self.contains(Self::NO_ACCESS_SPECIFIER)
}
#[must_use]
fn no_member_type(self) -> bool {
self.contains(Self::NO_MEMBER_TYPE)
}
#[must_use]
fn no_return_type(self) -> bool {
self.contains(Self::NO_RETURN_TYPE)
}
#[must_use]
fn no_variable_type(self) -> bool {
self.contains(Self::NO_VARIABLE_TYPE)
}
#[must_use]
fn no_this_type(self) -> bool {
self.contains(Self::NO_THISTYPE)
}
#[must_use]
fn no_leading_underscores(self) -> bool {
self.contains(Self::NO_LEADING_UNDERSCORES)
}
#[must_use]
fn no_ms_keywords(self) -> bool {
self.contains(Self::NO_MS_KEYWORDS)
}
#[must_use]
fn name_only(self) -> bool {
self.contains(Self::NAME_ONLY)
}
}
/// Demangles a Microsoft symbol stored in `mangled_name`.
/// ```rust
/// use undname::Flags;
/// let result = undname::demangle("?world@@YA?AUhello@@XZ", Flags::default()).unwrap();
/// assert_eq!(result, "struct hello __cdecl world(void)");
/// ```
pub fn demangle(mangled_name: &str, flags: Flags) -> Result<String> {
let mut result = String::default();
demangle_into(mangled_name, flags, &mut result)?;
Ok(result)
}
/// See [`demangle`] for more info.
pub fn demangle_into(mangled_name: &str, flags: Flags, result: &mut String) -> Result<()> {
let alloc = Bump::default();
let d = Demangler::new(mangled_name, flags, &alloc);
result.clear();
d.parse_into(result)
}