2010-12-15 Nicola Pero <nicola.pero@meta-innovation.com>

	* sendmsg.c: Reindented some code and tidied up comments.  No
	actual code changes.


git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@167835 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 134 insertions, 133 deletions

diff --git a/libobjc/sendmsg.c b/libobjc/sendmsg.c
index 4748695938d..48605fc67f8 100644
--- a/libobjc/sendmsg.c
+++ b/libobjc/sendmsg.c
@@ -60,32 +60,30 @@ see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 #define INVISIBLE_STRUCT_RETURN 0
 #endif
 
-/* The uninstalled dispatch table */
+/* The uninstalled dispatch table.  */
 struct sarray *__objc_uninstalled_dtable = 0;   /* !T:MUTEX */
 
-/* Two hooks for method forwarding. If either is set, it is invoked
- * to return a function that performs the real forwarding.  If both
- * are set, the result of __objc_msg_forward2 will be preferred over
- * that of __objc_msg_forward.  If both return NULL or are unset,
- * the libgcc based functions (__builtin_apply and friends) are
- * used.
- */
+/* Two hooks for method forwarding. If either is set, it is invoked to
+ * return a function that performs the real forwarding.  If both are
+ * set, the result of __objc_msg_forward2 will be preferred over that
+ * of __objc_msg_forward.  If both return NULL or are unset, the
+ * libgcc based functions (__builtin_apply and friends) are used.  */
 IMP (*__objc_msg_forward) (SEL) = NULL;
 IMP (*__objc_msg_forward2) (id, SEL) = NULL;
 
-/* Send +initialize to class */
+/* Send +initialize to class.  */
 static void __objc_send_initialize (Class);
 
 static void __objc_install_dispatch_table_for_class (Class);
 
-/* Forward declare some functions */
+/* Forward declare some functions.  */
 static void __objc_init_install_dtable (id, SEL);
 
 /* Various forwarding functions that are used based upon the
    return type for the selector.
    __objc_block_forward for structures.
    __objc_double_forward for floats/doubles.
-   __objc_word_forward for pointers or types that fit in registers. */
+   __objc_word_forward for pointers or types that fit in registers.  */
 static double __objc_double_forward (id, SEL, ...);
 static id __objc_word_forward (id, SEL, ...);
 typedef struct { id many[8]; } __big;
