objint.c 10.3 KB
Newer Older
1
#include <stdlib.h>
Damien George's avatar
Damien George committed
2
3
#include <stdint.h>
#include <assert.h>
4
#include <string.h>
Damien George's avatar
Damien George committed
5

6
#include "mpconfig.h"
Damien George's avatar
Damien George committed
7
8
#include "nlr.h"
#include "misc.h"
9
#include "qstr.h"
Damien George's avatar
Damien George committed
10
#include "obj.h"
11
#include "parsenum.h"
12
#include "mpz.h"
13
#include "objint.h"
14
15
#include "runtime0.h"
#include "runtime.h"
16

17
18
19
20
#if MICROPY_ENABLE_FLOAT
#include <math.h>
#endif

21
22
// 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) {
23
24
    // TODO check n_kw == 0

Damien George's avatar
Damien George committed
25
26
27
28
29
    switch (n_args) {
        case 0:
            return MP_OBJ_NEW_SMALL_INT(0);

        case 1:
30
            if (MP_OBJ_IS_STR(args[0])) {
31
                // a string, parse it
32
                uint l;
33
                const char *s = mp_obj_str_get_data(args[0], &l);
34
                return mp_parse_num_integer(s, l, 0);
35
36
37
38
#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
39
40
41
            } else {
                return MP_OBJ_NEW_SMALL_INT(mp_obj_get_int(args[0]));
            }
Damien George's avatar
Damien George committed
42

xyb's avatar
xyb committed
43
        case 2:
44
        {
45
46
            // should be a string, parse it
            // TODO proper error checking of argument types
47
            uint l;
48
            const char *s = mp_obj_str_get_data(args[0], &l);
49
            return mp_parse_num_integer(s, l, mp_obj_get_int(args[1]));
50
        }
Damien George's avatar
Damien George committed
51
52

        default:
53
            nlr_raise(mp_obj_new_exception_msg_varg(&mp_type_TypeError, "int takes at most 2 arguments, %d given", n_args));
Damien George's avatar
Damien George committed
54
55
56
    }
}

57
void mp_obj_int_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
    // 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
74
typedef mp_longint_impl_t fmt_int_t;
75
#else
76
typedef mp_small_int_t fmt_int_t;
77
78
#endif

79
STATIC const uint log_base2_floor[] = {
80
81
82
83
84
85
86
87
88
89
90
    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
};

91
STATIC uint int_as_str_size_formatted(uint base, const char *prefix, char comma) {
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
    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.
char *mp_obj_int_formatted(char **buf, int *buf_size, int *fmt_size, mp_obj_t self_in,
                           int base, const char *prefix, char base_char, char comma) {
111
    fmt_int_t num;
112
113
114
115
116
117
    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.
118
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_LONGLONG
119
120
        mp_obj_int_t *self = self_in;
        // Get the value to format; mp_obj_get_int truncates to machine_int_t.
121
        num = self->val;
122
123
124
#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);
125
#endif
126
127
128
129
130
131
#endif
    } else {
        // Not an int.
        buf[0] = '\0';
        *fmt_size = 0;
        return *buf;
132
    }
133

134
135
136
137
138
139
140
141
142
143
    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;
144
    }
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
    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;
186
187
}

188
189
#if MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

190
191
192
193
bool mp_obj_int_is_positive(mp_obj_t self_in) {
    return mp_obj_get_int(self_in) >= 0;
}

194
// This is called for operations on SMALL_INT that are not handled by mp_unary_op
195
mp_obj_t mp_obj_int_unary_op(int op, mp_obj_t o_in) {
196
    return MP_OBJ_NOT_SUPPORTED;
197
198
}

199
// This is called for operations on SMALL_INT that are not handled by mp_binary_op
200
201
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);
202
203
204
205
}

// This is called only with strings whose value doesn't fit in SMALL_INT
mp_obj_t mp_obj_new_int_from_long_str(const char *s) {
206
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "long int not supported in this build"));
207
    return mp_const_none;
208
209
}

210
211
// 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) {
212
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
213
214
215
    return mp_const_none;
}

216
217
218
219
220
221
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);
    }
222
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
223
    return mp_const_none;
224
225
}

Damien George's avatar
Damien George committed
226
mp_obj_t mp_obj_new_int(machine_int_t value) {
227
228
229
    if (MP_OBJ_FITS_SMALL_INT(value)) {
        return MP_OBJ_NEW_SMALL_INT(value);
    }
230
    nlr_raise(mp_obj_new_exception_msg(&mp_type_OverflowError, "small int overflow"));
231
    return mp_const_none;
Damien George's avatar
Damien George committed
232
}
233
234
235
236
237
238
239
240
241

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

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

242
243
244
245
246
247
#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

248
249
#endif // MICROPY_LONGINT_IMPL == MICROPY_LONGINT_IMPL_NONE

250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
// 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);
        }
    }
265
    return MP_OBJ_NOT_SUPPORTED;
266
267
}

268
// this is a classmethod
269
STATIC mp_obj_t int_from_bytes(uint n_args, const mp_obj_t *args) {
270
271
272
273
274
    // 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
275
    mp_buffer_info_t bufinfo;
276
    mp_get_buffer_raise(args[1], &bufinfo, MP_BUFFER_READ);
277

278
279
    // convert the bytes to an integer
    machine_uint_t value = 0;
280
281
    for (const byte* buf = bufinfo.buf + bufinfo.len - 1; buf >= (byte*)bufinfo.buf; buf--) {
        value = (value << 8) | *buf;
282
283
284
    }

    return mp_obj_new_int_from_uint(value);
285
286
}

287
288
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);
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313

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);

314
const mp_obj_type_t mp_type_int = {
315
    { &mp_type_type },
316
    .name = MP_QSTR_int,
317
318
319
320
    .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,
321
    .locals_dict = (mp_obj_t)&int_locals_dict,
322
};