ff_text.h

/*
 * File:   ff_text.h
 * Author: Jari Williamsson
 *
 * Created on den 7 november 2010, 20:56
 */
 
#ifndef FF_TEXT_H
#define FF_TEXT_H
 
class FCRawText : public __FCBaseData
{
    bool _workaround2012bug;  /* Working around a FinMac2012 bug */
 
    template <typename T>
    int _GetNumChars() const
    {
        int length = DataSizeLoad() / sizeof(T);
        const T* pData = reinterpret_cast<T*>(_datablock);
        while (length > 0 && !pData[length-1]) length--;
        return length;
    }
    
protected:
 
    virtual void SetRawTextNumber(twobyte number)
    {
        _dataid.text.rawTextNumber = number;
    }
    int DataSizeLoad() const override;
    void* Allocate() override;
    void Deallocate() override;
    bool IsDynamicSize() override { return true; }
 
    EVERSION EnigmaVersion() const override;
 
 
    __FCBaseData* CreateObject() override { return NULL; }
 
    virtual bool HasUnicodeSupport() const;
    
public:
    const char* ClassName() const override { return "FCRawText"; }
    const PDKFRAMEWORK_CLASSID GetClassID() const override { return FCID_RAWTEXT; }
 
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    EXTAG Tag() const override { return GetCustomTag() ? GetCustomTag() : tx_TextBlock; }
#endif // DOXYGEN_SHOULD_IGNORE_THIS
    
    FCRawText();
 
    virtual ~FCRawText();
    
    enum RAWTEXTTYPES
    {
        RAWTEXTTYPE_TEXTBLOCK = 0,
        
        RAWTEXTTYPE_VERSELYRIC = 1,
        
        RAWTEXTTYPE_CHORUSLYRIC = 2,
        
        RAWTEXTTYPE_SECTIONLYRIC = 3,
 
        RAWTEXTTYPE_CUSTOMLINE = 4,
        
        RAWTEXTTYPE_EXPRESSION = 5,
        
        RAWTEXTTYPE_FILEINFO = 6,
        
        RAWTEXTTYPE_BOOKMARK = 7,
        
        RAWTEXTTYPE_UNKNOWN = -1
    };
 
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    static EXTAG _exTagFromRawTextType(RAWTEXTTYPES val)
    {
        switch (val)
        {
            default:
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
                throw std::runtime_error("invalid value for raw text type");
#endif
                break;
            case RAWTEXTTYPE_TEXTBLOCK: return tx_TextBlock;
            case RAWTEXTTYPE_VERSELYRIC: return tx_VerseLyric;
            case RAWTEXTTYPE_CHORUSLYRIC: return tx_ChorusLyric;
            case RAWTEXTTYPE_SECTIONLYRIC: return tx_SectionLyric;
            case RAWTEXTTYPE_CUSTOMLINE: return tx_SmartShape;
            case RAWTEXTTYPE_EXPRESSION: return tx_TextExpression;
            case RAWTEXTTYPE_FILEINFO: return tx_FileInfo;
            case RAWTEXTTYPE_BOOKMARK: return tx_BookMark;
        }
        return 0; // catch-all
    }
    
    static RAWTEXTTYPES _rawTextTypeFromExTag(EXTAG val)
    {
        switch (val)
        {
            case tx_TextBlock: return RAWTEXTTYPE_TEXTBLOCK;
            case tx_VerseLyric: return RAWTEXTTYPE_VERSELYRIC;
            case tx_ChorusLyric: return RAWTEXTTYPE_CHORUSLYRIC;
            case tx_SectionLyric: return RAWTEXTTYPE_SECTIONLYRIC;
            case tx_SmartShape: return RAWTEXTTYPE_CUSTOMLINE;
            case tx_TextExpression: return RAWTEXTTYPE_EXPRESSION;
            case tx_FileInfo: return RAWTEXTTYPE_FILEINFO;
            case tx_BookMark: return RAWTEXTTYPE_BOOKMARK;
        }
        // no throw here, because Finale might have introduced a new type,
        // or there could be file corruption. This allows us to recover.
        return RAWTEXTTYPE_UNKNOWN;
    }
#endif // DOXYGEN_SHOULD_IGNORE_THIS
    
#ifndef PDK_FRAMEWORK_LUAFRIENDLY
    RAWTEXTTYPES
#else
    int
#endif
    GetBlockType() const { return _rawTextTypeFromExTag(Tag()); }
    
