Implement rust TypeParser

Author: rbran

rust/src/lib.rs

@@ -148,6 +148,7 @@ pub mod fileaccessor;
 pub mod filemetadata;
 pub mod flowgraph;
 pub mod function;
+pub mod typeparser;
 pub mod functionrecognizer;
 pub mod headless;
 pub mod hlil;

rust/src/platform.rs

@@ -14,7 +14,7 @@
 
 //! Contains all information related to the execution environment of the binary, mainly the calling conventions used
 
-use std::{borrow::Borrow, collections::HashMap, os::raw, path::Path, ptr, slice};
+use std::{borrow::Borrow, ffi, ptr};
 
 use binaryninjacore_sys::*;
 
@@ -26,6 +26,7 @@ use crate::{
     typelibrary::TypeLibrary,
     types::{QualifiedName, QualifiedNameAndType, Type},
 };
+use crate::typeparser::{TypeParserError, TypeParserErrorSeverity, TypeParserResult};
 
 #[derive(PartialEq, Eq, Hash)]
 pub struct Platform {
@@ -260,95 +261,118 @@ impl Platform {
             Array::new(handles, count, ())
         }
     }
-}
 
-pub trait TypeParser {
-    fn parse_types_from_source<S: BnStrCompatible, P: AsRef<Path>>(
+    pub fn preprocess_source(
         &self,
-        _source: S,
-        _filename: S,
-        _include_directories: &[P],
-        _auto_type_source: S,
-    ) -> Result<TypeParserResult, String> {
-        Err(String::new())
+        source: &str,
+        file_name: &str,
+        include_dirs: &[BnString],
+    ) -> Result<BnString, Vec<TypeParserError>> {
+        let source_cstr = BnString::new(source);
+        let file_name_cstr = BnString::new(file_name);
+
+        let mut result = ptr::null_mut();
+        let mut error_string = ptr::null_mut();
+        let success = unsafe {
+            BNPreprocessSource(
+                source_cstr.as_ptr(),
+                file_name_cstr.as_ptr(),
+                &mut result,
+                &mut error_string,
+                include_dirs.as_ptr() as *mut *const ffi::c_char,
+                include_dirs.len(),
+            )
+        };
+        
+        if success {
+            assert!(!result.is_null());
+            Ok(unsafe { BnString::from_raw(result) })
+        } else {
+            assert!(!error_string.is_null());
+            Err(vec![TypeParserError::new(
+                TypeParserErrorSeverity::FatalSeverity,
+                unsafe { BnString::from_raw(error_string) },
+                file_name,
+                0,
+                0,
+            )])
+        }
     }
-}
-
-#[derive(Clone, Default)]
-pub struct TypeParserResult {
-    pub types: HashMap<QualifiedName, Ref<Type>>,
-    pub variables: HashMap<QualifiedName, Ref<Type>>,
-    pub functions: HashMap<QualifiedName, Ref<Type>>,
-}
-
-impl TypeParser for Platform {
-    fn parse_types_from_source<S: BnStrCompatible, P: AsRef<Path>>(
+    pub fn parse_types_from_source(
         &self,
-        source: S,
-        filename: S,
-        include_directories: &[P],
-        auto_type_source: S,
-    ) -> Result<TypeParserResult, String> {
-        let mut result = BNTypeParserResult::default();
-        let mut type_parser_result = TypeParserResult::default();
-        let mut error_string: *mut raw::c_char = ptr::null_mut();
-
-        let src = source.into_bytes_with_nul();
-        let filename = filename.into_bytes_with_nul();
-        let auto_type_source = auto_type_source.into_bytes_with_nul();
-
-        let mut include_dirs = vec![];
-
-        for dir in include_directories.iter() {
-            let d = dir
-                .as_ref()
-                .to_string_lossy()
-                .to_string()
-                .into_bytes_with_nul();
-            include_dirs.push(d.as_ptr() as _);
-        }
+        src: &str,
+        filename: &str,
+        include_dirs: &[BnString],
+        auto_type_source: &str,
+    ) -> Result<TypeParserResult, Vec<TypeParserError>> {
+        let source_cstr = BnString::new(src);
+        let file_name_cstr = BnString::new(filename);
+        let auto_type_source = BnString::new(auto_type_source);
 
-        unsafe {
-            let success = BNParseTypesFromSource(
+        let mut result = BNTypeParserResult::default();
+        let mut error_string = ptr::null_mut();
+        let success = unsafe {
+            BNParseTypesFromSource(
                 self.handle,
-                src.as_ref().as_ptr() as _,
-                filename.as_ref().as_ptr() as _,
+                source_cstr.as_ptr(),
+                file_name_cstr.as_ptr(),
                 &mut result,
                 &mut error_string,
-                include_dirs.as_mut_ptr(),
+                include_dirs.as_ptr() as *mut *const ffi::c_char,
                 include_dirs.len(),
-                auto_type_source.as_ref().as_ptr() as _,
-            );
-
-            let error_msg = BnString::from_raw(error_string);
+                auto_type_source.as_ptr(),
+            )
+        };
 
-            if !success {
-                return Err(error_msg.to_string());
-            }
+        if success {
+            Ok(unsafe { TypeParserResult::from_raw(result) })
+        } else {
+            assert!(!error_string.is_null());
+            Err(vec![TypeParserError::new(
+                TypeParserErrorSeverity::FatalSeverity,
+                unsafe { BnString::from_raw(error_string) },
+                filename,
+                0,
+                0,
+            )])
+        }
+    }
 
-            for i in slice::from_raw_parts(result.types, result.typeCount) {
-                let name = QualifiedName::from(i.name);
-                type_parser_result
-                    .types
-                    .insert(name, Type::ref_from_raw(i.type_));
-            }
+    pub fn parse_types_from_source_file(
+        &self,
+        filename: &str,
+        include_dirs: &[BnString],
+        auto_type_source: &str,
+    ) -> Result<TypeParserResult, Vec<TypeParserError>> {
+        let file_name_cstr = BnString::new(filename);
+        let auto_type_source = BnString::new(auto_type_source);
 
-            for i in slice::from_raw_parts(result.functions, result.functionCount) {
-                let name = QualifiedName::from(i.name);
-                type_parser_result
-                    .functions
-                    .insert(name, Type::ref_from_raw(i.type_));
-            }
+        let mut result = BNTypeParserResult::default();
+        let mut error_string = ptr::null_mut();
+        let success = unsafe {
+            BNParseTypesFromSourceFile(
+                self.handle,
+                file_name_cstr.as_ptr(),
+                &mut result,
+                &mut error_string,
+                include_dirs.as_ptr() as *mut *const ffi::c_char,
+                include_dirs.len(),
+                auto_type_source.as_ptr(),
+            )
+        };
 
-            for i in slice::from_raw_parts(result.variables, result.variableCount) {
-                let name = QualifiedName::from(i.name);
-                type_parser_result
-                    .variables
-                    .insert(name, Type::ref_from_raw(i.type_));
-            }
+        if success {
+            Ok(unsafe { TypeParserResult::from_raw(result) })
+        } else {
+            assert!(!error_string.is_null());
+            Err(vec![TypeParserError::new(
+                TypeParserErrorSeverity::FatalSeverity,
+                unsafe { BnString::from_raw(error_string) },
+                filename,
+                0,
+                0,
+            )])
         }
-
-        Ok(type_parser_result)
     }
 }
 

rust/src/settings.rs

@@ -50,6 +50,10 @@ impl Settings {
         }
     }
 
+    pub fn default() -> Ref<Self> {
+        Self::new("default")
+    }
+
     pub fn set_resource_id<S: BnStrCompatible>(&self, resource_id: S) {
         let resource_id = resource_id.into_bytes_with_nul();
         unsafe { BNSettingsSetResourceId(self.handle, resource_id.as_ref().as_ptr() as *mut _) };