Improve handling of structs

We have one spot where we need to build the FFI type for a struct and
we don't need to know the name of it, just its arity and its
individual types.

This adds a utility function in order to check on that and uses it
instead of checking knownStructs.

Author: keegnotrub

ext/obj_ext/RIGSBridgeSupportParser.m

@@ -306,7 +306,7 @@ - (void)finalizeArg
 
   if (_blockIndex != -1) {
     if (_methodName) {
-      rb_objc_register_block_from_objc([_methodName UTF8String], _blockIndex, [_objcTypes UTF8String]);
+      rb_objc_register_block_arg_from_objc([_methodName UTF8String], _blockIndex, [_objcTypes UTF8String]);
     }
 
     _blockIndex = -1;

ext/obj_ext/RIGSCore.h

@@ -40,11 +40,12 @@ VALUE rb_objc_register_instance_method_from_rb(VALUE rb_class, VALUE rb_method);
 void rb_objc_register_float_from_objc(const char *name, double value);
 void rb_objc_register_integer_from_objc(const char *name, long long value);
 void rb_objc_register_struct_from_objc(const char *key, const char *name, const char *args[], size_t argCount);
-void rb_objc_register_format_string_from_objc(const char *selector, size_t index);
-void rb_objc_register_block_from_objc(const char *selector, size_t index, const char *objcTypes);
 void rb_objc_register_constant_from_objc(const char *name, const char *type);
 void rb_objc_register_function_from_objc(const char *name, const char *objcTypes);
 void rb_objc_register_protocol_from_objc(const char *selector, const char *objcTypes);
+void rb_objc_register_format_string_from_objc(const char *selector, size_t index);
+void rb_objc_register_type_arg_from_objc(const char *selector, size_t index, const char *objcTypes);
+void rb_objc_register_block_arg_from_objc(const char *selector, size_t index, const char *objcTypes);
 
 VALUE rb_objc_import(VALUE rb_self, VALUE rb_name);
 VALUE rb_objc_new(int rigs_argc, VALUE *rigs_argv, VALUE rb_class);

ext/obj_ext/RIGSCore.m

@@ -48,8 +48,11 @@
 // Hash table that maps known ObjC functions to objcTypes encoding
 static NSMapTable *knownFunctions = 0;
 
-// Hash table that maps known ObjC selectors to block objcTypes encoding
-static NSMapTable *knownBlocks = 0;
+// Hash table that maps known ObjC selectors with arg position to block objcTypes encoding
+static NSMapTable *knownBlockArgs = 0;
+
+// Hash table that maps known ObjC selectors with arg position to objcTypes encoding
+static NSMapTable *knownTypeArgs = 0;
 
 // Hash table that maps known ObjC selectors to objcTypes encoding
 static NSMapTable *knownProtocols = 0;
@@ -154,9 +157,8 @@
 rb_objc_ffi_type_for_type(const char *type)
 {
   ffi_type *inStruct = NULL;
-  unsigned long inStructHash;
   int inStructIndex = 0;
-  long inStructCount = 0;
+  unsigned long inStructCount = 0;
 
   type = rb_objc_skip_type_qualifiers(type);
 
@@ -165,16 +167,15 @@
   }
 
   if (*type == _C_STRUCT_B) {
-    inStructHash = rb_objc_hash_struct(type);
-    type = rb_objc_skip_type_sname(type);
-    inStructCount = rb_array_len(rb_struct_s_members((VALUE)NSMapGet(knownStructs, (void*)inStructHash)));
-                               
+    inStructCount = rb_objc_struct_type_arity(type);
+
     inStruct = (ffi_type *)malloc(sizeof(ffi_type));
     inStruct->size = 0;
     inStruct->alignment = 0;
     inStruct->type = FFI_TYPE_STRUCT;
     inStruct->elements = malloc((inStructCount + 1) * sizeof(ffi_type *));
-    
+
+    type = rb_objc_skip_type_sname(type);
     while (*type != _C_STRUCT_E) {
       inStruct->elements[inStructIndex++] = rb_objc_ffi_type_for_type(type);
       type = rb_objc_skip_typespec(type);
@@ -192,10 +193,10 @@
   case _C_PTR:    
     return &ffi_type_pointer;
   case _C_BOOL:
-  case _C_UCHR:
-    return &ffi_type_uchar;
   case _C_CHR:
     return &ffi_type_schar;
+  case _C_UCHR:
+    return &ffi_type_uchar;
   case _C_SHT:
     return &ffi_type_sshort;
   case _C_USHT:
@@ -575,12 +576,7 @@ object by calling rb_objc_release() */
       break; 
     }
 
-    if (inStruct) {
-      // skip the component we have just processed
-      type = rb_objc_skip_typespec(type);
-    }
-
-  } while (inStruct && *type != _C_STRUCT_E);
+  } while (inStruct && (type = rb_objc_skip_typespec(type)) && *type != _C_STRUCT_E);
 
   if (ret == NO) {
     /* raise exception - Don't know how to handle this type of argument */
@@ -659,7 +655,6 @@ object by calling rb_objc_release() */
         break;
 
       case _C_CHR:
-        // Assume that if YES or NO then it's a BOOLean
         if (__OBJC_BOOL_IS_BOOL != 1 && *(char *)where == YES) 
           rb_val = Qtrue;
         else if (__OBJC_BOOL_IS_BOOL != 1 && *(char *)where == NO)
@@ -760,15 +755,13 @@ object by calling rb_objc_release() */
         // the end of the running Ruby array
         rb_ary_push(end, rb_val);
       }
