Base

Overview

What every module needs, included before anything else.

Every header includes base.h first, so a program that includes any module gets all of this:

• _POSIX_C_SOURCE set to 200809L, unless the program set it first. It only takes effect before the first system header, so include MULE before any of them.
• <stdbool.h>, <stddef.h> and <stdint.h>.
• ckd_add, ckd_sub and ckd_mul for overflow-checked arithmetic. They come from C23's <stdckdint.h> when the compiler has it, and from the gcc and clang builtins otherwise.
• The MULE_NODISCARD, MULE_UNUSED, MULE_NORETURN and MULE_PRINTF attribute macros. They are left out of the signatures in this reference.

Layout rules

These are for changing the library, not using it.

• One folder per module under src/, holding name.h and name.c. A module of only macros and static functions is name.h alone.
• Every header includes base/base.h first, and include paths are relative to src/ (#include "str/str.h").
• A .c file includes headers only, never another .c. Each program's unity file includes every .c it needs. Any order works, because each .c includes the headers it uses, so clang-format may sort them.
• The whole program is one translation unit, so static does not keep names apart. Static helpers carry the module prefix and a trailing _.
• Something belongs here only once two modules use it.

Targets are Unix with clang 17+ or gcc 13+. The floor is C11, written as C99. Attributes go through the MULE_ macros below, so a compiler without GNU attributes still builds the library.

Version
The library's version, which follows Semantic Versioning. See CHANGELOG.md for what changed in each one.
#define	MULE_VERSION_MAJOR   0
	Bumped for breaking changes, once the version reaches 1.0.0.
#define	MULE_VERSION_MINOR   0
	Bumped for new features.
#define	MULE_VERSION_PATCH   1
	Bumped for fixes that change no behaviour a program relies on.
#define	MULE_VERSION   "0.0.1"
	All three numbers as a string, such as "0.0.1".

Macro Definition Documentation

MULE_VERSION_MAJOR

#define MULE_VERSION_MAJOR   0

Bumped for breaking changes, once the version reaches 1.0.0.

Definition at line 77 of file base.h.

MULE_VERSION_MINOR

#define MULE_VERSION_MINOR   0

Bumped for new features.

Before 1.0.0, also for breaking changes.

Definition at line 79 of file base.h.

MULE_VERSION_PATCH

#define MULE_VERSION_PATCH   1

Bumped for fixes that change no behaviour a program relies on.

Definition at line 81 of file base.h.

MULE_VERSION

#define MULE_VERSION   "0.0.1"

All three numbers as a string, such as "0.0.1".

Definition at line 83 of file base.h.