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 */
protected:

    virtual void SetRawTextNumber(twobyte number)
    {
        _dataid.text.rawTextNumber = number;
    }
    virtual int DataSizeLoad();
    virtual void* Allocate();
    virtual void Deallocate();
    virtual bool IsDynamicSize() { return true; }

    virtual EVERSION EnigmaVersion();

    virtual EXTAG Tag() { return GetCustomTag() ? GetCustomTag() : tx_TextBlock; }

    virtual __FCBaseData* CreateObject() { return NULL; }

    virtual bool HasUnicodeSupport();

public:
    virtual const char* ClassName() { return "FCRawText"; }
    virtual const PDKFRAMEWORK_CLASSID GetClassID() { return FCID_RAWTEXT; }

    FCRawText();

    virtual ~FCRawText();

    bool Load(twobyte number);


    virtual bool LoadFirst()
    {
        SetRawTextNumber(0);
        return LoadNext();
    }

    bool SaveAs(twobyte number);

    bool SaveNew();

    void SetText(FCString* pString);
    
    void GetText(FCString* pString);

    virtual twobyte GetItemNo() const { return _dataid.text.rawTextNumber; }

    FCString* CreateString();

#ifdef PDK_FRAMEWORK_LUAFRIENDLY

    FCString* CreateString_GC();
#endif

#ifdef PDK_FRAMEWORK_DEBUG
    virtual void DebugDump()
    {
        __FCBaseData::DebugDump();
        FCString* pString = CreateString();
        DebugOutString("String value: ", pString->GetCString());
        delete pString;
    }
#endif
};



class __FCOtherText : public FCRawText
{
protected:
    virtual void SetRawTextNumber(twobyte number)
    {
        _dataid.other.cmper = number;
    }

    virtual EXTAG Tag() { return 0; }  /* MUST be overwritten in child classes. */
public:
    virtual const char* ClassName() { return "__FCOtherText"; }

    virtual twobyte GetItemNo() { return _dataid.other.cmper; }
};

class FCEndingRepeatText : public __FCOtherText
{
    virtual EXTAG Tag() { return ot_EndingRepeatText; }
public:
    virtual const char* ClassName() { return "FCEndingRepeatText"; }
};


class FCStaffListText : public __FCOtherText
{
    virtual EXTAG Tag() { 
#if FXT_VERSION >= FINALEVERSION_25_3
                /* Unicode and tag change since 25.3 */
                return ot_RepeatStaffListName;
#else
                return ot_StaffListName; 
#endif
        }

        virtual bool HasUnicodeSupport();

public:
    virtual const char* ClassName() { return "FCStaffListText"; }
};


/* Previously undocumented */

const EXTAG __ot_CategoryStaffListName = MAKEEXTAG(edOther, 'C', 'L');

class FCStaffListCategoryText : public __FCOtherText
{
    virtual EXTAG Tag() { return __ot_CategoryStaffListName; }
    virtual bool HasUnicodeSupport() { return false; }
public:
    virtual const char* ClassName() { return "FCCategoryStaffListText"; }
};


/* Previously undocumented */
const EXTAG __ot_StaffAssignStaffListName = MAKEEXTAG(edOther, 'S', 'l');

class FCStaffListStaffAssignText : public __FCOtherText
{
    virtual EXTAG Tag() { return __ot_StaffAssignStaffListName; }
    virtual bool HasUnicodeSupport() { return false; }
public:
    virtual const char* ClassName() { return "FCStaffListStaffAssignText"; }
};

class FCTextRepeatText : public __FCOtherText {
protected:
    virtual EXTAG Tag() { return ot_TextRepeatStyleText; }
public:
    virtual const char* ClassName() { return "FCTextRepeatText"; }
};

class FCPercussionLayoutNotesText : public __FCOtherText {
protected:
    virtual EXTAG Tag() { return ot_PercussionMapTitle; }
public:
    virtual const char* ClassName() { return "FCPercussionLayoutNotesText"; }
};

class FCInstrumentDefText : public __FCOtherText {
protected:
    virtual EXTAG Tag() { return ot_InstDefinitionName; }
public:
    virtual const char* ClassName() { return "FCInstrumentDefText"; }
};

class __FCLyricsBase : public FCRawText {
public:
    virtual EXTAG Tag() { return 0; }  /* Override, but keep a public reference here */
    virtual const char* ClassName() { return "__FCLyricsBase"; }
};

class FCVerseLyricsText : public __FCLyricsBase {
protected:
    virtual EXTAG Tag() { return tx_VerseLyric; }
public:
    virtual const char* ClassName() { return "FCLyricsVerseText"; }
};

class FCSectionLyricsText : public __FCLyricsBase {
protected:
    virtual EXTAG Tag() { return tx_SectionLyric; }
private:
    virtual const char* ClassName() { return "FCLyricsSectionText"; }
};

class FCChorusLyricsText : public __FCLyricsBase {
protected:
    virtual EXTAG Tag() { return tx_ChorusLyric; }
private:
    virtual const char* ClassName() { return "FCLyricsChorusText"; }
};


#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:
    virtual EXTAG Tag() { return tx_FileInfo; }
public:
    virtual const char* ClassName() { 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 */