objexcept.c 11 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
21
22
// Instance of MemoryError exception - needed by mp_malloc_fail
const mp_obj_exception_t mp_const_MemoryError_obj = {{&mp_type_MemoryError}, MP_OBJ_NULL, {{&mp_type_tuple}, 0}};

23
24
25
// 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.
26
const mp_obj_exception_t mp_const_GeneratorExit_obj = {{&mp_type_GeneratorExit}, MP_OBJ_NULL, {{&mp_type_tuple}, 0}};
27

28
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) {
29
    mp_obj_exception_t *o = o_in;
30
31
32
33
34
35
36
37
38
39
40
41
    if (kind == PRINT_REPR) {
        print(env, "%s", qstr_str(o->base.type->name));
    } else if (kind == PRINT_EXC) {
        print(env, "%s: ", qstr_str(o->base.type->name));
    }
    if (kind == PRINT_STR || kind == PRINT_EXC) {
        if (o->args.len == 0) {
            print(env, "");
            return;
        } else if (o->args.len == 1) {
            mp_obj_print_helper(print, env, o->args.items[0], PRINT_STR);
            return;
42
        }
43
    }
44
    tuple_print(print, env, &o->args, kind);
45
46
}

47
48
STATIC mp_obj_t mp_obj_exception_make_new(mp_obj_t type_in, uint n_args, uint n_kw, const mp_obj_t *args) {
    mp_obj_type_t *type = type_in;
49
50

    if (n_kw != 0) {
51
        nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "%s does not take keyword arguments", mp_obj_get_type_str(type_in)));
52
53
54
    }

    mp_obj_exception_t *o = m_new_obj_var(mp_obj_exception_t, mp_obj_t, n_args);
55
    o->base.type = type;
56
    o->traceback = MP_OBJ_NULL;
57
    o->args.base.type = &mp_type_tuple;
58
    o->args.len = n_args;
59
    memcpy(o->args.items, args, n_args * sizeof(mp_obj_t));
60
61
62
    return o;
}

63
64
65
66
67
68
69
70
71
72
// 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;
    if (self->args.len == 0) {
        return mp_const_none;
    } else {
        return self->args.items[0];
    }
}

73
74
75
76
77
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) {
        dest[0] = &self->args;
    } else if (self->base.type == &mp_type_StopIteration && attr == MP_QSTR_value) {
78
        dest[0] = mp_obj_exception_get_value(self);
79
80
81
    }
}

82
83
84
85
86
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,
87
    .load_attr = exception_load_attr,
88
89
};

90
#define MP_DEFINE_EXCEPTION_BASE(base_name) \
91
STATIC const mp_obj_tuple_t mp_type_ ## base_name ## _base_tuple = {{&mp_type_tuple}, 1, {(mp_obj_t)&mp_type_ ## base_name}};\
92
93

#define MP_DEFINE_EXCEPTION(exc_name, base_name) \
94
95
96
97
98
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, \
99
    .load_attr = exception_load_attr, \
100
    .bases_tuple = (mp_obj_t)&mp_type_ ## base_name ## _base_tuple, \
101
102
};

103
104
// List of all exceptions, arranged as in the table at:
// http://docs.python.org/3.3/library/exceptions.html
105
MP_DEFINE_EXCEPTION_BASE(BaseException)
106
//MP_DEFINE_EXCEPTION(SystemExit, BaseException)
107
108
109
110
111
112
113
//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)
114
    //MP_DEFINE_EXCEPTION(FloatingPointError, ArithmeticError)
115
116
117
118
    MP_DEFINE_EXCEPTION(OverflowError, ArithmeticError)
    MP_DEFINE_EXCEPTION(ZeroDivisionError, ArithmeticError)
  MP_DEFINE_EXCEPTION(AssertionError, Exception)
  MP_DEFINE_EXCEPTION(AttributeError, Exception)
119
  //MP_DEFINE_EXCEPTION(BufferError, Exception)
120
  //MP_DEFINE_EXCEPTION(EnvironmentError, Exception)
121
122
123
124
125
126
127
128
129
130
  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)
