From befe67a63739f0925d0731456a6abcfc497d54b3 Mon Sep 17 00:00:00 2001 From: Ryan Kurtz Date: Mon, 4 Nov 2024 11:25:04 -0500 Subject: [PATCH] GP-5078: Adding a little to modules' README --- Ghidra/Features/SwiftDemangler/README.md | 24 ++++++++++++++++++++++++ Ghidra/Framework/Utility/README.md | 6 ++++++ 2 files changed, 30 insertions(+) diff --git a/Ghidra/Features/SwiftDemangler/README.md b/Ghidra/Features/SwiftDemangler/README.md index bff6ba5a24..5801dc56e0 100644 --- a/Ghidra/Features/SwiftDemangler/README.md +++ b/Ghidra/Features/SwiftDemangler/README.md @@ -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. diff --git a/Ghidra/Framework/Utility/README.md b/Ghidra/Framework/Utility/README.md index 0b58bca881..6e06cd4015 100644 --- a/Ghidra/Framework/Utility/README.md +++ b/Ghidra/Framework/Utility/README.md @@ -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. \ No newline at end of file