    int GetNumChars() const
    {
        if (HasUnicodeSupport())
            return _GetNumChars<eUniChar16>();
        return _GetNumChars<char>();
    }
 
    bool Load(twobyte number);
 
    bool LoadFirst() override
    {
        SetRawTextNumber(0);
        return LoadNext();
    }
 
    bool SaveAs(twobyte number);
 
    bool SaveNew();
 
    void SetText(const FCString* pString);
    
    void GetText(FCString* pString) const;
 
    virtual twobyte GetItemNo() const { return _dataid.text.rawTextNumber; }
 
    FCString* CreateString() const;
    
#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
    luabridge::RefCountedPtr<FCString> CreateString_GC() const
    { return makeLuaSharedPtr(CreateString()); }
#endif
 
 
    bool GetSubString(FCString* pString, const FCRange *pRange) const;
 
#ifdef PDK_FRAMEWORK_DEBUG
    void DebugDump() override
    {
        __FCBaseData::DebugDump();
        FCString* pString = CreateString();
        DebugOutString("String value: ", pString->GetCString());
        delete pString;
    }
#endif
};
 
 
 
class __FCOtherText : public FCRawText
{
protected:
    void SetRawTextNumber(twobyte number) override
    {
        _dataid.other.cmper = number;
    }
 
    EXTAG Tag() const override { return 0; }  /* MUST be overwritten in child classes. */
public:
    const char* ClassName() const override { return "__FCOtherText"; }
 
    twobyte GetItemNo() const override { return _dataid.other.cmper; }
};
 
class FCEndingRepeatText : public __FCOtherText
{
    EXTAG Tag() const override { return ot_EndingRepeatText; }
public:
    const char* ClassName() const override { return "FCEndingRepeatText"; }
};
 
 
class FCStaffListText : public __FCOtherText
{
    EXTAG Tag() const override { 
#if FXT_VERSION >= FINALEVERSION_25_3
                /* Unicode and tag change since 25.3 */
                return ot_RepeatStaffListName;
#else
                return ot_StaffListName; 
#endif
        }
 
        bool HasUnicodeSupport() const override;
 
public:
    const char* ClassName() const override { return "FCStaffListText"; }
};
 
 
/* Previously undocumented */
 
const EXTAG __ot_CategoryStaffListName = MAKEEXTAG(edOther, 'C', 'L');
 
class FCStaffListCategoryText : public __FCOtherText
{
    EXTAG Tag() const override { return __ot_CategoryStaffListName; }
    bool HasUnicodeSupport() const override { return false; }
public:
    const char* ClassName() const override { return "FCCategoryStaffListText"; }
};
 
 
/* Previously undocumented */
const EXTAG __ot_StaffAssignStaffListName = MAKEEXTAG(edOther, 'S', 'l');
 
class FCStaffListStaffAssignText : public __FCOtherText
{
    EXTAG Tag() const override { return __ot_StaffAssignStaffListName; }
    bool HasUnicodeSupport() const override { return false; }
public:
    const char* ClassName() const override { return "FCStaffListStaffAssignText"; }
};
 
class FCTextRepeatText : public __FCOtherText {
protected:
    EXTAG Tag() const override { return ot_TextRepeatStyleText; }
public:
    const char* ClassName() const override { return "FCTextRepeatText"; }
};
 
class FCPercussionLayoutNotesText : public __FCOtherText {
protected:
    EXTAG Tag() const override { return ot_PercussionMapTitle; }
public:
    const char* ClassName() const override { return "FCPercussionLayoutNotesText"; }
};
 
class FCInstrumentDefText : public __FCOtherText {
protected:
    EXTAG Tag() const override { return ot_InstDefinitionName; }
public:
    const char* ClassName() const override { return "FCInstrumentDefText"; }
};
 
class FCBookmarkText : public FCRawText {
protected:
    EXTAG Tag() const override { return tx_BookMark; }
public:
    const char* ClassName() const override { return "FCBookmarkText"; }
};
 
