2014-05-03 23:27:38 +01:00
|
|
|
/*
|
|
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
2014-05-13 06:44:45 +01:00
|
|
|
* Copyright (c) 2014 Paul Sokolovsky
|
2014-05-03 23:27:38 +01:00
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be included in
|
|
|
|
* all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
* THE SOFTWARE.
|
|
|
|
*/
|
|
|
|
|
2013-12-21 18:17:45 +00:00
|
|
|
#include <stdlib.h>
|
|
|
|
#include <assert.h>
|
|
|
|
|
2014-05-02 15:47:01 +01:00
|
|
|
#include "mpconfig.h"
|
2013-12-21 18:17:45 +00:00
|
|
|
#include "nlr.h"
|
|
|
|
#include "misc.h"
|
2014-01-21 21:40:13 +00:00
|
|
|
#include "qstr.h"
|
2013-12-21 18:17:45 +00:00
|
|
|
#include "obj.h"
|
|
|
|
#include "runtime.h"
|
|
|
|
#include "bc.h"
|
2014-03-23 19:48:29 +00:00
|
|
|
#include "objgenerator.h"
|
2014-04-17 03:49:47 +01:00
|
|
|
#include "objfun.h"
|
2013-12-21 18:17:45 +00:00
|
|
|
|
|
|
|
/******************************************************************************/
|
|
|
|
/* generator wrapper */
|
|
|
|
|
|
|
|
typedef struct _mp_obj_gen_wrap_t {
|
|
|
|
mp_obj_base_t base;
|
|
|
|
mp_obj_t *fun;
|
|
|
|
} mp_obj_gen_wrap_t;
|
|
|
|
|
2014-06-11 18:17:38 +01:00
|
|
|
typedef struct _mp_obj_gen_instance_t {
|
|
|
|
mp_obj_base_t base;
|
|
|
|
mp_obj_dict_t *globals;
|
|
|
|
mp_code_state code_state;
|
|
|
|
} mp_obj_gen_instance_t;
|
2014-03-30 18:21:28 +01:00
|
|
|
|
2014-08-30 00:35:11 +01:00
|
|
|
STATIC mp_obj_t gen_wrap_call(mp_obj_t self_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
|
2013-12-21 18:17:45 +00:00
|
|
|
mp_obj_gen_wrap_t *self = self_in;
|
2014-04-17 03:49:47 +01:00
|
|
|
mp_obj_fun_bc_t *self_fun = (mp_obj_fun_bc_t*)self->fun;
|
2014-03-29 13:43:38 +00:00
|
|
|
assert(MP_OBJ_IS_TYPE(self_fun, &mp_type_fun_bc));
|
2013-12-30 22:32:17 +00:00
|
|
|
|
2014-06-11 18:17:38 +01:00
|
|
|
const byte *bytecode = self_fun->bytecode;
|
|
|
|
// get code info size, and skip the line number table
|
2014-07-03 13:25:24 +01:00
|
|
|
mp_uint_t code_info_size = bytecode[0] | (bytecode[1] << 8) | (bytecode[2] << 16) | (bytecode[3] << 24);
|
2014-06-11 18:17:38 +01:00
|
|
|
bytecode += code_info_size;
|
|
|
|
|
|
|
|
// bytecode prelude: get state size and exception stack size
|
2014-07-03 13:25:24 +01:00
|
|
|
mp_uint_t n_state = bytecode[0] | (bytecode[1] << 8);
|
|
|
|
mp_uint_t n_exc_stack = bytecode[2] | (bytecode[3] << 8);
|
2014-06-11 18:17:38 +01:00
|
|
|
bytecode += 4;
|
|
|
|
|
|
|
|
// allocate the generator object, with room for local stack and exception stack
|
|
|
|
mp_obj_gen_instance_t *o = m_new_obj_var(mp_obj_gen_instance_t, byte,
|
|
|
|
n_state * sizeof(mp_obj_t) + n_exc_stack * sizeof(mp_exc_stack_t));
|
|
|
|
o->base.type = &mp_type_gen_instance;
|
|
|
|
|
|
|
|
o->globals = self_fun->globals;
|
|
|
|
o->code_state.n_state = n_state;
|
|
|
|
o->code_state.ip = bytecode;
|
|
|
|
mp_setup_code_state(&o->code_state, self_fun, n_args, n_kw, args);
|
|
|
|
return o;
|
2013-12-21 18:17:45 +00:00
|
|
|
}
|
|
|
|
|
2014-03-29 13:43:38 +00:00
|
|
|
const mp_obj_type_t mp_type_gen_wrap = {
|
2014-02-15 16:10:44 +00:00
|
|
|
{ &mp_type_type },
|
2014-02-15 11:34:50 +00:00
|
|
|
.name = MP_QSTR_generator,
|
2014-01-18 14:10:48 +00:00
|
|
|
.call = gen_wrap_call,
|
2013-12-21 18:17:45 +00:00
|
|
|
};
|
|
|
|
|
2014-01-29 20:30:52 +00:00
|
|
|
mp_obj_t mp_obj_new_gen_wrap(mp_obj_t fun) {
|
2013-12-21 18:17:45 +00:00
|
|
|
mp_obj_gen_wrap_t *o = m_new_obj(mp_obj_gen_wrap_t);
|
2014-03-29 13:43:38 +00:00
|
|
|
o->base.type = &mp_type_gen_wrap;
|
2013-12-21 18:17:45 +00:00
|
|
|
o->fun = fun;
|
|
|
|
return o;
|
|
|
|
}
|
|
|
|
|
|
|
|
/******************************************************************************/
|
|
|
|
/* generator instance */
|
|
|
|
|
2014-01-13 17:19:16 +00:00
|
|
|
void gen_instance_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
|
2014-05-01 20:20:07 +01:00
|
|
|
mp_obj_gen_instance_t *self = self_in;
|
2014-05-31 14:50:46 +01:00
|
|
|
print(env, "<generator object '%s' at %p>", mp_obj_code_get_name(self->code_state.code_info), self_in);
|
2013-12-21 18:17:45 +00:00
|
|
|
}
|
|
|
|
|
2014-03-26 19:33:23 +00:00
|
|
|
mp_vm_return_kind_t mp_obj_gen_resume(mp_obj_t self_in, mp_obj_t send_value, mp_obj_t throw_value, mp_obj_t *ret_val) {
|
2014-03-30 00:32:30 +00:00
|
|
|
assert(MP_OBJ_IS_TYPE(self_in, &mp_type_gen_instance));
|
2013-12-21 18:17:45 +00:00
|
|
|
mp_obj_gen_instance_t *self = self_in;
|
2014-05-31 14:50:46 +01:00
|
|
|
if (self->code_state.ip == 0) {
|
2014-04-17 23:19:36 +01:00
|
|
|
*ret_val = MP_OBJ_STOP_ITERATION;
|
2014-03-26 19:33:23 +00:00
|
|
|
return MP_VM_RETURN_NORMAL;
|
2014-01-26 23:01:37 +00:00
|
|
|
}
|
2014-05-31 14:50:46 +01:00
|
|
|
if (self->code_state.sp == self->code_state.state - 1) {
|
2014-01-26 18:50:11 +00:00
|
|
|
if (send_value != mp_const_none) {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception_msg(&mp_type_TypeError, "can't send non-None value to a just-started generator"));
|
2014-01-26 18:50:11 +00:00
|
|
|
}
|
|
|
|
} else {
|
2014-05-31 14:50:46 +01:00
|
|
|
*self->code_state.sp = send_value;
|
2014-01-26 18:50:11 +00:00
|
|
|
}
|
2014-04-17 03:49:47 +01:00
|
|
|
mp_obj_dict_t *old_globals = mp_globals_get();
|
|
|
|
mp_globals_set(self->globals);
|
2014-06-07 14:16:08 +01:00
|
|
|
mp_vm_return_kind_t ret_kind = mp_execute_bytecode(&self->code_state, throw_value);
|
2014-04-17 03:49:47 +01:00
|
|
|
mp_globals_set(old_globals);
|
2014-03-23 19:48:29 +00:00
|
|
|
|
2014-03-26 19:33:23 +00:00
|
|
|
switch (ret_kind) {
|
2014-02-15 22:55:00 +00:00
|
|
|
case MP_VM_RETURN_NORMAL:
|
|
|
|
// Explicitly mark generator as completed. If we don't do this,
|
|
|
|
// subsequent next() may re-execute statements after last yield
|
|
|
|
// again and again, leading to side effects.
|
|
|
|
// TODO: check how return with value behaves under such conditions
|
|
|
|
// in CPython.
|
2014-05-31 14:50:46 +01:00
|
|
|
self->code_state.ip = 0;
|
|
|
|
*ret_val = *self->code_state.sp;
|
2014-03-26 19:33:23 +00:00
|
|
|
break;
|
2014-03-23 19:48:29 +00:00
|
|
|
|
|
|
|
case MP_VM_RETURN_YIELD:
|
2014-05-31 14:50:46 +01:00
|
|
|
*ret_val = *self->code_state.sp;
|
2014-03-26 19:33:23 +00:00
|
|
|
break;
|
2014-03-23 19:48:29 +00:00
|
|
|
|
|
|
|
case MP_VM_RETURN_EXCEPTION:
|
2014-05-31 14:50:46 +01:00
|
|
|
self->code_state.ip = 0;
|
|
|
|
*ret_val = self->code_state.state[self->code_state.n_state - 1];
|
2014-03-26 19:33:23 +00:00
|
|
|
break;
|
2014-03-23 19:48:29 +00:00
|
|
|
|
|
|
|
default:
|
|
|
|
assert(0);
|
2014-03-26 19:33:23 +00:00
|
|
|
*ret_val = mp_const_none;
|
|
|
|
break;
|
2014-03-23 19:48:29 +00:00
|
|
|
}
|
2014-03-26 19:33:23 +00:00
|
|
|
|
|
|
|
return ret_kind;
|
2014-03-23 19:48:29 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
STATIC mp_obj_t gen_resume_and_raise(mp_obj_t self_in, mp_obj_t send_value, mp_obj_t throw_value) {
|
2014-03-26 19:33:23 +00:00
|
|
|
mp_obj_t ret;
|
|
|
|
switch (mp_obj_gen_resume(self_in, send_value, throw_value, &ret)) {
|
2014-03-23 19:48:29 +00:00
|
|
|
case MP_VM_RETURN_NORMAL:
|
|
|
|
// Optimize return w/o value in case generator is used in for loop
|
2014-04-17 23:19:36 +01:00
|
|
|
if (ret == mp_const_none || ret == MP_OBJ_STOP_ITERATION) {
|
|
|
|
return MP_OBJ_STOP_ITERATION;
|
2014-02-15 22:55:00 +00:00
|
|
|
} else {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception_args(&mp_type_StopIteration, 1, &ret));
|
2014-02-15 22:55:00 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
case MP_VM_RETURN_YIELD:
|
2014-03-31 02:09:53 +01:00
|
|
|
if (throw_value != MP_OBJ_NULL && mp_obj_is_subclass_fast(mp_obj_get_type(throw_value), &mp_type_GeneratorExit)) {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "generator ignored GeneratorExit"));
|
2014-03-31 02:09:53 +01:00
|
|
|
}
|
2014-03-23 19:48:29 +00:00
|
|
|
return ret;
|
2014-02-15 22:55:00 +00:00
|
|
|
|
|
|
|
case MP_VM_RETURN_EXCEPTION:
|
2014-04-17 23:19:36 +01:00
|
|
|
// TODO: Optimization of returning MP_OBJ_STOP_ITERATION is really part
|
2014-03-30 21:14:55 +01:00
|
|
|
// of mp_iternext() protocol, but this function is called by other methods
|
2014-04-17 23:19:36 +01:00
|
|
|
// too, which may not handled MP_OBJ_STOP_ITERATION.
|
2014-03-30 21:14:55 +01:00
|
|
|
if (mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_StopIteration)) {
|
2014-04-17 23:19:36 +01:00
|
|
|
return MP_OBJ_STOP_ITERATION;
|
2014-03-30 21:14:55 +01:00
|
|
|
} else {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(ret);
|
2014-03-30 21:14:55 +01:00
|
|
|
}
|
2014-03-22 14:44:58 +00:00
|
|
|
|
2014-02-15 22:55:00 +00:00
|
|
|
default:
|
|
|
|
assert(0);
|
|
|
|
return mp_const_none;
|
2013-12-21 18:17:45 +00:00
|
|
|
}
|
|
|
|
}
|
2014-01-26 18:50:11 +00:00
|
|
|
|
|
|
|
mp_obj_t gen_instance_iternext(mp_obj_t self_in) {
|
2014-03-23 19:48:29 +00:00
|
|
|
return gen_resume_and_raise(self_in, mp_const_none, MP_OBJ_NULL);
|
2014-01-26 23:01:37 +00:00
|
|
|
}
|
|
|
|
|
2014-02-12 16:15:40 +00:00
|
|
|
STATIC mp_obj_t gen_instance_send(mp_obj_t self_in, mp_obj_t send_value) {
|
2014-03-23 19:48:29 +00:00
|
|
|
mp_obj_t ret = gen_resume_and_raise(self_in, send_value, MP_OBJ_NULL);
|
2014-04-17 23:19:36 +01:00
|
|
|
if (ret == MP_OBJ_STOP_ITERATION) {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception(&mp_type_StopIteration));
|
2014-02-15 16:10:44 +00:00
|
|
|
} else {
|
|
|
|
return ret;
|
2014-01-26 23:01:37 +00:00
|
|
|
}
|
2014-01-26 18:50:11 +00:00
|
|
|
}
|
2014-02-15 16:10:44 +00:00
|
|
|
|
2014-02-12 16:15:40 +00:00
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_2(gen_instance_send_obj, gen_instance_send);
|
2014-01-26 18:50:11 +00:00
|
|
|
|
2014-03-30 11:13:12 +01:00
|
|
|
STATIC mp_obj_t gen_instance_close(mp_obj_t self_in);
|
2014-08-30 00:35:11 +01:00
|
|
|
STATIC mp_obj_t gen_instance_throw(mp_uint_t n_args, const mp_obj_t *args) {
|
2014-03-30 11:13:12 +01:00
|
|
|
mp_obj_t exc = (n_args == 2) ? args[1] : args[2];
|
2014-03-30 13:35:08 +01:00
|
|
|
exc = mp_make_raise_obj(exc);
|
2014-03-30 11:13:12 +01:00
|
|
|
|
|
|
|
mp_obj_t ret = gen_resume_and_raise(args[0], mp_const_none, exc);
|
2014-04-17 23:19:36 +01:00
|
|
|
if (ret == MP_OBJ_STOP_ITERATION) {
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception(&mp_type_StopIteration));
|
2014-03-22 15:50:12 +00:00
|
|
|
} else {
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(gen_instance_throw_obj, 2, 4, gen_instance_throw);
|
|
|
|
|
2014-03-23 19:48:29 +00:00
|
|
|
STATIC mp_obj_t gen_instance_close(mp_obj_t self_in) {
|
2014-03-26 19:33:23 +00:00
|
|
|
mp_obj_t ret;
|
2014-03-29 13:15:08 +00:00
|
|
|
switch (mp_obj_gen_resume(self_in, mp_const_none, (mp_obj_t)&mp_const_GeneratorExit_obj, &ret)) {
|
2014-03-26 19:33:23 +00:00
|
|
|
case MP_VM_RETURN_YIELD:
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(mp_obj_new_exception_msg(&mp_type_RuntimeError, "generator ignored GeneratorExit"));
|
2014-03-23 19:48:29 +00:00
|
|
|
|
2014-03-26 19:33:23 +00:00
|
|
|
// Swallow StopIteration & GeneratorExit (== successful close), and re-raise any other
|
|
|
|
case MP_VM_RETURN_EXCEPTION:
|
|
|
|
// ret should always be an instance of an exception class
|
|
|
|
if (mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_GeneratorExit) ||
|
|
|
|
mp_obj_is_subclass_fast(mp_obj_get_type(ret), &mp_type_StopIteration)) {
|
|
|
|
return mp_const_none;
|
|
|
|
}
|
2014-04-05 18:32:08 +01:00
|
|
|
nlr_raise(ret);
|
2014-03-26 19:33:23 +00:00
|
|
|
|
|
|
|
default:
|
|
|
|
// The only choice left is MP_VM_RETURN_NORMAL which is successful close
|
2014-03-23 19:48:29 +00:00
|
|
|
return mp_const_none;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
STATIC MP_DEFINE_CONST_FUN_OBJ_1(gen_instance_close_obj, gen_instance_close);
|
2014-03-22 15:50:12 +00:00
|
|
|
|
2014-03-26 21:47:19 +00:00
|
|
|
STATIC const mp_map_elem_t gen_instance_locals_dict_table[] = {
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_close), (mp_obj_t)&gen_instance_close_obj },
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_send), (mp_obj_t)&gen_instance_send_obj },
|
|
|
|
{ MP_OBJ_NEW_QSTR(MP_QSTR_throw), (mp_obj_t)&gen_instance_throw_obj },
|
2014-01-26 18:50:11 +00:00
|
|
|
};
|
2013-12-21 18:17:45 +00:00
|
|
|
|
2014-03-26 21:47:19 +00:00
|
|
|
STATIC MP_DEFINE_CONST_DICT(gen_instance_locals_dict, gen_instance_locals_dict_table);
|
|
|
|
|
2014-03-29 13:43:38 +00:00
|
|
|
const mp_obj_type_t mp_type_gen_instance = {
|
2014-02-15 16:10:44 +00:00
|
|
|
{ &mp_type_type },
|
2014-02-15 11:34:50 +00:00
|
|
|
.name = MP_QSTR_generator,
|
2014-01-07 15:58:30 +00:00
|
|
|
.print = gen_instance_print,
|
2014-05-17 09:18:23 +01:00
|
|
|
.getiter = mp_identity,
|
2014-01-07 15:58:30 +00:00
|
|
|
.iternext = gen_instance_iternext,
|
2014-03-26 21:47:19 +00:00
|
|
|
.locals_dict = (mp_obj_t)&gen_instance_locals_dict,
|
2013-12-21 18:17:45 +00:00
|
|
|
};
|