2006-08-17 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mono / metadata / exception.c
index 725161488c607a6b25f1f4aaf5bc0946b3081b47..fa1d6126ac8e18c85ccf058dbd1a12cc05a50b28 100644 (file)
@@ -21,7 +21,8 @@
  * @name_space: the namespace for the class
  * @name: class name
  *
- * Creates an exception of the given namespace/name class.
+ * Creates an exception of the given namespace/name class in the
+ * current domain.
  *
  * Returns: the initialized exception instance.
  */
@@ -32,6 +33,18 @@ mono_exception_from_name (MonoImage *image, const char *name_space,
        return mono_exception_from_name_domain (mono_domain_get (), image, name_space, name);
 }
 
+/**
+ * mono_exception_from_name_domain:
+ * @domain: Domain where the return object will be created.
+ * @image: the Mono image where to look for the class
+ * @name_space: the namespace for the class
+ * @name: class name
+ *
+ * Creates an exception object of the given namespace/name class on
+ * the given domain.
+ *
+ * Returns: the initialized exception instance.
+ */
 MonoException *
 mono_exception_from_name_domain (MonoDomain *domain, MonoImage *image, 
                                 const char* name_space, const char *name)
@@ -150,11 +163,16 @@ mono_exception_from_name_msg (MonoImage *image, const char *name_space,
        ex = mono_exception_from_name (image, name_space, name);
 
        if (msg)
-               ex->message = mono_string_new (mono_object_get_domain ((MonoObject*)ex), msg);
+               MONO_OBJECT_SETREF (ex, message, mono_string_new (mono_object_get_domain ((MonoObject*)ex), msg));
 
        return ex;
 }
 
+/**
+ * mono_get_exception_divide_by_zero:
+ *
+ * Returns: a new instance of the System.DivideByZeroException
+ */
 MonoException *
 mono_get_exception_divide_by_zero ()
 {
@@ -162,6 +180,11 @@ mono_get_exception_divide_by_zero ()
                                         "DivideByZeroException");
 }
 
+/**
+ * mono_get_exception_security:
+ *
+ * Returns: a new instance of the System.Security.SecurityException
+ */
 MonoException *
 mono_get_exception_security ()
 {
@@ -169,6 +192,11 @@ mono_get_exception_security ()
                                         "SecurityException");
 }
 
+/**
+ * mono_get_exception_thread_abort:
+ *
+ * Returns: a new instance of the System.Threading.ThreadAbortException.
+ */
 MonoException *
 mono_get_exception_thread_abort ()
 {
@@ -176,6 +204,11 @@ mono_get_exception_thread_abort ()
                                         "ThreadAbortException");
 }
 
+/**
+ * mono_get_exception_arithmetic:
+ *
+ * Returns: a new instance of the System.ArithmeticException.
+ */
 MonoException *
 mono_get_exception_arithmetic ()
 {
@@ -183,6 +216,11 @@ mono_get_exception_arithmetic ()
                                         "ArithmeticException");
 }
 
+/**
+ * mono_get_exception_overflow:
+ *
+ * Returns: a new instance of the System.OverflowException
+ */
 MonoException *
 mono_get_exception_overflow ()
 {
@@ -190,6 +228,11 @@ mono_get_exception_overflow ()
                                         "OverflowException");
 }
 
+/**
+ * mono_get_exception_null_reference:
+ *
+ * Returns: a new instance of the System.NullReferenceException
+ */
 MonoException *
 mono_get_exception_null_reference ()
 {
@@ -197,27 +240,47 @@ mono_get_exception_null_reference ()
                                         "NullReferenceException");
 }
 
+/**
+ * mono_get_exception_execution_engine:
+ * @msg: the message to pass to the user
+ *
+ * Returns: a new instance of the System.ExecutionEngineException
+ */
 MonoException *
 mono_get_exception_execution_engine (const char *msg)
 {
-       return mono_exception_from_name_msg (mono_get_corlib (), "System",
-                                                                                "ExecutionEngineException", msg);
+       return mono_exception_from_name_msg (mono_get_corlib (), "System", "ExecutionEngineException", msg);
 }
 
