Skip to content
alkavanPublic

About

A library of core utilities for building software in C.

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

Bedrock

A library of core utilities for building software in C.

Features

  • Argument parsing (args.h/args.c, parse.h/parse.c)
  • Dynamic vector (dynvec.h)
  • Dynamic map (dynmap.h)
  • Virtual memory regions (vmem.h/vmem.c)
  • Arena memory allocator (arena.h/arena.c)
  • Polymorphic allocator (pmr.h/pmr.c)
  • Pinned colony container (pinned_colony.h/pinned_colony.c)

Names

Public functions are prefixed with their module, as in args_init and pinned_colony_create. Add a bd_ prefix only when the plain name is likely to collide with another library, as with bd_parse_i64.

Struct and enum names stay descriptive, as in ProgramCmd and ArgAction. Macros and other defines always start with BD_, as in BD_ARG_OPTION and BD_ARGS_OK.

Building

cmake -S . -B build -DCMAKE_BUILD_TYPE=Release \
  -DBEDROCK_BUILD_TESTS=ON
cmake --build build -j

-DBEDROCK_THREAD_SAFE=ON locks both dynvec and dynmap with pthreads and propagates that choice to targets that link Bedrock. DYNVEC_THREAD_SAFE and DYNMAP_THREAD_SAFE still enable one container on their own.

CMake Integration

Source using FetchContent

if(NOT TARGET bedrock::bedrock)
    include(FetchContent)
    FetchContent_Declare(bedrock
        GIT_REPOSITORY https://github.com/alkavan/bedrock.git
        GIT_TAG v1.0.0
    )
    FetchContent_MakeAvailable(bedrock)
endif()

target_link_libraries(my_app PRIVATE bedrock::bedrock)

Installed Package

find_package(bedrock 1.0 CONFIG REQUIRED)
target_link_libraries(my_app PRIVATE bedrock::bedrock)

System integration / Out-of-source build and installation

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug \
  -DBEDROCK_BUILD_TESTS=ON \
  -DCMAKE_INSTALL_PREFIX="$HOME/.local"
cmake --build build -j
cmake --install build

About

A library of core utilities for building software in C.

Resources

Contributing

Stars

1 star

Watchers

1 watching

Forks

Releases

Contributors

Languages