Exception: SystemExit

Inherits:
Exception show all
Defined in:
error.c,
error.c

Overview

Raised by exit to initiate the termination of the script.

Instance Method Summary collapse

Methods inherited from Exception

#==, #backtrace, #backtrace_locations, #cause, exception, #exception, #inspect, #message, #set_backtrace, #to_s

Constructor Details

#newObject #new(status) ⇒ Object #new(status, msg) ⇒ Object #new(msg) ⇒ Object

Create a new SystemExit exception with the given status and message. Status is true, false, or an integer. If status is not given, true is used.



1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'error.c', line 1006

static VALUE
exit_initialize(int argc, VALUE *argv, VALUE exc)
{
    VALUE status;
    if (argc > 0) {
	status = *argv;

	switch (status) {
	  case Qtrue:
	    status = INT2FIX(EXIT_SUCCESS);
	    ++argv;
	    --argc;
	    break;
	  case Qfalse:
	    status = INT2FIX(EXIT_FAILURE);
	    ++argv;
	    --argc;
	    break;
	  default:
	    status = rb_check_to_int(status);
	    if (NIL_P(status)) {
		status = INT2FIX(EXIT_SUCCESS);
	    }
	    else {
#if EXIT_SUCCESS != 0
		if (status == INT2FIX(0))
		    status = INT2FIX(EXIT_SUCCESS);
#endif
		++argv;
		--argc;
	    }
	    break;
	}
    }
    else {
	status = INT2FIX(EXIT_SUCCESS);
    }
    rb_call_super(argc, argv);
    rb_ivar_set(exc, id_status, status);
    return exc;
}

Instance Method Details

#statusFixnum

Return the status value associated with this system exit.

Returns:



1056
1057
1058
1059
1060
# File 'error.c', line 1056

static VALUE
exit_status(VALUE exc)
{
    return rb_attr_get(exc, id_status);
}

#success?Boolean

Returns true if exiting successful, false if not.

Returns:

  • (Boolean)

Returns:

  • (Boolean)


1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
# File 'error.c', line 1070

static VALUE
exit_success_p(VALUE exc)
{
    VALUE status_val = rb_attr_get(exc, id_status);
    int status;

    if (NIL_P(status_val))
	return Qtrue;
    status = NUM2INT(status_val);
    if (WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS)
	return Qtrue;

    return Qfalse;
}