misc.h 4.75 KB
Newer Older
Damien's avatar
Damien committed
1
2
3
4
5
6
7
// a mini library of useful types and functions

#ifndef _INCLUDED_MINILIB_H
#define _INCLUDED_MINILIB_H

/** types *******************************************************/

8
#include <stdbool.h>
Damien's avatar
Damien committed
9
10
11
12

typedef unsigned char byte;
typedef unsigned int uint;

13
14
/** generic ops *************************************************/

15
#ifndef MIN
16
#define MIN(x, y) ((x) < (y) ? (x) : (y))
17
18
#endif
#ifndef MAX
19
#define MAX(x, y) ((x) > (y) ? (x) : (y))
20
#endif
21

Damien's avatar
Damien committed
22
23
/** memomry allocation ******************************************/

24
25
// TODO make a lazy m_renew that can increase by a smaller amount than requested (but by at least 1 more element)

Damien's avatar
Damien committed
26
27
#define m_new(type, num) ((type*)(m_malloc(sizeof(type) * (num))))
#define m_new0(type, num) ((type*)(m_malloc0(sizeof(type) * (num))))
28
29
#define m_new_obj(type) (m_new(type, 1))
#define m_new_obj_var(obj_type, var_type, var_num) ((obj_type*)m_malloc(sizeof(obj_type) + sizeof(var_type) * (var_num)))
30
#define m_new_obj_var_maybe(obj_type, var_type, var_num) ((obj_type*)m_malloc_maybe(sizeof(obj_type) + sizeof(var_type) * (var_num)))
31
32
33
34
35
#if MICROPY_ENABLE_FINALISER
#define m_new_obj_with_finaliser(type) ((type*)(m_malloc_with_finaliser(sizeof(type))))
#else
#define m_new_obj_with_finaliser(type) m_new_obj(type)
#endif
36
#define m_renew(type, ptr, old_num, new_num) ((type*)(m_realloc((ptr), sizeof(type) * (old_num), sizeof(type) * (new_num))))
37
#define m_renew_maybe(type, ptr, old_num, new_num) ((type*)(m_realloc_maybe((ptr), sizeof(type) * (old_num), sizeof(type) * (new_num))))
38
39
#define m_del(type, ptr, num) m_free(ptr, sizeof(type) * (num))
#define m_del_obj(type, ptr) (m_del(type, ptr, 1))
John R. Lenton's avatar
John R. Lenton committed
40
#define m_del_var(obj_type, var_type, var_num, ptr) (m_free(ptr, sizeof(obj_type) + sizeof(var_type) * (var_num)))
Damien's avatar
Damien committed
41
42

void *m_malloc(int num_bytes);
43
void *m_malloc_maybe(int num_bytes);
44
void *m_malloc_with_finaliser(int num_bytes);
Damien's avatar
Damien committed
45
void *m_malloc0(int num_bytes);
46
void *m_realloc(void *ptr, int old_num_bytes, int new_num_bytes);
47
void *m_realloc_maybe(void *ptr, int old_num_bytes, int new_num_bytes);
48
void m_free(void *ptr, int num_bytes);
49
void *m_malloc_fail(int num_bytes);
Damien's avatar
Damien committed
50

51
int m_get_total_bytes_allocated(void);
52
int m_get_current_bytes_allocated(void);
53
int m_get_peak_bytes_allocated(void);
Damien's avatar
Damien committed
54
55
56
57
58

/** unichar / UTF-8 *********************************************/

typedef int unichar; // TODO

59
60
unichar utf8_get_char(const char *s);
char *utf8_next_char(const char *s);
Damien's avatar
Damien committed
61

62
63
64
65
bool unichar_isspace(unichar c);
bool unichar_isalpha(unichar c);
bool unichar_isprint(unichar c);
bool unichar_isdigit(unichar c);
66
bool unichar_isxdigit(unichar c);
Damien's avatar
Damien committed
67
68
69

