objexcept.c 12 KB
Newer Older
1
#include <string.h>
2
#include <stdarg.h>
3
4
5
6
7
#include <assert.h>

#include "nlr.h"
#include "misc.h"
#include "mpconfig.h"
8
#include "qstr.h"
9
#include "obj.h"
10
#include "objtuple.h"
11
12
#include "runtime.h"
#include "runtime0.h"
13

14
typedef struct _mp_obj_exception_t {
15
    mp_obj_base_t base;
16
    mp_obj_t traceback; // a list object, holding (file,line,block) as numbers (not Python objects); a hack for now
17
    mp_obj_tuple_t *args;
18
19
} mp_obj_exception_t;

20
// Instance of MemoryError exception - needed by mp_malloc_fail
21
const mp_obj_exception_t mp_const_MemoryError_obj = {{&mp_type_MemoryError}, MP_OBJ_NULL, mp_const_empty_tuple};
22

23
24
25
// Local non-heap memory for allocating an exception when we run out of RAM
STATIC mp_obj_exception_t mp_emergency_exception_obj;

26
27
28
// Instance of GeneratorExit exception - needed by generator.close()
// This would belong to objgenerator.c, but to keep mp_obj_exception_t
// definition module-private so far, have it here.
29
const mp_obj_exception_t mp_const_GeneratorExit_obj = {{&mp_type_GeneratorExit}, MP_OBJ_NULL, mp_const_empty_tuple};
30

31
STATIC void mp_obj_exception_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t o_in, mp_print_kind_t kind) {
32
    mp_obj_exception_t *o = o_in;
33
34
35
    mp_print_kind_t k = kind & ~PRINT_EXC_SUBCLASS;
    bool is_subclass = kind & PRINT_EXC_SUBCLASS;
    if (!is_subclass && (k == PRINT_REPR || k == PRINT_EXC)) {
36
37
        print(env, "%s", qstr_str(o->base.type->name));
    }
38
39
40
41
42
43

    if (k == PRINT_EXC) {
        print(env, ": ");
    }

    if (k == PRINT_STR || k == PRINT_EXC) {
44
        if (o->args == NULL || o->args->len == 0) {
45
46
            print(env, "");
            return;
47
48
        } else if (o->args->len == 1) {
            mp_obj_print_helper(print, env, o->args->items[0], PRINT_STR);
49
            return;
50
        }
51
    }
52
    tuple_print(print, env, o->args, kind);
53
54
}

55
mp_obj_t mp_obj_exception_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
56
    mp_obj_type_t *type = type_in;
57
58

    if (n_kw != 0) {
59
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "%s does not take keyword arguments", mp_obj_get_type_str(type_in)));
60
61
    }

62
    mp_obj_exception_t *o = m_new_obj_var_maybe(mp_obj_exception_t, mp_obj_t, 0);
63
64
65
66
67
    if (o == NULL) {
        // Couldn't allocate heap memory; use local data instead.
        o = &mp_emergency_exception_obj;
        // We can't store any args.
        n_args = 0;
68
69
70
        o->args = mp_const_empty_tuple;
    } else {
        o->args = mp_obj_new_tuple(n_args, args);
71
    }
72
    o->base.type = type;
73
    o->traceback = MP_OBJ_NULL;
74
75
76
    return o;
}

77
78
79
// Get exception "value" - that is, first argument, or None
mp_obj_t mp_obj_exception_get_value(mp_obj_t self_in) {
    mp_obj_exception_t *self = self_in;
80
    if (self->args->len == 0) {
81
82
        return mp_const_none;
    } else {
83
        return self->args->items[0];
84
85
86
    }
}

87
88
89
STATIC void exception_load_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
    mp_obj_exception_t *self = self_in;
    if (attr == MP_QSTR_args) {
90
        dest[0] = self->args;
91
    } else if (self->base.type == &mp_type_StopIteration && attr == MP_QSTR_value) {
92
        dest[0] = mp_obj_exception_get_value(self);
93
94
95
    }
}

96
97
98
99
100
const mp_obj_type_t mp_type_BaseException = {
    { &mp_type_type },
    .name = MP_QSTR_BaseException,
    .print = mp_obj_exception_print,
    .make_new = mp_obj_exception_make_new,
101
    .load_attr = exception_load_attr,
102
103
};

