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 * Copyright (c) 2014 Paul Sokolovsky
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 * THE SOFTWARE.
26 */
27
28#include <string.h>
29
30#include "py/objtuple.h"
31#include "py/runtime.h"
32#include "py/objstr.h"
33#include "py/objnamedtuple.h"
34
35#if MICROPY_PY_COLLECTIONS
36
37size_t mp_obj_namedtuple_find_field(const mp_obj_namedtuple_type_t *type, qstr name) {
38 for (size_t i = 0; i < type->n_fields; i++) {
39 if (type->fields[i] == name) {
40 return i;
41 }
42 }
43 return (size_t)-1;
44}
45
46#if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
47STATIC mp_obj_t namedtuple_asdict(mp_obj_t self_in) {
48 mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in);
49 const qstr *fields = ((mp_obj_namedtuple_type_t *)self->tuple.base.type)->fields;
50 mp_obj_t dict = mp_obj_new_dict(self->tuple.len);
51 // make it an OrderedDict
52 mp_obj_dict_t *dictObj = MP_OBJ_TO_PTR(dict);
53 dictObj->base.type = &mp_type_ordereddict;
54 dictObj->map.is_ordered = 1;
55 for (size_t i = 0; i < self->tuple.len; ++i) {
56 mp_obj_dict_store(dict, MP_OBJ_NEW_QSTR(fields[i]), self->tuple.items[i]);
57 }
58 return dict;
59}
60MP_DEFINE_CONST_FUN_OBJ_1(namedtuple_asdict_obj, namedtuple_asdict);
61#endif
62
63STATIC void namedtuple_print(const mp_print_t *print, mp_obj_t o_in, mp_print_kind_t kind) {
64 (void)kind;
65 mp_obj_namedtuple_t *o = MP_OBJ_TO_PTR(o_in);
66 mp_printf(print, "%q", o->tuple.base.type->name);
67 const qstr *fields = ((mp_obj_namedtuple_type_t *)o->tuple.base.type)->fields;
68 mp_obj_attrtuple_print_helper(print, fields, &o->tuple);
69}
70
71STATIC void namedtuple_attr(mp_obj_t self_in, qstr attr, mp_obj_t *dest) {
72 if (dest[0] == MP_OBJ_NULL) {
73 // load attribute
74 mp_obj_namedtuple_t *self = MP_OBJ_TO_PTR(self_in);
75 #if MICROPY_PY_COLLECTIONS_NAMEDTUPLE__ASDICT
76 if (attr == MP_QSTR__asdict) {
77 dest[0] = MP_OBJ_FROM_PTR(&namedtuple_asdict_obj);
78 dest[1] = self_in;
79 return;
80 }
81 #endif
82 size_t id = mp_obj_namedtuple_find_field((mp_obj_namedtuple_type_t *)self->tuple.base.type, attr);
83 if (id == (size_t)-1) {
84 return;
85 }
86 dest[0] = self->tuple.items[id];
87 } else {
88 // delete/store attribute
89 // provide more detailed error message than we'd get by just returning
90 mp_raise_msg(&mp_type_AttributeError, MP_ERROR_TEXT("can't set attribute"));
91 }
92}
93
94STATIC mp_obj_t namedtuple_make_new(const mp_obj_type_t *type_in, size_t n_args, size_t n_kw, const mp_obj_t *args) {
95 const mp_obj_namedtuple_type_t *type = (const mp_obj_namedtuple_type_t *)type_in;
96 size_t num_fields = type->n_fields;
97 if (n_args + n_kw != num_fields) {
98 #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
99 mp_arg_error_terse_mismatch();
100 #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_NORMAL
101 mp_raise_msg_varg(&mp_type_TypeError,
102 MP_ERROR_TEXT("function takes %d positional arguments but %d were given"),
103 num_fields, n_args + n_kw);
104 #elif MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_DETAILED
105 mp_raise_msg_varg(&mp_type_TypeError,
106 MP_ERROR_TEXT("%q() takes %d positional arguments but %d were given"),
107 type->base.name, num_fields, n_args + n_kw);
108 #endif
109 }
110
111 // Create a tuple and set the type to this namedtuple
112 mp_obj_tuple_t *tuple = MP_OBJ_TO_PTR(mp_obj_new_tuple(num_fields, NULL));
113 tuple->base.type = type_in;
114
115 // Copy the positional args into the first slots of the namedtuple
116 memcpy(&tuple->items[0], args, sizeof(mp_obj_t) * n_args);
117
118 // Fill in the remaining slots with the keyword args
119 memset(&tuple->items[n_args], 0, sizeof(mp_obj_t) * n_kw);
120 for (size_t i = n_args; i < n_args + 2 * n_kw; i += 2) {
121 qstr kw = mp_obj_str_get_qstr(args[i]);
122 size_t id = mp_obj_namedtuple_find_field(type, kw);
123 if (id == (size_t)-1) {
124 #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
125 mp_arg_error_terse_mismatch();
126 #else
127 mp_raise_msg_varg(&mp_type_TypeError, MP_ERROR_TEXT("unexpected keyword argument '%q'"), kw);
128 #endif
129 }
130 if (tuple->items[id] != MP_OBJ_NULL) {
131 #if MICROPY_ERROR_REPORTING == MICROPY_ERROR_REPORTING_TERSE
132 mp_arg_error_terse_mismatch();
133 #else
134 mp_raise_msg_varg(&mp_type_TypeError,
135 MP_ERROR_TEXT("function got multiple values for argument '%q'"), kw);
136 #endif
137 }
138 tuple->items[id] = args[i + 1];
139 }
140
141 return MP_OBJ_FROM_PTR(tuple);
142}
143
144mp_obj_namedtuple_type_t *mp_obj_new_namedtuple_base(size_t n_fields, mp_obj_t *fields) {
145 mp_obj_namedtuple_type_t *o = m_new_obj_var(mp_obj_namedtuple_type_t, qstr, n_fields);
146 memset(&o->base, 0, sizeof(o->base));
147 o->n_fields = n_fields;
148 for (size_t i = 0; i < n_fields; i++) {
149 o->fields[i] = mp_obj_str_get_qstr(fields[i]);
150 }
151 return o;
152}
153
154STATIC mp_obj_t mp_obj_new_namedtuple_type(qstr name, size_t n_fields, mp_obj_t *fields) {
155 mp_obj_namedtuple_type_t *o = mp_obj_new_namedtuple_base(n_fields, fields);
156 o->base.base.type = &mp_type_type;
157 o->base.flags = MP_TYPE_FLAG_EQ_CHECKS_OTHER_TYPE; // can match tuple
158 o->base.name = name;
159 o->base.print = namedtuple_print;
160 o->base.make_new = namedtuple_make_new;
161 o->base.unary_op = mp_obj_tuple_unary_op;
162 o->base.binary_op = mp_obj_tuple_binary_op;
163 o->base.attr = namedtuple_attr;
164 o->base.subscr = mp_obj_tuple_subscr;
165 o->base.getiter = mp_obj_tuple_getiter;
166 o->base.parent = &mp_type_tuple;
167 return MP_OBJ_FROM_PTR(o);
168}
169
170STATIC mp_obj_t new_namedtuple_type(mp_obj_t name_in, mp_obj_t fields_in) {
171 qstr name = mp_obj_str_get_qstr(name_in);
172 size_t n_fields;
173 mp_obj_t *fields;
174 #if MICROPY_CPYTHON_COMPAT
175 if (mp_obj_is_str(fields_in)) {
176 fields_in = mp_obj_str_split(1, &fields_in);
177 }
178 #endif
179 mp_obj_get_array(fields_in, &n_fields, &fields);
180 return mp_obj_new_namedtuple_type(name, n_fields, fields);
181}
182MP_DEFINE_CONST_FUN_OBJ_2(mp_namedtuple_obj, new_namedtuple_type);
183
184#endif // MICROPY_PY_COLLECTIONS
185