commandmap.h

Go to the documentation of this file.

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


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

#include    <april/april.h>
#include    <QMap>

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

namespace   april    {

class   AaTkString;
class   AprilModule;

typedef bool    (*cmdCallBack)  (
        const QString &         s_cmd,
        const AaTkString &      atks,
        QString &               s_err
        );

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

class
    APRILSHARED_EXPORT
    CommandMap      : public MemTrack       {
    BBM_TRACK( CommandMap );

    //
    //
    //
    //
    /*  DEFINITIONS    ----------------------------------------------------- */

    typedef QMap<QString,cmdCallBack>                       CmdList;
    typedef QMap<QString,cmdCallBack>::Iterator             CmdIter;
    
    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:

    CmdList                     cmd_list_;

    bool                        b_exit_;
    
    QList<AprilModule*>         modules_;
    
    static CommandMap *         def_inst_;
    
    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */

public:

    CommandMap          ( void );

    virtual             ~CommandMap     ( void );


    bool                addCommand      ( const QString & s_cmd, cmdCallBack kb );

    bool                remCommand      ( const QString & s_cmd, cmdCallBack kb );
    
    QStringList         commands        ( void ) const;

    bool                addModule       ( AprilModule * m );

    bool                remModule       ( AprilModule * m );
    
    QStringList         modules         ( void ) const;

    
    void                execute         ( const QString & s_input );
    
    bool                shouldExit      ( void ) const
    { return b_exit_; }
    
    bool                shouldContinue  ( void ) const
    { return b_exit_ == false; }

    static CommandMap * defaultInstance ( void );

    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //
    
};  /*  class CommandMap    */

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

}   //  namespace   april

#endif // __COMMANDMAP_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */