strmprov.h

#ifndef strmprov_h
#define strmprov_h

/*+
________________________________________________________________________

 (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: strmprov.h,v 1.35 2009-07-22 16:01:14 cvsbert Exp $
________________________________________________________________________

-*/
 
#include "streamconn.h"
class CallBack;
class TaskRunner;
class BufferStringSet;


mClass StreamProvider
{
public:
                StreamProvider(const char* nm=0);
                StreamProvider(const char*,const char*,StreamConn::Type);
    void        set(const char*);
    bool        rename(const char*,const CallBack* cb=0);

    bool        skipFiles(int) const;
    bool        rewind() const;
    bool        offline() const;
    bool        bad() const                             { return isbad_; }

    bool        exists(int forread) const;
    bool        remove(bool recursive=true) const;
    bool        setReadOnly(bool yn) const;
    bool        isReadOnly() const;

    StreamData  makeOStream(bool binary=true) const;
    StreamData  makeIStream(bool binary=true,bool allowpreloaded=true) const;
    bool        executeCommand(bool inbg=false,bool inconsole=false) const;
    void        mkBatchCmd(BufferString& comm) const;

    const char* fullName() const;
    const char* hostName() const                { return hostname_.buf(); }
    const char* fileName() const                { return fname_.buf(); }
    const char* command() const                 { return fname_.buf(); }
    long        blockSize() const               { return blocksize_; }

    void        setHostName( const char* hname ) { hostname_ = hname; }
    void        setFileName( const char* fn )   { fname_ = fn; }
    void        setCommand( const char* fn )    { fname_ = fn; }
    void        setBlockSize( long bs )         { blocksize_ = bs; }
    void        addPathIfNecessary(const char*);
    void        setRemExec( const char* s )             { rshcomm_ = s; }

    StreamConn::Type    type()                          { return type_; }
    bool                isNormalFile() const;

    static const char*  sStdIO();
    static const char*  sStdErr();

    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_;
    BufferString        hostname_;
    BufferString        rshcomm_;

    long                blocksize_;
    bool                isbad_;
    StreamConn::Type    type_;

    void                mkOSCmd(bool) const;
    static StreamData   makePLIStream(int);

    static void sendCBMsg(const CallBack*,const char*);

};

mGlobal bool ExecOSCmd(const char*,bool inbg=false);

mGlobal const char* GetExecCommand(const char* prognm,const char* filenm);

mGlobal bool ExecuteScriptCommand(const char* prognm,const char* filenm);

#endif