strmprov.h

Go to the documentation of this file.

#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$
________________________________________________________________________

-*/

#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* nm=0);
    void        set(const char*);

    inline bool isBad() const                   { return fname_.isEmpty(); }

    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;

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

    void        setFileName( const char* fn );
    void        setCommand(const char* cmd, const char* hostnm=0);
    void        addPathIfNecessary(const char*);

    bool        isFile() const                  { return !iscomm_; }
    bool        isCommand() const               { return iscomm_; }

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

    static StreamData   makePLIStream(int);
    void                mkOSCmd(BufferString&) const;

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

};



#endif