fixup! Introduce config-based demangler APIs

Author: plafosse

binaryninjaapi.h

@@ -2433,24 +2433,6 @@ namespace BinaryNinja {
 	*/
 	Ref<BinaryView> Load(Ref<BinaryView> rawData, bool updateAnalysis, ProgressFunction progress, Ref<Metadata> options = new Metadata(MetadataType::KeyValueDataType), bool isDatabase = false);
 
-	/*! Determines if a symbol name is a mangled Microsoft Visual Studio C++ name
-
-	    \param[in] mangledName a potentially mangled name
-
-	    \ingroup demangle
-	*/
-	bool IsMSVCMangledString(const std::string& mangledName);
-
-	/*! Determines if a symbol name is a mangled GNU3 name
-
-	    \param[in] mangledName a potentially mangled name
-
-	    \ingroup demangle
-	*/
-	bool IsGNU3MangledString(const std::string& mangledName);
-
-	QualifiedName SimplifyDemangledTemplateName(const QualifiedName& name);
-
 	/*!
 		\ingroup mainthread
 	*/
@@ -4723,8 +4705,7 @@ namespace BinaryNinja {
 	struct DemanglerConfig
 	{
 		Ref<Platform> platform;
-		// Borrowed reference; the caller must keep the view alive while this config is in use.
-		BinaryView* view = nullptr;
+		Ref<BinaryView> view;
 		bool simplifyTemplates = false;
 
 		DemanglerConfig(
@@ -4736,9 +4717,6 @@ namespace BinaryNinja {
 
 		Platform& GetPlatform() const;
 		BNDemanglerConfig ToAPIObject() const;
-
-	private:
-		Ref<BinaryView> m_viewOwner;
 	};
 
 	struct DemanglerResult
@@ -4747,10 +4725,12 @@ namespace BinaryNinja {
 		Ref<Type> type;
 
 		static DemanglerResult FromAPIObject(const BNDemanglerResult* result);
-		static DemanglerResult FromAPIObjectAndFree(BNDemanglerResult* result);
 		BNDemanglerResult ToAPIObject() const;
+		static void FreeAPIObject(BNDemanglerResult* result);
 	};
 
+	QualifiedName SimplifyDemangledTemplateName(const QualifiedName& name);
+
 	/*! Demangles using LLVM's demangler.
 
 		\param[in] mangledName A mangled MSVC/GNU3/Rust/D name.
@@ -4786,6 +4766,64 @@ namespace BinaryNinja {
 	std::optional<DemanglerResult> DemangleGNU3(
 		const Platform* platform, const std::string& mangledName, bool simplify = true);
 
+	/*! Determines if a symbol name is a mangled Microsoft Visual Studio C++ name.
+
+		\param[in] mangledName A potentially mangled name.
+		\return True if the name is recognized by the built-in MSVC demangler.
+
+		\ingroup demangle
+	*/
+	bool IsMSVCMangledString(const std::string& mangledName);
+
+	/*! Determines if a symbol name is a mangled GNU3 name.
+
+		\param[in] mangledName A potentially mangled name.
+		\return True if the name is recognized by the built-in GNU3 demangler.
+
+		\ingroup demangle
+	*/
+	bool IsGNU3MangledString(const std::string& mangledName);
+
+	BN_DEPRECATED("Use Demangler::DemangleAny with DemanglerConfig")
+	bool DemangleGeneric(Ref<Architecture> arch, const std::string& mangledName, Ref<Type>& outType,
+		QualifiedName& outVarName, Ref<BinaryView> view = nullptr, bool simplify = false);
+
+	BN_DEPRECATED("Use the DemangleLLVM overload returning std::optional<DemanglerResult>")
+	bool DemangleLLVM(
+		const std::string& mangledName, QualifiedName& outVarName, bool simplify = false);
+
+	BN_DEPRECATED("Use Demangler::DemangleAny with DemanglerConfig::ForBinaryView")
+	bool DemangleLLVM(
+		const std::string& mangledName, QualifiedName& outVarName, BinaryView* view);
+
+	BN_DEPRECATED("Use the DemangleMS overload returning std::optional<DemanglerResult>")
+	bool DemangleMS(Architecture* arch, const std::string& mangledName, Ref<Type>& outType,
+		QualifiedName& outVarName, bool simplify = false);
+
+	BN_DEPRECATED("Use Demangler::DemangleAny with DemanglerConfig::ForBinaryView")
+	bool DemangleMS(Architecture* arch, const std::string& mangledName, Ref<Type>& outType,
+		QualifiedName& outVarName, BinaryView* view);
+
+	BN_DEPRECATED("Use the DemangleGNU3 overload returning std::optional<DemanglerResult>")
+	bool DemangleGNU3(Ref<Architecture> arch, const std::string& mangledName, Ref<Type>& outType,
+		QualifiedName& outVarName, bool simplify = false);
+
+	BN_DEPRECATED("Use Demangler::DemangleAny with DemanglerConfig::ForBinaryView")
+	bool DemangleGNU3(Ref<Architecture> arch, const std::string& mangledName, Ref<Type>& outType,
+		QualifiedName& outVarName, BinaryView* view);
+
+	BN_DEPRECATED("Use SimplifyDemangledTemplateName")
+	std::string SimplifyToString(const std::string& input);
+
+	BN_DEPRECATED("Use SimplifyDemangledTemplateName")
+	std::string SimplifyToString(const QualifiedName& input);
+
+	BN_DEPRECATED("Use SimplifyDemangledTemplateName")
+	QualifiedName SimplifyToQualifiedName(const std::string& input, bool simplify);
+
+	BN_DEPRECATED("Use SimplifyDemangledTemplateName")
+	QualifiedName SimplifyToQualifiedName(const QualifiedName& input);
+
 	/*!
 
 		\ingroup namelist
@@ -22506,16 +22544,6 @@ namespace BinaryNinja {
 		 */
 		static bool Promote(const Ref<Demangler>& demangler);
 
-		/*!
-		    Attempt to demangle a mangled name, trying all relevant demanglers and using whichever one accepts it.
-
-		    \param[in] mangledName Raw mangled name
-		    \param[in] config Platform/view/options used while demangling
-		    \return Demangled type/name if successful
-		 */
-		static std::optional<Result> DemangleAny(
-		    const std::string& mangledName, const Config& config = DemanglerConfig::Default());
-
 		std::string GetName() const;
 
 		/*! Determine if a given name is mangled and this demangler can process it
@@ -22531,6 +22559,16 @@ namespace BinaryNinja {
 		 */
 		virtual bool IsMangledString(const std::string& mangledName) = 0;
 
+		/*!
+		    Attempt to demangle a mangled name, trying all relevant demanglers and using whichever one accepts it.
+
+		    \param[in] mangledName Raw mangled name
+		    \param[in] config Platform/view/options used while demangling
+		    \return Demangled type/name if successful
+		 */
+		static std::optional<Result> DemangleAny(
+		    const std::string& mangledName, const Config& config = DemanglerConfig::Default());
+
 		/*! Demangle a raw name into a Type and QualifiedName.
 
 			The most recently registered demangler that claims a name is a mangled string

binaryninjacore.h

@@ -37,14 +37,18 @@
 // Current ABI version for linking to the core. This is incremented any time
 // there are changes to the API that affect linking, including new functions,
 // new types, or modifications to existing functions or types.
-#define BN_CURRENT_CORE_ABI_VERSION 177
+#define BN_CURRENT_CORE_ABI_VERSION 178
 
 // Minimum ABI version that is supported for loading of plugins. Plugins that
 // are linked to an ABI version less than this will not be able to load and
 // will require rebuilding. The minimum version is increased when there are
 // incompatible changes that break binary compatibility, such as changes to
 // existing types or functions.
-#define BN_MINIMUM_CORE_ABI_VERSION 176
+#define BN_MINIMUM_CORE_ABI_VERSION 178
+
+#define BN_DEMANGLER_MSVC "MS"
+#define BN_DEMANGLER_GNU3 "GNU3"
+#define BN_DEMANGLER_LLVM "LLVM"
 
 #ifdef __GNUC__
 	#ifdef BINARYNINJACORE_LIBRARY
@@ -3913,7 +3917,6 @@ extern "C"
 
 	typedef struct BNDemanglerCallbacks
 	{
-		size_t size;
 		void* context;
 		bool (*isMangledString)(void* ctxt, const char* name);
 		bool (*demangle)(void* ctxt, const char* name, const BNDemanglerConfig* config,
@@ -8260,10 +8263,6 @@ extern "C"
 	BINARYNINJACOREAPI void BNUpdateReportFlowGraph(BNReportCollection* reports, size_t i, BNFlowGraph* graph);
 
 	// Demangler
-#define BN_DEMANGLER_MSVC "msvc"
-#define BN_DEMANGLER_GNU3 "gnu3"
-#define BN_DEMANGLER_LLVM "llvm"
-
 	BINARYNINJACOREAPI BNDemanglerConfig BNGetDefaultDemanglerConfig(void);
 	BINARYNINJACOREAPI BNDemanglerConfig BNGetDemanglerConfigForPlatform(BNPlatform* platform,
 	    bool simplifyTemplates);