strmprov.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:          17-5-1995
 Contents:      Generalized stream opener.
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
#include "basicmod.h"
#include "strmdata.h"
#include "bufstring.h"
#include "oscommand.h"
class CallBack;
class TaskRunner;
class BufferStringSet;
 
 
 
mExpClass(Basic) StreamProvider
{
public:
                StreamProvider(const char* filenm=nullptr);
                StreamProvider(const OS::MachineCommand&,
                               const char* workdir);
                ~StreamProvider();
 
    void        setFileName(const char*);
    void        setCommand(const OS::MachineCommand&,const char* workdir);
 
    bool        isBad() const;
 
    const char* fileName() const        { return fname_.buf(); }
    bool        exists(bool forread) const;
    bool        remove(bool recursive=true) const;
    bool        setReadOnly(bool yn) const;
    bool        isReadOnly() const;
    bool        rename(const char*,const CallBack* cb=0);
 
    StreamData  makeOStream(bool binary=true,bool editmode=false) const;
    StreamData  makeIStream(bool binary=true,bool allowpreloaded=true) const;
 
    void        addPathIfNecessary(const char*);
 
    bool        isFile() const          { return !mc_; }
    bool        isCommand() const       { return mc_; }
 
    static const char*  sStdIO();
    static const char*  sStdErr();
 
    // Pre-load interface
    static bool         isPreLoaded(const char*,bool isid);
    static bool         preLoad(const char*,TaskRunner&,const char* id);
    static bool         preLoad(const BufferStringSet&,TaskRunner&,
                                const char* id);
    static void         getPreLoadedIDs(BufferStringSet&);
    static void         getPreLoadedFileNames(const char* id,BufferStringSet&);
    static int          getPreLoadedDataPackID(const char*);
    static void         unLoad(const char*,bool isid=false);
    static void         unLoadAll();
 
protected:
 
    BufferString        fname_;
    OS::MachineCommand* mc_ = nullptr;
    BufferString        workingdir_;
 
    static StreamData   makePLIStream(int);
 
    static void         sendCBMsg(const CallBack*,const char*);
 
private:
                        StreamProvider(const StreamProvider&)   = delete;
    StreamProvider&     operator=(const StreamProvider&)        = delete;
 
public:
 
    mDeprecatedDef void set(const char* inp);
 
    static StreamData createIStream(const char*,bool binary=true);
    static StreamData createOStream(const char*,bool binary=true,
                                    bool inplaceedit=false);
};