Cue.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 <memory>
#include <vector>
 
#include "musx/dom/Entries.h"
 
namespace musx::util {
 
class Cue
{
public:
    enum class EntryVisibility
    {
        Visible,                    
        HiddenEntry,                
        HiddenStaff,                
        HiddenByAlternateNotation,  
        ExcludedByVoicing           
    };
 
    struct EntryAnalysis
    {
        enum class Kind
        {
            None,           
            PartOnly,       
            ScoreVisible    
        };
 
        Kind kind{Kind::None};              
        int entrySizePercent{100};          
        bool visibleInRequestedContext{};   
        bool visibleInScore{};              
        bool visibleInAnyLinkedPart{};      
 
        [[nodiscard]] bool isCue() const noexcept
        { return kind != Kind::None; }
    };
 
    struct FrameAnalysis
    {
        bool isCueFrame{};                    
        bool hasVisibleCueEntries{};           
        std::vector<size_t> cueEntryIndices;   
    };
 
    struct StaffMeasureAnalysis
    {
        std::vector<dom::LayerIndex> cueLayers;        
        std::vector<dom::LayerIndex> visibleCueLayers; 
        bool isCueOnly{};                              
 
        explicit operator bool() const
        { return isCueOnly; }
    };
 
    [[nodiscard]]
    static EntryVisibility calcVisibility(const dom::EntryInfoPtr& entry, dom::Cmper targetPartId);
 
    [[nodiscard]]
    static EntryVisibility calcVisibilityInRequestedContext(const dom::EntryInfoPtr& entry);
 
    [[nodiscard]]
    static bool calcIsVisibleInRequestedContext(const dom::EntryInfoPtr& entry)
    { return calcVisibilityInRequestedContext(entry) == EntryVisibility::Visible; }
 
    [[nodiscard]]
    static EntryAnalysis calcEntryAnalysis(const dom::EntryInfoPtr& entry);
 
    [[nodiscard]]
    static FrameAnalysis calcFrameAnalysis(const std::shared_ptr<const dom::EntryFrame>& frame);
 
    [[nodiscard]]
    static StaffMeasureAnalysis calcStaffMeasureAnalysis(const dom::details::GFrameHoldContext& context);
};
 
} // namespace musx::util