https://github.com/brainstone/staticmap

A compile time static map for C++20 or above
https://github.com/brainstone/staticmap

constexpr constexpr-all-the-things cpp-library cpp20 cpp23 header-only library map modern-cpp storage string

Last synced: 7 days ago
JSON representation

A compile time static map for C++20 or above

• Host: GitHub
• URL: https://github.com/brainstone/staticmap
• Owner: BrainStone
• License: mit
• Created: 2023-10-29T02:33:27.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-11-08T23:46:59.000Z (about 1 year ago)
• Last Synced: 2024-01-27T19:07:56.904Z (10 months ago)
• Topics: constexpr, constexpr-all-the-things, cpp-library, cpp20, cpp23, header-only, library, map, modern-cpp, storage, string
• Language: C++
• Homepage:
• Size: 25.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# StaticMap

A compile time static map for C++20 or above.

This nifty little library offers the class `static_map` and the convenient alias `static_string_map`, which is a class

that can store a key value mapping at compile time, including retrieving the values at compile time. The strings in

question for `static_string_map` are `std::string_view` strings for maximum efficiency.

## Usage Example

```cpp

#include "static_string_map.hpp"

constexpr static_map messages = make_static_string_map({{"hi", "hi"}, {"foo", "bar"}});

constexpr std::string_view constexpr_message = messages["foo"]; // Initialized to "bar"

constexpr std::string_view constexpr_message = messages["xxx"]; // Compile error

int main() {

    std::string dynamic_message;

    std::cin >> dynamic_message

    

    std::cout << messages[dynamic_message] << std::endl; // Will either print the corresponding message or throw an exception

}

```

## Using this lib

This is a CMake library, and you can use it as you would any other CMake library. See Instructions further down on how

to use it without CMake too.

### CMake

You can use the `FetchContent` module to let CMake download the lib for you:

```cmake

# Download stomfoolery

include(FetchContent)

FetchContent_Declare(

        static_map

        GIT_REPOSITORY https://github.com/BrainStone/StaticMap.git

        GIT_TAG v2.0.0

)

FetchContent_MakeAvailable(static_map)

# Use static_map

project(${PROJECT_NAME} CXX)

target_link_libraries(${PROJECT_NAME} PRIVATE static_map)

```

### Without CMake

Essentially you have two options:

- Add `$static_map_base_path/src` to your include paths.

- Copy `src/static{,_string}_map.hpp` into an already in use include path.

## Building

First of all there's no actual library to build. The only thing that can be build and executed are the test.  

Now this is a CMake project, so just follow standard build procedure:

```bash

# Build

cmake -B build

cmake --build build

# Run tests

cd build

ctest

```