fixup! Migrate Rust demangler bindings and consumers

Author: plafosse

plugins/pdb-ng/src/symbol_parser.rs

@@ -39,7 +39,7 @@ use crate::PDBParserInstance;
 use binaryninja::architecture::{Architecture, ArchitectureExt, Register, RegisterId};
 use binaryninja::binary_view::BinaryViewBase;
 use binaryninja::confidence::{Conf, MAX_CONFIDENCE, MIN_CONFIDENCE};
-use binaryninja::demangle::demangle_ms;
+use binaryninja::demangle::{demangle_ms_with_config, DemanglerConfig};
 use binaryninja::rc::Ref;
 use binaryninja::types::{FunctionParameter, QualifiedName, StructureBuilder, Type, TypeClass};
 use binaryninja::variable::{Variable, VariableSourceType};
@@ -1813,11 +1813,8 @@ impl<'a, S: Source<'a> + 'a> PDBParserInstance<'a, S> {
         raw_name: &String,
         rva: Rva,
     ) -> Result<(Option<Conf<Ref<Type>>>, Option<QualifiedName>)> {
-        let simplify_templates = self.settings.get_bool_with_opts(
-            "analysis.types.templateSimplifier",
-            &mut self.settings_query_opts.clone(),
-        );
-        let (mut t, mut name) = match demangle_ms(&self.arch, raw_name, simplify_templates) {
+        let demangler_config = DemanglerConfig::for_binary_view(self.bv);
+        let (mut t, mut name) = match demangle_ms_with_config(raw_name, &demangler_config) {
             Some(result) => (
                 result.ty.map(|ty| Conf::new(ty, DEMANGLE_CONFIDENCE)),
                 result.name,

rust/src/demangle.rs

@@ -67,9 +67,9 @@ impl DemanglerConfig {
         Self::from_api_object(&config)
     }
 
-    pub fn from_api_object(config: &BNDemanglerConfig) -> Self {
+    pub(crate) fn from_api_object(config: &BNDemanglerConfig) -> Self {
         let platform = match config.platform.is_null() {
-            true => Self::default().platform,
+            true => None,
             false => {
                 Some(unsafe { Platform::ref_from_raw(BNNewPlatformReference(config.platform)) })
             }
@@ -92,7 +92,7 @@ impl DemanglerConfig {
             .expect("default demangler config has no platform")
     }
 
-    pub fn to_api_object(&self) -> BNDemanglerConfig {
+    pub(crate) fn to_api_object(&self) -> BNDemanglerConfig {
         let platform = self.get_platform();
         BNDemanglerConfig {
             platform: platform.handle,
@@ -124,9 +124,10 @@ impl DemanglerResult {
         }
     }
 
-    pub fn from_api_object(result: &BNDemanglerResult) -> Self {
+    pub(crate) fn from_api_object(result: &BNDemanglerResult) -> Self {
         let ty = match result.type_.is_null() {
             true => None,
+            // The source result remains independently owned and is freed by the caller.
             false => Some(unsafe { Type::ref_from_raw(BNNewTypeReference(result.type_)) }),
         };
         Self {
@@ -135,13 +136,13 @@ impl DemanglerResult {
         }
     }
 
-    pub fn from_api_object_and_free(result: &mut BNDemanglerResult) -> Self {
+    pub(crate) fn from_api_object_and_free(result: &mut BNDemanglerResult) -> Self {
         let demangler_result = Self::from_api_object(result);
         unsafe { BNFreeDemanglerResult(result) };
         demangler_result
     }
 
-    pub fn to_api_object(&self) -> BNDemanglerResult {
+    pub(crate) fn to_api_object(&self) -> BNDemanglerResult {
         BNDemanglerResult {
             name: QualifiedName::into_raw(self.name.clone()),
             type_: self
@@ -223,9 +224,18 @@ pub fn demangle_generic(
 }
 
 pub fn demangle_llvm(mangled_name: &str, simplify: bool) -> Option<DemanglerResult> {
-    let mut config = DemanglerConfig::default();
-    config.simplify_templates = simplify;
-    demangle_with_demangler(llvm_demangler(), mangled_name, &config)
+    let config = DemanglerConfig {
+        simplify_templates: simplify,
+        ..DemanglerConfig::default()
+    };
+    demangle_llvm_with_config(mangled_name, &config)
+}
+
+pub fn demangle_llvm_with_config(
+    mangled_name: &str,
+    config: &DemanglerConfig,
+) -> Option<DemanglerResult> {
+    demangle_with_demangler(llvm_demangler(), mangled_name, config)
 }
 
 pub fn demangle_gnu3(
@@ -238,7 +248,14 @@ pub fn demangle_gnu3(
         .map(|platform| DemanglerConfig::for_platform(&platform, simplify))
         .unwrap_or_default();
     config.simplify_templates = simplify;
-    demangle_with_demangler(gnu3_demangler(), mangled_name, &config)
+    demangle_gnu3_with_config(mangled_name, &config)
+}
+
+pub fn demangle_gnu3_with_config(
+    mangled_name: &str,
+    config: &DemanglerConfig,
+) -> Option<DemanglerResult> {
+    demangle_with_demangler(gnu3_demangler(), mangled_name, config)
 }
 
 pub fn demangle_ms(
@@ -251,7 +268,14 @@ pub fn demangle_ms(
         .map(|platform| DemanglerConfig::for_platform(&platform, simplify))
         .unwrap_or_default();
     config.simplify_templates = simplify;
-    demangle_with_demangler(msvc_demangler(), mangled_name, &config)
+    demangle_ms_with_config(mangled_name, &config)
+}
+
+pub fn demangle_ms_with_config(
+    mangled_name: &str,
+    config: &DemanglerConfig,
+) -> Option<DemanglerResult> {
+    demangle_with_demangler(msvc_demangler(), mangled_name, config)
 }
 
 pub fn simplify_demangled_template_name(name: impl Into<QualifiedName>) -> QualifiedName {
@@ -366,7 +390,6 @@ impl Demangler {
         let ctxt = Box::into_raw(Box::new(demangler));
 
         let callbacks = Box::into_raw(Box::new(BNDemanglerCallbacks {
-            size: std::mem::size_of::<BNDemanglerCallbacks>(),
             context: ctxt as *mut c_void,
             isMangledString: Some(cb_is_mangled_string::<C>),
             demangle: Some(cb_demangle::<C>),