conPlotTypes.hpp

/**************************************************************************************************
 * Copyright (c) 2023-2025 NWSOFT                                                                 *
 *                                                                                                *
 * 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.                                                                                      *
 **************************************************************************************************/
 
#pragma once
 
#include "colors.hpp"
#include "steppable/number.hpp"
#include "steppable/parameter.hpp"
 
#include <string>
#include <string_view>
#include <utility>
 
namespace steppable::graphing
{
    using namespace steppable::__internals::utils;
    using namespace steppable::__internals::symbols;
    using namespace steppable::__internals::parameter;
 
    using GraphFn = std::function<Number(Number)>;

    namespace GraphDot
    {
        constexpr std::string_view ROUND_DOT = "\u25CF"; 
        constexpr std::string_view BLOCK = "\u2588"; 
        constexpr std::string_view LIGHT_BLOCK_1 = "\u2591"; 
        constexpr std::string_view LIGHT_BLOCK_2 = "\u2592"; 
        constexpr std::string_view LIGHT_BLOCK_3 = "\u2593"; 
    } // namespace GraphDot
 
    struct GraphOptionsBase
    {
        std::string title = "Graph"; 
        std::string xAxisTitle = "X Axis Title"; 
        std::string yAxisTitle = "Y Axis Title"; 
 
        long long width = 30; 
        long long height = 20; 
 
        long long xTickSpacing = 10; 
        long long yTickSpacing = 5; 
 
        Number xMin = -1; 
        Number xMax = 1; 
    };
 
    enum class ShadeOptions : std::uint8_t
    {
        NO_SHADE = 0,
        SHADE_ABOVE_FIRST = 1,
        SHADE_BELOW_SECOND = 2,
        SHADE_BETWEEN_BOTH = 3,
        SHADE_OUTSIDE_BOTH = 4,
        SHADE_ABOVE_SECOND = 5,
        SHADE_BELOW_FIRST = 6,
    };
 
    using NumberPair = std::pair<Number, Number>;

    struct GraphOptions : GraphOptionsBase
    {
        template<typename... Params>
        GraphOptions(Params... params)
        {
            auto map = processParams(params...);
 
            PARAM_GET_FALLBACK(map, Number, xMin, -1);
            PARAM_GET_FALLBACK(map, Number, xMax, 1);
            PARAM_GET_FALLBACK(map, long long, width, 30LL);
            PARAM_GET_FALLBACK(map, long long, height, 20LL);
            PARAM_GET_FALLBACK(map, long long, xTickSpacing, 10LL);
            PARAM_GET_FALLBACK(map, long long, yTickSpacing, 5LL);
            PARAM_GET_FALLBACK(map, std::string, title, "Graph");
            PARAM_GET_FALLBACK(map, std::string, xAxisTitle, "X Axis Title");
            PARAM_GET_FALLBACK(map, std::string, yAxisTitle, "Y Axis Title");
 
            this->xMin = xMin;
            this->xMax = xMax;
            this->width = width;
            this->height = height;
            this->xTickSpacing = xTickSpacing;
            this->yTickSpacing = yTickSpacing;
            this->title = title;
            this->xAxisTitle = xAxisTitle;
            this->yAxisTitle = yAxisTitle;
        }
    };
 
    struct BarGraphOptions : GraphOptionsBase
    {
        long long yTickSpacing = 5; 
        long long xTickSpacing = 2; 
        Number xMin = 0;
        Number xMax = 100;

        template<typename... Params>
        BarGraphOptions(Params... params)
        {
            auto map = processParams(params...);
 
            PARAM_GET_FALLBACK(map, long long, width, 30LL);
            PARAM_GET_FALLBACK(map, long long, height, 20LL);
            PARAM_GET_FALLBACK(map, long long, yTickSpacing, 5LL);
            PARAM_GET_FALLBACK(map, long long, barWidth, 2LL);
            PARAM_GET_FALLBACK(map, std::string, title, "Bar Graph");
            PARAM_GET_FALLBACK(map, std::string, xAxisTitle, "X Axis Title");
            PARAM_GET_FALLBACK(map, std::string, yAxisTitle, "Y Axis Title");
 
            this->width = width;
            this->height = height;
            this->yTickSpacing = yTickSpacing;
            this->title = title;
            this->xAxisTitle = xAxisTitle;
            this->yAxisTitle = yAxisTitle;
            this->xTickSpacing = barWidth;
        }
    };
 
    struct LineOptionsBase
    {
        std::string_view lineDot = GraphDot::BLOCK; 
        ColorFunc lineColor = colors::green; 
        std::string title = "Line"; 
    };
 
    template<typename T>
    concept LineOptionsDerivation = std::derived_from<T, LineOptionsBase>;

    struct LineOptions : LineOptionsBase
    {
        long long samplesSpacing = 2; 
        NumberPair shadeValues = { 0, 0 };
        ShadeOptions shadeOptions = ShadeOptions::NO_SHADE;
        std::string_view shadeDot = GraphDot::LIGHT_BLOCK_1;

        template<typename... Params>
        LineOptions(Params... params)
        {
            auto map = processParams(params...);
            PARAM_GET_FALLBACK(map, std::string_view, lineDot, GraphDot::BLOCK);
            PARAM_GET_FALLBACK(map, ColorFunc, lineColor, (ColorFunc)colors::green);
            PARAM_GET_FALLBACK(map, std::string, title, "Line"s);
            PARAM_GET_FALLBACK(map, long long, samplesSpacing, 2LL);
 
            PARAM_GET_FALLBACK(map, NumberPair, shadeValues, {});
            PARAM_GET_FALLBACK(map, ShadeOptions, shadeOptions, ShadeOptions::NO_SHADE);
            PARAM_GET_FALLBACK(map, std::string_view, shadeBlock, GraphDot::LIGHT_BLOCK_1);
 
            this->lineDot = lineDot;
            this->lineColor = lineColor;
            this->title = title;
            this->samplesSpacing = samplesSpacing;
 
            this->shadeValues = shadeValues;
            this->shadeOptions = shadeOptions;
            this->shadeDot = shadeBlock;
        }
    };
 
    struct BarOptions : LineOptionsBase
    {
        std::string title = "Bar";
 
        template<typename... Params>
        BarOptions(Params... params)
        {
            auto map = processParams(params...);
            PARAM_GET_FALLBACK(map, std::string_view, block, GraphDot::BLOCK);
            PARAM_GET_FALLBACK(map, ColorFunc, color, colors::keepOriginal);
            PARAM_GET_FALLBACK(map, long long, barWidth, 2);
            PARAM_GET_FALLBACK(map, std::string, title, "Bar"s);
 
            this->lineDot = block;
            this->lineColor = color;
            this->title = title;
        }
    };
} // namespace steppable::graphing