104
#define MP_DEFINE_EXCEPTION_BASE(base_name) \
105
STATIC const mp_obj_tuple_t mp_type_ ## base_name ## _base_tuple = {{&mp_type_tuple}, 1, {(mp_obj_t)&mp_type_ ## base_name}};\
106
107

#define MP_DEFINE_EXCEPTION(exc_name, base_name) \
108
109
110
111
112
const mp_obj_type_t mp_type_ ## exc_name = { \
    { &mp_type_type }, \
    .name = MP_QSTR_ ## exc_name, \
    .print = mp_obj_exception_print, \
    .make_new = mp_obj_exception_make_new, \
113
    .load_attr = exception_load_attr, \
114
    .bases_tuple = (mp_obj_t)&mp_type_ ## base_name ## _base_tuple, \
115
116
};

117
118
// List of all exceptions, arranged as in the table at:
// http://docs.python.org/3.3/library/exceptions.html
119
MP_DEFINE_EXCEPTION_BASE(BaseException)
120
//MP_DEFINE_EXCEPTION(SystemExit, BaseException)
121
122
123
124
125
126
127
//MP_DEFINE_EXCEPTION(KeyboardInterrupt, BaseException)
MP_DEFINE_EXCEPTION(GeneratorExit, BaseException)
MP_DEFINE_EXCEPTION(Exception, BaseException)
  MP_DEFINE_EXCEPTION_BASE(Exception)
  MP_DEFINE_EXCEPTION(StopIteration, Exception)
  MP_DEFINE_EXCEPTION(ArithmeticError, Exception)
    MP_DEFINE_EXCEPTION_BASE(ArithmeticError)
128
    //MP_DEFINE_EXCEPTION(FloatingPointError, ArithmeticError)
129
130
131
132
    MP_DEFINE_EXCEPTION(OverflowError, ArithmeticError)
    MP_DEFINE_EXCEPTION(ZeroDivisionError, ArithmeticError)
  MP_DEFINE_EXCEPTION(AssertionError, Exception)
  MP_DEFINE_EXCEPTION(AttributeError, Exception)
133
  //MP_DEFINE_EXCEPTION(BufferError, Exception)
134
  //MP_DEFINE_EXCEPTION(EnvironmentError, Exception)
135
136
137
138
139
140
141
142
143
144
  MP_DEFINE_EXCEPTION(EOFError, Exception)
  MP_DEFINE_EXCEPTION(ImportError, Exception)
  MP_DEFINE_EXCEPTION(IOError, Exception)
  MP_DEFINE_EXCEPTION(LookupError, Exception)
    MP_DEFINE_EXCEPTION_BASE(LookupError)
    MP_DEFINE_EXCEPTION(IndexError, LookupError)
    MP_DEFINE_EXCEPTION(KeyError, LookupError)
  MP_DEFINE_EXCEPTION(MemoryError, Exception)
  MP_DEFINE_EXCEPTION(NameError, Exception)
    MP_DEFINE_EXCEPTION_BASE(NameError)
145
    //MP_DEFINE_EXCEPTION(UnboundLocalError, NameError)
146
  MP_DEFINE_EXCEPTION(OSError, Exception)
147
    MP_DEFINE_EXCEPTION_BASE(OSError)
148
149
    /*
    MP_DEFINE_EXCEPTION(BlockingIOError, OSError)
150
151
152
153
154
155
156
157
158
159
160
    MP_DEFINE_EXCEPTION(ChildProcessError, OSError)
    MP_DEFINE_EXCEPTION(ConnectionError, OSError)
      MP_DEFINE_EXCEPTION(BrokenPipeError, ConnectionError)
      MP_DEFINE_EXCEPTION(ConnectionAbortedError, ConnectionError)
      MP_DEFINE_EXCEPTION(ConnectionRefusedError, ConnectionError)
      MP_DEFINE_EXCEPTION(ConnectionResetError, ConnectionError)
    MP_DEFINE_EXCEPTION(InterruptedError, OSError)
    MP_DEFINE_EXCEPTION(IsADirectoryError, OSError)
    MP_DEFINE_EXCEPTION(NotADirectoryError, OSError)
    MP_DEFINE_EXCEPTION(PermissionError, OSError)
    MP_DEFINE_EXCEPTION(ProcessLookupError, OSError)
161
    MP_DEFINE_EXCEPTION(TimeoutError, OSError)
162
163
    MP_DEFINE_EXCEPTION(FileExistsError, OSError)
    MP_DEFINE_EXCEPTION(FileNotFoundError, OSError)
164
165
    MP_DEFINE_EXCEPTION(ReferenceError, Exception)
    */
