1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2013, 2014 Damien P. George
7  *
8  * Permission is hereby granted, free of charge, to any person obtaining a copy
9  * of this software and associated documentation files (the "Software"), to deal
10  * in the Software without restriction, including without limitation the rights
11  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12  * copies of the Software, and to permit persons to whom the Software is
13  * furnished to do so, subject to the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be included in
16  * all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24  * THE SOFTWARE.
25  */
26 
27 #include <string.h>
28 
29 #include "py/obj.h"
30 #include "py/runtime.h"
31 
32 typedef struct _mp_obj_bound_meth_t {
33     mp_obj_base_t base;
34     mp_obj_t meth;
35     mp_obj_t self;
36 } mp_obj_bound_meth_t;
37 
38 #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
bound_meth_print(const mp_print_t * print,mp_obj_t o_in,mp_print_kind_t kind)39 STATIC void bound_meth_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
40     (void)kind;
41     mp_obj_bound_meth_t *o = MP_OBJ_TO_PTR(o_in);
42     mp_printf(print, "<bound_method %p ", o);
43     mp_obj_print_helper(print, o->self, PRINT_REPR);
44     mp_print_str(print, ".");
45     mp_obj_print_helper(print, o->meth, PRINT_REPR);
46     mp_print_str(print, ">");
47 }
48 #endif
49 
mp_call_method_self_n_kw(mp_obj_t meth,mp_obj_t self,size_t n_args,size_t n_kw,const mp_obj_t * args)50 mp_obj_t mp_call_method_self_n_kw(mp_obj_t meth, mp_obj_t self, size_t n_args, size_t n_kw, const mp_obj_t *args) {
51     // need to insert self before all other args and then call meth
52     size_t n_total = n_args + 2 * n_kw;
53     mp_obj_t *args2 = NULL;
54     #if MICROPY_ENABLE_PYSTACK
55     args2 = mp_pystack_alloc(sizeof(mp_obj_t) * (1 + n_total));
56     #else
57     mp_obj_t *free_args2 = NULL;
58     if (n_total > 4) {
59         // try to use heap to allocate temporary args array
60         args2 = m_new_maybe(mp_obj_t, 1 + n_total);
61         free_args2 = args2;
62     }
63     if (args2 == NULL) {
64         // (fallback to) use stack to allocate temporary args array
65         args2 = alloca(sizeof(mp_obj_t) * (1 + n_total));
66     }
67     #endif
68     args2[0] = self;
69     memcpy(args2 + 1, args, n_total * sizeof(mp_obj_t));
70     mp_obj_t res = mp_call_function_n_kw(meth, n_args + 1, n_kw, args2);
71     #if MICROPY_ENABLE_PYSTACK
72     mp_pystack_free(args2);
73     #else
74     if (free_args2 != NULL) {
75         m_del(mp_obj_t, free_args2, 1 + n_total);
76     }
77     #endif
78     return res;
79 }
80 
bound_meth_call(mp_obj_t self_in,size_t n_args,size_t n_kw,const mp_obj_t * args)81 STATIC mp_obj_t bound_meth_call(mp_obj_t self_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
82     mp_obj_bound_meth_t *self = MP_OBJ_TO_PTR(self_in);
83     return mp_call_method_self_n_kw(self->meth, self->self, n_args, n_kw, args);
84 }
85 
86 #if MICROPY_PY_FUNCTION_ATTRS
bound_meth_attr(mp_obj_t self_in,qstr attr,mp_obj_t * dest)87 STATIC void bound_meth_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
88     if (dest[0] != MP_OBJ_NULL) {
89         // not load attribute
90         return;
91     }
92     // Delegate the load to the method object
93     mp_obj_bound_meth_t *self = MP_OBJ_TO_PTR(self_in);
94     mp_load_method_maybe(self->meth, attr, dest);
95 }
96 #endif
97 
98 STATIC const mp_obj_type_t mp_type_bound_meth = {
99     { &mp_type_type },
100     .name = MP_QSTR_bound_method,
101     #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
102     .print = bound_meth_print,
103     #endif
104     .call = bound_meth_call,
105     #if MICROPY_PY_FUNCTION_ATTRS
106     .attr = bound_meth_attr,
107     #endif
108 };
109 
mp_obj_new_bound_meth(mp_obj_t meth,mp_obj_t self)110 mp_obj_t mp_obj_new_bound_meth(mp_obj_t meth, mp_obj_t self) {
111     mp_obj_bound_meth_t *o = m_new_obj(mp_obj_bound_meth_t);
112     o->base.type = &mp_type_bound_meth;
113     o->meth = meth;
114     o->self = self;
115     return MP_OBJ_FROM_PTR(o);
116 }
117