Proposal

Currently, we use sizeof(char*) and sizeof(char) interchangeably, we should make a diiference as they are not the same thing, and we should allocate as little memory as possible.

Also running the automated tests by compiling with the gcc flag -fsanitize=address, it yields a bunch of errors.

Could be a good practice to run valgrind to check for memory leaks.

YouTube - Jacob Sorber- find memory errors quickly. (-fsanitize, addresssanitizer)

Currently, we already have the dictionary data structure, however it has a $O(n)$ lookup complexity.
We could improve this with a hash_map data structure (and probably removing the current dictionary data structure).

With a HashMap, we could have a $O(1)$ lookup complexity.

Can be useful to see how Rust implemented this Data Structure (hashing function called SipHash): https://doc.rust-lang.org/book/ch08-03-hash-maps.html#hashing-functions.

Similar to the ArrayList class in Java (ref: https://docs.oracle.com/en/java/javase/18/docs/api/java.base/java/util/ArrayList.html), we could have a array_list structure to easily manage array with unknown size at compile time.

So we can avoid managing this ourselves with malloc.

Type of Improvement

Performance

Proposal

Currently, each time we execute make, we compile all the files again, even if it didn't changed.

Documentation

Documentation is Missing

Proposal

We should be able to generate a documentation to see all available functions and data structures, so the library is easier to use.

Maybe, we can generate it with: https://www.doxygen.nl/.