# neargye/magic_enum architecture

> Architecture diagram of the GitHub repository neargye/magic_enum, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-07). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/neargye/magic_enum
- Repository: https://github.com/neargye/magic_enum

## Overview

##### Project Type Analysis
This is a specialized C++ utility library with the following characteristics:
- Header-only library
- Focused on compile-time enum reflection
- No runtime dependencies
- Multiple build system support (CMake, Bazel, Meson, etc.)

##### Main Components

A. Core Library Components:
**┌─────────────────────────────────────────────┐**
- Magic Enum Core                 │
- ┤
- Basic Enum Operations                     │
- Enum Reflection                           │
- Type Traits                              │
- ┘

B. Extension Modules:
**┌─────────────────────┐  ┌─────────────────────┐**
- Container Support │  │    I/O Operations   │
- Array            │  │ - Stream Operators   │
- Bitset           │  │ - Formatting        │
- Set              │  └─────────────────────┘
- ┘

C. Integration Layer:
**┌─────────────────────────────────────────────┐**
- Build System Integration          │
- ┤
- CMake │ Bazel │ Meson │ Conan │ Vcpkg      │
- ┘

##### Component Relationships

- All components depend on the core library
- Extension modules are optional and can be used independently
- Build system integration is independent of the core functionality

##### Specific Elements

Header Files Organization:
**┌─────────────────────────────────────────────┐**
- Header Organization              │
- ┤
- magic_enum.hpp         (Core)              │
- magic_enum_containers.hpp (Extensions)      │
- magic_enum_format.hpp    (Extensions)       │
- magic_enum_flags.hpp     (Extensions)       │
- ┘

##### Implementation Details

Compile-time nature of the library:
**┌─────────────────────────────────────────────┐**
- Compile-Time Processing             │
- ┤
- Template Metaprogramming                    │
- Constexpr Evaluation                        │
- Static Reflection                           │
- ┘

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core["Magic Enum Core Library"]
        BasicOps["Basic Enum Operations"]:::core
        Reflection["Enum Reflection"]:::core
        TypeTraits["Type Traits"]:::core
        CoreUtils["Core Utilities"]:::core
    end

    subgraph Extensions["Extension Modules"]
        ContainerSupport["Container Support"]:::extension
        IOOps["I/O Operations"]:::extension
        Format["Formatting Support"]:::extension
        Flags["Flags Extension"]:::extension
        Switch["Switch Functionality"]:::extension
    end

    subgraph Headers["Header Files"]
        MainHeader["magic_enum.hpp"]:::header
        ContainerHeader["magic_enum_containers.hpp"]:::header
        IOHeader["magic_enum_iostream.hpp"]:::header
        FormatHeader["magic_enum_format.hpp"]:::header
        FlagsHeader["magic_enum_flags.hpp"]:::header
        SwitchHeader["magic_enum_switch.hpp"]:::header
        AllHeader["magic_enum_all.hpp"]:::header
    end

    subgraph Build["Build System Integration"]
        CMake["CMake"]:::build
        Bazel["Bazel"]:::build
        Meson["Meson"]:::build
    end

    subgraph Implementation["Implementation Details"]
        Templates["Template Metaprogramming"]:::impl
        Constexpr["Constexpr Evaluation"]:::impl
        StaticRefl["Static Reflection"]:::impl
    end

    %% Core Dependencies
    BasicOps --> Reflection
    Reflection --> TypeTraits
    CoreUtils --> BasicOps

    %% Extension Dependencies
    ContainerSupport --> BasicOps
    IOOps --> BasicOps
    Format --> BasicOps
    Flags --> BasicOps
    Switch --> BasicOps

    %% Header Dependencies
    MainHeader --> BasicOps
    ContainerHeader --> ContainerSupport
    IOHeader --> IOOps
    FormatHeader --> Format
    FlagsHeader --> Flags
    SwitchHeader --> Switch
    AllHeader --> MainHeader
    AllHeader --> ContainerHeader
    AllHeader --> IOHeader
    AllHeader --> FormatHeader
    AllHeader --> FlagsHeader
    AllHeader --> SwitchHeader

    %% Build System Dependencies
    CMake --> MainHeader
    Bazel --> MainHeader
    Meson --> MainHeader

    %% Implementation Details
    Templates --> BasicOps
    Constexpr --> BasicOps
    StaticRefl --> BasicOps

    %% Click Events
    click BasicOps "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum.hpp"
    click CoreUtils "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_utility.hpp"
    click ContainerSupport "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_containers.hpp"
    click IOOps "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_iostream.hpp"
    click Format "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_format.hpp"
    click Flags "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_flags.hpp"
    click Switch "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_switch.hpp"
    click AllHeader "https://github.com/Neargye/magic_enum/blob/master/include/magic_enum/magic_enum_all.hpp"
    click CMake "https://github.com/Neargye/magic_enum/blob/master/CMakeLists.txt"
    click Bazel "https://github.com/Neargye/magic_enum/blob/master/BUILD.bazel"
    click Meson "https://github.com/Neargye/magic_enum/blob/master/meson.build"

    %% Styling
    classDef core fill:#a8d1f0,stroke:#333,stroke-width:2px
    classDef extension fill:#90EE90,stroke:#333,stroke-width:2px
    classDef header fill:#FFE4B5,stroke:#333,stroke-width:2px
    classDef build fill:#D3D3D3,stroke:#333,stroke-width:2px
    classDef impl fill:#E6E6FA,stroke:#333,stroke-width:2px
```
