Amaan's Simple and Functional Library - ASF Lib

This is my personal collection of libraries, I create them on my own for practice purposes and small hobby projects, Ideally, one should use pre-existing libraries in this domain to avoid security and memory bugs.

This repository is mostly C, with some hints of C++ or ASM perhaps.

The files in this repository are licensed to you under the MIT License. Read more here

Guidelines

Just clone the repository and include whatever header you need. By default the implementation of the file in question is not compiled along with the main file so that you can generate separate object files for it. You should generate all the object files and rely on the linker to remove any additional dead code because the files in this library may be inter dependent.

To generate the implementation alongside your main.c code

#define ASF_IMPL

Note, any other files from this repository that are included will also be implemented if you do this.

Ideally, include the following rule into your Makefile to compile the files from this library separately into object files

SRC_C := $(wildcard src/*.c)
SRC_O := $(SRC_C:.c=.o)

asflib/src/%.o: asflib/src/%.c
	$(CC) $(CFLAGS) -c -o $@ $<

main.o: main.c
	$(CC) $(CFLAGS) -c -o $@ $<

main: main.o $(SRC_O)
	$(CC) $(CFLAGS) -o $@ $^

where asflib is the folder where this repository is cloned.

Please also read the top block of each file, it contains important information regarding custom compile options and other notes.

Also read the header definitions and doc comments provided alongside function implementation to understand the cases which may or may not return an Error.