objint.c 12.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * 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.
 */

27
#include <stdlib.h>
Damien George's avatar
Damien George committed
28
29
#include <stdint.h>
#include <assert.h>
30
#include <string.h>
Damien George's avatar
Damien George committed
31

32
#include "mpconfig.h"
Damien George's avatar
Damien George committed
33
34
#include "nlr.h"
#include "misc.h"
35
#include "qstr.h"
Damien George's avatar
Damien George committed
36
#include "obj.h"
37
#include "parsenum.h"
38
#include "smallint.h"
39
#include "mpz.h"
40
#include "objint.h"
41
#include "objstr.h"
42
43
#include "runtime0.h"
#include "runtime.h"
44

45
#if MICROPY_PY_BUILTINS_FLOAT
46
47
48
#include <math.h>
#endif

49
// This dispatcher function is expected to be independent of the implementation of long int
50
STATIC mp_obj_t mp_obj_int_make_new(mp_obj_t type_in, mp_uint_t n_args, mp_uint_t n_kw, const mp_obj_t *args) {
51
    mp_arg_check_num(n_args, n_kw, 0, 2, false);
52

Damien George's avatar
Damien George committed
53
54
55
56
57
    switch (n_args) {
        case 0:
            return MP_OBJ_NEW_SMALL_INT(0);

        case 1:
58
59
60
            if (MP_OBJ_IS_INT(args[0])) {
                // already an int (small or long), just return it
                return args[0];
Dave Hylands's avatar
Dave Hylands committed
61
            } else if (MP_OBJ_IS_STR_OR_BYTES(args[0])) {
62
                // a string, parse it
63
                mp_uint_t l;
64
                const char *s = mp_obj_str_get_data(args[0], &l);
65
                return mp_parse_num_integer(s, l, 0);
66
#if MICROPY_PY_BUILTINS_FLOAT
67
            } else if (MP_OBJ_IS_TYPE(args[0], &mp_type_float)) {
68
                return MP_OBJ_NEW_SMALL_INT((MICROPY_FLOAT_C_FUN(trunc)(mp_obj_float_get(args[0]))));
69
#endif
70
            } else {
71
                // try to convert to small int (eg from bool)
72
73
                return MP_OBJ_NEW_SMALL_INT(mp_obj_get_int(args[0]));
            }
Damien George's avatar
Damien George committed
74

xyb's avatar
xyb committed
75
        case 2:
76
        default: {
77
78
            // should be a string, parse it
            // TODO proper error checking of argument types
79
            mp_uint_t l;
80
            const char *s = mp_obj_str_get_data(args[0], &l);
81
            return mp_parse_num_integer(s, l, mp_obj_get_int(args[1]));
82
        }
Damien George's avatar
Damien George committed
83
84
85
    }
}

86
void mp_obj_int_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
87
88
    // The size of this buffer is rather arbitrary. If it's not large
    // enough, a dynamic one will be allocated.
89
    char stack_buf[sizeof(mp_int_t) * 4];
90
    char *buf = stack_buf;
91
92
    mp_uint_t buf_size = sizeof(stack_buf);
    mp_uint_t fmt_size;
93
94
95
96
97
98
99
100
101
102

    char *str = mp_obj_int_formatted(&buf, &buf_size, &fmt_size, self_in, 10, NULL, '\0', '\0');
    print(env, "%s", str);

    if (buf != stack_buf) {
        m_free(buf, buf_size);
    }
}

#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
103
typedef mp_longint_impl_t fmt_int_t;
104
#else
105
typedef mp_int_t fmt_int_t;
106
107
#endif

108
STATIC const uint8_t log_base2_floor[] = {
109
110
111
112
113
114
115
116
117
118
119
    0,
    0, 1, 1, 2,
    2, 2, 2, 3,
    3, 3, 3, 3,
    3, 3, 3, 4,
    4, 4, 4, 4,
    4, 4, 4, 4,
    4, 4, 4, 4,
    4, 4, 4, 5
};

120
STATIC uint int_as_str_size_formatted(uint base, const char *prefix, char comma) {
121
122
123
124
125
126
127
128
129
130
    if (base < 2 || base > 32) {
        return 0;
    }

    uint num_digits = sizeof(fmt_int_t) * 8 / log_base2_floor[base] + 1;
    uint num_commas = comma ? num_digits / 3: 0;
    uint prefix_len = prefix ? strlen(prefix) : 0;
    return num_digits + num_commas + prefix_len + 2; // +1 for sign, +1 for null byte
}

