Stdm

Contents

1. Summary
2. Features
3. Usage

Summary

Stdm is the entire c++20 standard library exposed as c++20 header, given that import std; is a c++23 feature and c++23 has yet to be implemented by the major compilers it became convenient to give c++20 projects the compilation time benefits of modules. Compiling c++20 modules by hand is tedious so it is recommended to use CMake 3.28+ to handle the compiliation.

Basic Example ->

#CMakeLists.txt
cmake_minimum_required(VERSION 3.28)

add_subdirectory(path/to/Stdm)

add_executable(Main)
target_sources(Main PRIVATE Main.cpp)
target_compile_features(cxx_std_20)
target_link_libraries(Main PRIVATE Stdm)
set_target_properties(Main PROPERTIES
    CXX_STANDARD_REQUIRED On
    CXX_EXTENSIONS Off
    EXPORT_COMPILE_COMMANDS On)

# Modules need to be compiled with the same flags as the executables they are
# linked to, the GMF (Global Module Flags) target is made available to allow
# for both Stdm and Main to be compiled with the -fno-rtti flag
target_compile_options(GMF INTERFACE -fno-rtti)

// Main.cpp
import Eqx.Stdm

int main()
{
    stdm::cout << "Hello" << stdm::endl;
    return 0;
}

Features

Stdm is organized into various submodules, the structure is as follows:

• Stdm
  • Algorithms
    • Algorithm
    • Numeric
  • Concepts
    • Concepts
  • Concurrency
    • Atomic
    • Barrier
    • Condition_Variable
    • Future
    • Latch
    • Mutex
    • Semaphore
    • Thread
  • Containers
    • Array
    • Deque
    • Forward_List
    • List
    • Map
    • Queue
    • Set
    • Span
    • Stack
    • Unordered_Map
    • Unordered_Set
    • Vector
  • IO
    • FileSystem
    • FStream
    • IOManip
    • IOStream
    • IStream
    • OStream
    • StringStream
  • Iterator
    • Iterator
  • Locale
    • Locale
  • Meta
    • Type_Traits
  • Numerics
    • CMath
    • Complex
    • Numbers
    • Random
  • Ranges
    • Ranges
  • Strings
    • String
    • String_View
  • Time
    • Chrono
  • Utils
    • Bit
    • Compare
    • CStdDef
    • CStdLib
    • Exception
    • Execution
    • Functional
    • Initializer_List
    • Limits
    • Optional
    • Source_Location
    • Utility

Importing a submodule is performed like so import Eqx.Stdm.Concurrency.Latch, you can also import the entire library import Eqx.Stdm or a sub library of the standard library import Eqx.Stdm.Concurrency. Stdm is exposed under the namespace stdm instead of std, this is to avoid affecting the std namespace.

Usage

To use Stdm it is expected that you use CMake version 3.28+, your CMakeLists file should add Stdm as a subdirectory (add_subdirectory(path/to/Stdm)). This will expose two library targets, Stdm and GMF, simply link the library to your target (target_link_libraries(yourTarget PRIVATE Stdm)). The GMF target (Global Module Flags) exsits to allow you to compile Stdm and your target with the same flags, for instance if you were compiling with the -fno-rtti flag the Stdm BMI would be incompatiable with your target. Instead of adding the flag to your target with target_compile_options(yourTarget PRIVATE -fno-rtti) you should add the flag to the GMF target target_compile_options(GMF INTERFACE -fno-rtti) now both your target and Stdm will be compiled with this flag.