markup.h

Go to the documentation of this file.

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


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

#include    <libbbb/libbbb.h>
#include    <QMap>
#include    <QString>
#include    <QtScript/QtScript>

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

namespace   bbb    {

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

class
        BBBSHARED_EXPORT
        Markup          : public QScriptEngine  {
    
    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */
    
public:
    
    #define MARKUP_OPENING  "{{"
    
    #define MARKUP_CLOSING  "}}"
    
    
    #define MARKUP_OPENING_PRINT    "{%"
    
    #define MARKUP_CLOSING_PRINT    "%}"
    
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */
    
protected:
    
    QString     s_temp_output_;

    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */
    
public:
    
    
    Markup          ( void );
    
    virtual         ~Markup         ( void );
    
    bool            executeFile     (
            const QString &         s_file_script,
            QString &               s_error
            );
    

    bool            convertFile     (
            const QString &         s_file_input,
            const QString &         s_file_output,
            QString &               s_error
            );
    

    bool            convertString   (
            const QString &         s_input,
            QString &               s_output,
            QString &               s_error
            );
    

    QString         transform       ( const QString & s_input );
    
    void            appendToOutput  ( const QString & s )
    { s_temp_output_.append( s ); }
    
    const QString & output          ( void ) const
    { return s_temp_output_; }
    
    void            clearOutput     ( void )
    { s_temp_output_.clear(); }
    
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class Markup    */

/*  CLASS    =============================================================== */
//
//
//
//
}   //  namespace   bbb

#endif // __MARKUP_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */