od_stream.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:          Sep 2013
________________________________________________________________________

-*/

#include "basicmod.h"

#include "bufstring.h"
#include "strmdata.h"
#include "uistring.h"
#include "od_iosfwd.h"
#include <iosfwd>
namespace File { class Path; }



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

    typedef od_stream_Count     Count;
    typedef od_stream_Pos       Pos;

    virtual                     ~od_stream();

    bool                        isOK() const;   
    bool                        isBad() const;  

    uiString                    errMsg() const;
    bool                        forRead() const;
    bool                        forWrite() const;
    bool                        isLocal() const;

    enum Ref                    { Abs, Rel, End };
    Pos                         position() const;
    void                        setPosition(Pos,Ref r=Abs);
    Pos                         endPosition() const;

    const char*                 fileName() const;
    void                        setFileName(const char*);

    inline StreamData&          streamData()                    { return sd_; }
    inline const StreamData&    streamData() const              { return sd_; }

    void                        setNoClose( bool yn=true )      { noclose_=yn; }
    void                        close();

    void                        addErrMsgTo(BufferString&) const;
    void                        addErrMsgTo(uiString&) const;
    void                        addErrMsgTo(uiRetVal&) const;
    static od_stream*           create(const char*,bool forread,
                                           uiString& errmsg);
    static const char*          sStdIO();

protected:

                        od_stream();
                        od_stream(const char*,bool,bool editmode=false);
                        od_stream(const File::Path&,bool,bool editmode=false);
                        od_stream(std::ostream*);
                        od_stream(std::ostream&);
                        od_stream(std::istream*);
                        od_stream(std::istream&);
    od_stream&          operator=(const od_stream&)             = delete;

    StreamData          sd_;
    bool                mine_           = true;
    bool                noclose_        = false;
    mutable uiString    errmsg_;

};