166
167
168
169
170
171
  MP_DEFINE_EXCEPTION(RuntimeError, Exception)
    MP_DEFINE_EXCEPTION_BASE(RuntimeError)
    MP_DEFINE_EXCEPTION(NotImplementedError, RuntimeError)
  MP_DEFINE_EXCEPTION(SyntaxError, Exception)
    MP_DEFINE_EXCEPTION_BASE(SyntaxError)
    MP_DEFINE_EXCEPTION(IndentationError, SyntaxError)
172
    /*
173
      MP_DEFINE_EXCEPTION_BASE(IndentationError)
174
175
      MP_DEFINE_EXCEPTION(TabError, IndentationError)
      */
176
177
178
179
  MP_DEFINE_EXCEPTION(SystemError, Exception)
  MP_DEFINE_EXCEPTION(TypeError, Exception)
  MP_DEFINE_EXCEPTION(ValueError, Exception)
    //TODO: Implement UnicodeErrors which take arguments
180
  /*
181
182
183
184
185
186
187
188
189
190
191
192
  MP_DEFINE_EXCEPTION(Warning, Exception)
    MP_DEFINE_EXCEPTION_BASE(Warning)
    MP_DEFINE_EXCEPTION(DeprecationWarning, Warning)
    MP_DEFINE_EXCEPTION(PendingDeprecationWarning, Warning)
    MP_DEFINE_EXCEPTION(RuntimeWarning, Warning)
    MP_DEFINE_EXCEPTION(SyntaxWarning, Warning)
    MP_DEFINE_EXCEPTION(UserWarning, Warning)
    MP_DEFINE_EXCEPTION(FutureWarning, Warning)
    MP_DEFINE_EXCEPTION(ImportWarning, Warning)
    MP_DEFINE_EXCEPTION(UnicodeWarning, Warning)
    MP_DEFINE_EXCEPTION(BytesWarning, Warning)
    MP_DEFINE_EXCEPTION(ResourceWarning, Warning)
193
    */
194
195

mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type) {
196
    return mp_obj_new_exception_args(exc_type, 0, NULL);
197
198
}

199
200
201
202
203
// "Optimized" version for common(?) case of having 1 exception arg
mp_obj_t mp_obj_new_exception_arg1(const mp_obj_type_t *exc_type, mp_obj_t arg) {
    return mp_obj_new_exception_args(exc_type, 1, &arg);
}

204
205
206
207
208
mp_obj_t mp_obj_new_exception_args(const mp_obj_type_t *exc_type, uint n_args, const mp_obj_t *args) {
    assert(exc_type->make_new == mp_obj_exception_make_new);
    return exc_type->make_new((mp_obj_t)exc_type, n_args, 0, args);
}

209
210
mp_obj_t mp_obj_new_exception_msg(const mp_obj_type_t *exc_type, const char *msg) {
    return mp_obj_new_exception_msg_varg(exc_type, msg);
211
212
}

