cstring header + test
[smdp.git] / include / cstring.h
1 #if !defined( CSTRING_H )
2 #define CSTRING_H
3
4 /*
5  * A implementation of expandable c strings in heap memory.
6  *
7  * struct: cstring_t which defines a expandable c string type in heap memory
8  *
9  * function: cstring_init to intialize struct of type cstring_t
10  * function: cstring_t->expand to add one character to the string
11  * function: cstring_t->delete to free the allocated memory
12  *
13  * Example:
14  *      cstring_t *p = cstring_init();
15  *      (p->expand)(p, 'X');
16  *      (p->delete)(p);
17  *
18  */
19
20 #include <string.h> // strlen
21 #include <stdlib.h> // malloc, realloc
22
23 // The amount of memory allocated from heap when string expansion hits the
24 // allocated memory limit
25 #define REALLOC_ADD 10
26
27 typedef struct _cstring_t {
28     char *text;
29     size_t size;
30     size_t alloc;
31     void (*expand)(struct _cstring_t *self, char x);
32     void (*expand_arr)(struct _cstring_t *self, char *x);
33     void (*delete)(struct _cstring_t *self);
34 } cstring_t;
35
36 void cstring_expand(cstring_t *self, char x);
37 void cstring_expand_arr(cstring_t *self, char *x);
38 void cstring_delete(cstring_t *self);
39
40 cstring_t *cstring_init() {
41     cstring_t *x = malloc(sizeof(cstring_t));
42     x->text = (void*)0;
43     x->size = x->alloc = 0;
44     x->expand = cstring_expand;
45     x->expand_arr = cstring_expand_arr;
46     x->delete = cstring_delete;
47     return x;
48 }
49
50 void cstring_expand(cstring_t *self, char x) {
51     if(self->size + sizeof(x) + sizeof(char) > self->alloc) {
52         self->alloc += (REALLOC_ADD * sizeof(char));
53         self->text = realloc(self->text, self->alloc);
54     }
55     self->text[self->size] = x;
56     self->text[self->size+1] = '\0';
57     self->size = strlen(self->text);
58 }
59
60 void cstring_expand_arr(cstring_t *self, char *x) {
61     if(self->size + strlen(x) + sizeof(char) > self->alloc) {
62         self->alloc += (REALLOC_ADD * sizeof(char));
63         self->text = realloc(self->text, self->alloc);
64     }
65     self->text = strcat(self->text, x);
66     self->size = strlen(self->text);
67 }
68
69
70 void cstring_delete(cstring_t *self) {
71     free(self->text);
72     free(self);
73 }
74
75 #endif // !defined( CSTRING_H )