class __FCLyricsBase : public FCRawText {
public:
    EXTAG Tag() const override = 0;  /* Override, but keep a public reference here */
    const char* ClassName() const override { return "__FCLyricsBase"; }
  
    int CalcSyllableOffset(int syllableindex, int searchfromindex = 0) const;
    
    FCFontInfo* CreateSyllableFontInfo(int syllableindex, int searchfromindex = 0) const;
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
    luabridge::RefCountedPtr<FCFontInfo> CreateSyllableFontInfo_GC(int syllableindex, int searchfromindex = 0) const
    { return makeLuaSharedPtr(CreateSyllableFontInfo(syllableindex, searchfromindex)); }
#endif
    
    bool GetSyllableRange(FCRange* pRange, int syllableindex, int searchfromindex = 0) const;
    
    bool GetSyllableText(FCString* pString, int syllableno) const;
};
 
class FCVerseLyricsText : public __FCLyricsBase {
protected:
    EXTAG Tag() const override { return tx_VerseLyric; }
public:
    const char* ClassName() const override { return "FCVerseLyricsText"; }
};
 
class FCSectionLyricsText : public __FCLyricsBase {
protected:
    EXTAG Tag() const override { return tx_SectionLyric; }
public:
    const char* ClassName() const override { return "FCSectionLyricsText"; }
};
 
class FCChorusLyricsText : public __FCLyricsBase {
protected:
    EXTAG Tag() const override { return tx_ChorusLyric; }
public:
    const char* ClassName() const override { return "FCChorusLyricsText"; }
};
 
 
#ifdef PDK_FRAMEWORK_ENIGMASTRINGS
class FCFileInfoText : public FCRawText {
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
private:
    bool _LoadWrapper(twobyte number)
    {
        if (!Load(number)) return false;
        FCString* pString = CreateString();
        if (!pString) return true;
        pString->TrimEnigmaFontTags();        
        SetText(pString);
        delete pString;
        return true;
    }
#endif  /* #ifndef DOXYGEN_SHOULD_IGNORE_THIS */
protected:
    EXTAG Tag() const override { return tx_FileInfo; }
public:
    const char* ClassName() const override { return "FCFileInfoText"; }
 
#ifndef DOXYGEN_SHOULD_IGNORE_THIS
    const twobyte GetID_Title() { return 1; }
    const twobyte GetID_Subtitle() { return 7; }
    const twobyte GetID_Composer() { return 2; }
    const twobyte GetID_Arranger() { return 6; }
    const twobyte GetID_Lyricist() { return 5; }
    const twobyte GetID_Copyright() { return 3; }
    const twobyte GetID_Description() { return 4; }
#endif /* #ifndef DOXYGEN_SHOULD_IGNORE_THIS */
    
    bool LoadTitle() { return _LoadWrapper(GetID_Title()); }
 
    bool LoadSubtitle()  { return _LoadWrapper(GetID_Subtitle()); }
 
    bool LoadComposer()  { return _LoadWrapper(GetID_Composer()); }
 
    bool LoadArranger()  { return _LoadWrapper(GetID_Arranger()); }
 
    bool LoadLyricist() { return _LoadWrapper(GetID_Lyricist()); }
 
    bool LoadCopyright() { return _LoadWrapper(GetID_Copyright()); }
 
    bool LoadDescription() { return _LoadWrapper(GetID_Description()); }
    
    bool SaveAsTitle() { return SaveAs(GetID_Title()); }
 
    bool SaveAsSubtitle() { return SaveAs(GetID_Subtitle()); }
 
    bool SaveAsComposer() { return SaveAs(GetID_Composer()); }
 
    bool SaveAsArranger() { return SaveAs(GetID_Arranger()); }
 
    bool SaveAsLyricist() { return SaveAs(GetID_Lyricist()); }
 
    bool SaveAsCopyright() { return SaveAs(GetID_Copyright()); }
 
    bool SaveAsDescription() { return SaveAs(GetID_Description()); }    
};
#endif   /* PDK_FRAMEWORK_ENIGMASTRINGS */
 
 
 
 
#endif  /* FF_TEXT_H */