131
// This routine expects you to pass in a buffer and size (in *buf and *buf_size).
132
133
134
135
136
137
// If, for some reason, this buffer is too small, then it will allocate a
// buffer and return the allocated buffer and size in *buf and *buf_size. It
// is the callers responsibility to free this allocated buffer.
//
// The resulting formatted string will be returned from this function and the
// formatted size will be in *fmt_size.
138
char *mp_obj_int_formatted(char **buf, mp_uint_t *buf_size, mp_uint_t *fmt_size, mp_const_obj_t self_in,
139
                           int base, const char *prefix, char base_char, char comma) {
140
    fmt_int_t num;
141
142
143
144
145
146
    if (MP_OBJ_IS_SMALL_INT(self_in)) {
        // A small int; get the integer value to format.
        num = mp_obj_get_int(self_in);
#if MICROPY_LONGINT_IMPL != MICROPY_LONGINT_IMPL_NONE
    } else if (MP_OBJ_IS_TYPE(self_in, &mp_type_int)) {
        // Not a small int.
147
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
148
        const mp_obj_int_t *self = self_in;
149
        // Get the value to format; mp_obj_get_int truncates to mp_int_t.
150
        num = self->val;
151
152
153
#else
        // Delegate to the implementation for the long int.
        return mp_obj_int_formatted_impl(buf, buf_size, fmt_size, self_in, base, prefix, base_char, comma);
154
#endif
155
156
157
#endif
    } else {
        // Not an int.
158
        **buf = '\0';
159
160
        *fmt_size = 0;
        return *buf;
161
    }
162

163
164
165
166
167
168
169
170
171
172
    char sign = '\0';
    if (num < 0) {
        num = -num;
        sign = '-';
    }

    uint needed_size = int_as_str_size_formatted(base, prefix, comma);
    if (needed_size > *buf_size) {
        *buf = m_new(char, needed_size);
        *buf_size = needed_size;
173
    }
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
    char *str = *buf;

    char *b = str + needed_size;
    *(--b) = '\0';
    char *last_comma = b;

    if (num == 0) {
        *(--b) = '0';
    } else {
        do {
            int c = num % base;
            num /= base;
            if (c >= 10) {
                c += base_char - 10;
            } else {
                c += '0';
            }
            *(--b) = c;
            if (comma && num != 0 && b > str && (last_comma - b) == 3) {
                *(--b) = comma;
                last_comma = b;
            }
        }
        while (b > str && num != 0);
    }
    if (prefix) {
        size_t prefix_len = strlen(prefix);
        char *p = b - prefix_len;
        if (p > str) {
            b = p;
            while (*prefix) {
                *p++ = *prefix++;
            }
        }
    }
    if (sign && b > str) {
        *(--b) = sign;
    }
    *fmt_size = *buf + needed_size - b - 1;

    return b;
215
216
}

217
218
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

Damien George's avatar
Damien George committed
219
220
221
222
mp_int_t mp_obj_int_hash(mp_obj_t self_in) {
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}

223
224
225
226
bool mp_obj_int_is_positive(mp_obj_t self_in) {
    return mp_obj_get_int(self_in) >= 0;
}

227
// This is called for operations on SMALL_INT that are not handled by mp_unary_op
228
mp_obj_t mp_obj_int_unary_op(mp_uint_t op, mp_obj_t o_in) {
229
    return MP_OBJ_NULL; // op not supported
230
231
}

232
// This is called for operations on SMALL_INT that are not handled by mp_binary_op
233
mp_obj_t mp_obj_int_binary_op(mp_uint_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
234
    return mp_obj_int_binary_op_extra_cases(op, lhs_in, rhs_in);
235
236
237
}

// This is called only with strings whose value doesn't fit in SMALL_INT
238
mp_obj_t mp_obj_new_int_from_str_len(const char **str, mp_uint_t len, bool neg, mp_uint_t base) {
239
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "long int not supported in this build"));
240
    return mp_const_none;
241
242
}

243
244
// This is called when an integer larger than a SMALL_INT is needed (although val might still fit in a SMALL_INT)
mp_obj_t mp_obj_new_int_from_ll(long long val) {
245
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
246
247
248
    return mp_const_none;
}

249
250
251
252
253
254
// This is called when an integer larger than a SMALL_INT is needed (although val might still fit in a SMALL_INT)
mp_obj_t mp_obj_new_int_from_ull(unsigned long long val) {
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
    return mp_const_none;
}

255
mp_obj_t mp_obj_new_int_from_uint(mp_uint_t value) {
256
257
258
259
260
    // SMALL_INT accepts only signed numbers, of one bit less size
    // then word size, which totals 2 bits less for unsigned numbers.
    if ((value & (WORD_MSBIT_HIGH | (WORD_MSBIT_HIGH >> 1))) == 0) {
        return MP_OBJ_NEW_SMALL_INT(value);
    }
261
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
262
    return mp_const_none;
263
264
}

