batchprog.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:          14-9-1998
________________________________________________________________________

 Batch programs should include this header, and define a BatchProgram::go().
 If program args are needed outside this method, BP() can be accessed.

*/

#include "batchmod.h"
#include "prog.h"
#include "namedobj.h"
#include "bufstringset.h"
#include "genc.h"
#include "od_iostream.h"
#include "oscommand.h"

class CommandLineParser;
class IOObj;
class IOObjContext;
class MMSockCommunic;
class JobCommunic;
class StreamData;

mClass(Prog) BatchProgram : public NamedCallBacker
{ mODTextTranslationClass(BatchProgram);
    mGlobal(Batch) friend       BatchProgram& BP();

public:

    const IOPar&                pars() const    { return *iopar_; }
    IOPar&                      pars()          { return *iopar_; }

    const CommandLineParser&    clParser()      { return *clparser_; }

    bool                go(od_ostream& log_stream);

    mExp(Batch) IOObj*  getIOObjFromPars(const char* keybase,bool mknew,
                                         const IOObjContext& ctxt,
                                         bool msgiffail=true) const;

    mExp(Batch) bool    pauseRequested() const;

    mExp(Batch) bool    errorMsg( const uiString& msg, bool cc_stderr=false);
    mExp(Batch) bool    infoMsg( const char* msg, bool cc_stdout=false);

    mExp(Batch) static void     deleteInstance();


    static const char*  sKeyDataDir()   { return "datadir"; }
    static const char*  sKeyFinishMsg() { return "Finished batch processing."; }
    static bool         doImport( od_ostream& strm, IOPar& iop, bool is2d );
    static bool         doExport( od_ostream& strm, IOPar& iop, bool is2d );

protected:

    friend int          Execute_batch(int*,char**);

    //friend class      JobCommunic;

                        BatchProgram();
                        ~BatchProgram();

    mExp(Batch) void    init();
    static BatchProgram* inst_;


    bool                stillok_;
    bool                inbg_;
    StreamData&         sdout_;
    IOPar*              iopar_;
    CommandLineParser*  clparser_;

    BufferStringSet     requests_;

    mExp(Batch) bool    initOutput();
    mExp(Batch) void    progKilled(CallBacker*);
    mExp(Batch) void    killNotify( bool yn );

    JobCommunic*        mmComm()                { return comm_; }
    int                 jobId()                 { return jobid_; }

private:

    JobCommunic*        comm_;
    int                 jobid_;

};


int Execute_batch(int*,char**);
mGlobal(Batch) BatchProgram& BP();

#define mRetJobErr(s) \
{  \
    if ( comm_ ) comm_->setState( JobCommunic::JobError ); \
    mRetError(s) \
}


#define mRetError(s) \
{ errorMsg(toUiString(s)); mDestroyWorkers; return false; }

#define mRetHostErr(s) \
{  \
    if ( comm_ ) comm_->setState( JobCommunic::HostError ); \
        mRetError(toUiString(s)) \
}

#define mStrmWithProcID(s) \
strm << "\n[" << process_id << "]: " << s << "." << od_newline

#define mMessage(s) \
strm << s << '.' << od_newline

#define mSetCommState(State) \
if ( comm_ ) \
{ \
    comm_->setState( JobCommunic::State ); \
    if ( !comm_->updateState() ) \
        mRetHostErr( comm_->errMsg() ) \
}

#ifdef __prog__
# ifdef __win__
#  include "_execbatch.h"
# endif
#define mMainIsDefined
    int main( int argc, char** argv )
    {
        SetProgramArgs( argc, argv );
        int ret = Execute_batch(&argc,argv);
        ExitProgram( ret );
        return ret;
    }

#endif // __prog__