aprilmodule.h

Go to the documentation of this file.

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


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

#include    <april/april.h>
#include    <libbbb/1/refcnt.h>
#include    <april/logic/uniqueid.h>

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

namespace   april    {

class   World;
class   AaTkString;
class   AaToken;
class   CommandMap;
class   Actor;

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

class
        APRILSHARED_EXPORT
        AprilModule     : public libbbb::RefCnt, public MemTrack        {
    BBM_TRACK( AprilModule );
    
    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */
    
private:
    
    CommandMap *            cmd_map_;
    
    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */
    
public:
    
    AprilModule         ( CommandMap * cmd_map );
    
protected:
    
    virtual             ~AprilModule        ( void );
    
public:
    
    virtual void        insertCommands  ( CommandMap * cm ) = 0;
    
    virtual void        removeCommands  ( CommandMap * cm ) = 0;
    
    virtual QString     name            ( void ) = 0;
    
    inline CommandMap * cmdMap          ( void ) const 
    { return cmd_map_; }
    
    
public:
    static void errorNumberOfArguments(QString &s_err);
    static void errorOneArgumentExpected(QString &s_err);
    static void errorNoAssocFile(World *w, QString &s_err);
    static void errorEnergyInteger(QString &s_err);
    static void errorUnknownOption(QString &s_err, const QString &s_tk);
    static void errorIntegerExpected(QString &s_err, const QString &s_tk);
    static void errorIdExpected(QString &s_err, const QString &s_tk);
    static void errorNoCurrentWorld(QString &s_err);
    
public:
    
    static QString      getCLUsage      ( const QString & s_name );
    
    static bool         setUsage        (
            const QString &                 s_name,
            const QStringList &             usage,
            const QStringList &             usage_descr,
            const QStringList &             opts,
            const QList<QStringList> &      opts_descr,
            const QStringList &             obs
            );
    
    
    typedef QString ( * arg0Func)   ( void );
    
    typedef QString ( * arg1Func)   ( const QString & s_arg_1, const AaToken & tk1 );
    
    typedef QString ( * arg0WFunc)  ( World * w );
    
    typedef QString ( * arg1WFunc)  ( 
            World *                 w, 
            const QString &         s_arg_1, 
            const AaToken &         tk1
            );
    
    typedef QString ( * argW2Func)  ( 
            World * w, const QString & s_arg_1, const AaToken & tk1,
            const QString & s_arg_2, const AaToken & tk2 );
    
    typedef QString ( * argA0Func)  ( Actor * a );
    
    typedef QString ( * argAIdFunc) ( Actor * a, ID id );
    
    
    
    static bool         getUIntArg      (
            const AaTkString &      atks,
            int                     i,
            QString &               s_err,
            quint64 *               val
            );
    
protected:
    
    static bool         funcArg0        (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            arg0Func                kb
            );
    
    static bool         funcArg1        (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            arg1Func                kb
            );
    
    static bool         funcArg0W       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            arg0WFunc               kb
            );
    
    static bool         funcArg1W       (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            arg1WFunc               kb
            );
    
    
    static bool         funcArg_W2      (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            argW2Func               kb
            );
    
    
    static bool         funcArg_A0      (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            argA0Func               kb
            );
    
    static bool         funcArg_AID     (
            const QString &         s_cmd,
            const AaTkString &      atks,
            QString &               s_err,
            argAIdFunc              kb
            );
    
    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class AprilModule   */

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

}   //  namespace   april

#endif // __APRILMODULE_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */