Layout.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 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 "musx/dom/DocumentElement.h"
#include "musx/dom/MusxInstance.h"
 
namespace musx::util {
 
struct StaffOriginOffsetRequest
{
    dom::StaffCmper sourceStaffId{}; 
    dom::StaffCmper targetStaffId{}; 
    dom::MeasCmper measureId{}; 
    dom::Edu eduPosition{}; 
};
 
enum class StaffOriginOffsetResolverDecision
{
    NotHandled,  
    Unavailable, 
    Offset       
};
 
struct StaffOriginOffsetResolverResult
{
    StaffOriginOffsetResolverDecision decision{StaffOriginOffsetResolverDecision::NotHandled}; 
    double targetOriginOffsetEvpu{}; 
};
 
using StaffOriginOffsetResolver = std::function<StaffOriginOffsetResolverResult(
    const dom::DocumentPtr& document,
    dom::Cmper partId,
    const StaffOriginOffsetRequest& request)>;
 
[[nodiscard]]
dom::MusxInstanceList<dom::others::StaffUsed> calcSystemStavesOrScrollView(
    const dom::DocumentPtr& document,
    dom::Cmper partId,
    dom::MeasCmper measureId);
 
[[nodiscard]]
StaffOriginOffsetResolverResult calcStaffOriginOffsetUsingSystemStaffProxy(
    const dom::DocumentPtr& document,
    dom::Cmper partId,
    const StaffOriginOffsetRequest& request);
 
[[nodiscard]]
StaffOriginOffsetResolverResult calcStaffOriginOffsetUsingScrollViewProxy(
    const dom::DocumentPtr& document,
    dom::Cmper partId,
    const StaffOriginOffsetRequest& request);
 
} // namespace musx::util