color.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_COLOR_HPP_
#define INCLUDE_FIFECHAN_COLOR_HPP_
 
// Standard library includes
#include <algorithm>
#include <cstdint>
#include <iomanip>
#include <iostream>
#include <ostream>
#include <sstream>
#include <stdexcept>
#include <string>
#include <vector>
 
// Platform config include
#include "fifechan/platform.hpp"
 
namespace fcn
{
    class FIFEGUI_API Color
    {
        public:
            Color() = default;

            Color(Color const &) = default;

            Color& operator=(Color const &) = default;

            Color(Color&&) = default;

            Color& operator=(Color&&) = default;

            explicit Color(int hexColor);

            explicit Color(std::string const & colorString);

            Color(int r, int g, int b, int a);

            Color(uint8_t r, uint8_t g, uint8_t b, uint8_t a = 255);

            ~Color() = default;
 
            //
            // Arithmetic operators
            //

            Color operator+(Color const & color) const;

            Color operator-(Color const & color) const;

            Color operator*(float value) const;

            Color operator+(float value) const;

            Color operator-(float value) const;
 
            //
            // Object manipulation operators
            //

            Color& operator+=(Color const & color);

            Color& operator-=(Color const & color);

            Color& operator*=(float value);
 
            //
            // Comparison operators
            //

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

            bool operator!=(Color const & color) const;
 
            //
            // Color conversions
            //

            Color lighten(float percentage) const;

            Color darken(float percentage) const;

            Color toGrayScale() const;

            Color blendWith(Color const & other) const;
 
            //
            // to string and stream functions
            //

            std::string toHexString() const;

            std::string toRGBString() const;

            std::string toRGBAString() const;

            friend FIFEGUI_API std::ostream& operator<<(std::ostream& out, Color const & color);

            uint8_t r{0};

            uint8_t g{0};

            uint8_t b{0};

            uint8_t a{255};
 
        private:
            void parseHex(std::string const & hex);

            void parseRGB(std::string const & rgbString);

            void parseRGBA(std::string const & rgbaString);

            static std::vector<int> parseColorComponents(std::string const & colors, bool withAlpha = false);
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_COLOR_HPP_