-      // skip the type of the component we have just processed
-      type = (char*)rb_objc_skip_typespec(type);
     } else {
       // We are not in a C structure so simply return the
       // Ruby value
       *rb_val_ptr = rb_val;
     }   
 
-  } while (inStruct && *type != _C_STRUCT_E);
+  } while (inStruct && (type = rb_objc_skip_typespec(type)) && *type != _C_STRUCT_E);
 
   if (end != Qnil && NSMapGet(knownStructs, (void*)inStructHash) != NULL) {
     *rb_val_ptr = rb_struct_alloc((VALUE)NSMapGet(knownStructs, (void*)inStructHash), end);
@@ -793,7 +786,7 @@ object by calling rb_objc_release() */
   nbArgs = [signature numberOfArguments];
   objcTypesIndex = 0;
 
-  type = [signature methodReturnType];  
+  type = [signature methodReturnType];
   while (*type) {
     objcTypes[objcTypesIndex++] = *type++;
   }
@@ -961,10 +954,9 @@ object by calling rb_objc_release() */
 }
 
 static VALUE
-rb_objc_dispatch(id rcv, const char *method, NSMethodSignature *signature, int rigs_argc, VALUE *rigs_argv)
+rb_objc_dispatch(id rcv, const char *method, unsigned long hash, const char *types, int rigs_argc, VALUE *rigs_argv)
 {
   void *sym;
-  unsigned long hash;
   int nbArgs;
   int nbArgsExtra;
   int nbArgsAdjust;
@@ -982,9 +974,14 @@ object by calling rb_objc_release() */
   void *closurePtr;
   struct rb_objc_block *block;
   ffi_cif closureCif;
+  NSMethodSignature *signature;
+
+  signature = [NSMethodSignature signatureWithObjCTypes:types];
+  if (!signature) {
+    rb_raise(rb_eTypeError, "selector %s is missing an Objective-C signature", method);
+  }
 
   if (rcv != nil) {
-    // TODO: perhaps check [rcv methodForSelector:sel] for IMP
     nbArgsAdjust = 2;
     switch(*(signature.methodReturnType)) {
 #ifndef __aarch64__
@@ -1006,8 +1003,6 @@ object by calling rb_objc_release() */
     return Qnil;
   }
 
-  hash = rb_objc_hash(method);
-
   nbArgs = (int)[signature numberOfArguments];
   nbArgsExtra = rigs_argc - (nbArgs - nbArgsAdjust);
 
@@ -1058,7 +1053,7 @@ object by calling rb_objc_release() */
   for (i=nbArgsAdjust;i<nbArgs;i++) {
     type = [signature getArgumentTypeAtIndex:i];
     if (strcmp(type, "@?") == 0) {
-      const char* blockObjcTypes = NSMapGet(knownBlocks, (void*)(hash + i - nbArgsAdjust));
+      const char* blockObjcTypes = NSMapGet(knownBlockArgs, (void*)(hash + i - nbArgsAdjust));
       if (blockObjcTypes && rb_objc_build_closure_cif(&closureCif, blockObjcTypes) == FFI_OK) {
         closure = ffi_closure_alloc(sizeof(ffi_closure), &closurePtr);
         if (ffi_prep_closure_loc(closure, &closureCif, rb_objc_block_handler, &rigs_argv[i-nbArgsAdjust], closurePtr) == FFI_OK) {
@@ -1137,17 +1132,24 @@ object by calling rb_objc_release() */
 rb_objc_send(int rigs_argc, VALUE *rigs_argv, VALUE rb_self)
 {
   @autoreleasepool {
-    const char *method;
+    const char *our_method;
     int our_argc;
     VALUE *our_argv;
     id rcv;
     SEL sel;
-    NSMethodSignature *signature;
+    const char *method;
+    const char *pos;
+    const char *lpos;
+    const char *type;
+    unsigned long typeIndex;
+    unsigned long hash;
+    Method mth;
+    char types[128] = { '\0' };
 
-    method = rb_id2name(rb_frame_this_func());
+    our_method = rb_id2name(rb_frame_this_func());
     our_argc = rigs_argc;
     our_argv = rigs_argv;
-  
+
     if (rb_block_given_p()) {
       our_argc = rigs_argc + 1;
       our_argv = alloca(our_argc * sizeof(VALUE));
@@ -1157,31 +1159,47 @@ object by calling rb_objc_release() */
       our_argv[our_argc-1] = rb_block_proc();
     }
 
+    sel = rb_objc_method_to_sel(our_method, our_argc);
+    if (sel == NULL) {
+      rb_raise(rb_eTypeError, "method %s is not a valid Objective-C selector", method);
+    }
+
+    method = sel_getName(sel);
+    hash = rb_objc_hash(method);
+
     /* determine the receiver type - Class or instance ? */
     switch (TYPE(rb_self)) {
     case T_DATA:
       Data_Get_Struct(rb_self, void, rcv);
+      mth = class_getInstanceMethod(object_getClass(rcv), sel);
       break;
     case T_CLASS:
       rcv = (Class)NUM2LL(rb_iv_get(rb_self, "@objc_class"));
+      mth = class_getClassMethod(rcv, sel);
       break;
     default:
       rb_raise(rb_eTypeError, "can't convert %"PRIsVALUE" into compatible objc_msgSend value", rb_self);
       break;
     }
 
-    sel = rb_objc_method_to_sel(method, our_argc);
-    if (sel == NULL) {
-      rb_raise(rb_eTypeError, "method %s is not a valid Objective-C selector", method);
-    }
-
-    signature = [rcv methodSignatureForSelector:sel];
-    if (!signature) {
-      rb_raise(rb_eTypeError, "selector %s is missing an Objective-C signature", sel_getName(sel));
+    pos = rb_objc_skip_type_qualifiers(method_getTypeEncoding(mth));
+    typeIndex = 0;
+    while((lpos = pos) && (pos = rb_objc_skip_typespec(lpos))) {
+      if (typeIndex != 1 &&
+          typeIndex != 2 &&
+          (type = NSMapGet(knownTypeArgs, (void*)(hash + typeIndex == 0 ? -1 : typeIndex - 2)))) {
+        strlcat(types, type, strlen(type) + strlen(types) + 1);
+      }
+      else {
+        strlcat(types, lpos, pos - lpos + strlen(types) + 1);
+      }
+      pos = rb_objc_skip_type_size(pos);
+      pos = rb_objc_skip_type_qualifiers(pos);
+      typeIndex++;
     }
 
     @try {
-      return rb_objc_dispatch(rcv, sel_getName(sel), signature, our_argc, our_argv);
+      return rb_objc_dispatch(rcv, method, hash, types, our_argc, our_argv);
     }
     @catch (NSException *exception) {
       rb_objc_raise_exception(exception);
@@ -1196,7 +1214,6 @@ object by calling rb_objc_release() */
     const char *method;
     unsigned long hash;
     const char *objcTypes;
-    NSMethodSignature *signature;
 
     method = rb_id2name(rb_frame_this_func());
     hash = rb_objc_hash(method);
@@ -1206,14 +1223,8 @@ object by calling rb_objc_release() */
       return Qnil;
     }
 
-    signature = [NSMethodSignature signatureWithObjCTypes:objcTypes];
-
-    if (!signature) {
-      return Qnil;
-    }
-
     @try {
-      return rb_objc_dispatch(nil, method, signature, rigs_argc, rigs_argv);
+      return rb_objc_dispatch(nil, method, hash, objcTypes, rigs_argc, rigs_argv);
     }
     @catch (NSException *exception) {
       rb_objc_raise_exception(exception);
@@ -1363,33 +1374,6 @@ object by calling rb_objc_release() */
   rb_define_const(rb_mRigs, name, rb_integer);
 }
 
-void
-rb_objc_register_block_from_objc(const char *selector, size_t index, const char *objcTypes)
-{
-  unsigned long hash;
-  char *data;
-
-  hash = rb_objc_hash(selector) + index;
-
-  if (!NSMapGet(knownBlocks, (void*)hash)) {
-    data = malloc(sizeof(char) * (strlen(objcTypes) + 1));
-    strcpy(data, objcTypes);
-    NSMapInsertKnownAbsent(knownBlocks, (void*)hash, (void*)data);
-  }
-}
-
-void
-rb_objc_register_format_string_from_objc(const char *selector, size_t index)
-{
-  unsigned long hash;
-
-  hash = rb_objc_hash(selector);
-
-  if (!NSMapGet(knownFormatStrings, (void*)hash)) {
-    NSMapInsertKnownAbsent(knownFormatStrings, (void*)hash, (void*)(index + 1));
-  }
-}
-
 void
 rb_objc_register_struct_from_objc(const char *key, const char *name, const char *args[], size_t argCount)
 {
@@ -1427,6 +1411,49 @@ object by calling rb_objc_release() */
   NSMapInsertKnownAbsent(knownStructs, (void*)hash, (void*)rb_struct);
 }
 
+void
+rb_objc_register_type_arg_from_objc(const char *selector, size_t index, const char *objcTypes)
+{
+  unsigned long hash;
+  char *data;
+
+  hash = rb_objc_hash(selector) + index;
+
+  if (!NSMapGet(knownTypeArgs, (void*)hash)) {
+    data = malloc(sizeof(char) * (strlen(objcTypes) + 1));
+    strcpy(data, objcTypes);
+    NSMapInsertKnownAbsent(knownTypeArgs, (void*)hash, (void*)data);
+  }
+}
+
+
+void
+rb_objc_register_block_arg_from_objc(const char *selector, size_t index, const char *objcTypes)
+{
+  unsigned long hash;
+  char *data;
+
+  hash = rb_objc_hash(selector) + index;
+
+  if (!NSMapGet(knownBlockArgs, (void*)hash)) {
+    data = malloc(sizeof(char) * (strlen(objcTypes) + 1));
+    strcpy(data, objcTypes);
+    NSMapInsertKnownAbsent(knownBlockArgs, (void*)hash, (void*)data);
+  }
+}
+
+void
+rb_objc_register_format_string_from_objc(const char *selector, size_t index)
+{
+  unsigned long hash;
+
+  hash = rb_objc_hash(selector);
+
+  if (!NSMapGet(knownFormatStrings, (void*)hash)) {
+    NSMapInsertKnownAbsent(knownFormatStrings, (void*)hash, (void*)(index + 1));
+  }
+}
+
 VALUE
 rb_objc_register_class_from_objc (Class objc_class)
 {
@@ -1767,7 +1794,8 @@ void __attribute__((noreturn))
   knownObjects = NSCreateMapTable(NSNonOwnedPointerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
   knownStructs = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
   knownFunctions = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
-  knownBlocks = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
+  knownBlockArgs = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
+  knownTypeArgs = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
   knownProtocols = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
   knownImplementations = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSNonOwnedPointerMapValueCallBacks, 0);
   knownFormatStrings = NSCreateMapTable(NSIntegerMapKeyCallBacks, NSIntegerMapValueCallBacks, 0);

ext/obj_ext/RIGSUtilities.h

@@ -42,7 +42,9 @@ char *rb_objc_sel_to_alias(SEL sel);
 
 unsigned long rb_objc_hash(const char *value);
 unsigned long rb_objc_hash_struct(const char *value);
+unsigned long rb_objc_struct_type_arity(const char *type);
 const char *rb_objc_skip_type_qualifiers(const char *type);
+const char *rb_objc_skip_type_size(const char *type);
 const char *rb_objc_skip_type_sname(const char *type);
 const char *rb_objc_skip_typespec(const char *type);