color.hpp

// Copyright (c) 2014-2022 Thomas Fussell
// Copyright (c) 2010-2015 openpyxl
// Copyright (c) 2024-2026 xlnt-community
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE
//
// @license: http://www.opensource.org/licenses/mit-license.php
// @author: see AUTHORS file

#pragma once

#include <array>
#include <cstring>
#include <functional>

#include <xlnt/xlnt_config.hpp>
#include <xlnt/utils/optional.hpp>
#include <xlnt/utils/hash_combine.hpp>
#include <xlnt/utils/value_with_default.h>

namespace xlnt {

namespace detail {

class xlsx_producer;

} // namespace detail

class XLNT_API indexed_color
{
public:
    //TODO: should this be explicit?
    indexed_color(std::size_t index);

    std::size_t index() const;

    void index(std::size_t index);

private:
    std::size_t index_;
};

class XLNT_API theme_color
{
public:
    theme_color(std::size_t index);

    std::size_t index() const;

    void index(std::size_t index);

private:
    std::size_t index_;
};

class XLNT_API rgb_color
{
public:
    rgb_color(const std::string &hex_string);

    rgb_color(std::uint8_t r, std::uint8_t g, std::uint8_t b, std::uint8_t a = 255);

    std::string hex_string() const;

    std::uint8_t red() const;

    std::uint8_t green() const;

    std::uint8_t blue() const;

    std::uint8_t alpha() const;

    std::array<std::uint8_t, 3> rgb() const;

    std::array<std::uint8_t, 4> rgba() const;

private:
    std::array<std::uint8_t, 4> rgba_;
};

enum class color_type
{
    indexed,
    theme,
    rgb
};

class XLNT_API color
{
public:
    static const color black();

    static const color white();

    static const color red();

    static const color darkred();

    static const color blue();

    static const color darkblue();

    static const color green();

    static const color darkgreen();

    static const color yellow();

    static const color darkyellow();

    color();

    color(const rgb_color &rgb);

    color(const indexed_color &indexed);

    color(const theme_color &theme);

    color_type type() const;

    bool auto_() const;

    void auto_(bool value);

    const rgb_color &rgb() const;

    rgb_color &rgb();

    const indexed_color &indexed() const;

    indexed_color &indexed();

    const theme_color &theme() const;

    theme_color &theme();

    bool has_tint() const;

    double tint() const;

    void tint(double tint);

    bool operator==(const color &other) const;

    bool operator!=(const color &other) const;

private:
    friend class detail::xlsx_producer;

    void assert_type(color_type t) const;

    color_type type_;

    rgb_color rgb_;

    indexed_color indexed_;

    theme_color theme_;

    detail::double_with_default<0> tint_;

    bool auto_color = false;
};

} // namespace xlnt

namespace std {

template<>
struct hash<xlnt::color>
{
    size_t operator()(const xlnt::color& c) const
    {
        size_t seed = 0;
        // Start by hashing the type to prevent collisions between different color types
        // that might share an underlying value (e.g., theme(1) vs indexed(1)).
        xlnt::detail::hash_combine(seed, static_cast<int>(c.type()));

        // Hash auto color flag
        xlnt::detail::hash_combine(seed, c.auto_());

        // Hash tint if present
        if (c.has_tint())
        {
            xlnt::detail::hash_combine(seed, c.tint());
        }

        switch (c.type())
        {
            case xlnt::color_type::indexed:
                xlnt::detail::hash_combine(seed, c.indexed().index());
                break;
            case xlnt::color_type::theme:
                xlnt::detail::hash_combine(seed, c.theme().index());
                break;
            case xlnt::color_type::rgb:
            {
                const auto& rgb = c.rgb();
                xlnt::detail::hash_combine(seed, rgb.red());
                xlnt::detail::hash_combine(seed, rgb.green());
                xlnt::detail::hash_combine(seed, rgb.blue());
                xlnt::detail::hash_combine(seed, rgb.alpha());
                break;
            }
        }
        return seed;
    }
};

} // namespace std