Ini.h

Aller à la documentation de ce fichier.

/*! \file Ini.h
    \brief Gestion de fichier ini.

    Utilisation de fichier structurer .ini.

    \author     aerith (http://aerith.fr)
    \version    1.0
    \date       01/07/2008
*/

#ifndef INCLUDE_RSRC_INI
#define INCLUDE_RSRC_INI

#include    "IniSection.h"
#include    "../Surcouche/SurcoucheMultitache.h"
#include    "../Tools/Tools.h"
#include    <stdio.h>
#include    <vector>
#include    <string>

using namespace std;


#define     INI_BUFFERSIZE      10240           /*!< Taille buffer de travaille.                        */

//! Gestion de fichier ini.
/*! Utilisation de fichier structurer .ini.
*/
class Ini
{
private :
    string                      fileName;       /*!< Nom du fichier.                                    */
    std::vector<IniSection *>   sections;       /*!< Chaque lignes est une section.                     */
    static unsigned int         iniInstance;    /*!< Compte les instance de la class.                   */
    static MUTEX                iniMutex;       /*!< Utiliser des que l'on accede à un fichier.         */
    IniSection                  *sectionVide;   /*!< Section vide pour évité les segfault.              */

public  :
    /*! Charge le fichier ini en mémoire.
        \param pName nom du fichier ini
    */
    Ini(const char *pName);

    /*! Libere proprement la mémoire, ne sauve pas dans le fichier.
        \sa SaveIni().
    */
    ~Ini();

    //! Charge le fichier à la suite.
    /*! Charge le fichier à la suite des données actuelles.
    */
    void    Load();

    //! Sauve les données.
    /*! Sauve toutes les données dans le fichier ini.
    */
    void    Save();

    //! Ajoute une section.
    /*! Ajoute une section.
        \param pName nom de la section
        \sa DelSection(), GetSection() et GetNbSection().
    */
    void    AddSection(const char *pName);

    //! Supprime une section.
    /*! Supprime la section étant à la position \a iPos.
        \param iPos position de la section.
        \sa AddSection(), GetSection() et GetNbSection().
    */
    void    DelSection(unsigned int iPos);

    //! Supprime une section.
    /*! Supprime la section de nom \a pName.
        \param pName nom de la section.
        \sa AddSection(), GetSection() et GetNbSection().
    */
    void    DelSection(const char *pName);

    //! Retourne une section par sa position.
    /*! Permet l'acces à la section étant à la position \a iPos.
        \param iPos position de la section.
        \return pointeur sur la class de la section.
        \sa AddSection(), DelSection() et GetNbSection().
    */
    IniSection  *GetSection(unsigned int iPos);

    //! Retourne une section par son nom.
    /*! Permet l'acces à la section ayant le nom \a pName.
        \param pName nom de la section.
        \param iOcur numéro de l'occurence si plusieur section on le même nom.
        \return pointeur sur la class de la section.
        \sa AddSection(), DelSection() et GetNbSection().
    */
    IniSection  *GetSection(const char *pName, unsigned int iOcur = 0);

    //! Retourne le nom d'une section.
    /*! Retourne le nom de la section étant à la position \a iPos.
        \param iPos position de la section.
        \return nom de la section.
    */
    const char  *GetSectionName(unsigned int iPos);

    //! Retourne le nombre de section.
    /*! Retourne le nombre de section contenu dans le fichier ini.
        \return nombre de section dans le fichier ini.
        \sa AddSection(), DelSection() et GetSection().
    */
    inline unsigned int     GetNbSection()
    {
        return sections.size();
    };

    //! Retourne le nombre de section.
    /*! Retourne le nombre de section ayant pour nom \a pName contenu dans le fichier ini.
        \param pName nom de la section.
        \return nombre de section dans le fichier ini se nomant \a pName.
        \sa AddSection(), DelSection() et GetSection().
    */
    unsigned int    GetNbSection(const char *pName);

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

    //! Retourne le nom du fichier.
    /*! Retourne le nom le nom du fichier ini \a name.
        \return un pointeur sur le nom du fichier ini \a name.
        \sa SetName().
    */
    inline const char   *GetName()
    {
        return fileName.data();
    };

    //! Définie le nom du fichier.
    /*! Définie le nom du fichier ini \a name.
        \param pName nom du fichier.
        \return un pointeur sur le nom du fichier \a name.
        \sa GetName().
    */
    inline const char   *SetName(const char *pName)
    {
        fileName = pName;
        return fileName.data();
    };
};


#endif

---