objint.c 11.4 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 "mpz.h"
39
#include "objint.h"
40
41
#include "runtime0.h"
#include "runtime.h"
42

43
44
45
46
#if MICROPY_ENABLE_FLOAT
#include <math.h>
#endif

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

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

        case 1:
56
            if (MP_OBJ_IS_STR(args[0])) {
57
                // a string, parse it
58
                uint l;
59
                const char *s = mp_obj_str_get_data(args[0], &l);
60
                return mp_parse_num_integer(s, l, 0);
61
62
63
64
#if MICROPY_ENABLE_FLOAT
            } else if (MP_OBJ_IS_TYPE(args[0], &mp_type_float)) {
                return MP_OBJ_NEW_SMALL_INT((machine_int_t)(MICROPY_FLOAT_C_FUN(trunc)(mp_obj_float_get(args[0]))));
#endif
65
66
67
            } else {
                return MP_OBJ_NEW_SMALL_INT(mp_obj_get_int(args[0]));
            }
Damien George's avatar
Damien George committed
68

xyb's avatar
xyb committed
69
        case 2:
70
        default: {
71
72
            // should be a string, parse it
            // TODO proper error checking of argument types
73
            uint l;
74
            const char *s = mp_obj_str_get_data(args[0], &l);
75
            return mp_parse_num_integer(s, l, mp_obj_get_int(args[1]));
76
        }
Damien George's avatar
Damien George committed
77
78
79
    }
}

80
void mp_obj_int_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
    // The size of this buffer is rather arbitrary. If it's not large
    // enough, a dynamic one will be allocated.
    char stack_buf[sizeof(machine_int_t) * 4];
    char *buf = stack_buf;
    int buf_size = sizeof(stack_buf);
    int fmt_size;

    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
97
typedef mp_longint_impl_t fmt_int_t;
98
#else
99
typedef mp_small_int_t fmt_int_t;
100
101
#endif

102
STATIC const uint log_base2_floor[] = {
103
104
105
106
107
108
109
110
111
112
113
    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
};

114
STATIC uint int_as_str_size_formatted(uint base, const char *prefix, char comma) {
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
    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
}

// This routine expects you to pass in a buffer and size (in *buf and buf_size).
// 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.
Paul Sokolovsky's avatar
Paul Sokolovsky committed
132
char *mp_obj_int_formatted(char **buf, int *buf_size, int *fmt_size, mp_const_obj_t self_in,
133
                           int base, const char *prefix, char base_char, char comma) {
134
    fmt_int_t num;
135
136
137
138
139
140
    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.
141
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
142
143
        mp_obj_int_t *self = self_in;
        // Get the value to format; mp_obj_get_int truncates to machine_int_t.
144
        num = self->val;
145
146
147
#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);
148
#endif
149
150
151
152
153
154
#endif
    } else {
        // Not an int.
        buf[0] = '\0';
        *fmt_size = 0;
        return *buf;
155
    }
156

157
158
159
160
161
162
163
164
165
166
    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;
167
    }
168
169
170
171
172
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
    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;
209
210
}

211
212
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

213
214
215
216
bool mp_obj_int_is_positive(mp_obj_t self_in) {
    return mp_obj_get_int(self_in) >= 0;
}

217
// This is called for operations on SMALL_INT that are not handled by mp_unary_op
218
mp_obj_t mp_obj_int_unary_op(int op, mp_obj_t o_in) {
219
    return MP_OBJ_NULL; // op not supported
220
221
}

222
// This is called for operations on SMALL_INT that are not handled by mp_binary_op
223
224
mp_obj_t mp_obj_int_binary_op(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
    return mp_obj_int_binary_op_extra_cases(op, lhs_in, rhs_in);
225
226
227
}

// This is called only with strings whose value doesn't fit in SMALL_INT
228
mp_obj_t mp_obj_new_int_from_qstr(qstr qst) {
229
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "long int not supported in this build"));
230
    return mp_const_none;
231
232
}

233
234
// 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) {
235
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
236
237
238
    return mp_const_none;
}

239
240
241
242
243
244
mp_obj_t mp_obj_new_int_from_uint(machine_uint_t value) {
    // 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);
    }
245
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
246
    return mp_const_none;
247
248
}

Damien George's avatar
Damien George committed
249
mp_obj_t mp_obj_new_int(machine_int_t value) {
250
251
252
    if (MP_OBJ_FITS_SMALL_INT(value)) {
        return MP_OBJ_NEW_SMALL_INT(value);
    }
253
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
254
    return mp_const_none;
Damien George's avatar
Damien George committed
255
}
256
257
258
259
260

machine_int_t mp_obj_int_get(mp_obj_t self_in) {
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}

261
machine_int_t mp_obj_int_get_checked(mp_const_obj_t self_in) {
262
263
264
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}

265
266
267
268
269
270
#if MICROPY_ENABLE_FLOAT
mp_float_t mp_obj_int_as_float(mp_obj_t self_in) {
    return MP_OBJ_SMALL_INT_VALUE(self_in);
}
#endif

271
272
#endif // MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
// This dispatcher function is expected to be independent of the implementation of long int
// It handles the extra cases for integer-like arithmetic
mp_obj_t mp_obj_int_binary_op_extra_cases(int op, mp_obj_t lhs_in, mp_obj_t rhs_in) {
    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) {
        if (MP_OBJ_IS_STR(rhs_in) || MP_OBJ_IS_TYPE(rhs_in, &mp_type_tuple) || MP_OBJ_IS_TYPE(rhs_in, &mp_type_list)) {
            // multiply is commutative for these types, so delegate to them
            return mp_binary_op(op, rhs_in, lhs_in);
        }
    }
288
    return MP_OBJ_NULL; // op not supported
289
290
}

291
// this is a classmethod
292
STATIC mp_obj_t int_from_bytes(uint n_args, const mp_obj_t *args) {
293
294
295
296
297
    // 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
298
    mp_buffer_info_t bufinfo;
299
    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
300

301
302
    // convert the bytes to an integer
    machine_uint_t value = 0;
stijn's avatar
stijn committed
303
    for (const byte* buf = (const byte*)bufinfo.buf + bufinfo.len - 1; buf >= (byte*)bufinfo.buf; buf--) {
304
        value = (value << 8) | *buf;
305
306
307
    }

    return mp_obj_new_int_from_uint(value);
308
309
}

310
311
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);
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

STATIC mp_obj_t int_to_bytes(uint n_args, const mp_obj_t *args) {
    machine_int_t val = mp_obj_int_get_checked(args[0]);

    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);
    memcpy(data, &val, len < sizeof(machine_int_t) ? len : sizeof(machine_int_t));
    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);

337
const mp_obj_type_t mp_type_int = {
338
    { &mp_type_type },
339
    .name = MP_QSTR_int,
340
341
342
343
    .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,
344
    .locals_dict = (mp_obj_t)&int_locals_dict,
345
};