ioman.h

Go to the documentation of this file.

#pragma once
 
/*+
________________________________________________________________________
 
 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          3-8-1995
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
 
#include "generalmod.h"
#include "ctxtioobj.h"
#include "multiid.h"
#include "namedobj.h"
#include "surveydisklocation.h"
 
class CommandLineParser;
class CtxtIOObj;
class IODir;
class IOMManager;
class IOObj;
class IOObjContext;
class IOSubDir;
class SurveyInfo;
class SurveyDataTreePreparer;
class SurveyDiskLocation;
 
extern "C" {
 
mGlobal(General) const char* setDBMDataSource(const char* fullpath,
                                              bool refresh=false);
}
 
mExpClass(General) IOMan : public NamedCallBacker
{ mODTextTranslationClass(IOMan);
public:
 
    bool                isBad() const           { return state_ != Good; }
    bool                isReady() const;
    const OD::String&   message() const         { return msg_; }
 
    bool                isUsable(const DBKey&) const;
    bool                isUsable(const MultiID&) const;
    bool                implExists(const MultiID&) const;
    bool                isReadOnly(const MultiID&) const;
    bool                isManagedObject(const MultiID&) const;
    bool                implRename(const MultiID&,const char* newnm,
                                   const CallBack* cb=nullptr);
    bool                implReloc(const MultiID&,const char* newdir,
                                   const CallBack* cb=nullptr);
    bool                implRemove(const MultiID&,
                                   bool rmentry=false,uiRetVal* uirv=nullptr);
    bool                implRemove(const IOObj&) const;
 
    void                removeUnusable(DBKeySet&);
    IOObj*              get(const DBKey&) const;
    IOObj*              get(const MultiID&) const;
    IOObj*              getLocal(const char* objname,const char* tgname) const;
    IOObj*              getOfGroup(const char* tgname,bool first=true,
                                   bool onlyifsingle=false) const;
    IOObj*              getIfOnlyOne( const char* trgroupname )
                        { return getOfGroup(trgroupname,true,true); }
    IOObj*              getFirst(const IOObjContext&,int* nrpresent=0) const;
    IOObj*              getFromPar(const IOPar&,const char* basekey,
                                   const IOObjContext&,bool mknew,
                                   BufferString& errmsg) const;
    IOObj*              get(const char* objname,const char* tgname) const;
    IOObj*              get(const IOObjContext&,const char* objnm) const;
 
    bool                isPresent(const MultiID&) const;
    bool                isPresent(const char*,const char* tgname=0) const;
    const MultiID&      key() const;            
    const char*         curDirName() const;     
    const char*         rootDir() const         { return rootdir_; }
    bool                isKey(const char* keystr) const;
    const char*         nameOf(const char* keystr) const;
    const char*         objectName(const DBKey&) const;
 
    MultiID             createNewKey(const MultiID& dirkey);
 
    bool                to(const MultiID&,bool force_reread=false);
    bool                toRoot(bool force_reread=false)
                        { return to(0,force_reread); }
 
    void                getEntry(CtxtIOObj&,bool newistmp=false,
                                 int translidxingroup=-1);
    bool                commitChanges(const IOObj&);
    bool                permRemove(const MultiID&);
 
    const char*         surveyName() const;
 
    mExpClass(General) CustomDirData
    {
    public:
                        CustomDirData( const char* selkey, const char* dirnm,
                                        const char* desc="Custom data" )
                            : selkey_(selkey)
                            , dirname_(dirnm)
                            , desc_(desc)               {}
 
        MultiID         selkey_; 
        BufferString    dirname_; 
        BufferString    desc_; 
 
        bool            operator ==( const CustomDirData& cdd ) const
                        { return selkey_ == cdd.selkey_; }
    };
 
    static const MultiID& addCustomDataDir(const CustomDirData&);
 
    Notifier<IOMan>     newIODir;
    Notifier<IOMan>     entryRemoved;       
    Notifier<IOMan>     entryAdded;
    Notifier<IOMan>     entryChanged;
    Notifier<IOMan>     surveyToBeChanged;  
    Notifier<IOMan>     surveyChanged;      
    Notifier<IOMan>     afterSurveyChange;  
    Notifier<IOMan>     applicationClosing; 
 
    static bool         isValidDataRoot(const char* dirnm);
    static bool         isValidSurveyDir(const char* dirnm);
 
    static void         setTempSurvey(const SurveyDiskLocation&);
    static void         cancelTempSurvey();
 
private:
 
    enum State          { Bad, NeedInit, Good };
 
    BufferString        rootdir_;
    State               state_;
    IODir*              dirptr_;
    int                 curlvl_;
    BufferString        msg_;
    bool                survchgblocked_;
    mutable Threads::Lock lock_;
 
    void                init();
    void                reInit(bool dotrigger);
                        IOMan(const char* rd=0);
                        ~IOMan();
 
    static IOMan*       theinst_;
    static void         setupCustomDataDirs(int);
 
    bool                setDir(const char*);
    int                 levelOf(const char* dirnm) const;
    int                 curLevel() const        { return curlvl_; }
    bool                to(const IOSubDir*,bool);
    bool                doReloc(const MultiID&,Translator*,IOStream&,IOStream&,
                                const CallBack* cb=nullptr);
    IOObj*              crWriteIOObj(const CtxtIOObj&,const MultiID&,int) const;
 
    friend class        IOMManager;
    friend class        SurveyDataTreePreparer;
    friend mGlobal(General)     IOMan&  IOM();
 
public:
 
    // Don't use these functions unless you really know what you're doing
 
    bool                setRootDir(const char*);
    static bool         validSurveySetup(BufferString& errmsg);
    static IOSubDir*    getIOSubDir(const CustomDirData&);
 
    void                setChangeSurveyBlocked( bool yn )
                                        { survchgblocked_ = yn; }
    bool                changeSurveyBlocked() const
                                        { return survchgblocked_; }
    void                applClosing()   { applicationClosing.trigger(); }
    static bool         newSurvey(SurveyInfo* newsi=0);
    static bool         setSurvey(const char*);
    static void         surveyParsChanged();
    uiRetVal            setDataSource(const char* dataroot,const char* survdir,
                                      bool refresh=false);
    uiRetVal            setDataSource(const char* fullpath,bool refresh=false);
    uiRetVal            setDataSource(const IOPar&,bool refresh=false);
    uiRetVal            setDataSource(const CommandLineParser&,
                                      bool refresh=false);
    BufferString        fullSurveyPath() const;
    IODir*              getDir(const char* trlgrpnm) const;
    IODir*              getDir(IOObjContext::StdSelType) const;
    IODir*              getDir(const MultiID&) const;
};
 
 
mGlobal(General) IOMan& IOM();
 
 
mExpClass(General) SurveyChanger
{
public:
                                SurveyChanger(const SurveyDiskLocation&);
                                ~SurveyChanger();
 
    static bool                 hasChanged();
    static SurveyDiskLocation   changedToSurvey();
 
private:
    bool                        needscleanup_   = false;
};