How do I use C Macro Collections with my own custom struct types?

Define macros for your type (e.g., V, PFX, SNAME) and provide a function table with comparators, hashing, or other required operations. The README includes an example with integers, and you can extend it by implementing similar functions for your structs.

C Macro Collections vs GLib: which is better for C projects?

C Macro Collections is header-only and macro-based, offering type safety and no external dependencies, while GLib is a full-featured library with precompiled binaries but less type safety in C. Choose C Macro Collections for lightweight, type-safe integration; GLib for a broader ecosystem with GUI and networking support.

Is C Macro Collections thread-safe?

The core collections are not thread-safe by default, but the library includes a Thread-Safe Collections (TSC) sub-library for concurrent operations. You need to explicitly use TSC modules or add external synchronization for thread safety.

How to handle errors when operations like push_back fail?

Check the return value of functions (e.g., bool for success/failure) and use the collection's flag system to get error codes. The README example shows using cmc_flags_to_str to map error enums to descriptive strings for debugging.

Can I use C Macro Collections in embedded systems?

Yes, its header-only design and support for custom allocators make it suitable for embedded systems. However, the heap allocation requirement and macro overhead might need careful evaluation for memory-constrained environments.

What are the performance benchmarks for C Macro Collections?

The library includes a benchmarks folder for testing, but specific numbers aren't detailed in the README. It claims low runtime overhead due to macro-based code generation, but performance can vary based on data types and compiler optimizations.

How to iterate over a collection and safely delete elements?

Use the provided two-way iterators, but note that structural modifications invalidate iterators. For safe deletion, consider collecting indices or keys first, or use the LinkedList with node-based functions which allow modifications during iteration as per the design decisions.

C Macro Collections — Header-Only C Data Structures

What is C Macro Collections?

C Macro Collections is a header-only library that provides generic, type-safe implementations of common data structures for the C programming language. It uses macros to generate type-specific code at compile time, solving the problem of C's lack of built-in generics while maintaining performance and safety. The library includes a wide range of collections like lists, maps, sets, and queues, all designed for easy integration and modular use.

Target Audience

C developers needing robust, reusable data structures without external dependencies, particularly those working on embedded systems, performance-critical applications, or projects where avoiding complex build systems is essential.

Value Proposition

It offers a pure C solution with no runtime overhead, full type safety through macros, and a modular design that lets developers include only the collections they need. Unlike template-based approaches in other languages, it keeps compilation fast and integrates seamlessly into existing C codebases.

Easy to use, modular, header only, macro based, generic and type-safe Data Structures in C

Use Cases

Best For

Implementing generic data structures in C without language extensions
Embedded systems development where header-only libraries are preferred
Educational projects teaching data structures in C
Performance-critical applications needing type-safe collections
Projects requiring custom memory allocators for collections
Avoiding external dependencies in C projects

Not Ideal For

Projects requiring structural modifications to collections during iteration without invalidating iterators
Teams preferring C++ or other languages with built-in generics to avoid macro complexity and debugging challenges
Environments with strict coding standards that discourage extensive macro usage due to readability concerns
Applications needing ultra-minimal, stack-allocated data structures without heap overhead

Pros & Cons

Pros

Header-Only Integration

No installation or build system required; simply include headers with a compiler flag, making it easy to integrate into any C project without dependencies.

Type-Safe Generics

Uses C macros to generate type-specific implementations at compile time, ensuring type safety and reducing code duplication while maintaining performance.

Comprehensive Collection Suite

Offers a wide range of data structures including lists, maps, sets, and specialized types like interval heaps, covering most common use cases in C development.

Customizable Behavior

Supports custom allocators, function tables for data operations, and callbacks for CRUD actions, providing fine-grained control over memory and behavior.

Cons

Macro Complexity

Heavy reliance on macros can make code harder to read, debug, and maintain, especially for developers unfamiliar with macro metaprogramming in C.

Heap Allocation Requirement

All collections must be allocated on the heap, as noted in the design decisions, which may not suit performance-critical or embedded systems preferring stack allocation.

Incomplete Features

Several collections like SkipList and TreeBidiMap are marked as WIP in the README, indicating the library is still under development and lacks some advanced structures.

Iterator Invalidation

Modifying a collection invalidates all iterators (except for LinkedList using node-based functions), limiting flexibility during traversal and updates.

Frequently Asked Questions

What is C Macro Collections?

Target Audience

Value Proposition

Use Cases

Best For

Implementing generic data structures in C without language extensions
Embedded systems development where header-only libraries are preferred
Educational projects teaching data structures in C
Performance-critical applications needing type-safe collections
Projects requiring custom memory allocators for collections
Avoiding external dependencies in C projects

Not Ideal For

Projects requiring structural modifications to collections during iteration without invalidating iterators
Teams preferring C++ or other languages with built-in generics to avoid macro complexity and debugging challenges
Environments with strict coding standards that discourage extensive macro usage due to readability concerns
Applications needing ultra-minimal, stack-allocated data structures without heap overhead

Pros & Cons

Pros

Header-Only Integration

No installation or build system required; simply include headers with a compiler flag, making it easy to integrate into any C project without dependencies.

Type-Safe Generics

Uses C macros to generate type-specific implementations at compile time, ensuring type safety and reducing code duplication while maintaining performance.

Comprehensive Collection Suite

Offers a wide range of data structures including lists, maps, sets, and specialized types like interval heaps, covering most common use cases in C development.

Customizable Behavior

Supports custom allocators, function tables for data operations, and callbacks for CRUD actions, providing fine-grained control over memory and behavior.

Cons

Macro Complexity

Heavy reliance on macros can make code harder to read, debug, and maintain, especially for developers unfamiliar with macro metaprogramming in C.

Heap Allocation Requirement

All collections must be allocated on the heap, as noted in the design decisions, which may not suit performance-critical or embedded systems preferring stack allocation.

Incomplete Features

Several collections like SkipList and TreeBidiMap are marked as WIP in the README, indicating the library is still under development and lacks some advanced structures.

Iterator Invalidation

Modifying a collection invalidates all iterators (except for LinkedList using node-based functions), limiting flexibility during traversal and updates.

Frequently Asked Questions

C Macro Collections

What is C Macro Collections?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

C Macro Collections

What is C Macro Collections?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?