gaps.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 <optional>
#include <span>
#include <string>
#include <utility>
#include <variant>
#include <vector>
 
#include "denigma/classify/chords.h"
#include "denigma/classify/expressions.h"
#include "denigma/classify/formatted_text.h"
#include "denigma/classify/lyrics.h"
#include "denigma/classify/noteheads.h"
#include "denigma/classify/smartshapes.h"
 
namespace denigma {
namespace classify {
 
struct GapAnchor
{
    std::string id;
    std::optional<int> staff;
    std::optional<musx::util::Fraction> position;
};
 
enum class GapExtent {
    Complete, 
    Partial 
};
 
struct GapPlacement
{
    enum class Kind {
        Staff, 
        SystemTop, 
        SystemBottom 
    };
 
    Kind kind{Kind::Staff};
    GapAnchor anchor;
};
 
struct PlaybackOnly
{};
 
using GapPayload = std::variant<ChordSymbolClassification, NoteheadClassification, ExpressionClassification, FormattedText, PlaybackOnly,
    SmartShapeClassification, LyricWordExtension>;
 
struct Gap
{
    GapAnchor anchor;
    std::optional<GapAnchor> end;
    GapExtent extent{GapExtent::Complete};
    std::vector<GapPlacement> placements;
    GapPayload payload;
};
 
class GapCollector
{
public:
    void retainDocument(musx::dom::DocumentPtr document) { m_documents.push_back(std::move(document)); }
 
    template <typename Payload>
    void add(GapAnchor anchor, Payload payload, GapExtent extent = GapExtent::Complete, std::vector<GapPlacement> placements = {})
    {
        m_gaps.push_back({std::move(anchor), std::nullopt, extent, std::move(placements), GapPayload(std::move(payload))});
    }
 
    template <typename Payload>
    void addSpan(GapAnchor anchor, GapAnchor end, Payload payload, GapExtent extent = GapExtent::Complete)
    {
        m_gaps.push_back({std::move(anchor), std::move(end), extent, {}, GapPayload(std::move(payload))});
    }
 
    [[nodiscard]] std::span<const Gap> gaps() const noexcept { return m_gaps; }
 
private:
    std::vector<Gap> m_gaps;
    std::vector<musx::dom::DocumentPtr> m_documents;
};
 
} // namespace classify
} // namespace denigma