213
214
215
216
mp_obj_t mp_obj_new_exception_msg_varg(const mp_obj_type_t *exc_type, const char *fmt, ...) {
    // check that the given type is an exception type
    assert(exc_type->make_new == mp_obj_exception_make_new);

217
    // make exception object
218
    mp_obj_exception_t *o = m_new_obj_var_maybe(mp_obj_exception_t, mp_obj_t, 0);
219
220
221
222
223
224
    if (o == NULL) {
        // Couldn't allocate heap memory; use local data instead.
        // Unfortunately, we won't be able to format the string...
        o = &mp_emergency_exception_obj;
        o->base.type = exc_type;
        o->traceback = MP_OBJ_NULL;
225
        o->args = mp_const_empty_tuple;
226
    } else {
227
228
        o->base.type = exc_type;
        o->traceback = MP_OBJ_NULL;
229
        o->args = mp_obj_new_tuple(1, NULL);
230
231
232
233
234
235
236
237
238
239
240
241

        if (fmt == NULL) {
            // no message
            assert(0);
        } else {
            // render exception message and store as .args[0]
            // TODO: optimize bufferbloat
            vstr_t *vstr = vstr_new();
            va_list ap;
            va_start(ap, fmt);
            vstr_vprintf(vstr, fmt, ap);
            va_end(ap);
242
            o->args->items[0] = mp_obj_new_str((byte*)vstr->buf, vstr->len, false);
243
244
            vstr_free(vstr);
        }
245
246
247
248
249
    }

    return o;
}

250
251
252
// return true if the given object is an exception type
bool mp_obj_is_exception_type(mp_obj_t self_in) {
    if (MP_OBJ_IS_TYPE(self_in, &mp_type_type)) {
253
        // optimisation when self_in is a builtin exception
254
        mp_obj_type_t *self = self_in;
255
256
257
        if (self->make_new == mp_obj_exception_make_new) {
            return true;
        }
258
    }
259
    return mp_obj_is_subclass_fast(self_in, &mp_type_BaseException);
260
261
262
263
}

// return true if the given object is an instance of an exception type
bool mp_obj_is_exception_instance(mp_obj_t self_in) {
264
    return mp_obj_is_exception_type(mp_obj_get_type(self_in));
265
266
}

267
268
269
270
// return true if exception (type or instance) is a subclass of given
// exception type.
bool mp_obj_exception_match(mp_obj_t exc, const mp_obj_type_t *exc_type) {
    // TODO: move implementation from RT_BINARY_OP_EXCEPTION_MATCH here.
Damien George's avatar
Damien George committed
271
    return mp_binary_op(MP_BINARY_OP_EXCEPTION_MATCH, exc, (mp_obj_t)exc_type) == mp_const_true;
272
273
}

274
275
void mp_obj_exception_clear_traceback(mp_obj_t self_in) {
    // make sure self_in is an exception instance
276
277
278
    // TODO add traceback information to user-defined exceptions (need proper builtin subclassing for that)
    if (mp_obj_get_type(self_in)->make_new == mp_obj_exception_make_new) {
        mp_obj_exception_t *self = self_in;
279

280
281
282
283
        // just set the traceback to the null object
        // we don't want to call any memory management functions here
        self->traceback = MP_OBJ_NULL;
    }
284
}
285

286
void mp_obj_exception_add_traceback(mp_obj_t self_in, qstr file, machine_uint_t line, qstr block) {
287
    // make sure self_in is an exception instance
288
    // TODO add traceback information to user-defined exceptions (need proper builtin subclassing for that)
289
    if (mp_obj_get_type(self_in)->make_new == mp_obj_exception_make_new && self_in != &mp_emergency_exception_obj) {
290
        mp_obj_exception_t *self = self_in;
291

292
293
294
295
296
297
298
        // for traceback, we are just using the list object for convenience, it's not really a list of Python objects
        if (self->traceback == MP_OBJ_NULL) {
            self->traceback = mp_obj_new_list(0, NULL);
        }
        mp_obj_list_append(self->traceback, (mp_obj_t)(machine_uint_t)file);
        mp_obj_list_append(self->traceback, (mp_obj_t)(machine_uint_t)line);
        mp_obj_list_append(self->traceback, (mp_obj_t)(machine_uint_t)block);
299
    }
300
301
}

302
void mp_obj_exception_get_traceback(mp_obj_t self_in, machine_uint_t *n, machine_uint_t **values) {
303
304
    // make sure self_in is an exception instance
    assert(mp_obj_get_type(self_in)->make_new == mp_obj_exception_make_new);
305
    mp_obj_exception_t *self = self_in;
306

307
308
309
310
311
312
313
314
    if (self->traceback == MP_OBJ_NULL) {
        *n = 0;
        *values = NULL;
    } else {
        uint n2;
        mp_obj_list_get(self->traceback, &n2, (mp_obj_t**)values);
        *n = n2;
    }
315
}