safefileio.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:          Nov 2004
________________________________________________________________________

-*/

#include "basicmod.h"

#include "od_iostream.h"
#include "uistring.h"


mExpClass(Basic) SafeFileIO
{ mODTextTranslationClass(SafeFileIO);
public:

                        SafeFileIO(const char*,bool locked=false);
                        ~SafeFileIO();

    bool                open(bool forread,bool ignorelock=false);
    uiString            errMsg() const          { return errmsg_; }
    uiString            warnMsg() const         { return warnmsg_; }
    od_istream&         istrm();
    od_ostream&         ostrm();

    void                closeFail( bool keeplock=false )
                        { doClose( keeplock, false ); }
    bool                closeSuccess( bool keeplock=false )
                        { return doClose( keeplock, true ); }

    const char*         fileName() const        { return filenm_.buf(); }

    // Some setup variables
    bool                usebakwhenmissing_;     
    bool                removebakonsuccess_;    
    int                 lockretries_;           
    double              lockwaitincr_;          
    bool                allowlockremove_;       

    bool                remove();

protected:

    const bool          locked_;
    const BufferString  filenm_;
    const BufferString  lockfnm_;
    const BufferString  bakfnm_;
    const BufferString  newfnm_;
    od_stream*          strm_;
    mutable uiString    errmsg_;
    mutable uiString    warnmsg_;

    bool                openRead(bool);
    bool                openWrite(bool);
    bool                commitWrite();
    bool                doClose(bool, bool);

    bool                haveLock() const;
    bool                waitForLock() const;
    void                mkLock(bool);
    void                rmLock();
};



mExpClass(Basic) SafeWriteHelper
{ mODTextTranslationClass(SafeWriteHelper);
public:

                        SafeWriteHelper(const char*,bool keepbak=false);
                        ~SafeWriteHelper();

    od_ostream&         stream()                { return strm_; }

    bool                commit();
    void                rollback();

protected:

    od_ostream          strm_;
    bool                closed_;
    const bool          keepbak_;
    const BufferString  fnm_;

    void                closeStream();

};