@@ -99,14 +97,15 @@ static struct objc_method * search_for_method_in_hierarchy (Class class, SEL sel
 struct objc_method * search_for_method_in_list (struct objc_method_list * list, SEL op);
 id nil_method (id, SEL);
 
-/* Given a selector, return the proper forwarding implementation. */
+/* Given a selector, return the proper forwarding implementation.  */
 inline
 IMP
 __objc_get_forward_imp (id rcv, SEL sel)
 {
-  /* If a custom forwarding hook was registered, try getting a forwarding
-     function from it. There are two forward routine hooks, one that
-     takes the receiver as an argument and one that does not. */
+  /* If a custom forwarding hook was registered, try getting a
+     forwarding function from it. There are two forward routine hooks,
+     one that takes the receiver as an argument and one that does
+     not.  */
   if (__objc_msg_forward2)
     {
       IMP result;
@@ -120,11 +119,11 @@ __objc_get_forward_imp (id rcv, SEL sel)
         return result;
     }
 
-  /* In all other cases, use the default forwarding functions built using
-     __builtin_apply and friends.  */
+  /* In all other cases, use the default forwarding functions built
+     using __builtin_apply and friends.  */
     {
       const char *t = sel->sel_types;
-
+      
       if (t && (*t == '[' || *t == '(' || *t == '{')
 #ifdef OBJC_MAX_STRUCT_BY_VALUE
           && objc_sizeof_type (t) > OBJC_MAX_STRUCT_BY_VALUE
@@ -234,7 +233,8 @@ __objc_resolve_instance_method (Class class, SEL sel)
 /* Temporary definition until we include objc/runtime.h.  */
 objc_EXPORT Class objc_lookupClass (const char *name);
 
-/* Given a class and selector, return the selector's implementation.  */
+/* Given a class and selector, return the selector's
+   implementation.  */
 inline
 IMP
 get_imp (Class class, SEL sel)
@@ -250,10 +250,10 @@ get_imp (Class class, SEL sel)
   void *res = sarray_get_safe (class->dtable, (size_t) sel->sel_id);
   if (res == 0)
     {
-      /* Not a valid method */
+      /* Not a valid method.  */
       if (class->dtable == __objc_uninstalled_dtable)
 	{
-	  /* The dispatch table needs to be installed. */
+	  /* The dispatch table needs to be installed.  */
 	  objc_mutex_lock (__objc_runtime_mutex);
 
 	   /* Double-checked locking pattern: Check
@@ -266,8 +266,8 @@ get_imp (Class class, SEL sel)
            }
 
 	  objc_mutex_unlock (__objc_runtime_mutex);
-	  /* Call ourselves with the installed dispatch table
-	     and get the real method */
+	  /* Call ourselves with the installed dispatch table and get
+	     the real method.  */
 	  res = get_imp (class, sel);
 	}
       else
@@ -277,8 +277,7 @@ get_imp (Class class, SEL sel)
          /* Get the method from the dispatch table (we try to get it
 	    again in case another thread has installed the dtable just
 	    after we invoked sarray_get_safe, but before we checked
-	    class->dtable == __objc_uninstalled_dtable).
-         */
+	    class->dtable == __objc_uninstalled_dtable).  */
 	  res = sarray_get_safe (class->dtable, (size_t) sel->sel_id);
 	  if (res == 0)
 	    {
@@ -305,12 +304,12 @@ get_imp (Class class, SEL sel)
 	      if (res == 0)
 		{
 		  /* If that fails, then return the forwarding
-		     implementation.  We don't know the receiver (only its
-		     class), so we have to pass 'nil' as the first
+		     implementation.  We don't know the receiver (only
+		     its class), so we have to pass 'nil' as the first
 		     argument.  Passing the class as first argument is
-		     wrong because the class is not the receiver; it can
-		     result in us calling a class method when we want an
-		     instance method of the same name.  */
+		     wrong because the class is not the receiver; it
+		     can result in us calling a class method when we
+		     want an instance method of the same name.  */
 		  res = __objc_get_forward_imp (nil, sel);
 		}
 	    }
@@ -338,15 +337,15 @@ method_get_imp (struct objc_method * method)
 }
 
 /* Query if an object can respond to a selector, returns YES if the
-object implements the selector otherwise NO.  Does not check if the
-method can be forwarded. */
+   object implements the selector otherwise NO.  Does not check if the
+   method can be forwarded.  */
 inline
 BOOL
 __objc_responds_to (id object, SEL sel)
 {
   void *res;
 
-  /* Install dispatch table if need be */
+  /* Install dispatch table if need be.  */
   if (object->class_pointer->dtable == __objc_uninstalled_dtable)
     {
       objc_mutex_lock (__objc_runtime_mutex);
@@ -357,7 +356,7 @@ __objc_responds_to (id object, SEL sel)
       objc_mutex_unlock (__objc_runtime_mutex);
     }
 
-  /* Get the method from the dispatch table */
+  /* Get the method from the dispatch table.  */
   res = sarray_get_safe (object->class_pointer->dtable, (size_t) sel->sel_id);
   return (res != 0);
 }
@@ -370,7 +369,7 @@ class_respondsToSelector (Class class_, SEL selector)
   if (class_ == Nil  ||  selector == NULL)
     return NO;
 
-  /* Install dispatch table if need be */
+  /* Install dispatch table if need be.  */
   if (class_->dtable == __objc_uninstalled_dtable)
     {
       objc_mutex_lock (__objc_runtime_mutex);
@@ -381,15 +380,15 @@ class_respondsToSelector (Class class_, SEL selector)
       objc_mutex_unlock (__objc_runtime_mutex);
     }
 
-  /* Get the method from the dispatch table */
+  /* Get the method from the dispatch table.  */
   res = sarray_get_safe (class_->dtable, (size_t) selector->sel_id);
   return (res != 0);
 }
 
-/* This is the lookup function.  All entries in the table are either a 
+/* This is the lookup function.  All entries in the table are either a
    valid method *or* zero.  If zero then either the dispatch table
-   needs to be installed or it doesn't exist and forwarding is attempted. */
-
+   needs to be installed or it doesn't exist and forwarding is
+   attempted.  */
 IMP
 objc_msg_lookup (id receiver, SEL op)
 {
@@ -400,14 +399,16 @@ objc_msg_lookup (id receiver, SEL op)
 				(sidx)op->sel_id);
       if (result == 0)
 	{
-	  /* Not a valid method */
+	  /* Not a valid method.  */
 	  if (receiver->class_pointer->dtable == __objc_uninstalled_dtable)
 	    {
-	      /* The dispatch table needs to be installed.
-		 This happens on the very first method call to the class. */
+	      /* The dispatch table needs to be installed.  This
+		 happens on the very first method call to the
+		 class.  */
 	      __objc_init_install_dtable (receiver, op);
 
-	      /* Get real method for this in newly installed dtable */
+	      /* Get real method for this in newly installed
+		 dtable.  */
 	      result = get_imp (receiver->class_pointer, op);
 	    }
 	  else
@@ -415,8 +416,7 @@ objc_msg_lookup (id receiver, SEL op)
 	      /* The dispatch table has been installed.  Check again
 		 if the method exists (just in case the dispatch table
 		 has been installed by another thread after we did the
-		 previous check that the method exists).
-	      */
+		 previous check that the method exists).  */
 	      result = sarray_get_safe (receiver->class_pointer->dtable,
 					(sidx)op->sel_id);
 	      if (result == 0)
@@ -432,7 +432,7 @@ objc_msg_lookup (id receiver, SEL op)
 		  if (result == 0)
 		    {
 		      /* If the method still just doesn't exist for
-			 the class, attempt to forward the method. */
+			 the class, attempt to forward the method.  */
 		      result = __objc_get_forward_imp (receiver, op);
 		    }
 		}
@@ -477,16 +477,16 @@ __objc_init_dispatch_tables ()
   selector_resolveInstanceMethod  =sel_register_name ("resolveInstanceMethod:");
 }
 
