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
|
# STC [cstack](../stc/cstack.h): Stack
The **cstack** is a container adapter that gives the programmer the functionality of a stack - specifically, a LIFO (last-in, first-out) data structure. The class template acts as a wrapper to the underlying container - only a specific set of functions is provided. The stack pushes and pops the element from the back of the underlying container, known as the top of the stack.
See the c++ class [std::stack](https://en.cppreference.com/w/cpp/container/stack) for a functional description.
## Declaration
```c
using_cstack(X, ctype)
```
The macro `using_cstack()` must be instantiated in the global scope. **cstack** uses normally
a **cvec_X** or **cdeq_X** type as underlying implementation, given as `ctype`. `X` is a type tag name and will
affect the names of all cstack types and methods. E.g. declaring `using_cstack(i, cvec_i);`,
`X` should be replaced by `i` in all of the following documentation.
## Header file
All cstack definitions and prototypes are available by including a single header file.
```c
#include "stc/cstack.h" /* includes default underlying implementation header cvec.h */
```
## Methods
```c
cstack_X cstack_X_init(void);
cstack_X cstack_X_clone(cstack_X st);
void cstack_X_del(cstack_X* self); // destructor
size_t cstack_X_size(cstack_X st);
bool cstack_X_empty(cstack_X st);
cstack_X_value_t* cstack_X_top(cstack_X* self);
void cstack_X_push(cstack_X* self, cstack_X_value_t value);
void cstack_X_emplace(cstack_X* self, cstack_X_rawvalue_t raw);
void cstack_X_emplace_n(cstack_X *self, const cstack_X_rawvalue_t arr[], size_t size);
void cstack_X_pop(cstack_X* self);
cstack_X_iter_t cstack_X_begin(cstack_X* self);
cstack_X_iter_t cstack_X_end(cstack_X* self);
void cstack_X_next(cstack_X_iter_t* it);
cstack_X_value_t* cstack_X_itval(cstack_X_iter_t it);
cstack_X_value_t cstack_X_value_clone(cstack_X_value_t val);
```
## Types
| Type name | Type definition | Used to represent... |
|:----------------------|:---------------------------------------|:----------------------------|
| `cstack_X` | Depends on underlying container type | The cstack type |
| `cstack_X_value_t` | " | The cstack element type |
| `cstack_X_rawvalue_t` | " | cstack raw value type |
| `cstack_X_iter_t` | " | cstack iterator |
## Example
```c
#include <stdio.h>
#include "stc/cstack.h"
using_cvec(i, int);
using_cstack(i, cvec_i);
int main() {
cstack_i stack = cstack_i_init();
for (int i=0; i < 100; ++i)
cstack_i_push(&stack, i*i);
for (int i=0; i < 90; ++i)
cstack_i_pop(&stack);
printf("top: %d\n", *cstack_i_top(&stack));
}
```
Output:
```
top: 81
```
|
