gap_report.h

/*
 * Copyright (C) 2026, 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 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 <string>
#include <utility>
 
#include "denigma/classify/gaps.h"
#include "musx/util/SvgConvert.h"
 
namespace denigma {
 
struct GapReportProducer
{
    std::string name;
    std::string version;
    std::string commit;
};
 
using GlyphMetricsFn = musx::util::SvgConvert::GlyphMetricsFn;
 
struct GapReportOptions
{
    GapReportProducer producer;
    GlyphMetricsFn glyphMetrics;
};
 
#if DENIGMA_HAS_GAP_REPORT
inline constexpr bool GAP_REPORT_AVAILABLE = true;
 
std::string serializeGapReport(const classify::GapCollector& collector, const GapReportOptions& options);
 
class GapReportWriter
{
public:
    explicit GapReportWriter(const classify::GapCollector& collector)
        : m_collector(collector)
    {}
 
    [[nodiscard]] std::string serialize(const GapReportOptions& options) const { return serializeGapReport(m_collector, options); }
 
private:
    const classify::GapCollector& m_collector;
};
#else
inline constexpr bool GAP_REPORT_AVAILABLE = false;
 
class GapReportWriter
{
public:
    explicit GapReportWriter(const classify::GapCollector&) {}
};
#endif // DENIGMA_HAS_GAP_REPORT
 
template <typename Callback>
bool withGapReport(const classify::GapCollector& collector, Callback&& callback)
{
    if constexpr (GAP_REPORT_AVAILABLE) {
        GapReportWriter writer(collector);
        std::forward<Callback>(callback)(writer);
    }
    return GAP_REPORT_AVAILABLE;
}
 
} // namespace denigma