GP-5078: Adding a little to modules' README

This commit is contained in:
Ryan Kurtz 2024-11-04 11:25:04 -05:00
parent c702d7c66d
commit befe67a637
2 changed files with 30 additions and 0 deletions

View File

@ -1 +1,25 @@
# SwiftDemangler
This module provides support for demanling mangled [Swift](https://www.swift.org) symbols. Supported
mangled symbols begin with `$S`, `$s`, `_$S"`, `_$s`, or `_T`.
The demangler currently relies on making direct calls to the native Swift demangler tool, which
comes [bundled with Swift](https://www.swift.org/download/). For example:
```bash
% swift demangle --compact --expand _\$s7SwiftUI4ViewMp
Demangling for _$s7SwiftUI4ViewMp
kind=Global
kind=ProtocolDescriptor
kind=Type
kind=Protocol
kind=Module, text="SwiftUI"
kind=Identifier, text="View"
protocol descriptor for SwiftUI.View
```
The resulting tree is parsed by the Ghidra Swift Demangler to form and apply a demangled symbol
name.
By default, the `Demangler Swift` Analyzer will search for the native Swift Demangler on the `PATH`.
If it resides elsewhere, its path can be specified in the analyzer's options.

View File

@ -1 +1,7 @@
# Utility
This module provides the entry point for the Ghidra application, as well as all of the utilities
needed to dynamically discover and load Ghidra modules.
__NOTE:__ Classes in this module may not depend on any classes/jars that reside outside of this
module.