result.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 <cstdint>
#include <output.hpp>
#include <platform.hpp>
#include <string>
#include <util.hpp>
#include <utility>
#include <vector>
 
using namespace std::literals;
using namespace steppable::__internals::utils;

namespace steppable::types
{
    enum class Status : std::uint8_t
    {
        CALCULATED_SIMPLIFIED, 
        CALCULATED_UNSIMPLIFIED, 
        MATH_ERROR 
    };

    enum class StatusBool : std::uint8_t
    {
        CALCULATED_SIMPLIFIED_YES, 
        CALCULATED_SIMPLIFIED_NO, 
        CALCULATED_UNSIMPLIFIED_YES, 
        CALCULATED_UNSIMPLIFIED_NO, 
        MATH_ERROR 
    };

    template<typename StatusType, typename ResultT, StringLiteral ResultTName>
    class ResultBase
    {
        StatusType done;

        std::vector<std::string> inputs;

        std::vector<std::string> outputs;

        ResultT result;
 
    public:
        ResultBase() = delete;

        ResultBase(const std::vector<std::string>& _inputs,
                   std::vector<std::string> _out,
                   ResultT result,
                   StatusType _done) :
            done(_done), inputs(_inputs), outputs(std::move(_out)), result(result)
        {
        }

        StatusType getStatus() const { return done; }
 
        [[nodiscard("Result should be used")]] ResultT getResult() const { return result; }

        [[nodiscard("Output should be used")]] std::string getOutput(size_t idx = 0) const
        {
            if (idx >= outputs.size())
            {
                output::error("getOutput"s, "Output index out of range"s);
                programSafeExit(1);
            }
            return outputs[idx];
        }

        [[nodiscard("Inputs should be used")]] std::vector<std::string> getInputs() const { return inputs; }
    };

    template<typename ResultT>
    using Result = ResultBase<Status, ResultT, StringLiteral{ "str" }>;

    template<typename ResultT>
    using ResultBool = ResultBase<StatusBool, ResultT, StringLiteral{ "bool" }>;
} // namespace steppable::types