https://github.com/m0t9/c-generics
Idea of generic containers (templates) implementation on pure C ⚙️
https://github.com/m0t9/c-generics
c generics generics-c macros preprocessing stl-c templates-c
Last synced: 3 months ago
JSON representation
Idea of generic containers (templates) implementation on pure C ⚙️
- Host: GitHub
- URL: https://github.com/m0t9/c-generics
- Owner: m0t9
- License: mit
- Created: 2022-12-30T16:24:01.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-10T11:35:29.000Z (over 1 year ago)
- Last Synced: 2025-01-13T22:39:10.010Z (5 months ago)
- Topics: c, generics, generics-c, macros, preprocessing, stl-c, templates-c
- Language: C
- Homepage:
- Size: 23.4 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# c-generics
## ❓ What is this repository about
C language does not support generics and templates. This repository introduces one of the possible (and convenient) ways to implement generic containers using C preprocessing macros.
## 🧰 How to implement custom generic data structure
1. Header file with any generic container implementation **must** include `instantiation.h` file, which allows programmer to use simpler and standardized typed container initialization.
2. Container ***instantiation*** should be implemented in implicit and explicit ways. Implicit instantiation is a `#define` directive that accepts arguments such as structure name, type (data type that structure will contain), arguments (optional instantiation parametres). This instantiation will explicitly create a ***template*** of data structure of the given type. This define name **must** have the form `_do_instantiate_`.
3. Explicit instantiation is a convenient way for programmer to create a template of data structure. This `#define` may have the form `instantiate_(type)` and substitute `INSTANTIATION_INSTANTIATE_CONTAINER(, , )`.
4. To create an ***instance*** of previously described container header file **must** implement directive `#define ()` that declares a type named `INSTANTIATION_GET_CONTAINER_NAME(, )`.
5. Container methods can be implemented in different ways (either `#define` or regular functions). It may depend on container type or your ideology :)
You can check implementation details in our examples of [stack implementation](https://github.com/m0t9/c-generics/blob/master/stack.h) and [vector implementation](https://github.com/m0t9/c-generics/blob/master/vector.h).
## 🚩 Usage
### Example for [stack](https://github.com/m0t9/c-generics/blob/master/stack.h)
#### Code
```c
#include
#include "stack.h"
typedef struct box {
int weight;
char *content;
} box;
instantiate_stack(box);
int main() {
stack(box) storage = init_stack();
box toolbox = {.weight = 5, .content = "tools"};
box clothes = {.weight = 3, .content = "t-shirts, pants"};
box paper = {.weight = 1, .content = "sheets of paper"};
stack_push(&storage, toolbox);
stack_push(&storage, clothes);
stack_push(&storage, paper);
printf("%lld boxes in storage\n", stack_size(&storage));
while (!stack_empty(&storage)) {
printf("Box with %s and weight %d kg.\n", stack_top(&storage).content, stack_top(&storage).weight);
stack_pop(&storage);
}
}
```
#### Output
```
3 boxes in storage
Box with sheets of paper and weight 1 kg.
Box with t-shirts, pants and weight 3 kg.
Box with tools and weight 5 kg.
```
### Example for [vector](https://github.com/m0t9/c-generics/blob/master/vector.h)
#### Code
```c
#include
#include "vector.h"
instantiate_vector((char)(*));
int main() {
vector((char)(*)) shopping_list = init_vector();
vector_push(&shopping_list, "Potatoes");
vector_push(&shopping_list, "Carrots");
vector_push(&shopping_list, "Meat");
vector_pop(&shopping_list);
vector_push(&shopping_list, "Milk");
printf("%d products in list\n", vector_size(&shopping_list));
for (int i = 0; i < vector_size(&shopping_list); i++) {
printf("%d. %s\n", i + 1, shopping_list[i]);
}
vector_destroy(&shopping_list);
return 0;
}
```
#### Output
```
3 products in list
1. Potatoes
2. Carrots
3. Milk
```
## 🌟 I express my gratitude to [purplesyringa](https://github.com/purplesyringa) for her great contribution!