saveablemanager.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Bert
 Date:          July 2016
________________________________________________________________________

-*/

#include "saveable.h"
#include "objectset.h"
class ChangeRecorder;
class IOObjContext;


mExpClass(General) SaveableManager : public NamedMonitorable
{ mODTextTranslationClass(SaveableManager)
public:

    typedef ::DBKey                             ObjID;
    typedef ObjectSet<Saveable>::size_type      size_type;
    typedef size_type                           IdxType;

                        ~SaveableManager();

    bool                nameExists(const char*) const;
    bool                canSave(const ObjID&) const;
    uiRetVal            save(const ObjID&) const;
    uiRetVal            saveAs(const ObjID& curid,const ObjID& newid) const;
    bool                needsSave(const ObjID&) const;
    void                setJustSaved(const ObjID&) const;

    bool                isValidID(const ObjID&) const;
    bool                isLoaded(const char*) const;
    bool                isLoaded(const ObjID&) const;
    void                getAllLoaded(DBKeySet&) const;
    ObjID               getIDByName(const char*) const;
    IOPar               getIOObjPars(const ObjID&) const;
    BufferString        nameOf(const ObjID&) const;

                        // Use MonitorLock when iterating
    IdxType             size() const;
    ObjID               getIDByIndex(IdxType) const;
    IOPar               getIOObjParsByIndex(IdxType) const;

    CNotifier<SaveableManager,ObjID>    ObjOrphaned;
    CNotifier<SaveableManager,ObjID>    UnsavedObjLastCall;
    CNotifier<SaveableManager,ObjID>    ShowRequested;
    CNotifier<SaveableManager,ObjID>    HideRequested;
    CNotifier<SaveableManager,ObjID>    VanishRequested;

    CNotifier<SaveableManager,ObjID>    ObjAdded;
    void                clearChangeRecords(const ObjID&);
    void                getChangeInfo(const ObjID&,
                                  uiString& undotxt,uiString& redotxt) const;
    bool                useChangeRecord(const ObjID&,bool forundo);

    enum DispOpt        { Show, Hide, Vanish };
    void                displayRequest(const DBKey&,DispOpt=Show);

protected:

                        SaveableManager(const IOObjContext&,bool autosv,
                                        bool tempobjsonly=false);

    virtual Saveable*   getSaver(const SharedObject&) const     = 0;
    virtual ChangeRecorder* getChangeRecorder(const SharedObject&) const
                                                                { return 0; }
    virtual void        addCBsToObj(const SharedObject&);
    virtual void        setAuxOnAdd()                           {}

    ObjectSet<Saveable> savers_;
    ObjectSet<ChangeRecorder> chgrecs_;
    const IOObjContext& ctxt_;
    const bool          autosaveable_;
    const bool          tempobjsonly_;

                        // to be called from public obj-type specific ones
    ObjID               getID(const SharedObject&) const;
    uiRetVal            store(const SharedObject&,const IOPar*) const;
    uiRetVal            store(const SharedObject&,const ObjID&,
                              const IOPar*) const;
    uiRetVal            save(const SharedObject&) const;
    bool                needsSave(const SharedObject&) const;
    IOObj*              getIOObj(const DBKey&) const;
    IOObj*              getIOObjByName(const char*) const;

                        // Tools for locked state
    void                setEmpty();
    IdxType             gtIdx(const char*) const;
    IdxType             gtIdx(const ObjID&) const;
    IdxType             gtIdx(const SharedObject&) const;
    SharedObject*       gtObj(IdxType) const;
    const Saveable*     saverFor(const ObjID&) const;
    uiRetVal            doSave(const ObjID&) const;
    void                add(const SharedObject&,const ObjID&,AccessLocker&,
                                const IOPar*,bool) const;

    void                dbmEntryRemovedCB(CallBacker*);
    void                survChgCB(CallBacker*);
    void                appExitCB(CallBacker*);
    void                objDelCB(CallBacker*);
    void                objChgCB(CallBacker*);

public:

    SaveableManager*    clone() const           { return 0; }
    void                handleUnsavedLastCall();

                        // intended only for dedicated loaders
    void                addNew(const SharedObject&,const ObjID&,
                                const IOPar*,bool) const;

};


#define mDeclareSaveableManagerInstance(typ) \
    static typ& getInstance(); \
    typ*        clone() const   { return 0; } \
    mDeclInstanceCreatedNotifierAccess(typ)

#define mDefineSaveableManagerInstance(typ) \
mDefineInstanceCreatedNotifierAccess(typ) \
 \
static typ* theinst_ = 0; \
static Threads::Lock theinstcreatelock_(true); \
 \
typ& typ::getInstance() \
{ \
    if ( !theinst_ ) \
    { \
        Threads::Locker locker( theinstcreatelock_ ); \
        if ( !theinst_ ) \
            theinst_ = new typ; \
    } \
    return *theinst_; \
}


#define mDefineStdFns(typ) \
    ObjID               getID( const char* nm ) const \
                        { return SaveableManager::getID(nm); } \
    ObjID               getID( const SharedObject& obj ) const \
                        { return SaveableManager::getID(obj); } \
    ObjID               getID(const typ&) const; \
    uiRetVal            store(const typ&,const IOPar* ioobjpars=0) const; \
    uiRetVal            store(const typ&,const ObjID&,const IOPar* p=0) const; \
    uiRetVal            save(const typ&) const; \
    bool                needsSave(const typ&) const