+/**
+ * mono_get_exception_serialization:
+ * @msg: the message to pass to the user
+ *
+ * Returns: a new instance of the System.Runtime.Serialization.SerializationException
+ */
 MonoException *
 mono_get_exception_serialization (const char *msg)
 {
-       return mono_exception_from_name_msg (mono_get_corlib (), "System.Runtime.Serialization",
-                                                                                "SerializationException", msg);
+       return mono_exception_from_name_msg (mono_get_corlib (), "System.Runtime.Serialization", "SerializationException", msg);
 }
 
+/**
+ * mono_get_exception_invalid_cast:
+ *
+ * Returns: a new instance of the System.InvalidCastException
+ */
 MonoException *
 mono_get_exception_invalid_cast ()
 {
-       return mono_exception_from_name (mono_get_corlib (), "System",
-                                        "InvalidCastException");
+       return mono_exception_from_name (mono_get_corlib (), "System", "InvalidCastException");
 }
 
+/**
+ * mono_get_exception_invalid_operation:
+ * @msg: the message to pass to the user
+ *
+ * Returns: a new instance of the System.InvalidOperationException
+ */
 MonoException *
 mono_get_exception_invalid_operation (const char *msg)
 {
@@ -225,6 +288,11 @@ mono_get_exception_invalid_operation (const char *msg)
                                        "InvalidOperationException", msg);
 }
 
+/**
+ * mono_get_exception_index_out_of_range:
+ *
+ * Returns: a new instance of the System.IndexOutOfRangeException
+ */
 MonoException *
 mono_get_exception_index_out_of_range ()
 {
@@ -232,6 +300,11 @@ mono_get_exception_index_out_of_range ()
                                         "IndexOutOfRangeException");
 }
 
+/**
+ * mono_get_exception_array_type_mismatch:
+ *
+ * Returns: a new instance of the System.ArrayTypeMismatchException
+ */
 MonoException *
 mono_get_exception_array_type_mismatch ()
 {
@@ -239,40 +312,86 @@ mono_get_exception_array_type_mismatch ()
                                         "ArrayTypeMismatchException");
 }
 
+/**
+ * mono_get_exception_type_load:
+ * @class_name: the name of the class that could not be loaded
+ * @assembly_name: the assembly where the class was looked up.
+ *
+ * Returns: a new instance of the System.TypeLoadException.
+ */
 MonoException *
-mono_get_exception_type_load (MonoString *type_name)
+mono_get_exception_type_load (MonoString *class_name, char *assembly_name)
 {
-       MonoTypeLoadException *exc;
-       
-       exc = (MonoTypeLoadException *) mono_exception_from_name (mono_get_corlib (),
-                                       "System",
-                                       "TypeLoadException");
+       MonoString *s = assembly_name ? mono_string_new (mono_domain_get (), assembly_name) : mono_string_new (mono_domain_get (), "");
 
-       exc->type_name = type_name;
-       return (MonoException *) exc;
+       return mono_exception_from_name_two_strings (mono_get_corlib (), "System",
+                                                    "TypeLoadException", class_name, s);
 }
 
+/**
+ * mono_get_exception_not_implemented:
+ * @msg: the message to pass to the user
+ *
+ * Returns: a new instance of the System.NotImplementedException
+ */
 MonoException *
 mono_get_exception_not_implemented (const char *msg)
 {
-       MonoException *ex;
-       
-       ex = mono_exception_from_name (mono_get_corlib (), "System",
-                                      "NotImplementedException");
+       return mono_exception_from_name_msg (mono_get_corlib (), "System", "NotImplementedException", msg);
+}
 
-       if (msg)
-               ex->message = mono_string_new (mono_object_get_domain ((MonoObject*)ex), msg);
+/**
+ * mono_get_exception_not_supported:
+ * @msg: the message to pass to the user
+ *
+ * Returns: a new instance of the System.NotSupportedException
+ */
+MonoException *
+mono_get_exception_not_supported (const char *msg)
+{
+       return mono_exception_from_name_msg (mono_get_corlib (), "System", "NotSupportedException", msg);
+}
 
