generator.h

Go to the documentation of this file.

/* ========================================================================= */
/* ------------------------------------------------------------------------- *//*


 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Please read COPYING and README files in root folder
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
/* ------------------------------------------------------------------------- */
/* ========================================================================= */
#ifndef __GENERATOR_INC__
#define __GENERATOR_INC__
//
//
//
//
/*  INCLUDES    ------------------------------------------------------------ */

#include    <scaffold/scaffold.h>

/*  INCLUDES    ============================================================ */
//
//
//
//
/*  DEFINITIONS    --------------------------------------------------------- */

namespace   scaffold    {

/*  DEFINITIONS    ========================================================= */
//
//
//
//
/*  CLASS    --------------------------------------------------------------- */

class Generator     : public List2De, public bbb::VarMap, public MemTrack       {
    BBM_TRACK( Generator );
    
    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */
    
public:
    
#   define VGEN_TEMPLATES   "TEMPLATES"

#   define VGEN_NAME        "NAME"

#   define VGEN_OUTPATH     "OUTPATH"
    
    
    typedef Generator *     (*generatorFactory)     ( Project * p, const QString & s_name );
    
    enum    ExistingPolicy  {
        OVERWRITE, 
        KEEP,
        BLEND
    };
    
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */
    
private:
    
    Project *               parent_;
    
    QString                 name_;
    
    ExistingPolicy          existp_;
    
    static QMap<QString,generatorFactory>   factories_;
    
    
    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */
    
public:
    
    Generator           ( Project * p, const QString & s_name );
    
    virtual             ~Generator      ( void );
    
    inline Project *    parent          ( void ) const
    { return parent_; }
    
    const QString &     name            ( void ) const
    { return name_; }
    
    QString             outputPath      ( void ) const
    { return valueS( VGEN_OUTPATH ); }
    
    ExistingPolicy      overwriteMode   ( void ) const
    { return existp_; }
    
    void                setOverwriteMode( ExistingPolicy new_p )
    { existp_ = new_p; }

    
    /* -------------------------------------------------------------------- */

    

    virtual bool        addTemplate     ( 
            const QString &     s_path
            ) = 0;
    
    virtual bool        generate        ( void ) = 0;
    
    /* ==================================================================== */
    
    
    /* -------------------------------------------------------------------- */

    
    static void         addGeneratorFactory     (
            const QString &     s_gen_name,
            generatorFactory    factory
            );
    
    static void         remGeneratorFactory     (
            const QString &     s_gen_name
            );
    
    static generatorFactory factory             (
            const QString &     s_name
            );
    
    /* ==================================================================== */
    
    
    
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class Generator */

/*  CLASS    =============================================================== */
//
//
//
//

}   //  namespace   scaffold

#endif // __GENERATOR_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */