DesignTokens.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <cstdint>
#include <string>
#include <unordered_map>

 
namespace hmi {

struct DesignColor {
    std::uint8_t r = 0;
    std::uint8_t g = 0;
    std::uint8_t b = 0;
    std::uint8_t a = 255;
 
    [[nodiscard]] friend bool operator==(const DesignColor& lhs, const DesignColor& rhs) noexcept {
        return lhs.r == rhs.r && lhs.g == rhs.g && lhs.b == rhs.b && lhs.a == rhs.a;
    }
};

struct ColorTokens {
    DesignColor background;   
    DesignColor surface;      
    DesignColor surfaceAlt;   
    DesignColor border;       
    DesignColor text;         
    DesignColor textMuted;    
    DesignColor accent;       
    DesignColor accentHover;  
    DesignColor error;        
    // Rôles du cadre de parchemin (`LOT-66`, `EX-IHM-070`). Ajoutés aux DEUX portées : la
    // structure est commune par construction, ce qui garantit qu'un rôle ajouté à l'une existe
    // dans l'autre. Le châssis d'édition les définit sans dessiner d'encadrement — il s'en sert
    // pour ses bordures et ses séparateurs, où ils tenaient déjà lieu de `border` éclairci ou
    // assombri.
    DesignColor frameEdge;      
    DesignColor frameOrnament;  
    DesignColor frameShadow;    
    // Rôles de la GEMME des ornements (`LOT-76`, `EX-IHM-075`). Le cabochon d'angle et la plaque
    // du bandeau de titre sont, dans les feuilles de personnage, un grenat serti d'or — la seule
    // couleur froide-chaude de l'habillage, et la seule qui ne soit ni du parchemin ni de l'encre.
    // Ajoutés aux DEUX portées, la structure étant commune par construction.
    DesignColor gem;        
    DesignColor gemShadow;  
};
 
// Neutralise la macro Windows `small` (`rpcndr.h`, incluse via <Windows.h> dans toute unite de
// traduction qui tire un en-tete Windows avant ce fichier) : `#define small char` casserait sinon
// silencieusement `SpacingTokens::small` ci-dessous. Garde conservee apres le portage QRhi : le
// projet n'inclut plus <d3d11.h>, mais rien ne garantit qu'aucun en-tete Windows ne remonte.
#ifdef small
#undef small
#endif

struct SpacingTokens {
    int extraSmall = 4;
    int small = 8;
    int medium = 12;
    int large = 16;
    int extraLarge = 24;
 
    [[nodiscard]] friend bool operator==(const SpacingTokens&,
                                         const SpacingTokens&) noexcept = default;
};

struct TypographyLevel {
    int pointSize = 10;
    int weight = 400;  
 
    [[nodiscard]] friend bool operator==(const TypographyLevel&,
                                         const TypographyLevel&) noexcept = default;
};

enum class FontRole {
    Ui,        
    Identity,  
};

struct TypographyTokens {
    FontRole family = FontRole::Ui;  
    TypographyLevel screenTitle;     
    TypographyLevel sectionTitle;    
    TypographyLevel body;            
    TypographyLevel caption;         
    TypographyLevel monospaceBody;   
 
    [[nodiscard]] friend bool operator==(const TypographyTokens&,
                                         const TypographyTokens&) noexcept = default;
};

struct SizeTokens {
    int iconSmall = 16;
    int iconMedium = 20;  
    int iconLarge = 24;
    int paletteThumbnail = 32;  
    int assetThumbnail = 48;    
    int controlMinWidth =
        160;  
 
    [[nodiscard]] friend bool operator==(const SizeTokens&, const SizeTokens&) noexcept = default;
};

struct DesignTokens {
    ColorTokens color;
    SpacingTokens spacing;
    TypographyTokens typography;
    SizeTokens size;
};

struct IdentityBaseScale {
    int screenTitle = 23;   
    int sectionTitle = 14;  
    int body = 10;          
    int caption = 8;        
 
    int spaceSmall = 4;
    int spaceMedium = 6;
    int spaceLarge = 8;
    int spaceExtraLarge = 12;
 
    int frameThickness = 1;  
 
    [[nodiscard]] friend bool operator==(const IdentityBaseScale&,
                                         const IdentityBaseScale&) noexcept = default;
};

[[nodiscard]] const IdentityBaseScale& identityBaseScale() noexcept;

[[nodiscard]] DesignColor mixColor(DesignColor from, DesignColor to, float ratio) noexcept;

[[nodiscard]] const char* genericCssFamily(FontRole role) noexcept;

[[nodiscard]] const DesignTokens& identityTokens() noexcept;

[[nodiscard]] const DesignTokens& editorDarkTokens() noexcept;

[[nodiscard]] const DesignTokens& editorLightTokens() noexcept;

[[nodiscard]] DesignColor viewportClearColor(bool editorMode,
                                             const DesignTokens& activeEditorTokens) noexcept;

[[nodiscard]] std::string toCssColor(DesignColor color);

[[nodiscard]] std::string toCssRgba(DesignColor color);

[[nodiscard]] double relativeLuminance(DesignColor color) noexcept;

[[nodiscard]] double contrastRatio(DesignColor a, DesignColor b) noexcept;

[[nodiscard]] std::unordered_map<std::string, std::string> buildStyleSheetValues(
    const DesignTokens& editorTokens, int identityScale = 1);
 
}  // namespace hmi