symbols.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 <array>
#include <cstddef>
#include <string>
#include <string_view>
#include <vector>

namespace steppable::prettyPrint
{
    struct Position
    {
        long long x = 0;
        long long y = 0;
    };
 
    // // Not currently in use.
    // enum PrintingAlignment
    // {
    //     BASELINE = 0,
    //     MIDDLE = 1
    // };
 
    // struct PrintingObj
    // {
    //     std::string str;
    //     PrintingAlignment alignment;
    // };

    class ConsoleOutput
    {
    private:
        Position curPos;

        std::vector<std::vector<char>> buffer;

        size_t height = 10;

        size_t width = 10;
 
    public:
        ConsoleOutput(size_t height, size_t width);

        void write(char c, long long dLine, long long dCol, bool updatePos = false);

        void write(char c, const Position& pos, bool updatePos = false);

        void write(const std::string& s, const Position& pos, bool updatePos = false);

        [[nodiscard]] std::string asString() const;
    };

    size_t getStringWidth(const std::string& s);

    size_t getStringHeight(const std::string& s);
} // namespace steppable::prettyPrint

namespace steppable::__internals::symbols
{
    constexpr std::string_view BECAUSE = "\u2235";
    constexpr std::string_view THEREFORE = "\u2234";

    constexpr std::string_view MULTIPLY = "\u00D7";
    constexpr std::string_view DIVIDED_BY = "\u00F7";
 
    constexpr std::string_view SURD = "\u221A";
    constexpr std::string_view COMBINE_MACRON = "\u0305";

    constexpr std::string_view LARGE_DOT = "\u25C9";
    constexpr std::string_view ABOVE_DOT = "\u02D9";
 
    // Subscripts
    constexpr std::string_view SUB_0 = "\u2080";
    constexpr std::string_view SUB_Z = "\u1D69";
    constexpr int SUB_MAGIC_NUMBER = 8272;

    extern const std::array<std::string, 10>& SUPERSCRIPTS;

    std::string makeSubscript(const std::string& normal);

    std::string makeSubscript(int normal);
 
    // Superscripts
    constexpr std::string_view SUP_0 = "\u2070";
    constexpr std::string_view SUP_Z = "\u1DBB";
    constexpr int SUP_MAGIC_NUMBER = 8304;

    std::string makeSuperscript(const std::string& normal);

    std::string makeSuperscript(char normal);

    std::string makeSurd(const std::string& radicand);
} // namespace steppable::__internals::symbols

namespace steppable::prettyPrint::printers
{
    std::string ppRoot(const std::string& radicand, const std::string& index = "2");

    std::string ppFraction(const std::string& top, const std::string& bottom, bool inLine = false);

    std::string ppSubscript(const std::string& base, const std::string& subscript);

    std::string ppSuperscript(const std::string& base, const std::string& superscript);
} // namespace steppable::prettyPrint::printers