ioman.h

Go to the documentation of this file.

#ifndef ioman_h
#define ioman_h

/*+
________________________________________________________________________

 (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 "namedobj.h"
#include "multiid.h"

class CtxtIOObj;
class IODir;
class IOObj;
class IOObjContext;
class IOSubDir;
class SurveyInfo;
class SurveyDataTreePreparer;

mExpClass(General) IOMan : public NamedObject
{
public:

    bool                isBad() const           { return state_ != Good; }
    bool                isReady() const;
    const OD::String&   message() const         { return msg_; }

    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;

    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;

    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>     surveyToBeChanged;  
    Notifier<IOMan>     surveyChanged;      
    Notifier<IOMan>     afterSurveyChange;  
    Notifier<IOMan>     applicationClosing; 

    static bool         isValidDataRoot(const char* dirnm);
    static bool         isValidSurveyDir(const char* dirnm);

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);
    IOObj*              crWriteIOObj(const CtxtIOObj&,const MultiID&,int) const;

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


mGlobal(General) IOMan& IOM();


#endif