265
mp_obj_t mp_obj_new_int(mp_int_t value) {
266
    if (MP_SMALL_INT_FITS(value)) {
267
268
        return MP_OBJ_NEW_SMALL_INT(value);
    }
269
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
270
    return mp_const_none;
Damien George's avatar
Damien George committed
271
}
272

273
mp_int_t mp_obj_int_get(mp_const_obj_t self_in) {
274
275
276
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}

277
mp_int_t mp_obj_int_get_checked(mp_const_obj_t self_in) {
278
279
280
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}

281
#if MICROPY_PY_BUILTINS_FLOAT
282
283
284
285
286
mp_float_t mp_obj_int_as_float(mp_obj_t self_in) {
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}
#endif

287
288
#endif // MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

289
290
// This dispatcher function is expected to be independent of the implementation of long int
// It handles the extra cases for integer-like arithmetic
291
mp_obj_t mp_obj_int_binary_op_extra_cases(mp_uint_t op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
292
293
294
295
296
297
298
    if (rhs_in == mp_const_false) {
        // false acts as 0
        return mp_binary_op(op, lhs_in, MP_OBJ_NEW_SMALL_INT(0));
    } else if (rhs_in == mp_const_true) {
        // true acts as 0
        return mp_binary_op(op, lhs_in, MP_OBJ_NEW_SMALL_INT(1));
    } else if (op == MP_BINARY_OP_MULTIPLY) {
299
        if (MP_OBJ_IS_STR(rhs_in) || MP_OBJ_IS_TYPE(rhs_in, &mp_type_bytes) || MP_OBJ_IS_TYPE(rhs_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(rhs_in, &mp_type_list)) {
300
301
302
303
            // multiply is commutative for these types, so delegate to them
            return mp_binary_op(op, rhs_in, lhs_in);
        }
    }
304
    return MP_OBJ_NULL; // op not supported
305
306
}

307
// this is a classmethod
308
STATIC mp_obj_t int_from_bytes(mp_uint_t n_args, const mp_obj_t *args) {
309
310
311
312
313
    // TODO: Support long ints
    // TODO: Support byteorder param (assumes 'little' at the moment)
    // TODO: Support signed param (assumes signed=False at the moment)

    // get the buffer info
314
    mp_buffer_info_t bufinfo;
315
    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
316

317
    // convert the bytes to an integer
318
    mp_uint_t value = 0;
stijn's avatar
stijn committed
319
    for (const byte* buf = (const byte*)bufinfo.buf + bufinfo.len - 1; buf >= (byte*)bufinfo.buf; buf--) {
320
        value = (value << 8) | *buf;
321
322
323
    }

    return mp_obj_new_int_from_uint(value);
324
325
}

326
327
STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(int_from_bytes_fun_obj, 2, 3, int_from_bytes);
STATIC MP_DEFINE_CONST_CLASSMETHOD_OBJ(int_from_bytes_obj, (const mp_obj_t)&int_from_bytes_fun_obj);
328

329
STATIC mp_obj_t int_to_bytes(mp_uint_t n_args, const mp_obj_t *args) {
330
    mp_int_t val = mp_obj_int_get_checked(args[0]);
331
332
333
334
335
336
337
338
339

    uint len = MP_OBJ_SMALL_INT_VALUE(args[1]);
    byte *data;

    // TODO: Support long ints
    // TODO: Support byteorder param
    // TODO: Support signed param
    mp_obj_t o = mp_obj_str_builder_start(&mp_type_bytes, len, &data);
    memset(data, 0, len);
340
    memcpy(data, &val, len < sizeof(mp_int_t) ? len : sizeof(mp_int_t));
341
342
343
344
345
346
347
348
349
350
351
352
    return mp_obj_str_builder_end(o);
}

STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(int_to_bytes_obj, 2, 4, int_to_bytes);

STATIC const mp_map_elem_t int_locals_dict_table[] = {
    { MP_OBJ_NEW_QSTR(MP_QSTR_from_bytes), (mp_obj_t)&int_from_bytes_obj },
    { MP_OBJ_NEW_QSTR(MP_QSTR_to_bytes), (mp_obj_t)&int_to_bytes_obj },
};

STATIC MP_DEFINE_CONST_DICT(int_locals_dict, int_locals_dict_table);

353
const mp_obj_type_t mp_type_int = {
354
    { &mp_type_type },
355
    .name = MP_QSTR_int,
356
357
358
359
    .print = mp_obj_int_print,
    .make_new = mp_obj_int_make_new,
    .unary_op = mp_obj_int_unary_op,
    .binary_op = mp_obj_int_binary_op,
360
    .locals_dict = (mp_obj_t)&int_locals_dict,
361
};