Boomers of Memory

A reference-counted memory management system for C with automatic cleanup through conservative object scanning and configurable cascade limits.

Documentation

This project uses Doxygen to generate API documentation.

Generating docs

doxygen Doxyfile

This will generate the documentation in the docs/html folder. You can open the index.html file in a web browser to view the documentation.

Build & Run

Commands

Using Makefile

# Clone with submodules (om vi lägger till några)
git clone --recursive https://github.com/IOOPM-UU/bom.git
cd bom

# Build library
make all

Running tests

Using Makefile

# Build and run tests
make test

# Build and run tests with Valgrind
make memtest

Running demo (Valgrind*)

Using Makefile

# Build library
make all

# Build and run demo
make demo

# Build and run demo with test input
make demo-tests

# Build and run backend tests
make demo-backend-tests

# Build and run data structure tests
make demo-data-tests

# Build and run original
make demo-original

# Build and run original with test input
make demo-original-tests

Generate coverage reports

Using Makefile

# Generate reports
make generate_coverage

After being created, coverage reports can be found in docs/coverage.