131
    //MP_DEFINE_EXCEPTION(UnboundLocalError, NameError)
132
  MP_DEFINE_EXCEPTION(OSError, Exception)
133
    MP_DEFINE_EXCEPTION_BASE(OSError)
134
135
    /*
    MP_DEFINE_EXCEPTION(BlockingIOError, OSError)
136
137
138
139
140
141
142
143
144
145
146
    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)
147
    MP_DEFINE_EXCEPTION(TimeoutError, OSError)
148
149
    MP_DEFINE_EXCEPTION(FileExistsError, OSError)
    MP_DEFINE_EXCEPTION(FileNotFoundError, OSError)
150
151
    MP_DEFINE_EXCEPTION(ReferenceError, Exception)
    */
152
153
154
155
156
157
  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)
158
    /*
159
      MP_DEFINE_EXCEPTION_BASE(IndentationError)
160
161
      MP_DEFINE_EXCEPTION(TabError, IndentationError)
      */
162
163
164
165
  MP_DEFINE_EXCEPTION(SystemError, Exception)
  MP_DEFINE_EXCEPTION(TypeError, Exception)
  MP_DEFINE_EXCEPTION(ValueError, Exception)
    //TODO: Implement UnicodeErrors which take arguments
166
  /*
167
168
169
170
171
172
173
174
175
176
177
178
  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)
179
    */
180
181

mp_obj_t mp_obj_new_exception(const mp_obj_type_t *exc_type) {
182
    return mp_obj_new_exception_args(exc_type, 0, NULL);
183
184
}

185
186
187
188
189
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);
}

190
191
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);
192
193
}

194
195
196
197
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);

198
    // make exception object
199
    mp_obj_exception_t *o = m_new_obj_var(mp_obj_exception_t, mp_obj_t, 1);
200
    o->base.type = exc_type;
201
    o->traceback = MP_OBJ_NULL;
202
    o->args.base.type = &mp_type_tuple;
203
    o->args.len = 1;
204

205
    if (fmt == NULL) {
206
        // no message
207
        assert(0);
208
    } else {
209
210
211
        // render exception message and store as .args[0]
        // TODO: optimize bufferbloat
        vstr_t *vstr = vstr_new();
212
213
        va_list ap;
        va_start(ap, fmt);
214
        vstr_vprintf(vstr, fmt, ap);
215
        va_end(ap);
216
217
        o->args.items[0] = mp_obj_new_str((byte*)vstr->buf, vstr->len, false);
        vstr_free(vstr);
218
219
220
221
222
    }

    return o;
}

223
224
225
// 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)) {
226
        // optimisation when self_in is a builtin exception
227
        mp_obj_type_t *self = self_in;
228
229
230
        if (self->make_new == mp_obj_exception_make_new) {
            return true;
        }
231
    }
232
    return mp_obj_is_subclass_fast(self_in, &mp_type_BaseException);
233
234
235
236
}

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

240
241
242
243
// 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
244
    return mp_binary_op(MP_BINARY_OP_EXCEPTION_MATCH, exc, (mp_obj_t)exc_type) == mp_const_true;
245
246
}

247
248
void mp_obj_exception_clear_traceback(mp_obj_t self_in) {
    // make sure self_in is an exception instance
249
250
251
    // 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;
252

253
254
255
256
        // just set the traceback to the null object
        // we don't want to call any memory management functions here
        self->traceback = MP_OBJ_NULL;
    }
257
}
258

259
void mp_obj_exception_add_traceback(mp_obj_t self_in, qstr file, machine_uint_t line, qstr block) {
260
    // make sure self_in is an exception instance
261
262
263
    // 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;
264

265
266
267
268
269
270
271
        // 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);
272
    }
273
274
}

275
void mp_obj_exception_get_traceback(mp_obj_t self_in, machine_uint_t *n, machine_uint_t **values) {
276
277
    // make sure self_in is an exception instance
    assert(mp_obj_get_type(self_in)->make_new == mp_obj_exception_make_new);
278
    mp_obj_exception_t *self = self_in;
279

280
281
282
283
284
285
286
287
    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;
    }
288
}