/** variable string *********************************************/

Damien's avatar
Damien committed
70
typedef struct _vstr_t {
71
72
    uint alloc;
    uint len;
Damien's avatar
Damien committed
73
    char *buf;
74
75
    bool had_error : 1;
    bool fixed_buf : 1;
Damien's avatar
Damien committed
76
77
} vstr_t;

78
79
80
// convenience macro to declare a vstr with a fixed size buffer on the stack
#define VSTR_FIXED(vstr, alloc) vstr_t vstr; char vstr##_buf[(alloc)]; vstr_init_fixed_buf(&vstr, (alloc), vstr##_buf);

81
void vstr_init(vstr_t *vstr, int alloc);
82
void vstr_init_fixed_buf(vstr_t *vstr, int alloc, char *buf);
Damien's avatar
Damien committed
83
void vstr_clear(vstr_t *vstr);
84
vstr_t *vstr_new(void);
85
vstr_t *vstr_new_size(int alloc);
Damien's avatar
Damien committed
86
87
void vstr_free(vstr_t *vstr);
void vstr_reset(vstr_t *vstr);
88
bool vstr_had_error(vstr_t *vstr);
Damien's avatar
Damien committed
89
90
91
char *vstr_str(vstr_t *vstr);
int vstr_len(vstr_t *vstr);
void vstr_hint_size(vstr_t *vstr, int size);
92
char *vstr_extend(vstr_t *vstr, int size);
93
94
bool vstr_set_size(vstr_t *vstr, int size);
bool vstr_shrink(vstr_t *vstr);
Damien's avatar
Damien committed
95
char *vstr_add_len(vstr_t *vstr, int len);
Damien's avatar
Damien committed
96
97
void vstr_add_byte(vstr_t *vstr, byte v);
void vstr_add_char(vstr_t *vstr, unichar chr);
Damien's avatar
Damien committed
98
99
void vstr_add_str(vstr_t *vstr, const char *str);
void vstr_add_strn(vstr_t *vstr, const char *str, int len);
Damien's avatar
Damien committed
100
101
//void vstr_add_le16(vstr_t *vstr, unsigned short v);
//void vstr_add_le32(vstr_t *vstr, unsigned int v);
102
103
104
105
106
void vstr_ins_byte(vstr_t *vstr, uint byte_pos, byte b);
void vstr_ins_char(vstr_t *vstr, uint char_pos, unichar chr);
void vstr_cut_head_bytes(vstr_t *vstr, uint bytes_to_cut);
void vstr_cut_tail_bytes(vstr_t *vstr, uint bytes_to_cut);
void vstr_cut_out_bytes(vstr_t *vstr, uint byte_pos, uint bytes_to_cut);
107
void vstr_printf(vstr_t *vstr, const char *fmt, ...);
108

109
110
111
/** non-dynamic size-bounded variable buffer/string *************/

#define CHECKBUF(buf, max_size) char buf[max_size + 1]; uint buf##_len = max_size; char *buf##_p = buf;
112
#define CHECKBUF_RESET(buf, max_size) buf##_len = max_size; buf##_p = buf;
113
114
115
116
117
118
119
120
#define CHECKBUF_APPEND(buf, src, src_len) \
        { int l = MIN(src_len, buf##_len); \
        memcpy(buf##_p, src, l); \
        buf##_len -= l; \
        buf##_p += l; }
#define CHECKBUF_APPEND_0(buf) { *buf##_p = 0; }
#define CHECKBUF_LEN(buf) (buf##_p - buf)

121
#ifdef va_start
122
void vstr_vprintf(vstr_t *vstr, const char *fmt, va_list ap);
123
#endif
Damien's avatar
Damien committed
124

125
126
127
// Debugging helpers
int DEBUG_printf(const char *fmt, ...);

Damien's avatar
Damien committed
128
#endif // _INCLUDED_MINILIB_H