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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
|
# STC [ccommon](../stc/ccommon.h): Common definitions and handy macros
The following handy macros are safe to use, i.e. have no side-effects.
### c_init, c_emplace_items
**c_init** declares and initializes any container with an array of elements. **c_emplace_items** adds elements to any existing container:
```c
c_init (cvec_i, vec, {1, 2, 3});
c_emplace_items(&vec, cvec_i, {4, 5, 6});
```
### c_forrange
Declare an iterator and specify a range to iterate with a for loop. Like python's ***for i in range()*** loop:
| Usage | Python equivalent |
|:----------------------------------------------|:-------------------------------------|
| `c_forrange (stop)` | `for _ in range(stop):` |
| `c_forrange (i, stop) // IterType=size_t` | `for i in range(stop):` |
| `c_forrange (i, IterType, stop)` | `for i in range(stop):` |
| `c_forrange (i, IterType, start, stop)` | `for i in range(start, stop):` |
| `c_forrange (i, IterType, start, stop, step)` | `for i in range(start, stop, step):` |
```c
c_forrange (5) printf("x");
// xxxxx
c_forrange (i, 5) printf(" %zu", i);
// 0 1 2 3 4
c_forrange (i, int, -3, 3) printf(" %d", i);
// -3 -2 -1 0 1 2
c_forrange (i, int, 30, 0, -5) printf(" %d", i);
// 30 25 20 15 10 5
```
### c_foreach
| Usage | Description |
|:----------------------------------------------|:--------------------------------|
| `c_foreach (it, ctype, container)` | `Iteratate all elements ` |
| `c_foreach (it, ctype, it1, it2)` | `Iterate the range [it1, it2)` |
```c
using_csset(x, int);
...
c_init (csset_x, set, {23, 3, 7, 5, 12});
c_foreach (i, csset_x, set) printf(" %d", *i.ref);
// 3 5 7 12 23
csset_x_iter_t it = csset_x_find(&set, 7);
c_foreach (i, csset_x, it, csset_x_end(&set)) printf(" %d", *i.ref);
// 7 12 23
```
### c_withfile, c_breakwith
Simplifies reading a file. Use only **c_breakwith** to break out of the block if needed. Example:
```c
// Load each line of a text file into a vector of strings
#include <errno.h>
#include <stc/cstr.h>
#include <stc/cvec.h>
using_cvec_str();
cvec_str readFile(const char* name) {
cvec_str vec = cvec_str_init();
// Next line declares, opens, and closes the FILE*
c_withfile (fp, fopen(name, "r")) {
cstr_t line = cstr_init();
while (cstr_getline(&line, fp))
cvec_str_emplace_back(&vec, line.str);
cstr_del(&line);
}
return vec; // receiver should check errno variable
}
```
### c_new, c_del
| Usage | Meaning |
|:-------------------------------|:----------------------------------------|
| `c_new (type)` | `(type *) c_malloc(sizeof(type))` |
| `c_new (type, N)` | `(type *) c_malloc((N) * sizeof(type))` |
| `c_del (ctype, c1, ..., cN)` | `ctype_del(c1); ... ctype_del(cN)` |
```c
int* array = c_new (int, 100);
c_free(array);
cstr a = cstr_from("Hello"), b = cstr_from("World");
c_del(cstr, &a, &b);
```
### c_malloc, c_calloc, c_realloc, c_free
Memory allocator for the entire library. Macros can be overloaded by the user.
### c_swap, c_arraylen
- **c_swap(type, x, y)**: Simple macro for swapping internals of two objects.
- **c_arraylen(array)**: Return number of elements in an array, e.g. `int array[] = {1, 2, 3, 4};`
|
