SvgConvert.h

/*
 * Copyright (C) 2025, Robert Patterson
 *
 * 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 <functional>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
#include "musx/dom/Fundamentals.h"
#include "musx/dom/MusxInstance.h"
 
namespace musx {
namespace dom {
class FontInfo;
namespace others {
class ShapeDef;
} // namespace others
} // namespace dom
 
namespace util {
 
class SvgConvert
{
public:
    enum class SvgUnit
    {
        None, 
        Pixels,        
        Points,        
        Picas,         
        Centimeters,   
        Millimeters,   
        Inches         
    };
 
    struct GlyphMetrics
    {
        dom::EvpuFloat advance{};
        dom::EvpuFloat ascent{};
        dom::EvpuFloat descent{};
    };
 
    using GlyphMetricsFn = std::function<std::optional<GlyphMetrics>(const dom::FontInfo&, std::u32string_view)>;
 
    static std::string toSvg(const dom::others::ShapeDef& shape);
 
    static std::string toSvg(const dom::others::ShapeDef& shape,
                             GlyphMetricsFn glyphMetrics);
 
    static std::string toSvg(const dom::others::ShapeDef& shape,
                             double scaling,
                             SvgUnit unit);
 
    static std::string toSvg(const dom::others::ShapeDef& shape,
                             double scaling,
                             SvgUnit unit,
                             GlyphMetricsFn glyphMetrics);
 
    static std::string presetArrowheadAsSvg(dom::ArrowheadPreset preset,
                                            double scaling = 1.0,
                                            SvgUnit unit = SvgUnit::None);
 
    static std::string toSvgWithPageFormatScaling(const dom::others::ShapeDef& shape,
                                                  SvgUnit unit = SvgUnit::Millimeters);
 
    static std::string toSvgWithPageFormatScaling(const dom::others::ShapeDef& shape,
                                                  SvgUnit unit,
                                                  GlyphMetricsFn glyphMetrics);
};
 
} // namespace util
} // namespace musx