-/* This function is called by objc_msg_lookup when the
-   dispatch table needs to be installed; thus it is called once
-   for each class, namely when the very first message is sent to it. */
+/* This function is called by objc_msg_lookup when the dispatch table
+   needs to be installed; thus it is called once for each class,
+   namely when the very first message is sent to it.  */
 static void
 __objc_init_install_dtable (id receiver, SEL op __attribute__ ((__unused__)))
 {
   objc_mutex_lock (__objc_runtime_mutex);
   
-  /* This may happen, if the programmer has taken the address of a 
-     method before the dtable was initialized... too bad for him! */
+  /* This may happen, if the programmer has taken the address of a
+     method before the dtable was initialized... too bad for him!  */
   if (receiver->class_pointer->dtable != __objc_uninstalled_dtable)
     {
       objc_mutex_unlock (__objc_runtime_mutex);
@@ -495,23 +495,23 @@ __objc_init_install_dtable (id receiver, SEL op __attribute__ ((__unused__)))
   
   if (CLS_ISCLASS (receiver->class_pointer))
     {
-      /* receiver is an ordinary object */
+      /* receiver is an ordinary object.  */
       assert (CLS_ISCLASS (receiver->class_pointer));
 
-      /* install instance methods table */
+      /* Install instance methods table.  */
       __objc_install_dispatch_table_for_class (receiver->class_pointer);
 
-      /* call +initialize -- this will in turn install the factory 
-	 dispatch table if not already done :-) */
+      /* Call +initialize -- this will in turn install the factory
+	 dispatch table if not already done. :-)  */
       __objc_send_initialize (receiver->class_pointer);
     }
   else
     {
-      /* receiver is a class object */
+      /* receiver is a class object.  */
       assert (CLS_ISCLASS ((Class)receiver));
       assert (CLS_ISMETA (receiver->class_pointer));
 
-      /* Install real dtable for factory methods */
+      /* Install real dtable for factory methods.  */
       __objc_install_dispatch_table_for_class (receiver->class_pointer);
 
       __objc_send_initialize ((Class)receiver);
@@ -520,7 +520,7 @@ __objc_init_install_dtable (id receiver, SEL op __attribute__ ((__unused__)))
 }
 
 /* Install dummy table for class which causes the first message to
-   that class (or instances hereof) to be initialized properly */
+   that class (or instances hereof) to be initialized properly.  */
 void
 __objc_install_premature_dtable (Class class)
 {
@@ -528,11 +528,11 @@ __objc_install_premature_dtable (Class class)
   class->dtable = __objc_uninstalled_dtable;
 }   
 
-/* Send +initialize to class if not already done */
+/* Send +initialize to class if not already done.  */
 static void
 __objc_send_initialize (Class class)
 {
-  /* This *must* be a class object */
+  /* This *must* be a class object.  */
   assert (CLS_ISCLASS (class));
   assert (! CLS_ISMETA (class));
 
@@ -541,60 +541,62 @@ __objc_send_initialize (Class class)
       CLS_SETINITIALIZED (class);
       CLS_SETINITIALIZED (class->class_pointer);
 
-      /* Create the garbage collector type memory description */
+      /* Create the garbage collector type memory description.  */
       __objc_generate_gc_type_description (class);
 
       if (class->super_class)
 	__objc_send_initialize (class->super_class);
 
       {
-	SEL 	     op = sel_register_name ("initialize");
-	IMP	     imp = 0;
+	SEL op = sel_register_name ("initialize");
+	IMP imp = 0;
         struct objc_method_list * method_list = class->class_pointer->methods;
-
-        while (method_list) {
-	  int i;
-          struct objc_method * method;
-
-          for (i = 0; i < method_list->method_count; i++) {
-	    method = &(method_list->method_list[i]);
-            if (method->method_name
-                && method->method_name->sel_id == op->sel_id) {
-	      imp = method->method_imp;
-              break;
-            }
-          }
-
-          if (imp)
-            break;
-
-          method_list = method_list->method_next;
-
-	}
+	
+        while (method_list)
+	  {
+	    int i;
+	    struct objc_method * method;
+	    
+	    for (i = 0; i < method_list->method_count; i++)
+	      {
+		method = &(method_list->method_list[i]);
+		if (method->method_name
+		    && method->method_name->sel_id == op->sel_id)
+		  {
+		    imp = method->method_imp;
+		    break;
+		  }
+	      }
+	    
+	    if (imp)
+	      break;
+	    
+	    method_list = method_list->method_next;
+	  }
 	if (imp)
-	    (*imp) ((id) class, op);
-		
+	  (*imp) ((id) class, op);
       }
     }
 }
 
-/* Walk on the methods list of class and install the methods in the reverse
-   order of the lists. Since methods added by categories are before the methods
-   of class in the methods list, this allows categories to substitute methods
-   declared in class. However if more than one category replaces the same
-   method nothing is guaranteed about what method will be used.
-   Assumes that __objc_runtime_mutex is locked down. */
+/* Walk on the methods list of class and install the methods in the
+   reverse order of the lists.  Since methods added by categories are
+   before the methods of class in the methods list, this allows
+   categories to substitute methods declared in class.  However if
+   more than one category replaces the same method nothing is
+   guaranteed about what method will be used.  Assumes that
+   __objc_runtime_mutex is locked down.  */
 static void
 __objc_install_methods_in_dtable (Class class, struct objc_method_list * method_list)
 {
   int i;
-
+  
   if (! method_list)
     return;
-
+  
   if (method_list->method_next)
     __objc_install_methods_in_dtable (class, method_list->method_next);
-
+  
   for (i = 0; i < method_list->method_count; i++)
     {
       struct objc_method * method = &(method_list->method_list[i]);
@@ -604,23 +606,23 @@ __objc_install_methods_in_dtable (Class class, struct objc_method_list * method_
     }
 }
 
-/* Assumes that __objc_runtime_mutex is locked down. */
+/* Assumes that __objc_runtime_mutex is locked down.  */
 static void
 __objc_install_dispatch_table_for_class (Class class)
 {
   Class super;
 
-  /* If the class has not yet had its class links resolved, we must 
-     re-compute all class links */
+  /* If the class has not yet had its class links resolved, we must
+     re-compute all class links.  */
   if (! CLS_ISRESOLV (class))
     __objc_resolve_class_links ();
-
+  
   super = class->super_class;
 
   if (super != 0 && (super->dtable == __objc_uninstalled_dtable))
     __objc_install_dispatch_table_for_class (super);
 
-  /* Allocate dtable if necessary */
+  /* Allocate dtable if necessary.  */
   if (super == 0)
     {
       objc_mutex_lock (__objc_runtime_mutex);
@@ -639,7 +641,7 @@ __objc_update_dispatch_table_for_class (Class class)
   Class next;
   struct sarray *arr;
 
-  /* not yet installed -- skip it */
+  /* Not yet installed -- skip it.  */
   if (class->dtable == __objc_uninstalled_dtable) 
     return;
 
@@ -648,25 +650,24 @@ __objc_update_dispatch_table_for_class (Class class)
   arr = class->dtable;
   __objc_install_premature_dtable (class); /* someone might require it... */
   sarray_free (arr);			   /* release memory */
-
-  /* could have been lazy... */
+  
+  /* Could have been lazy...  */
   __objc_install_dispatch_table_for_class (class); 
 
-  if (class->subclass_list)	/* Traverse subclasses */
+  if (class->subclass_list)	/* Traverse subclasses.  */
     for (next = class->subclass_list; next; next = next->sibling_class)
       __objc_update_dispatch_table_for_class (next);
 
   objc_mutex_unlock (__objc_runtime_mutex);
 }
 
-
 /* This function adds a method list to a class.  This function is
    typically called by another function specific to the run-time.  As
    such this function does not worry about thread safe issues.
 
    This one is only called for categories. Class objects have their
    methods installed right away, and their selectors are made into
-   SEL's by the function __objc_register_selectors_from_class. */
+   SEL's by the function __objc_register_selectors_from_class.  */
 void
 class_add_method_list (Class class, struct objc_method_list * list)
 {
@@ -679,7 +680,7 @@ class_add_method_list (Class class, struct objc_method_list * list)
   list->method_next = class->methods;
   class->methods = list;
 
-  /* Update the dispatch table of class */
+  /* Update the dispatch table of class.  */
   __objc_update_dispatch_table_for_class (class);
 }
 
@@ -707,8 +708,8 @@ class_getInstanceMethod (Class class_, SEL selector)
   if (m)
     return m;
 
-  /* Try going through +resolveInstanceMethod:, and do
-     the search again if successful.  */
+  /* Try going through +resolveInstanceMethod:, and do the search
+     again if successful.  */
   if (__objc_resolve_instance_method (class_, selector))
     return search_for_method_in_hierarchy (class_, selector);
 
@@ -811,9 +812,9 @@ class_replaceMethod (Class class_, SEL selector, IMP implementation,
     }
 }
 
-/* Search for a method starting from the current class up its hierarchy.
-   Return a pointer to the method's method structure if found.  NULL
-   otherwise. */   
+/* Search for a method starting from the current class up its
+   hierarchy.  Return a pointer to the method's method structure if
+   found.  NULL otherwise.  */
 static struct objc_method *
 search_for_method_in_hierarchy (Class cls, SEL sel)
 {
@@ -823,8 +824,8 @@ search_for_method_in_hierarchy (Class cls, SEL sel)
   if (! sel_is_mapped (sel))
     return NULL;
 
-  /* Scan the method list of the class.  If the method isn't found in the
-     list then step to its super class. */
+  /* Scan the method list of the class.  If the method isn't found in
+     the list then step to its super class.  */
   for (class = cls; ((! method) && class); class = class->super_class)
     method = search_for_method_in_list (class->methods, sel);
 
@@ -833,9 +834,9 @@ search_for_method_in_hierarchy (Class cls, SEL sel)
 
 
 
-/* Given a linked list of method and a method's name.  Search for the named
-   method's method structure.  Return a pointer to the method's method
-   structure if found.  NULL otherwise. */  
+/* Given a linked list of method and a method's name.  Search for the
+   named method's method structure.  Return a pointer to the method's
+   method structure if found.  NULL otherwise.  */  
 struct objc_method *
 search_for_method_in_list (struct objc_method_list * list, SEL op)
 {
@@ -869,7 +870,7 @@ search_for_method_in_list (struct objc_method_list * list, SEL op)
 
 static retval_t __objc_forward (id object, SEL sel, arglist_t args);
 
-/* Forwarding pointers/integers through the normal registers */
+/* Forwarding pointers/integers through the normal registers.  */
 static id
 __objc_word_forward (id rcv, SEL op, ...)
 {
@@ -884,10 +885,10 @@ __objc_word_forward (id rcv, SEL op, ...)
 }
 
 /* Specific routine for forwarding floats/double because of
-   architectural differences on some processors.  i386s for
-   example which uses a floating point stack versus general
-   registers for floating point numbers.  This forward routine 
-   makes sure that GCC restores the proper return values */
+   architectural differences on some processors.  i386s for example
+   which uses a floating point stack versus general registers for
+   floating point numbers.  This forward routine makes sure that GCC
+   restores the proper return values.  */
 static double
 __objc_double_forward (id rcv, SEL op, ...)
 {
@@ -920,8 +921,9 @@ __objc_block_forward (id rcv, SEL op, ...)
 }
 
 
-/* This function is installed in the dispatch table for all methods which are
-   not implemented.  Thus, it is called when a selector is not recognized. */
+/* This function is installed in the dispatch table for all methods
+   which are not implemented.  Thus, it is called when a selector is
+   not recognized.  */
 static retval_t
 __objc_forward (id object, SEL sel, arglist_t args)
 {
@@ -929,7 +931,7 @@ __objc_forward (id object, SEL sel, arglist_t args)
   static SEL frwd_sel = 0;                      /* !T:SAFE2 */
   SEL err_sel;
 
-  /* first try if the object understands forward:: */
+  /* First try if the object understands forward::.  */
   if (! frwd_sel)
     frwd_sel = sel_get_any_uid ("forward::");
 
@@ -939,8 +941,8 @@ __objc_forward (id object, SEL sel, arglist_t args)
       return (*imp) (object, frwd_sel, sel, args);
     }
 
-  /* If the object recognizes the doesNotRecognize: method then we're going
-     to send it. */
+  /* If the object recognizes the doesNotRecognize: method then we're
+     going to send it.  */
   err_sel = sel_get_any_uid ("doesNotRecognize:");
   if (__objc_responds_to (object, err_sel))
     {
@@ -949,7 +951,7 @@ __objc_forward (id object, SEL sel, arglist_t args)
     }
   
   /* The object doesn't recognize the method.  Check for responding to
-     error:.  If it does then sent it. */
+     error:.  If it does then sent it.  */
   {
     char msg[256 + strlen ((const char *) sel_get_name (sel))
              + strlen ((const char *) object->class_pointer->name)];
@@ -968,8 +970,8 @@ __objc_forward (id object, SEL sel, arglist_t args)
 	return (*imp) (object, sel_get_any_uid ("error:"), msg);
       }
 
-    /* The object doesn't respond to doesNotRecognize: or error:;  Therefore,
-       a default action is taken. */
+    /* The object doesn't respond to doesNotRecognize: or error:;
+       Therefore, a default action is taken.  */
     _objc_abort ("%s\n", msg);
 
     return 0;
@@ -1006,10 +1008,9 @@ __objc_print_dtable_stats ()
   objc_mutex_unlock (__objc_runtime_mutex);
 }
 
-/* Returns the uninstalled dispatch table indicator.
- If a class' dispatch table points to __objc_uninstalled_dtable
- then that means it needs its dispatch table to be installed. */
-
+/* Returns the uninstalled dispatch table indicator.  If a class'
+   dispatch table points to __objc_uninstalled_dtable then that means
+   it needs its dispatch table to be installed.  */
 struct sarray *
 objc_get_uninstalled_dtable ()
 {