Texts.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 <string>
#include <unordered_map>
#include <vector>
#include <memory>
#include <stdexcept>
 
#include "BaseClasses.h"
#include "CommonClasses.h"
#include "musx/util/EnigmaString.h"
 // do not add other dom class dependencies. Use Implementations.h for implementations that need total class access.
 
namespace musx {
namespace dom {
 
namespace texts {
 
class FileInfoText : public TextsBase
{
public:
    explicit FileInfoText(const DocumentWeakPtr& document, Cmper partId, ShareMode shareMode, Cmper textNumber)
        : TextsBase(document, partId, shareMode, textNumber)
    {
        if (textNumber <= 0 || textNumber > Cmper(TextType::Subtitle)) {
            throw std::invalid_argument("invalid text type value provided to FileInfoText constructor");
        }
    }
 
    explicit FileInfoText(const DocumentWeakPtr& document, Cmper textNumber)
        : TextsBase(document, 0, ShareMode::All, textNumber)
    {
        if (textNumber <= 0 || textNumber > Cmper(TextType::Subtitle)) {
            throw std::invalid_argument("invalid text type value provided to FileInfoText constructor");
        }
    }
 
    enum class TextType : Cmper
    {
        Title = 1,        
        Composer = 2,     
        Copyright = 3,    
        Description = 4,  
        Lyricist = 5,     
        Arranger = 6,     
        Subtitle = 7      
    };
 
    TextType getTextType() const
    {
        const Cmper textNumber = getTextNumber();
        MUSX_ASSERT_IF(textNumber <= 0 || textNumber > Cmper(TextType::Subtitle)) {
            throw std::logic_error("File Info text found with invalid text number " + std::to_string(textNumber));
        }
        return TextType(textNumber);
    }
 
    constexpr static std::string_view XmlNodeName = "fileInfo";
};
 
class LyricsTextBase : public TextsBase
{
public:
    using TextsBase::TextsBase;
 
    std::vector<std::shared_ptr<const LyricsSyllableInfo>> syllables; 
 
    bool iterateStylesForSyllable(size_t syllableIndex, util::EnigmaString::TextChunkCallback callback) const;
 
    void createSyllableInfo(const MusxInstance<TextsBase>& ptrToThis);
 
private:
    std::vector<util::EnigmaStyles> m_syllableStyles; 
};
 
class LyricsVerse : public LyricsTextBase
{
public:
    using LyricsTextBase::LyricsTextBase;
 
    constexpr static std::string_view XmlNodeName = "verse"; 
    constexpr static LyricTextType lyricTextType = LyricTextType::Verse; 
};
 
class LyricsChorus : public LyricsTextBase
{
public:
    using LyricsTextBase::LyricsTextBase;
 
    constexpr static std::string_view XmlNodeName = "chorus"; 
    constexpr static LyricTextType lyricTextType = LyricTextType::Chorus; 
};
 
class LyricsSection : public LyricsTextBase
{
public:
    using LyricsTextBase::LyricsTextBase;
 
    constexpr static std::string_view XmlNodeName = "section"; 
    constexpr static LyricTextType lyricTextType = LyricTextType::Section; 
};
 
class BlockText : public TextsBase
{
public:
    using TextsBase::TextsBase;
 
    constexpr static std::string_view XmlNodeName = "blockText";
};
 
class SmartShapeText : public TextsBase
{
public:
    using TextsBase::TextsBase;
 
    constexpr static std::string_view XmlNodeName = "smartShapeText";
};
 
class ExpressionText : public TextsBase
{
public:
    using TextsBase::TextsBase;
 
    constexpr static std::string_view XmlNodeName = "expression";
};
 
class BookmarkText : public TextsBase
{
public:
    using TextsBase::TextsBase;
 
    constexpr static std::string_view XmlNodeName = "bookmarkText";
};
 
} // namespace texts
} // namespace dom
} // namespace musx