blob: 662513eb1acca9bc251db73eecb97fb28e8871ac [file] [log] [blame]
Damien429d7192013-10-04 19:53:11 +01001// a mini library of useful types and functions
2
3#ifndef _INCLUDED_MINILIB_H
4#define _INCLUDED_MINILIB_H
5
6/** types *******************************************************/
7
ian-v5fd8fd22014-01-06 13:51:53 -08008#include <stdbool.h>
Damien429d7192013-10-04 19:53:11 +01009
10typedef unsigned char byte;
11typedef unsigned int uint;
12
Paul Sokolovsky6e6b8882014-02-05 00:44:55 +020013/** generic ops *************************************************/
14
Damien Georgee09ffa12014-02-05 23:57:48 +000015#ifndef MIN
Paul Sokolovsky6e6b8882014-02-05 00:44:55 +020016#define MIN(x, y) ((x) < (y) ? (x) : (y))
Damien Georgee09ffa12014-02-05 23:57:48 +000017#endif
18#ifndef MAX
Paul Sokolovsky6e6b8882014-02-05 00:44:55 +020019#define MAX(x, y) ((x) > (y) ? (x) : (y))
Damien Georgee09ffa12014-02-05 23:57:48 +000020#endif
Paul Sokolovsky6e6b8882014-02-05 00:44:55 +020021
Damien429d7192013-10-04 19:53:11 +010022/** memomry allocation ******************************************/
23
Damien732407f2013-12-29 19:33:23 +000024// TODO make a lazy m_renew that can increase by a smaller amount than requested (but by at least 1 more element)
25
Damien429d7192013-10-04 19:53:11 +010026#define m_new(type, num) ((type*)(m_malloc(sizeof(type) * (num))))
27#define m_new0(type, num) ((type*)(m_malloc0(sizeof(type) * (num))))
Damiend99b0522013-12-21 18:17:45 +000028#define m_new_obj(type) (m_new(type, 1))
29#define m_new_obj_var(obj_type, var_type, var_num) ((obj_type*)m_malloc(sizeof(obj_type) + sizeof(var_type) * (var_num)))
Damien732407f2013-12-29 19:33:23 +000030#define m_renew(type, ptr, old_num, new_num) ((type*)(m_realloc((ptr), sizeof(type) * (old_num), sizeof(type) * (new_num))))
31#define m_del(type, ptr, num) m_free(ptr, sizeof(type) * (num))
32#define m_del_obj(type, ptr) (m_del(type, ptr, 1))
John R. Lenton07205ec2014-01-13 02:31:00 +000033#define m_del_var(obj_type, var_type, var_num, ptr) (m_free(ptr, sizeof(obj_type) + sizeof(var_type) * (var_num)))
Damien429d7192013-10-04 19:53:11 +010034
Damien429d7192013-10-04 19:53:11 +010035void *m_malloc(int num_bytes);
36void *m_malloc0(int num_bytes);
Damien732407f2013-12-29 19:33:23 +000037void *m_realloc(void *ptr, int old_num_bytes, int new_num_bytes);
38void m_free(void *ptr, int num_bytes);
Damien George6902eed2014-04-04 10:52:59 +000039void *m_malloc_fail(int num_bytes);
Damien429d7192013-10-04 19:53:11 +010040
Damien8b3a7c22013-10-23 20:20:17 +010041int m_get_total_bytes_allocated(void);
Paul Sokolovsky02de0c52014-01-01 23:15:47 +020042int m_get_current_bytes_allocated(void);
Paul Sokolovsky780f5552014-01-01 23:42:21 +020043int m_get_peak_bytes_allocated(void);
Damien429d7192013-10-04 19:53:11 +010044
45/** unichar / UTF-8 *********************************************/
46
47typedef int unichar; // TODO
48
Damien George8cc96a32013-12-30 18:23:50 +000049unichar utf8_get_char(const char *s);
50char *utf8_next_char(const char *s);
Damien429d7192013-10-04 19:53:11 +010051
ian-v5fd8fd22014-01-06 13:51:53 -080052bool unichar_isspace(unichar c);
53bool unichar_isalpha(unichar c);
54bool unichar_isprint(unichar c);
55bool unichar_isdigit(unichar c);
Paul Sokolovsky0b7184d2014-01-22 22:40:02 +020056bool unichar_isxdigit(unichar c);
Damien429d7192013-10-04 19:53:11 +010057
Damien429d7192013-10-04 19:53:11 +010058/** variable string *********************************************/
59
Damien68f59a92013-10-20 14:39:58 +010060typedef struct _vstr_t {
Damien George280e7202014-03-15 14:33:09 +000061 uint alloc;
62 uint len;
Damien68f59a92013-10-20 14:39:58 +010063 char *buf;
Damien George51047752014-02-26 17:40:52 +000064 bool had_error : 1;
65 bool fixed_buf : 1;
Damien68f59a92013-10-20 14:39:58 +010066} vstr_t;
Damien429d7192013-10-04 19:53:11 +010067
Damien George354d15a2014-02-06 21:11:19 +000068// convenience macro to declare a vstr with a fixed size buffer on the stack
69#define VSTR_FIXED(vstr, alloc) vstr_t vstr; char vstr##_buf[(alloc)]; vstr_init_fixed_buf(&vstr, (alloc), vstr##_buf);
70
Paul Sokolovsky5d2499c2014-01-13 23:15:23 +020071void vstr_init(vstr_t *vstr, int alloc);
Damien George354d15a2014-02-06 21:11:19 +000072void vstr_init_fixed_buf(vstr_t *vstr, int alloc, char *buf);
Damien68f59a92013-10-20 14:39:58 +010073void vstr_clear(vstr_t *vstr);
Damien8b3a7c22013-10-23 20:20:17 +010074vstr_t *vstr_new(void);
Paul Sokolovsky5d2499c2014-01-13 23:15:23 +020075vstr_t *vstr_new_size(int alloc);
Damien429d7192013-10-04 19:53:11 +010076void vstr_free(vstr_t *vstr);
77void vstr_reset(vstr_t *vstr);
ian-v5fd8fd22014-01-06 13:51:53 -080078bool vstr_had_error(vstr_t *vstr);
Damien429d7192013-10-04 19:53:11 +010079char *vstr_str(vstr_t *vstr);
80int vstr_len(vstr_t *vstr);
81void vstr_hint_size(vstr_t *vstr, int size);
Damien George354d15a2014-02-06 21:11:19 +000082char *vstr_extend(vstr_t *vstr, int size);
Paul Sokolovsky5d2499c2014-01-13 23:15:23 +020083bool vstr_set_size(vstr_t *vstr, int size);
84bool vstr_shrink(vstr_t *vstr);
Damien429d7192013-10-04 19:53:11 +010085char *vstr_add_len(vstr_t *vstr, int len);
Damien68f59a92013-10-20 14:39:58 +010086void vstr_add_byte(vstr_t *vstr, byte v);
87void vstr_add_char(vstr_t *vstr, unichar chr);
Damien429d7192013-10-04 19:53:11 +010088void vstr_add_str(vstr_t *vstr, const char *str);
89void vstr_add_strn(vstr_t *vstr, const char *str, int len);
Damien68f59a92013-10-20 14:39:58 +010090//void vstr_add_le16(vstr_t *vstr, unsigned short v);
91//void vstr_add_le32(vstr_t *vstr, unsigned int v);
Damien George280e7202014-03-15 14:33:09 +000092void vstr_ins_byte(vstr_t *vstr, uint byte_pos, byte b);
93void vstr_ins_char(vstr_t *vstr, uint char_pos, unichar chr);
94void vstr_cut_head_bytes(vstr_t *vstr, uint bytes_to_cut);
95void vstr_cut_tail_bytes(vstr_t *vstr, uint bytes_to_cut);
96void vstr_cut_out_bytes(vstr_t *vstr, uint byte_pos, uint bytes_to_cut);
Damien2f06c572013-11-03 18:20:56 +000097void vstr_printf(vstr_t *vstr, const char *fmt, ...);
Damien96a0add2013-11-03 18:30:10 +000098
Paul Sokolovskye11b17c2014-02-05 00:47:06 +020099/** non-dynamic size-bounded variable buffer/string *************/
100
101#define CHECKBUF(buf, max_size) char buf[max_size + 1]; uint buf##_len = max_size; char *buf##_p = buf;
Damien Georgee09ffa12014-02-05 23:57:48 +0000102#define CHECKBUF_RESET(buf, max_size) buf##_len = max_size; buf##_p = buf;
Paul Sokolovskye11b17c2014-02-05 00:47:06 +0200103#define CHECKBUF_APPEND(buf, src, src_len) \
104 { int l = MIN(src_len, buf##_len); \
105 memcpy(buf##_p, src, l); \
106 buf##_len -= l; \
107 buf##_p += l; }
108#define CHECKBUF_APPEND_0(buf) { *buf##_p = 0; }
109#define CHECKBUF_LEN(buf) (buf##_p - buf)
110
Damien96a0add2013-11-03 18:30:10 +0000111#ifdef va_start
Damien2f06c572013-11-03 18:20:56 +0000112void vstr_vprintf(vstr_t *vstr, const char *fmt, va_list ap);
Damien96a0add2013-11-03 18:30:10 +0000113#endif
Damien429d7192013-10-04 19:53:11 +0100114
Paul Sokolovsky44739e22014-02-16 18:11:42 +0200115// Debugging helpers
116int DEBUG_printf(const char *fmt, ...);
117
Damien429d7192013-10-04 19:53:11 +0100118#endif // _INCLUDED_MINILIB_H