Ossia.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 "BaseClasses.h"
#include "CommonClasses.h"
#include "Others.h"
 // do not add other dom class dependencies. Use .cpp files for implementations that need total class access.
 
namespace musx {
namespace dom {
 
namespace details {
class Bracket;
}
 
namespace others {
 
class OssiaBounds : public OthersBase
{
public:
    explicit OssiaBounds(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper)
        : OthersBase(document, partId, shareMode, cmper)
    {
    }
 
    Evpu topMargin{};       
    Evpu leftMargin{};      
    Evpu rightMargin{};     
    Evpu centerPull{};      
 
    constexpr static std::string_view XmlNodeName = "ossiaBounds"; 
    static const xml::XmlElementArray<OssiaBounds>& xmlMappingArray(); 
};
 
class OssiaHeader : public OthersBase
{
public:
    explicit OssiaHeader(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper)
        : OthersBase(document, partId, shareMode, cmper)
    {
    }
 
    ClefIndex clefId{};                         
    std::shared_ptr<KeySignature> keySig;       
    Cmper beats{};                              
    Cmper divBeat{};                            
    Cmper bracketGroup{};                       
    bool compositeNumerator{};                  
    bool compositeDenominator{};                
    Measure::BarlineType barlineType{};         
 
    MusxInstance<TimeSignature> createTimeSignature() const;
 
    MusxInstanceList<details::Bracket> getBrackets() const;
 
    void integrityCheck(const std::shared_ptr<Base>& ptrToThis) override
    {
        this->OthersBase::integrityCheck(ptrToThis);
        if (!keySig) {
            keySig = std::make_shared<KeySignature>(getDocument());
        }
    }
 
    constexpr static std::string_view XmlNodeName = "ossiaHeader"; 
    static const xml::XmlElementArray<OssiaHeader>& xmlMappingArray(); 
};
 
class OssiaMusic : public OthersBase
{
public:
    explicit OssiaMusic(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper)
        : OthersBase(document, partId, shareMode, cmper)
    {
    }
 
    int percent{};                  
    StaffCmper sourceStaffId{};     
    MeasCmper sourceMeasureId{};    
    bool hideLeftLine{};            
    bool hideKey{};                 
    bool hideTime{};                
    bool hideDynamic{};             
    bool hideStaff{};               
    bool hideRepeat{};              
    bool hideClef{};                
    // posMode: Positioning behavior for the ossia (xml node is `<posMode>`).
    // posMode appears to be an unused legacy spacing feature and is intentionally not stored. The only value ever seen
    // is "ossiaDefault".
 
    constexpr static std::string_view XmlNodeName = "ossiaMusic"; 
    static const xml::XmlElementArray<OssiaMusic>& xmlMappingArray(); 
};
 
class PageOssiaAssign : public OthersBase
{
public:
    explicit PageOssiaAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper cmper, Inci inci)
        : OthersBase(document, partId, shareMode, cmper, inci)
    {
    }
 
    Cmper ossiaId{};        
    Evpu xOffset{};         
    Evpu yOffset{};         
    Evpu measureWidth{};    
    bool hidden{};          
 
    constexpr static std::string_view XmlNodeName = "pageOssiaAssign"; 
    static const xml::XmlElementArray<PageOssiaAssign>& xmlMappingArray(); 
};
 
} //namespace others
 
namespace details {
 
class MeasureOssiaAssign : public DetailsBase
{
public:
    explicit MeasureOssiaAssign(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper staffId, Cmper measureId, Inci inci)
        : DetailsBase(document, partId, shareMode, staffId, measureId, inci)
    {
    }
 
    Cmper ossiaId{};     
    Evpu xOffset{};      
    Evpu yOffset{};      
    bool hidden{};       
 
    constexpr static std::string_view XmlNodeName = "measOssiaAssign"; 
    static const xml::XmlElementArray<MeasureOssiaAssign>& xmlMappingArray(); 
};
 
} //namespace details
 
} //namespace dom
} //namespace musx