ff_documents.h

/*
 * File:   ff_documents.h
 * Author: Jari Williamsson
 *
 * Created on den 22 mars 2011, 17:30
 */
 
#ifndef FF_DOCUMENTS_H
#define FF_DOCUMENTS_H
 
#include <map>
#include <string>
 
class FCDocument : public __FCBase
{    
    EDOCID      _docid;
    EDOCID      _lastdocid;
    
    void _StoreIDForSwitchBack()
    {
        _lastdocid = FX_GetCurrentEnigmaDocument();
        if (FX_GetCurrentEnigmaDocument() < 1) _lastdocid = 0;
    }
 
public:
    
    const char* ClassName() const override { return "FCDocument"; }
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
    static FCDocument* FCDocument_Lua(void* ptr, lua_State* L)
    {
        return _OneOptionalParamLuaConstructor<FCDocument, EDOCID>(ptr, L);
    }
#endif
 
    FCDocument(EDOCID id = -1) : __FCBase()
    {
        if (id < 1)
            _docid = FX_GetCurrentEnigmaDocument();
        else
            _docid = id;
        _lastdocid = 0;
    }
    
    EDOCID GetID() const { return _docid; }
 
    bool IsCurrent() { return _docid == FX_GetCurrentEnigmaDocument(); }
 
    bool IsIdentical(const __FCBase* pCompareObject) const override
    {
        const FCDocument* pOtherDocument = dynamic_cast<const FCDocument*>(pCompareObject);
        if (!pOtherDocument) return false;
        return (GetID() == pOtherDocument->GetID());
    }
    
    bool IsUntitled();
 
    bool GetPath(FCString* pString);
 
    std::string GetCreatedDate() const;
 
    std::string GetModifiedDate() const;
 
    EVERSION GetCreatedVersion() const;
 
    EVERSION GetModifiedVersion() const;
 
        bool GetPathSpec(void *pathspec, EVERSION convertversion);
 
    bool SetToCurrent()
    {
        if (_lastdocid != 0) return false;
        _docid = FX_GetCurrentEnigmaDocument();
        return true;
    }
 
        bool _SetID(EDOCID docID)
        {
                if (_lastdocid != 0) return false;
                _docid = docID;
                return true;
        }
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
    bool SwitchTo(const FCString* pUndoString, bool saveedits, _state_ptr S);
#else
    bool SwitchTo(const FCString* pUndoString, bool saveedits, _state_ptr S = nullptr);
#endif
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
    bool SwitchBack(bool saveedits, _state_ptr S);
#else
    bool SwitchBack(bool saveedits, _state_ptr S = nullptr);
#endif
    bool DisplayVisually()
    {
        /* Try to find the docid in a window first. */
        int windowcount = FX_GetWindowCount();
        if (windowcount == 0) return false;
#if FXT_VERSION < FINALEVERSION_2012
                int datasize = sizeof (EXDocWindow2009) * windowcount;
                EXDocWindow2009* pDocwindowarray = new EXDocWindow2009[windowcount];
#elif FXT_VERSION < FINALEVERSION_25
                int datasize = sizeof (EXDocWindow2012) * windowcount;
                EXDocWindow2012* pDocwindowarray = new EXDocWindow2012[windowcount];
#else
                int datasize = sizeof (EXDocWindow25) * windowcount;
                EXDocWindow25* pDocwindowarray = new EXDocWindow25[windowcount];
#endif
        memset(pDocwindowarray, 0, datasize);
        /* Don't look at the return value of FX_GetWindowInfoList,
         * since it returns false on Finale 2012 at least. */
        FX_GetWindowInfoList(pDocwindowarray, windowcount);
        bool windowswitched = false;
        for (int i = 0; i < windowcount; i++)
        {
            if (pDocwindowarray[i].docID == _docid)
            {
                if (!FX_SetCurrentWindow(pDocwindowarray[i].hWnd))
                {
                    delete [] pDocwindowarray;
                    return false;
                }
                windowswitched = true;
                break;
            }
        }
        if (!windowswitched) {
            delete [] pDocwindowarray;
            return false;
        }
        /* Window have switched, make sure Enigma contents is correct as well. */
        if (!FX_SetCurrentEnigmaDocument(_docid))
        {
            delete [] pDocwindowarray;
            return false;
        }
        FX_RedrawMusic(NULL);
        _lastdocid = 0;
        return true;
    }
 
    bool Save(const FCString* pFilePath = nullptr);
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
    static int Save_CFunc(lua_State* L)
    {
        return _CFunctionOneOptionalParameter<FCDocument, bool, const FCString*, &FCDocument::Save>(L, nullptr);
    }
#endif
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
    bool Open(const FCString* pFilePath, bool createwindow, const FCString* pUndoString, bool saveedits, bool addtorecents, bool hidedialogs, _state_ptr S);
#else
    bool Open(const FCString* pFilePath, bool createwindow, const FCString* pUndoString, bool saveedits, bool addtorecents, bool hidedialogs, _state_ptr S = nullptr);
#endif
 
#ifdef PDK_FRAMEWORK_LUAFRIENDLY
        bool New(const FCString* pUndoString, bool saveedits, _state_ptr S);
#else
    bool New(const FCString* pUndoString, bool saveedits, _state_ptr S = nullptr);
#endif
 
    bool CloseCurrentDocumentAndWindow(bool saveedits = true, _state_ptr S = nullptr);
    
#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
    static int CloseCurrentDocumentAndWindow_CFunc(lua_State *L)
    {
        return _CFunctionOneOptionalParameterWithState<FCDocument, bool, bool, &FCDocument::CloseCurrentDocumentAndWindow>(L, true);
    }
#endif
 
    bool Close(bool saveedits = true, _state_ptr S = nullptr);
    
#ifdef PDK_FRAMEWORK_LUAFRIENDLY_CPP
    static int Close_CFunc(lua_State *L)
    {
        return _CFunctionOneOptionalParameterWithState<FCDocument, bool, bool, &FCDocument::Close>(L, true);
    }
#endif
 
    bool Print(FCPrintSettings* pSettings);
 
    bool GetDirty() const
    {
        return FX_IsEnigmaDocumentDirty(GetID()) != 0;
    }
 
    void SetDirty(bool state)
    {
        return FX_SetEnigmaDocumentDirty(GetID(), state);
    }
 
#ifdef PDK_FRAMEWORK_DEBUG
    void DebugDump() override
    {
        __FCBase::DebugDump();
        DebugOutInt("Document ID: ", GetID());
        FCString astring;
        GetPath(&astring);
        DebugOutString("Document path: ", astring.GetCString());
    }
#endif
};
 
class FCDocuments : public __FCCollection
{
public:
    const char* ClassName() const override { return "FCDocuments"; }
 
    int LoadAll();
 
    int ForEachWithScope(FCIteratorHandler* pIterator, FCString* pUndoString, _state_ptr S _NOLUACODE(= nullptr));
 
    FCDocument* FindCurrent()
    {
        for (int i = 0; i < GetCount(); i++)
        {
            FCDocument* pObject = (FCDocument*) GetItemAt(i);
            if (pObject->IsCurrent()) return pObject;
        }
        return NULL;
    }
    
    FCDocument* FindID(EDOCID docid)
    {
        for (int i = 0; i < GetCount(); i++)
        {
            FCDocument* pObject = (FCDocument*) GetItemAt(i);
            if (pObject->GetID() == docid) return pObject;
        }
        return NULL;
    }
    
    FCDocument* GetItemAt(int index) const { return (FCDocument*) __FCCollection::GetItemAt(index); }
};
 
 
#endif  /* FF_DOCUMENTS_H */