IniSection.h

Aller à la documentation de ce fichier.

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

    Gestion d'une section dans \a Ini.

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

#ifndef INCLUDE_RSRC_INI_SECTION
#define INCLUDE_RSRC_INI_SECTION

#include    "../Error/Error.h"
#include    "IniItem.h"
#include    <vector>
#include    <string>

using namespace std;


//! Gestion d'une section.
/*! Gestion d'une section dans \a Ini.
*/
class IniSection
{
private :
    string                  name;       /*!< Nom de la section.                                     */
    std::vector<IniItem *>  items;      /*!< Chaque ligne est un item.                              */
    IniItem                 *itemVide;  /*!< Item vide pour évité les segfault.                     */

public  :
    /*! Initialise avec des parametres par defaut.
        \param pName nom de l'item
    */
    IniSection(const char *pName);

    /*! Libere proprement la mémoire.
    */
    ~IniSection();

    //! Ajoute un item.
    /*! Ajoute un item avec comme nom \a pName.
        \sa DelItem(), GetItem() et GetNbItem().
    */
    void    AddItem(const char *pName);

    //! Supprime un item.
    /*! Supprime l'item étant à la position \a iPos.
        \param iPos position de l'item.
        \sa AddItem(), GetItem() et GetNbItem().
    */
    void    DelItem(unsigned int iPos);

    //! Supprime un item.
    /*! Supprime l'item de nom \a pName.
        \param pName nom de l'item.
        \sa AddItem(), GetItem() et GetNbItem().
    */
    void    DelItem(const char *pName);

    //! Retourne un item par sa position.
    /*! Permet l'acces à l'item étant à la position \a iPos.
        \param iPos  position de l'item.
        \return pointeur sur la classe de l'item.
        \sa AddItem(), DelItem() et GetNbItem().
    */
    IniItem *GetItem(unsigned int iPos);

    //! Retourne le dernier item.
    /*! Permet l'acces au dernier item ajouter.
        \return pointeur sur la classe de l'item.
        \sa AddItem(), DelItem() et GetNbItem().
    */
    IniItem *GetItem();

    //! Retourne un item par son nom.
    /*! Permet l'acces à l'item ayant le nom \a pName.
        \param pName nom de l'item.
        \param iOcur numéro de l'occurence si plusieur item on le même nom.
        \return pointeur sur la class de l'item.
        \sa AddItem(), DelItem() et GetNbItem().
    */
    IniItem *GetItem(const char *pName, unsigned int iOcur = 0);

    //! Retourne le nom d'un item.
    /*! Retourne le nom de l'item étant à la position \a iPos.
        \param iPos  position de l'item.
        \return nom de l'item.
    */
    const char  *GetItemName(unsigned int iPos);

    //! Retourne le nombre d'item.
    /*! Retourne le nombre d'item contenu dans la section.
        \return nombre d'item dans la section.
        \sa AddItem(), DelItem() et GetItem().
    */
    inline unsigned int     GetNbItem()
    {
        return items.size();
    };

    //! Retourne le nombre d'item.
    /*! Retourne le nombre d'item se nomant \a pName contenu dans la section.
        \param pName nom de l'item.
        \return nombre d'item dans la section.
        \sa AddItem(), DelItem() et GetItem().
    */
    unsigned int    GetNbItem(const char *pName);

    //! Retourne le nom de la section.
    /*! Retourne le nom le nom de la section \a Name.
        \return un pointeur sur le nom de la section \a Name.
        \sa SetName().
    */
    inline const char   *GetName()
    {
        return name.data();
    };

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


#endif

---