DataBase.h

Aller à la documentation de ce fichier.

/*! \file DataBase.h
    \brief Gestion base de données.

    Gestionnaire de base de données avec notion de tables et entrée indexé et libélé. \n

    Fichiers (dans le repertoire "DB"): \n

    DB.sys  : info sur la base \n
        int     Id          : Id d'une table \n
        int     Size        : taille du nom de la table \n
        char    Name[Size]  : nom de la table \n
        ... jusqu'a la fin pour chaque table \n

    x.dbt   : une table (x = Id de la table) \n
        int     NbData      : nombre de Data dans une entrée \n
        int     Size        : taille du nom du label \n
        char    Name[Size]  : nom du label \n
        ... NbData fois pour chaque label\n
        int     NbEntry     : nombre d'entrée \n
        int     Id          : Id de l'entrée \n
        int     Size        : taille de la data \n
        char    Data[Size]  : la data \n
        ... jusqu'a la fin pour chaque entrée \n

    \author     aerith (www.aerith.fr)
    \version    1.0
    \date       01/11/2007
*/

#ifndef INCLUDE_RSRC_DB
#define INCLUDE_RSRC_DB

#include    "../Surcouche/SurcoucheFichier.h"
#include    "DataBaseTable.h"


//! Gestion base de données.
/*! Gestionnaire de base de données avec notion de tables et entrée indexer.
*/
class DataBase
{
private :
    char                            Repertoire[DB_REPERTOIRE];  /*!< Repertoire où ce trouve la base.       */
    int                             NbTable;        /*!< Nombre de tables.                                  */
    std::vector<DataBaseTable *>    Tables;         /*!< Chaque lignes est une table.                       */
    int                             IdMax;          /*!< Contien l'Id maximum des tables.                   */
    static int                      DBInstance;     /*!< Compte les instance de la class.                   */
    static MUTEX                    DBMutex;        /*!< Utiliser des que l'on accede au fichier "DB.sys".  */

    //! Charge le fichier des tables.
    /*! Charge le fichier "DB.sys", d'info sur les tables et la base en memoire.
        \return code d'erreur
    */
    int     LoadTables();

    //! Sauve le fichier des tables.
    /*! Sauve le fichier "DB.sys", d'info sur les tables et la base.
        \return code d'erreur
    */
    int     SaveTables();

public  :
    /*! Charge la base en mémoire.
        \param pRepertoire repertoire de la base.
    */
    DataBase(char *pRepertoire);

    /*! Libere proprement la mémoire, ne sauve pas la base dans les fichiers.
        \sa SaveBase().
    */
    ~DataBase();

    //! Ajoute une table.
    /*! Ajoute une table avec un nouvelle Id.
        \param pName nom de la table
        \param iNbData nombre de champs de la table.
        \return Code d'erreur.
        \sa DelTable(), GetTable(), GetTableNo() et GetNbTable().
    */
    int     AddTable(char *pName, int iNbData);

    //! Supprime une table.
    /*! Supprime la table ayant l'id \a iId.
        \param iId Id de la table.
        \return Code d'erreur.
        \sa AddTable(), GetTable(), GetTableNo() et GetNbTable().
    */
    int     DelTable(int iId);

    //! Supprime une table.
    /*! Supprime la table de nom \a pName.
        \param pName nom de la table.
        \return Code d'erreur
        \sa AddTable(), GetTable(), GetTableNo() et GetNbTable().
    */
    inline int      DelTable(char *pName)
    {
        for(int i = 0; i < NbTable; i++)
        {
            if(!strcmp(Tables[i]->GetName(), pName))
                return DelTable(Tables[i]->GetId());
        }

        return 0;
    };

    //! Retourne une table par son Id.
    /*! Permet l'acces à la table ayant l'id \a iId.
        \param iId Id de la table.
        \return pointeur sur la class de la table.
        \sa AddTable(), DelTable(), GetTable(), GetTableNo() et GetNbTable().
    */
    inline DataBaseTable    *GetTable(int iId)
    {
        for(int i = 0; i < NbTable; i++)
        {
            if(Tables[i]->GetId() == iId)
                return Tables[i];
        }

        return NULL;
    };

    //! Retourne une table par son nom.
    /*! Permet l'acces à la table ayant le nom \a pName.
        \param pName nom de la table.
        \return pointeur sur la class de la table.
        \sa AddTable(), DelTable(), GetTable(), GetTableNo() et GetNbTable().
    */
    inline DataBaseTable    *GetTable(char *pName)
    {
        for(int i = 0; i < NbTable; i++)
        {
            if(!strcmp(Tables[i]->GetName(), pName))
                return Tables[i];
        }

        return NULL;
    };

    //! Retourne une table par sa position.
    /*! Permet l'acces à la table étant à la position \a iPos.
        \param iPos position de la table.
        \return pointeur sur la class de la table.
        \sa AddTable(), DelTable(), GetTable() et GetNbTable().
    */
    inline DataBaseTable    *GetTableNo(int iPos)
    {
        if(iPos < NbTable)
            return Tables[iPos];

        return NULL;
    };

    //! Retourne le nombre de table.
    /*! Retourne le nombre de table contenu dans la base.
        \return nombre de table dans la base.
        \sa AddTable(), DelTable(), GetTable() et GetTableNo().
    */
    inline int      GetNbTable()
    {
        return NbTable;
    };

    //! Retourne le nombre d'instance.
    /*! Retourne le nombre d'instance de la class (pour multitache).
        \return nombre d'instance de la class.
    */
    inline int      GetNbInstance()
    {
        return DBInstance;
    };

    //! Retourne le repertoire de la base.
    /*! Retourne le repertoire \a Repertoire de la base.
        \return pointeur sur \a Repertoire.
    */
    inline char     *GetBaseDir()
    {
        return Repertoire;
    };

    //! Sauve la base.
    /*! Sauve toute la base dans les fichiers "DB.sys" et "x.dbt".
        \return code d'erreur
    */
    int     SaveBase();
};

#endif

---