Tie.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 <optional>
#include <utility>
 
#include "musx/dom/Details.h"
#include "musx/dom/EnumClasses.h"
#include "musx/dom/Options.h"
 
namespace musx {
namespace dom {
class NoteInfoPtr;
}
 
namespace util {
 
class Tie
{
public:
    enum class EndPointKind
    {
        Notehead,           
        MeasureBoundary,    
        SystemBoundary      
    };
 
    struct ContourGeometry
    {
        dom::EvpuFloat startToEndLeft{}; 
        dom::EvpuFloat startNoteheadWidth{}; 
        std::optional<dom::EvpuFloat> endNoteheadWidth{}; 
        dom::EvpuFloat startAdjustment{}; 
        dom::EvpuFloat endAdjustment{}; 
        EndPointKind startPointKind{EndPointKind::Notehead}; 
        EndPointKind endPointKind{EndPointKind::Notehead}; 
    };
 
    struct ContourResult
    {
        dom::options::TieOptions::ControlStyleType styleType{}; 
        dom::Evpu length{}; 
    };
 
    struct ContourControlPoint
    {
        dom::Efix insetRatio{}; 
        dom::Evpu height{}; 
        dom::Evpu insetFixed{}; 
    };
 
    struct ContourControlPoints
    {
        ContourControlPoint left; 
        ContourControlPoint right; 
        dom::options::TieOptions::InsetStyle insetStyle{}; 
    };
 
    struct ContourMetrics
    {
        ContourResult contour; 
        ContourControlPoints controlPoints; 
    };
 
    [[nodiscard]]
    static dom::CurveContourDirection calcDefaultDirection(const dom::NoteInfoPtr& noteInfo, bool forTieEnd = false);
 
    [[nodiscard]]
    static dom::CurveContourDirection calcEffectiveDirection(const dom::NoteInfoPtr& noteInfo, bool forTieEnd = false);
 
    [[nodiscard]]
    static std::optional<std::pair<dom::TieConnectStyleType, dom::TieConnectStyleType>> calcConnectStyleTypes(
        const dom::NoteInfoPtr& noteInfo, bool forTieEnd);
 
    [[nodiscard]]
    static bool calcIsOuterConnectStyle(dom::TieConnectStyleType type);
 
    [[nodiscard]]
    static std::optional<dom::details::TieAlterBase::ConnectionType> calcConnectionType(
        const dom::NoteInfoPtr& noteInfo, bool forTieEnd, bool forEndPoint, bool forPageView = true);
 
    [[nodiscard]]
    static dom::options::TieOptions::ConnectStyle calcEndpointOffsets(const dom::NoteInfoPtr& noteInfo, bool forTieEnd, bool forEndPoint,
        std::optional<dom::CurveContourDirection> direction = std::nullopt, bool forPageView = true);
 
    [[nodiscard]]
    static std::optional<ContourResult> calcContourStyleType(
        const dom::NoteInfoPtr& noteInfo, const ContourGeometry& geometry, bool forTieEnd = false);
 
    [[nodiscard]]
    static std::optional<ContourControlPoints> calcDefaultContourControlPoints(
        const dom::NoteInfoPtr& noteInfo, dom::options::TieOptions::ControlStyleType styleType, dom::Evpu length);
 
    [[nodiscard]]
    static std::optional<ContourControlPoints> calcEffectiveContourControlPoints(
        const dom::NoteInfoPtr& noteInfo, bool forTieEnd, dom::options::TieOptions::ControlStyleType styleType, dom::Evpu length);
 
    [[nodiscard]]
    static std::optional<ContourMetrics> calcEffectiveContourMetrics(
        const dom::NoteInfoPtr& noteInfo, const ContourGeometry& geometry, bool forTieEnd = false);
 
private:
    [[nodiscard]]
    static std::optional<dom::TieConnectStyleType> calcConnectStyleTypeAtEndPoint(
        const dom::NoteInfoPtr& noteInfo, bool forTieEnd, dom::CurveContourDirection direction, bool stemUp,
        const dom::NoteInfoPtr& tieAlterContext, bool forEndPoint,
        std::optional<size_t> noteIndexOverride = std::nullopt, std::optional<size_t> noteCountOverride = std::nullopt,
        std::optional<bool> upStemSecondOverride = std::nullopt, std::optional<bool> downStemSecondOverride = std::nullopt);
};
 
} // namespace util
} // namespace musx