https://github.com/nasso/libmy
C library for my Epitech projects - you probably don't need this
https://github.com/nasso/libmy
c epitech
Last synced: 8 months ago
JSON representation
C library for my Epitech projects - you probably don't need this
- Host: GitHub
- URL: https://github.com/nasso/libmy
- Owner: nasso
- License: mit
- Created: 2019-10-08T13:38:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-02-04T18:25:04.000Z (over 4 years ago)
- Last Synced: 2025-01-13T01:11:54.931Z (9 months ago)
- Topics: c, epitech
- Language: C
- Homepage:
- Size: 369 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# libmy
Personal library for my [EPITECH](https://www.epitech.eu) projects.
## Demo
```c
#include "my/my.h"
#include "my/collections/hash_map.h"
// Demonstrate the use of the OPT(T) type
static OPT(f64) safe_div(f64_t a, f64_t b)
{
if (b == 0)
return (NONE(f64));
return (SOME(f64, a / b));
}
// Put arguments in a hash map
int main(int ac, char **av) {
hash_map_t *args = hash_map_new();
char *foo = NULL;
for (usize_t i = 1; i + 1 < ac; i += 2)
hash_map_insert(args, av[i], av[i + 1]);
foo = hash_map_get(args, "foo");
if (foo)
my_printf("foo: %s\n", foo);
hash_map_destroy(args);
return (0);
}
```
## Features
### Obvious primitive data type definitions:
- `[iu](8|16|32|64|size)_t`: integer data types (`u8_t`, `i32_t`, ...)
- `f(32|64)_t`: floating point data types (e.g. an `f32_t` is just a `float`)
- `_(min|max)`: `min` and `max` functions for any primitive
### Additionnal useful generic data types:
- `OPT(T)`: similar to Rust's `Option` or Haskell's `Maybe T`
- `RES(T, E)`: similar to Rust's `Result`
- `OPT()`: `OPT(T)` for all primitives!!
- `RC(T)`: (R)eference (C)ounting primitive; similar to C++'s `std::shared_ptr`
### Wrappers for standard functions to avoid `"banned function used"` errors:
- `my_malloc`, `my_free` and `my_calloc`
- `my_memcpy`, `my_memmove` and `my_memset`
- `my_open` and `my_close`
- `my_read` and `my_write`
### General purpose collections:
- `vector_t`: a continuous growable array (copies the elements' data)
- `list_t`: circular doubly linked list (stores pointers to elements)
- `hash_map_t`: an hash table implementation (stores pointers to elements)
### Formatting utilities:
- `my_printf`: yeah (no support for floating point data types yet tho)
- `my_format`: format a string to a newly allocated `char *`
### Buffered IO helpers:
- `bufreader_t`: abstract buffered input stream
- `bufwriter_t`: abstract buffered output stream
- `filereader_t`: implementation of `bufreader_t` around a file descriptor
- `filewriter_t`: implementation of `bufwriter_t` around a file descriptor