maddefs.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     : June 2007
 * ID       : $Id$
-*/
 
#include "madagascarmod.h"
#include "bufstringset.h"
#include "uistring.h"
 
class Executor;
 
namespace ODMad
{
 
mClass(Madagascar) ProgDef
{ mODTextTranslationClass(ProgDef);
public:
 
                                ProgDef() : group_(0) {}
    BufferString                name_;
    BufferString                shortdesc_;
    BufferString                synopsis_;
    BufferString                comment_;
    const BufferString*         group_; 
 
};
 
 
/* Scans $RSFROOT/doc/txt directory for program definitions */
 
mExpClass(Madagascar) ProgInfo
{ mODTextTranslationClass(ProgInfo);
public:
 
    bool                scanned() const         { return scanned_; }
    Executor*           getScanner() const;
 
    const uiString&     errMsg() const          { return errmsg_; }
 
    const ObjectSet<ProgDef>&   defs() const    { return defs_; }
    const BufferStringSet&      groups() const  { return groups_; }
    void                        search(const char* globexpr,
                                       ObjectSet<const ProgDef>&) const;
 
                        ProgInfo();
                        ~ProgInfo()             { cleanUp(); }
 
protected:
 
    BufferString        rsfroot_;
    BufferString        defdir_;
    uiString            errmsg_;
    bool                scanned_;
    BufferStringSet     groups_;
    ObjectSet<ProgDef>  defs_;
 
    void                cleanUp();
    void                doPreScanCheck();
    void                addEntry(const char*);
 
    friend class        ProgInfoScanner;
    mGlobal(Madagascar) friend  ProgInfo& PI();
};
 
mGlobal(Madagascar) ProgInfo& PI();
 
 
 
} // namespace ODMad