Arpeggio.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 <functional>
#include <optional>
#include <string>
 
#include "musx/dom/Details.h"
#include "musx/dom/Entries.h"
#include "musx/dom/Others.h"
#include "musx/util/Layout.h"
 
namespace musx::util {
 
enum class ArpeggioDirection
{
    Auto, 
    Up,   
    Down  
};
 
enum class ArpeggioArrow
{
    Auto, 
    None, 
    Up,   
    Down  
};
 
enum class ArpeggioSpanType
{
    Normal,  
    Bracket  
};
 
struct ArpeggioSpanCandidate
{
    ArpeggioSpanType type{ArpeggioSpanType::Normal}; 
    dom::EntryInfoPtr sourceEntry; 
    dom::EntryInfoPtr topEntry; 
    dom::EntryInfoPtr bottomEntry; 
    ArpeggioDirection direction{ArpeggioDirection::Auto}; 
    ArpeggioArrow arrow{ArpeggioArrow::Auto}; 
 
    [[nodiscard]] std::string key() const;
};
 
struct ArpeggioSpanOptions
{
    bool includeHiddenEntries{false}; 
    bool skipGraceEntries{false}; 
    bool constrainToSourceStaffOnly{false}; 
    StaffOriginOffsetResolver staffOriginOffsetResolver;
};
 
[[nodiscard]]
std::optional<ArpeggioSpanCandidate> calcArpeggioSpanForAssignment(
    const dom::EntryInfoPtr& sourceEntry,
    const dom::MusxInstance<dom::details::ArticulationAssign>& assign,
    const ArpeggioSpanOptions& options = {},
    std::function<bool(const dom::details::ArticulationAssign::SelectedSymbolContext&)> symbolContextFilter = {});
 
[[nodiscard]]
std::optional<ArpeggioSpanCandidate> calcNonArpeggioSpanForAssignment(
    const dom::EntryInfoPtr& sourceEntry,
    const dom::MusxInstance<dom::details::ArticulationAssign>& assign,
    const ArpeggioSpanOptions& options = {});
 
[[nodiscard]]
std::optional<ArpeggioSpanCandidate> calcNonArpeggioSpanForAssignment(
    const dom::MusxInstance<dom::others::MeasureExprAssign>& assign,
    const ArpeggioSpanOptions& options = {});
 
[[nodiscard]]
std::optional<ArpeggioSpanCandidate> calcNonArpeggioSpanForSmartShape(
    const dom::MusxInstance<dom::others::SmartShape>& smartShape,
    const ArpeggioSpanOptions& options = {});
 
} // namespace musx::util