scaffold.h

Go to the documentation of this file.

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


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

#include    <libbbb/rexscript.h>
#include    <libbbb/memtrack.h>
#include    <libbbb/varmap.h>
#include    <libbbb/list2d.h>
#include    <libbbb/exit-codes.h>

#include    <scaffold/scaffold_debug.h>
#include    <scaffold/scaffold_global.h>
#include    <scaffold/scaffold_config.h>
#include    <scaffold/scaffold_version.h>
#include    <scaffold/scafrex.h>
#include    <scaffold/diff_match_patch.h>

#include    <QDebug>
#include    <QString>
#include    <QStringList>
#include    <QList>
#include    <QVector>
#include    <QRegExp>

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

class   QCoreApplication;

namespace   scaffold    {
class   Project;

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

class Scaffold      : public MemTrack       {
    BBM_TRACK( Scaffold );
    
    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */
    
public:
    

    enum LogTypes       {
        LOG_PROJECTS   = 0x0000100, 
        LOG_GENERATORS = 0x0000200, 
        LOG_GENFILES = 0x0000400,   
        LOG_ALL = 
        bbb::RexScript::LOG_ALL | 
        LOG_PROJECTS | LOG_GENERATORS | 
        0 
    };
    
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */
    
private:
    
    Scafrex                     srex_;
    
    List2Dh                     projects_;
    
    Project *                   project_crt_;
    
    diff_match_patch            dmp_;
    
    static Scaffold *           uniq_;
    
    
    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */
    
private:
    
    
    Scaffold                (
            const QStringList &     init_files,
            const bbb::VarMap &     var_map         
            );
    
    virtual             ~Scaffold       ( void );
    
    
public:
    
    static Scaffold *   unique          ( void )
    { return uniq_; }
    
    
    static bool         init            ( 
            const QStringList &     init_files,
            const bbb::VarMap &     var_map
            );
    
    static ExitCode     perform         ( QCoreApplication & app );
    
    static void         end             ( void );
    
    static Scafrex *    scafrex         ( void )
    { return &uniq_->srex_; }
    

    bool                initDMP         ( void );
    
    static bool         blendTwoFiles   (
            const QString &     s_path_1,
            const QString &     s_path_2
            );
    
    static bool         readTextFile    (
            const QString &     s_path,
            QString &           s_out
            );
    
    static bool         writeTextFile   (
            const QString &     s_path,
            const QString &     s_out
            );
    
    
    /* -------------------------------------------------------------------- */

    
    static int          findProjectId       ( const QString & s_name );
    
    static int          findProjectId       ( const Project * trg );
    
    static Project *    findProject         ( const QString & s_name );
    
    static Project *    getProject          ( const QString & s_name );
    
    static Project *    currentProject      ( void )
    { return uniq_->project_crt_; }
    
    static Project *    getValidProject     ( void );
    
    static Project *    getValidProject     (  const QString & s_name );
    
    static Project *    startProject        ( 
            const QString &         s_name
            );
    
    QString             defaultProjectPath  ( void );
    
    /* ==================================================================== */
    
    
    /* -------------------------------------------------------------------- */

    
    static Generator *      getValidGenerator   ( void );
    
    static Generator *      getValidGenerator   ( const QString & s_name );
    
    /* ==================================================================== */
    
    
    /* -------------------------------------------------------------------- */

    
    static inline void      fileError       ( const QString & s ) {
        uniq_->srex_.fileError( s );
    }
    
    static inline void      error           ( const QString & s ) {
        uniq_->srex_.error( s );
    }
    
    static inline void      info            ( const QString & s ) {
        uniq_->srex_.info( s );
    }
    
    static inline void      log             ( int ty, const QString & s ) {
        uniq_->srex_.log( ty, s );
    }
    
    /* ==================================================================== */
    
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class SCAFFOLD  */

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

}   //  namespace   scaffold

#endif // __SCAFFOLD_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */