aprillibrary.h

Go to the documentation of this file.

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


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

#include    <april/april.h>
#include    <QObject>
#include    <QSettings>
#include    <QMap>
#include    <libbbb/1/list2d.h>

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

class   AprilPluginInterf;
class   AprilPluginLoader;

namespace   april    {

class   World;
class   Factory;
class   WorldFactory;


typedef Factory *       (*FactoryCreator)   ( World * w, const QString & s_name );


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

class
    APRILSHARED_EXPORT
    AprilLibrary        : public QObject, public MemTrack   {
    APRIL_OBJECT
    BBM_TRACK( AprilLibrary );

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

    friend class World;
    friend class WorldFactory;
    

public:

    struct      LibProps            {



        void save ( QSettings & s );
        
        void load ( QSettings & s );
    };


    /*  DEFINITIONS    ===================================================== */
    //
    //
    //
    //
    /*  DATA    ------------------------------------------------------------ */

private:

    LibProps                        props_;

    List2Dh                         worlds_;

    List2Dh                         plugins_;

    World *                         def_world_;

    QMap<QString,WorldFactory*>     world_factories_;

    QMap<QString,FactoryCreator>    factories_src_;


    static AprilLibrary *           uniq_;


    /*  DATA    ============================================================ */
    //
    //
    //
    //
    /*  FUNCTIONS    ------------------------------------------------------- */

public:


    AprilLibrary            ( QObject * parent = NULL );


    virtual                 ~AprilLibrary       ( void );


    static AprilLibrary *   unique              ( void )
    { return uniq_; }




    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


public:

    void                    loadProps           ( void );


    void                    saveProps           ( void );

    static LibProps &       properties          ( void )
    { Q_ASSERT( uniq_ != NULL ); return uniq_->props_; }


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


public:

    static bool     hasWorld            (
            World *         world
            );

    static void     remWorld            (
            World *         world
            );
    

    static World *          firstWorld      ( void );
    
    static QString          uniqueWorldName ( const QString & pattern );
    
    static int              worldsCount     ( void )
    { return uniq_->worlds_.count(); }
    
    static World *          findWorld       ( const QString & s_name );
    
    static World *          worldAt         ( int i );
    
    static bool             setCrtWorld     (  World * new_crt );
    
    static World *          crtWorld        ( void )
    { return uniq_->def_world_; }
    
    
    
protected:


    static void     addWorld                (
            World *         world
            );

private:

    void            internalAddWorld        ( World * world );

    void            internalRemWorld        ( World * world );


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


public:

    static AprilPluginInterf *  loadPlugIn          ( const QString & s );
    
    static bool                 unloadPlugIn        ( const QString & s );
    
    static bool                 unloadPlugIn        ( AprilPluginInterf * p );
    
    static bool                 unloadPlugIn        ( AprilPluginLoader * pld );
    
    static AprilPluginInterf *  findPlugIn          ( const QString & s );
    
    static AprilPluginLoader *  findPlugInLoader    ( const QString & s );
    
    static AprilPluginInterf *  findPlugInRel       ( const QString & s );
    
    static AprilPluginLoader *  findPlugInLoaderRel ( const QString & s );

    static AprilPluginLoader *  firstPlugin         ( void );

    static int                  pluginsCount        ( void )
    { return uniq_->plugins_.count(); }
    
    static AprilPluginLoader *  pluginAt            ( int i );

    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */


public:
    
    static bool                 registerFactory     ( 
            const QString &         s_name,
            FactoryCreator          callback
            );
    
    static bool                 unregisterFactory       ( 
            const QString &         s_name,
            FactoryCreator          callback
            );

    static QString              defaultWorldFactoryName ( void );
    
    static Factory *            factoryForString    (
            World *                 w, 
            const QString &         s_name
            );


    static WorldFactory *       findWorldFactory        (
            const QString &         s
            );
    
protected:

    static bool                 addWorldFactory     (
            const QString &         s,
            WorldFactory *          inst
            );
            
    static bool                 remWorldFactory     (
            const QString &         s, 
            WorldFactory *          inst
            );
    
private:


    static Factory *            defaultWorldFactoryCreator  ( 
            World *             w,
            const QString &     s_name
            );
    
    void                        registerFactoryCreators     ( void );

    
    /* ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo */



    /*  FUNCTIONS    ======================================================= */
    //
    //
    //
    //

};  /*  class AprilLibrary  */

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

}   //  namespace   april

APRILSHARED_EXPORT bool initAprilLibrary            ( void );

APRILSHARED_EXPORT void endAprilLibrary             ( void );

#endif // __APRILLIBRARY_INC__
/* ------------------------------------------------------------------------- */
/* ========================================================================= */