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


class FCDocument : public __FCBase
{
    static FCString _lastundostring;
    
    EDOCID      _docid;
    EDOCID      _lastdocid;
    FCString    _switchto_undostring;
public:
    
    virtual const char* ClassName() { return "FCDocument"; }

    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(); }

    virtual bool IsIdentical(__FCBase* pCompareObject)
    {
        FCDocument* pOtherDocument = (FCDocument*) pCompareObject;
        return (GetID() == pOtherDocument->GetID());
    }
    
    bool IsUntitled();

    bool GetPath(FCString* pString);

        bool GetPathSpec(void *pathspec, EVERSION convertversion);

    bool SetToCurrent()
    {
        if (_lastdocid != 0) return false;
        _docid = FX_GetCurrentEnigmaDocument();
        return true;
    }

    bool SwitchTo(FCString* pUndoString, bool saveedits);
    
#ifndef DOXYGEN_SHOULD_IGNORE_THIS

    void _DiscardSwitchBack() { _lastdocid = 0; }
#endif /* #ifndef DOXYGEN_SHOULD_IGNORE_THIS */

    bool SwitchBack(bool saveedits);

    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();
    
    bool Open(FCString* pFilePath, bool createwindow, FCString* pUndoString);

        bool CloseCurrentDocumentWindow();

        bool Close();

    bool Print(FCPrintSettings* pSettings);

    bool GetDirty() const
    {
        return FX_IsEnigmaDocumentDirty(GetID()) != 0;
    }

    void SetDirty(bool state)
    {
        return FX_SetEnigmaDocumentDirty(GetID(), state);
    }
    
    static void _SetLastUndoString(FCString* pString)
    {
        _lastundostring.SetString(pString);
    }
    
    static void GetLastUndoString(FCString* pString)
    {
        if (!pString) return;
        pString->SetString(&_lastundostring);
    }

#ifdef PDK_FRAMEWORK_DEBUG
    void DebugDump()
    {
        __FCBase::DebugDump();
        DebugOutDigit("Document ID: ", GetID());
        FCString astring;
        GetPath(&astring);
        DebugOutString("Document path: ", astring.GetCString());
    }
#endif
};

class FCDocuments : public __FCCollection
{
public:
    virtual const char* ClassName() { return "FCDocuments"; }

    int LoadAll();

    int ForEachWithScope(FCIteratorHandler* pIterator, FCString* pUndoString);

    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) { return (FCDocument*) __FCCollection::GetItemAt(index); }
};


#endif  /* FF_DOCUMENTS_H */