-       return ex;
+/**
+ * mono_get_exception_missing_method:
+ * @class_name: the class where the lookup was performed.
+ * @member_name: the name of the missing method.
+ *
+ * Returns: a new instance of the System.MissingMethodException
+ */
+MonoException *
+mono_get_exception_missing_method (const char *class_name, const char *member_name)
+{
+       MonoString *s1 = mono_string_new (mono_domain_get (), class_name);
+       MonoString *s2 = mono_string_new (mono_domain_get (), member_name);
+
+       return mono_exception_from_name_two_strings (mono_get_corlib (), "System",
+                                                    "MissingMethodException", s1, s2);
 }
 
+/**
+ * mono_get_exception_missing_field:
+ * @class_name: the class where the lookup was performed
+ * @member_name: the name of the missing method.
+ *
+ * Returns: a new instance of the System.MissingFieldException
+ */
 MonoException *
-mono_get_exception_missing_method ()
+mono_get_exception_missing_field (const char *class_name, const char *member_name)
 {
-       return mono_exception_from_name (mono_get_corlib (), "System",
-                                        "MissingMethodException");
+       MonoString *s1 = mono_string_new (mono_domain_get (), class_name);
+       MonoString *s2 = mono_string_new (mono_domain_get (), member_name);
+
+       return mono_exception_from_name_two_strings (mono_get_corlib (), "System",
+                                                    "MissingFieldException", s1, s2);
 }
 
+/**
+ * mono_get_exception_argument_null:
+ * @arg: the name of the argument that is null
+ *
+ * Returns: a new instance of the System.ArgumentNullException
+ */
 MonoException*
 mono_get_exception_argument_null (const char *arg)
 {
@@ -281,13 +400,20 @@ mono_get_exception_argument_null (const char *arg)
        ex = mono_exception_from_name ( 
                mono_get_corlib (), "System", "ArgumentNullException");
 
-       if (arg)
-               ((MonoArgumentException *)ex)->param_name =
-                       mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg);
+       if (arg) {
+               MonoArgumentException *argex = (MonoArgumentException *)ex;
+               MONO_OBJECT_SETREF (argex, param_name, mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg));
+       }
        
        return ex;
 }
 
+/**
+ * mono_get_exception_argument:
+ * @arg: the name of the invalid argument.
+ *
+ * Returns: a new instance of the System.ArgumentException
+ */
 MonoException *
 mono_get_exception_argument (const char *arg, const char *msg)
 {
@@ -296,13 +422,20 @@ mono_get_exception_argument (const char *arg, const char *msg)
        ex = mono_exception_from_name_msg (
                mono_get_corlib (), "System", "ArgumentException", msg);
 
-       if (arg)
-               ((MonoArgumentException *)ex)->param_name =
-                       mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg);
+       if (arg) {
+               MonoArgumentException *argex = (MonoArgumentException *)ex;
+               MONO_OBJECT_SETREF (argex, param_name, mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg));
+       }
        
        return ex;
 }
 
+/**
+ * mono_get_exception_argument_out_of_range:
+ * @arg: the name of the out of range argument.
+ *
+ * Returns: a new instance of the System.ArgumentOutOfRangeException
+ */
 MonoException *
 mono_get_exception_argument_out_of_range (const char *arg)
 {
@@ -311,13 +444,20 @@ mono_get_exception_argument_out_of_range (const char *arg)
        ex = mono_exception_from_name (
                mono_get_corlib (), "System", "ArgumentOutOfRangeException");
 
-       if (arg)
-               ((MonoArgumentException *)ex)->param_name =
-                       mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg);
+       if (arg) {
+               MonoArgumentException *argex = (MonoArgumentException *)ex;
+               MONO_OBJECT_SETREF (argex, param_name, mono_string_new (mono_object_get_domain ((MonoObject*)ex), arg));
+       }
        
        return ex;
 }
 
+/**
+ * mono_get_exception_thread_state:
+ * @msg: the message to present to the user
+ *
+ * Returns: a new instance of the System.Threading.ThreadStateException
+ */
 MonoException *
 mono_get_exception_thread_state (const char *msg)
 {
@@ -325,6 +465,12 @@ mono_get_exception_thread_state (const char *msg)
                mono_get_corlib (), "System.Threading", "ThreadStateException", msg);
 }
 
+/**
+ * mono_get_exception_io:
+ * @msg: the message to present to the user
+ *
+ * Returns: a new instance of the System.IO.IOException
+ */
 MonoException *
 mono_get_exception_io (const char *msg)
 {
@@ -332,6 +478,12 @@ mono_get_exception_io (const char *msg)
                mono_get_corlib (), "System.IO", "IOException", msg);
 }
 
+/**
+ * mono_get_exception_file_not_found:
+ * @fname: the name of the file not found.
+ *
+ * Returns: a new instance of the System.IO.FileNotFoundException
+ */
 MonoException *
 mono_get_exception_file_not_found (MonoString *fname)
 {
@@ -339,6 +491,13 @@ mono_get_exception_file_not_found (MonoString *fname)
                mono_get_corlib (), "System.IO", "FileNotFoundException", fname, fname);
 }
 
+/**
+ * mono_get_exception_file_not_found2:
+ * @msg: an informative message for the user.
+ * @fname: the name of the file not found.
+ *
+ * Returns: a new instance of the System.IO.FileNotFoundException
+ */
 MonoException *
 mono_get_exception_file_not_found2 (const char *msg, MonoString *fname)
 {
@@ -348,6 +507,13 @@ mono_get_exception_file_not_found2 (const char *msg, MonoString *fname)
                mono_get_corlib (), "System.IO", "FileNotFoundException", s, fname);
 }
 
+/**
+ * mono_get_exception_type_initialization:
+ * @type_name: the name of the type that failed to initialize.
+ * @inner: the inner exception.
+ *
+ * Returns: a new instance of the System.TypeInitializationException
+ */
 MonoException *
 mono_get_exception_type_initialization (const gchar *type_name, MonoException *inner)
 {
@@ -381,36 +547,71 @@ mono_get_exception_type_initialization (const gchar *type_name, MonoException *i
        return (MonoException *) exc;
 }
 
+/**
+ * mono_get_exception_synchronization_lock:
+ * @inner: the inner exception.
+ *
+ * Returns: a new instance of the System.TypeInitializationException
+ */
 MonoException *
 mono_get_exception_synchronization_lock (const char *msg)
 {
        return mono_exception_from_name_msg (mono_get_corlib (), "System.Threading", "SynchronizationLockException", msg);
 }
 
+/**
+ * mono_get_exception_cannot_unload_appdomain:
+ * @inner: the inner exception.
+ *
+ * Returns: a new instance of the System.CannotUnloadAppDomainException
+ */
 MonoException *
 mono_get_exception_cannot_unload_appdomain (const char *msg)
 {
        return mono_exception_from_name_msg (mono_get_corlib (), "System", "CannotUnloadAppDomainException", msg);
 }
 
+/**
+ * mono_get_exception_appdomain_unloaded
+ *
+ * Returns: a new instance of the System.AppDomainUnloadedException
+ */
 MonoException *
 mono_get_exception_appdomain_unloaded (void)
 {
        return mono_exception_from_name (mono_get_corlib (), "System", "AppDomainUnloadedException");
 }
 
+/**
+ * mono_get_exception_bad_image_format:
+ * @msg: an informative message for the user.
+ *
+ * Returns: a new instance of the System.BadImageFormatException
+ */
 MonoException *
 mono_get_exception_bad_image_format (const char *msg)
 {
        return mono_exception_from_name_msg (mono_get_corlib (), "System", "BadImageFormatException", msg);
 }      
 
+/**
+ * mono_get_exception_stack_overflow:
+ *
+ * Returns: a new instance of the System.StackOverflowException
+ */
 MonoException *
 mono_get_exception_stack_overflow (void)
 {
        return mono_exception_from_name (mono_get_corlib (), "System", "StackOverflowException");       
 }
 
+/**
+ * mono_get_exception_reflection_type_load:
+ * @types: an array of types that were defined in the moduled loaded.
+ * @exceptions: an array of exceptions that were thrown during the type loading.
+ *
+ * Returns: a new instance of the System.Reflection.ReflectionTypeLoadException
+ */
 MonoException *
 mono_get_exception_reflection_type_load (MonoArray *types, MonoArray *exceptions)
 {